L'API GKE On-Prem è un'API ospitata da Google Cloud che consente di gestire
del ciclo di vita dei cluster on-premise mediante strumenti standard:
Console Google Cloud, Google Cloud CLI o Terraform. Quando crei un
utilizzando uno di questi strumenti, l'API archivia i metadati
nella regione Google Cloud specificata durante la creazione del cluster.
Questi metadati consentono di gestire il ciclo di vita del cluster utilizzando
gli strumenti standard. Se vuoi utilizzare questi strumenti per visualizzare i dettagli del cluster o gestire
il ciclo di vita dei cluster creati utilizzando bmctl
, devi
registrare i cluster nell'API GKE On-Prem.
Terminologia
La registrazione di un cluster ti consente di gestire il ciclo di vita del cluster utilizzando gcloud CLI o Terraform.
La registrazione di un cluster è un processo separato per la registrazione di un cluster in un parco risorse.
Un parco risorse è un raggruppamento logico di cluster Kubernetes che puoi gestire
in sinergia. Tutti i cluster Google Distributed Cloud vengono registrati a un parco risorse al momento della loro creazione. Quando crei un cluster utilizzando bmctl, il cluster viene registrato nel progetto Google Cloud specificato nel campo gkeConnect.projectID
del file di configurazione del cluster. Questo progetto
è definito come
progetto host del parco risorse.
Per saperne di più sui parchi risorse, inclusi casi d'uso, best practice ed esempi, consulta la documentazione relativa alla gestione del parco risorse.
Visualizzare i cluster registrati
Tutti i cluster del tuo parco risorse vengono visualizzati nelle pagine Cluster GKE della console. Entrambi ti offrono una panoramica l'intero parco risorse e, per Google Distributed Cloud, ti consente di vedere quali cluster gestite dall'API GKE On-Prem.
Per visualizzare i cluster del parco risorse:
-
Nella console, vai alla pagina dei cluster GKE.
Vai ai cluster GKE -
Seleziona il progetto Google Cloud.
- Se nella colonna Tipo viene visualizzato Bare metal, il valore è gestito dall'API GKE On-Prem.
- Se nella colonna Tipo è visualizzato Esterno, il cluster non è gestito dall'API GKE On-Prem.
Requisiti
- Solo i cluster utente e di amministrazione possono essere registrati con l'API GKE On-Prem. La registrazione di cluster ibridi e autonomi non è supportata.
Versione 1.13 o successive.
Se non sei proprietario del progetto, devi disporre minimo della funzionalità Identity and Access Management il ruolo
roles/gkeonprem.admin
nel progetto. Per informazioni dettagliate sulle autorizzazioni incluse in questo ruolo, consulta i ruoli GKE on-premise nella documentazione IAM.
Prima di iniziare
Configura l'interfaccia a riga di comando gcloud, se necessario.
Se devi installare gcloud CLI, consulta la documentazione di gcloud CLI. Aggiorna il Componenti della gcloud CLI, se necessario:
gcloud components update
Per attivare e utilizzare l'API GKE On-Prem:
Abilita l'API nel tuo progetto:
gcloud services enable \ --project PROJECT_ID \ gkeonprem.googleapis.com
Sostituisci
PROJECT_ID
con l'ID del progetto host del tuo parco risorse. Si tratta dell'ID progetto configurato nella sezionegkeconnect
del file di configurazione del cluster.Se viene visualizzato un errore
PERMISSION_DENIED
, controlla l'ID progetto inserito. Se l'ID progetto è corretto, eseguigcloud auth login
per accedere all'interfaccia a riga di comando Google Cloud con l'account che ha accesso al progetto.Se è la prima volta che attivi l'API GKE On-Prem nel tuo progetto, devi inizializzarla. Per farlo, chiama un comando gcloud CLI che mostra le versioni disponibili che puoi utilizzare per creare un cluster:
gcloud container bare-metal clusters query-version-config \ --project=PROJECT_ID \ --location=REGION
Sostituisci
REGION
conus-west1
o un altro regione supportata.
Se la tua organizzazione ha configurato una lista consentita che consente al traffico Le API di Google e altri indirizzi passano attraverso server proxy, aggiungi quanto segue alla lista consentita:
gkeonprem.googleapis.com
gkeonprem.mtls.googleapis.com
Questi sono i nomi dei servizi per l'API GKE On-Prem.
Registra un cluster utente
Interfaccia a riga di comando gcloud
Assicurati di scorrere, se necessario, per compilare il segnaposto ADMIN_CLUSTER_NAME
per il flag --admin-cluster-membership
.
gcloud container bare-metal clusters enroll USER_CLUSTER_NAME \ --project=PROJECT_ID \ --admin-cluster-membership=projects/PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \ --location=REGION
Sostituisci quanto segue:
USER_CLUSTER_NAME
: il nome del cluster utente che vuoi registrare.PROJECT_ID
L'ID del progetto host del parco risorse.ADMIN_CLUSTER_NAME
: il cluster di amministrazione che gestisce il cluster di utenti. Il nome del cluster di amministrazione è l'ultimo segmento del nome completo del cluster che identifica in modo univoco del cluster in Google Cloud.REGION
: la regione Google Cloud in cui viene eseguita l'API GKE On-Prem e vengono archiviati i metadati del cluster. Specificaus-west1
o un altro regione supportata. La regione non può essere modificata dopo la registrazione del cluster.
bmctl
Esegui i seguenti passaggi sulla workstation di amministrazione.
Aggiungi la seguente sezione al file di configurazione del cluster utente:
gkeOnPremAPI: enabled: true location: REGION
Sostituisci
REGION
con la regione Google Cloud in cui viene eseguita l'API GKE On-Prem e vengono archiviati i metadati del cluster. Specificaus-west1
o altro regione supportata. La regione non può essere modificata dopo la registrazione del cluster.Aggiorna il cluster:
bmctl update cluster -c USER_CLUSTER_NAME \ --kubeconfig ADMIN_CLUSTER_KUBECONFIG
Sostituisci quanto segue:
USER_CLUSTER_NAME
: il nome del cluster utente per aggiornarli.ADMIN_CLUSTER_KUBECONFIG
: il percorso del file kubeconfig del cluster di amministrazione.
Registra un cluster di amministrazione
Interfaccia a riga di comando gcloud
Assicurati di scorrere, se necessario, per compilare il segnaposto ADMIN_CLUSTER_NAME
per il flag --admin-cluster-membership
.
gcloud container bare-metal admin-clusters enroll ADMIN_CLUSTER_NAME \ --project=PROJECT_ID \ --admin-cluster-membership=projects/PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \ --location=REGION
Sostituisci quanto segue:
ADMIN_CLUSTER_NAME
: il nome del cluster di amministrazione che vuoi registrare.PROJECT_ID
L'ID progetto del tuo progetto host del parco risorse.ADMIN_CLUSTER_NAME
ePROJECT_ID
vengono utilizzati per formare il nome del cluster completamente specificato per il flag--admin-cluster-membership
.REGION
: la regione Google Cloud in cui viene eseguita l'API GKE On-Prem e vengono archiviati i metadati del cluster. Specificaus-west1
o un altro regione supportata. La regione non può essere modificata dopo la registrazione del cluster.
bmctl
Esegui i seguenti passaggi sulla workstation di amministrazione.
Aggiungi la sezione seguente al file di configurazione del cluster di amministrazione:
gkeOnPremAPI: enabled: true location: REGION
Sostituisci
REGION
con la regione Google Cloud in che l'API GKE On-Prem esegue e archivia i metadati del cluster. Specificaus-west1
o altro regione supportata. La regione non può essere modificata dopo la registrazione del cluster.Aggiorna il cluster:
bmctl update cluster -c ADMIN_CLUSTER_NAME \ --kubeconfig ADMIN_CLUSTER_KUBECONFIG
Sostituisci quanto segue:
ADMIN_CLUSTER_NAME
: il nome del cluster di amministrazione da aggiornare.ADMIN_CLUSTER_KUBECONFIG
: il percorso dell'amministratore kubeconfig del cluster.
Ottieni informazioni sul tuo cluster
Dopo aver registrato il cluster, puoi usare i comandi seguenti per informazioni sui cluster:
Cluster utente
- Per descrivere un cluster di utenti:
gcloud container bare-metal clusters describe USER_CLUSTER_NAME \ --project=PROJECT_ID \ --location=REGION
- Per elencare i cluster utente:
gcloud container bare-metal clusters list \ --project=PROJECT_ID \ --location=-
Se imposti --location=-
, vengono elencati tutti i cluster in tutte le regioni. Se devi ridurre l'ambito dell'elenco, imposta --location
sulla regione
che hai specificato al momento della registrazione del cluster.
Cluster di amministrazione
- Per descrivere un cluster di amministrazione:
gcloud container bare-metal admin-clusters describe ADMIN_CLUSTER_NAME \ --project=PROJECT_ID \ --location=REGION
- Per elencare i cluster di amministrazione:
gcloud container bare-metal admin-clusters list \ --project=PROJECT_ID \ --location=-
Se imposti --location=-
, vengono elencati tutti i cluster in tutte le regioni. Se devi ridurre l'ambito dell'elenco, imposta --location
sulla regione
che hai specificato al momento della registrazione del cluster.
Connettiti al cluster
Dopo aver registrato il cluster con l'API GKE On-Prem, devi scegliere e configurare un metodo di autenticazione per poter gestire il cluster dalla console Google Cloud. Il metodo di autenticazione selezionato controlla anche l'accesso al cluster dalla riga di comando. Per maggiori informazioni informazioni, consulta le seguenti risorse: