Die Anthos On-Prem API ist eine von Google Cloud gehostete API, mit der Sie den Lebenszyklus Ihrer lokalen Cluster mithilfe von Standardtools verwalten können: der Google Cloud Console, der Google Cloud CLI oder Terraform. Wenn Sie einen Cluster mit einem dieser Tools erstellen, speichert die API Metadaten zum Status des Clusters in der Google Cloud-Region, die Sie beim Erstellen des Clusters angegeben haben.
Mit diesen Metadaten können Sie den Lebenszyklus des Clusters mithilfe der Standardtools verwalten. Wenn Sie diese Tools verwenden möchten, um Clusterdetails anzusehen oder den Lebenszyklus von Clustern zu verwalten, die mit bmctl
erstellt wurden, müssen Sie die Cluster in der Anthos On-Prem API registrieren.
Terminologie
Durch die Registrierung eines Clusters können Sie den Clusterlebenszyklus mithilfe der Console, der gcloud CLI oder Terraform verwalten.
Das Registrieren eines Clusters ist ein separater Prozess zur Registrierung eines Clusters bei einer Flotte.
Eine Flotte ist eine logische Gruppierung von Kubernetes-Clustern, die Sie zusammen verwalten können. Alle GKE on Bare Metal werden beim Erstellen des Clusters bei einer Flotte registriert. Wenn Sie einen Cluster mit bmctl erstellen, wird der Cluster in dem Google Cloud-Projekt registriert, das Sie in der Clusterkonfigurationsdatei im Feld gkeConnect.projectID
angeben. Dieses Projekt wird als Flotten-Hostprojekt bezeichnet.
Weitere Informationen zu Flotten, einschließlich Anwendungsfällen, Best Practices und Beispielen, finden Sie in der Dokumentation zur Flottenverwaltung.
Registrierte Cluster ansehen
Alle Ihre Flottencluster werden in der Console auf den Seiten GKE Enterprise-Cluster und GKE-Cluster angezeigt. So erhalten Sie einen Überblick über Ihre gesamte Flotte und können bei GKE on Bare Metal sehen, welche Cluster von der Anthos On-Prem API verwaltet werden.
So rufen Sie Ihre Flottencluster auf:
-
Rufen Sie in der Console die Seite „GKE Enterprise-Cluster“ auf.
Zur Seite „GKE Enterprise-Cluster“ -
Wählen Sie das Google Cloud-Projekt aus.
- Wenn Anthos (Bare Metal) in der Spalte Typ angezeigt wird, wird der Cluster von der Anthos On-Prem API verwaltet.
- Wenn in der Spalte Typ Extern angezeigt wird, wird der Cluster nicht von der Anthos On-Prem API verwaltet.
Voraussetzungen
- Nur Nutzer- und Administratorcluster können mit der Anthos On-Prem API registriert werden. Die Registrierung von Hybrid- und eigenständigen Clustern wird nicht unterstützt.
- Version 1.13 oder höher.
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 Anthos On-Prem API.
Wenn Sie kein Projektinhaber sind, benötigen Sie mindestens die Rolle
roles/gkeonprem.admin
der Identity and Access Management für das Projekt. Weitere Informationen zu den Berechtigungen in dieser Rolle finden Sie in der IAM-Dokumentation unter GKE On-Prem-Rollen.
Cluster registrieren
So registrieren Sie einen Cluster für die Verwaltung durch die Anthos On-Prem API:
Prüfen Sie, ob Sie die neueste Version der gcloud CLI haben. Aktualisieren Sie bei Bedarf die Komponenten der gcloud CLI:
gcloud components update
Aktivieren Sie die Anthos On-Prem API in Ihrem Flottenhostprojekt:
gcloud services enable \ --project FLEET_HOST_PROJECT_ID \ gkeonprem.googleapis.com
Ersetzen Sie
FLEET_HOST_PROJECT_ID
durch die Projekt-ID Ihres Flotten-Hostprojekts. Dies ist die Projekt-ID, die im Abschnittgkeconnect
Ihrer Clusterkonfigurationsdatei konfiguriert wurde.Registrieren Sie den Cluster bei der Anthos On-Prem API:
Nutzercluster
Scrollen Sie gegebenenfalls nach unten, um den Platzhalter
ADMIN_CLUSTER_NAME
für das Flag--admin-cluster-membership
auszufüllen.gcloud container bare-metal clusters enroll USER_CLUSTER_NAME \ --project=FLEET_HOST_PROJECT_ID \ --admin-cluster-membership=projects/FLEET_HOST_PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \ --location=LOCATION
Ersetzen Sie Folgendes:
USER_CLUSTER_NAME
: Der Name des Nutzerclusters, den Sie registrieren möchten.FLEET_HOST_PROJECT_ID
: Die Projekt-ID Ihres Flottenhostprojekts.ADMIN_CLUSTER_NAME
: Der Administratorcluster, der den Nutzercluster verwaltet. Der Name des Administratorclusters ist das letzte Segment des vollständigen Clusternamens, der den Cluster in Google Cloud eindeutig identifiziert.LOCATION
: Die Google Cloud-Region, in der die Anthos On-Prem API ausgeführt wird. Geben Sieus-west1
oder eine andere unterstützte Region an. Die Region kann nach der Registrierung des Clusters nicht mehr geändert werden. Neben der Festlegung der Region, in der die Anthos On-Prem API ausgeführt wird, ist dies die Region, in der Folgendes gespeichert wird:- Die Nutzerclustermetadaten, die die Anthos On-Prem API zum Verwalten des Clusterlebenszyklus benötigt
- Cloud Logging- und Cloud Monitoring-Daten von Systemkomponenten
- Das von Cloud-Audit-Logs erstellte Administrator-Audit-Log
Administratorcluster
Scrollen Sie gegebenenfalls nach unten, um den Platzhalter
ADMIN_CLUSTER_NAME
für das Flag--admin-cluster-membership
auszufüllen.gcloud container bare-metal admin-clusters enroll ADMIN_CLUSTER_NAME \ --project=FLEET_HOST_PROJECT_ID \ --admin-cluster-membership=projects/FLEET_HOST_PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME \ --location=LOCATION
Ersetzen Sie Folgendes:
ADMIN_CLUSTER_NAME
: Der Name des Administratorclusters, den Sie registrieren möchten.FLEET_HOST_PROJECT_ID
: Die Projekt-ID Ihres Flottenhostprojekts.ADMIN_CLUSTER_NAME
undFLEET_HOST_PROJECT_ID
bilden den vollständig angegebenen Clusternamen für das Flag--admin-cluster-membership
.LOCATION
: Die Google Cloud-Region, in der die Anthos On-Prem API ausgeführt wird. Geben Sieus-west1
oder eine andere unterstützte Region an. Die Region kann nach der Registrierung des Clusters nicht mehr geändert werden. Neben der Festlegung der Region, in der die Anthos On-Prem API ausgeführt wird, ist dies die Region, in der Folgendes gespeichert wird:- Die Clustermetadaten, die die Anthos On-Prem API zum Verwalten des Clusterlebenszyklus benötigt
- Cloud Logging- und Cloud Monitoring-Daten von Systemkomponenten
- Das von Cloud-Audit-Logs erstellte Administrator-Audit-Log
Nach der Registrierung des Clusters 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=FLEET_HOST_PROJECT_ID \ --location=LOCATION
- So listen Sie Ihre Nutzercluster auf:
gcloud container bare-metal clusters list \ --project=FLEET_HOST_PROJECT_ID \ --location=-
Wenn Sie
--location=-
festlegen, werden alle Cluster in allen Regionen aufgelistet. Wenn Sie die Liste verkleinern müssen, legen Sie--location
auf die Region fest, die Sie bei der Registrierung des Clusters angegeben haben.Administratorcluster
- So beschreiben Sie einen Administratorcluster:
gcloud container bare-metal admin-clusters describe ADMIN_CLUSTER_NAME \ --project=FLEET_HOST_PROJECT_ID \ --location=LOCATION
- So listen Sie Ihre Administratorcluster auf:
gcloud container bare-metal admin-clusters list \ --project=FLEET_HOST_PROJECT_ID \ --location=-
Wenn Sie
--location=-
festlegen, werden alle Cluster in allen Regionen aufgelistet. Wenn Sie die Liste verkleinern müssen, legen Sie--location
auf die Region fest, die Sie bei der Registrierung des Clusters angegeben haben.
Mit dem Cluster verbinden
Nachdem der Cluster bei der Anthos 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. Hier finden Sie weitere Informationen: