Cluster konfigurieren, der von der GKE On-Prem API verwaltet werden soll

Die GKE On-Prem API ist eine von Google Cloud gehostete API, mit der Sie den Lebenszyklus Ihrer lokalen Cluster mithilfe von Standardtools verwalten können: Google Cloud Console, Google Cloud CLI oder Terraform. Wenn Sie mit einem dieser Tools einen Cluster erstellen, speichert die API Metadaten zum Status Ihres Clusters in der Google Cloud-Region, die Sie beim Erstellen des Clusters angegeben haben. Mit diesen Metadaten können Sie den Lebenszyklus des Clusters mit den Standardtools verwalten. Wenn Sie mit diesen Tools Clusterdetails aufrufen oder den Lebenszyklus von Clustern verwalten möchten, die mit bmctl erstellt wurden, müssen Sie die Cluster in der GKE On-Prem API anmelden.

Terminologie

Wenn Sie einen Cluster anmelden, können Sie den Clusterlebenszyklus über die Console, die gcloud CLI oder Terraform verwalten.

Die Anmeldung eines Clusters ist ein separater Vorgang, der sich von der Registrierung eines Clusters bei einer Flotte unterscheidet. Eine Flotte ist eine logische Gruppierung von Kubernetes-Clustern, die Sie gemeinsam verwalten können. Alle Google Distributed Cloud-Cluster werden beim Erstellen bei einer Flotte registriert. Wenn Sie einen Cluster mit bmctl erstellen, wird er bei dem Google Cloud-Projekt angemeldet, das Sie im gkeConnect.projectID-Feld der Cluster-Konfigurationsdatei angeben. Dieses Projekt wird auch als Flotten-Hostprojekt bezeichnet. Weitere Informationen zu Flotten, darunter Anwendungsfälle, Best Practices und Beispiele, finden Sie in der Dokumentation zur Flottenverwaltung.

Registrierte Cluster ansehen

Alle Ihre Flottencluster werden auf den GKE-Cluster-Seiten in der Console angezeigt. So erhalten Sie einen Überblick über Ihre gesamte Flotte und sehen bei Google Distributed Cloud, welche Cluster von der GKE On-Prem API verwaltet werden.

So rufen Sie Ihre Flottencluster auf:

Rufen Sie in der Console die Seite der GKE-Cluster auf.
Zu GKE-Clustern
Wählen Sie das Google Cloud-Projekt aus.
- Wenn in der Spalte Typ Bare Metal angezeigt wird, wird der Cluster von der GKE On-Prem API verwaltet.
- Wenn in der Spalte Typ Extern angezeigt wird, wird der Cluster nicht von der GKE On-Prem API verwaltet.

Voraussetzungen

Nur Nutzer- und Administratorcluster können bei der GKE On-Prem API registriert werden. Die Registrierung von Hybrid- und eigenständigen Clustern wird nicht unterstützt.
Version 1.13 oder höher.
Wenn Sie kein Projektinhaber sind, benötigen Sie mindestens die IAM-Rolle roles/gkeonprem.admin für das Projekt. Weitere Informationen zu den in dieser Rolle enthaltenen Berechtigungen finden Sie in der IAM-Dokumentation unter GKE On-Prem-Rollen.

Vorbereitung

Richten Sie bei Bedarf die gcloud CLI ein.
1. Informationen zur Installation der gcloud CLI finden Sie in der Dokumentation zur gcloud CLI. Aktualisieren Sie gegebenenfalls die gcloud CLI-Komponenten:
```
gcloud components update
```
Führen Sie die folgenden Schritte aus, um die GKE On-Prem API zu aktivieren und zu verwenden:
1. Aktivieren Sie die API in Ihrem Projekt:
```
gcloud services enable \
    --project PROJECT_ID \
    gkeonprem.googleapis.com
```
  Ersetzen Sie PROJECT_ID durch die Projekt-ID des Flotten-Hostprojekts. Dies ist die Projekt-ID, die im gkeconnect-Abschnitt der Cluster-Konfigurationsdatei konfiguriert wurde.
  
  Wenn Sie den PERMISSION_DENIED-Fehler erhalten, prüfen Sie die eingegebene Projekt-ID. Wenn die Projekt-ID korrekt ist, führen Sie gcloud auth login aus, um sich mit dem Konto, das Zugriff auf das Projekt hat, in der Google Cloud CLI anzumelden.
2. Wenn Sie die GKE On-Prem API zum ersten Mal in Ihrem Projekt aktiviert haben, müssen Sie die API initialisieren. Dazu können Sie einen gcloud-Befehl aufrufen, der die verfügbaren Versionen anzeigt, mit denen Sie einen Cluster erstellen können:
```
gcloud container bare-metal clusters query-version-config \
    --project=PROJECT_ID \
    --location=REGION
```
  Ersetzen Sie REGION durch us-west1 oder eine andere unterstützte Region.
Wenn Ihre Organisation eine Zulassungsliste eingerichtet hat, mit der Traffic von Google APIs und anderen Adressen über Ihren Proxyserver geleitet werden kann, fügen Sie der Zulassungsliste Folgendes hinzu:
- gkeonprem.googleapis.com
- gkeonprem.mtls.googleapis.com
Dies sind die Dienstnamen für die GKE On-Prem API.

Nutzercluster registrieren

gcloud-CLI

Scrollen Sie gegebenenfalls nach unten, um die ADMIN_CLUSTER_NAME-Platzhalter für das --admin-cluster-membership-Flag auszufüllen.

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

Ersetzen Sie dabei Folgendes:

USER_CLUSTER_NAME: Der Name des Nutzerclusters, den Sie registrieren möchten.
PROJECT_ID ist die Projekt-ID des Flotten-Hostprojekts.
ADMIN_CLUSTER_NAME: Der Administratorcluster, der den Nutzercluster verwaltet. Der Name des Administratorclusters ist das letzte Segment des vollständig spezifizierten Clusternamens, mit dem der Cluster in Google Cloud klar identifiziert wird.
REGION: Die Google Cloud-Region, in der die GKE On-Prem API ausgeführt wird und Clustermetadaten speichert. Geben Sie us-west1 oder eine andere unterstützte Region an. Die Region kann nach der Anmeldung des Clusters nicht mehr geändert werden.

`bmctl`

Führen Sie die folgenden Schritte auf Ihrer Administrator-Workstation aus.

Fügen Sie der Konfigurationsdatei für den Nutzercluster folgenden Abschnitt hinzu:
```
gkeOnPremAPI:
  enabled: true
  location: REGION
```
Ersetzen Sie REGION durch die Google Cloud-Region, in der die GKE On-Prem API ausgeführt wird und Clustermetadaten speichert. Geben Sie us-west1 oder eine andere unterstützte Region an. Die Region kann nach der Anmeldung des Clusters nicht mehr geändert werden.
Aktualisieren Sie den Cluster:
```
bmctl update cluster -c USER_CLUSTER_NAME \
  --kubeconfig ADMIN_CLUSTER_KUBECONFIG
```
Ersetzen Sie dabei Folgendes:
- USER_CLUSTER_NAME: Name des Nutzerclusters, der aktualisiert werden soll.
- ADMIN_CLUSTER_KUBECONFIG: Pfad der kubeconfig-Datei des Administratorclusters.

Administratorcluster registrieren

gcloud-CLI

Scrollen Sie gegebenenfalls nach unten, um die ADMIN_CLUSTER_NAME-Platzhalter für das --admin-cluster-membership-Flag auszufüllen.

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

Ersetzen Sie dabei Folgendes:

ADMIN_CLUSTER_NAME: Name des Administratorclusters, den Sie registrieren möchten.
PROJECT_ID ist die Projekt-ID des Flotten-Hostprojekts.

ADMIN_CLUSTER_NAME und PROJECT_ID werden verwendet, um den vollständig spezifizierten Clusternamen für das --admin-cluster-membership-Flag zu bilden.
REGION: Die Google Cloud-Region, in der die GKE On-Prem API ausgeführt wird und Clustermetadaten speichert. Geben Sie us-west1 oder eine andere unterstützte Region an. Die Region kann nach der Anmeldung des Clusters nicht mehr geändert werden.

`bmctl`

Führen Sie die folgenden Schritte auf Ihrer Administrator-Workstation aus.

Fügen Sie der Konfigurationsdatei für den Administratorcluster folgenden Abschnitt hinzu:
```
gkeOnPremAPI:
  enabled: true
  location: REGION
```
Ersetzen Sie REGION durch die Google Cloud-Region, in der die GKE On-Prem API ausgeführt wird und Clustermetadaten speichert. Geben Sie us-west1 oder eine andere unterstützte Region an. Die Region kann nach der Anmeldung des Clusters nicht mehr geändert werden.
Aktualisieren Sie den Cluster:
```
bmctl update cluster -c ADMIN_CLUSTER_NAME \
--kubeconfig ADMIN_CLUSTER_KUBECONFIG
```
Ersetzen Sie dabei Folgendes:
- ADMIN_CLUSTER_NAME: Name des zu aktualisierenden Administratorclusters.
- ADMIN_CLUSTER_KUBECONFIG: Pfad der kubeconfig-Datei des Administratorclusters.

Informationen zu Ihrem Cluster abrufen

Nachdem der Cluster registriert wurde, können Sie mit den folgenden Befehlen Informationen zu Ihren Clustern abrufen:

Nutzercluster

So beschreiben Sie einen Nutzercluster:

gcloud container bare-metal clusters describe USER_CLUSTER_NAME \
    --project=PROJECT_ID \
    --location=REGION

So listen Sie Ihre Nutzercluster auf:

gcloud container bare-metal clusters list \
    --project=PROJECT_ID \
    --location=-

Wenn Sie --location=- festlegen, bedeutet dies, dass alle Cluster in allen Regionen aufgelistet werden. Wenn Sie den Bereich in der Liste verkleinern möchten, legen Sie --location auf die Region fest, die Sie bei der Clusterregistrierung angegeben haben.

Administratorcluster

So beschreiben Sie einen Administratorcluster:

gcloud container bare-metal admin-clusters describe ADMIN_CLUSTER_NAME \
    --project=PROJECT_ID \
    --location=REGION

So rufen Sie eine Liste Ihrer Administratorcluster auf:

gcloud container bare-metal admin-clusters list \
    --project=PROJECT_ID \
    --location=-

Mit dem Cluster verbinden

Nachdem der Cluster bei der GKE On-Prem API registriert wurde, müssen Sie eine Authentifizierungsmethode auswählen und konfigurieren, damit Sie den Cluster über die Google Cloud Console verwalten können. Die von Ihnen ausgewählte Authentifizierungsmethode steuert auch den Zugriff auf den Cluster über die Befehlszeile. Weitere Informationen nachstehend: