Mit dem GKE-Add-on installieren

Auf dieser Seite wird beschrieben, wie Sie Config Connector mit dem Config-Add-on in einem Google Kubernetes Engine-Cluster (GKE) installieren.

Weitere Informationen zu den einzelnen Installationsoptionen mit ihren Vor- und Nachteilen finden Sie unter Installationstyp auswählen.

Hinweise

Führen Sie die folgenden Aufgaben aus, bevor Sie beginnen:

• Aktivieren Sie die Google Kubernetes Engine API.
Google Kubernetes Engine API aktivieren
• Wenn Sie die Google Cloud CLI für diese Aufgabe verwenden möchten, müssen Sie die gcloud CLI installieren und dann initialisieren. Wenn Sie die gcloud CLI bereits installiert haben, rufen Sie die neueste Version mit gcloud components update ab.

• Wählen Sie ein Google Cloud -Projekt aus oder erstellen Sie eines, um den Config Connector zu installieren.

• Wenn Sie Config Connector zuvor manuell installiert haben, deinstallieren Sie es, bevor Sie das Config Connector-Add-on installieren:

  • Clustermodus deinstallieren
  • Namespace-Modus deinstallieren

Config Connector-Add-ons installieren

Sie wenden das Config Connector-Add-on durch Erstellen eines neuen GKE Clusters oder durch Aktivieren eines vorhandenen Clusters an. Nach der Installation des Config Connector-Add-ons konfigurieren Sie die Config Connector-Installation mit Ihren Google-Dienstkonten und Ihren Namespaces.

Voraussetzungen

Das Config Connector-Add-on hat folgende Anforderungen:

• Sie benötigen eine der folgenden GKE-Versionen:

  • 1.15.11-gke.5 und höher
  • 1.16.8-gke.8 und höher
  • 1.17.4-gke.5 und höher

• Sie müssen einen Workload Identity-Pool und das Kubernetes Engine Monitoring für die Cluster aktivieren, in denen Sie Config Connector aktivieren.

Einen GKE-Cluster einrichten

Sie können das Config Connector-Add-on für neue oder vorhandene Cluster verwenden.

Neuen Cluster mit aktiviertem Config Connector-Add-on erstellen

Sie können einen GKE-Cluster mit der gcloud CLI oder derGoogle Cloud -Konsole erstellen.

gcloud container clusters create CLUSTER_NAME \
    --release-channel CHANNEL \
    --addons ConfigConnector \
    --workload-pool=PROJECT_ID.svc.id.goog \
    --logging=SYSTEM \
    --monitoring=SYSTEM

Nachdem Sie den Cluster erstellt haben, müssen Sie eine Identität erstellen.

Config Connector-Add-on für einen vorhandenen Cluster aktivieren

Sie können das Config Connector-Add-on in einem vorhandenen GKE-Cluster mit gcloud oder mit der Google Cloud -Konsole aktivieren.

Vorbereitung

Das Aktivieren des Config Connector-Add-ons in einem vorhandenen Cluster hat folgende Voraussetzungen:

• Sie benötigen einen Cluster, der die Anforderungen für das Config Connector-Add-ons erfüllt.

• Richten Sie Workload Identity Federation for GKE in dem Cluster ein, in dem Sie Config Connector installieren möchten.

Verwenden Sie das gcloud-Befehlszeilentool, um die Identitätsföderation von Arbeitslasten für GKE für einen Knotenpool zu aktivieren:

gcloud container node-pools update NODE_POOL \
    --workload-metadata=GKE_METADATA \
    --cluster CLUSTER_NAME

Ersetzen Sie Folgendes:

• NODE_POOL durch den Namen Ihres Knotenpools ersetzen
• Ersetzen Sie CLUSTER_NAME durch den Namen Ihres Clusters.

Config Connector-Add-on aktivieren

Sie können das Config Connector-Add-on in einem vorhandenen GKE-Cluster mit dem Google Cloud CLI oder der Google Cloud -Konsole aktivieren.

gcloud container clusters update CLUSTER_NAME \
    --update-addons ConfigConnector=ENABLED

Identität erstellen

Config Connector erstellt und verwaltet Google Cloud Ressourcen. Dabei erfolgt die Authentifizierung über ein IAM-Dienstkonto (Identity and Access Management). Die Verknüpfung der IAM-Dienstkonten mit Kubernetes-Dienstkonten erfolgt per Workload Identity Federation for GKE.

Führen Sie zum Erstellen der Identität folgende Schritte aus:

1. IAM-Dienstkonto erstellen. Wenn Sie ein vorhandenes Dienstkonto verwenden möchten, können Sie das tun und diesen Schritt überspringen:

   gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
   

   Ersetzen Sie SERVICE_ACCOUNT_NAME mit einem Namen für das Dienstkonto.

   Weitere Informationen zum Erstellen von Dienstkonten finden Sie unter Dienstkonten erstellen und verwalten.

2. Gewähren Sie dem IAM-Dienstkonto erweiterte Berechtigungen für Ihr Projekt:

   gcloud projects add-iam-policy-binding PROJECT_ID \
     --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
     --role="roles/editor"
   

   Ersetzen Sie PROJECT_ID durch Ihre Projekt-ID.

3. Erstellen Sie eine IAM-Richtlinienbindung zwischen dem IAM-Dienstkonto und dem vordefinierten Kubernetes-Dienstkonto, das von Config Connector ausgeführt wird:

   gcloud iam service-accounts add-iam-policy-binding \
   SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
     --member="serviceAccount:PROJECT_ID.svc.id.goog[cnrm-system/cnrm-controller-manager]" \
     --role="roles/iam.workloadIdentityUser"
   

Config Connector konfigurieren

Um die Installation abzuschließen, erstellen Sie eine Konfigurationsdatei für die CustomResource-ConfigConnector und wenden diese dann mit dem Befehl kubectl apply an. Der Config Connector-Operator installiertGoogle Cloud -Ressourcen-CRDs und Config Connector-Komponenten in Ihrem Cluster.

Führen Sie die folgenden Schritte aus, um den Operator im Clustermodus zu konfigurieren:

1. Kopieren Sie die folgende YAML-Datei in eine Datei mit dem Namen configconnector.yaml:

   # configconnector.yaml
   apiVersion: core.cnrm.cloud.google.com/v1beta1
   kind: ConfigConnector
   metadata:
     # the name is restricted to ensure that there is only one
     # ConfigConnector resource installed in your cluster
     name: configconnector.core.cnrm.cloud.google.com
   spec:
     mode: cluster
     googleServiceAccount: "SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"
     # Setting `stateIntoSpec` to `Absent` is recommended. It means setting `cnrm.cloud.google.com/state-into-spec`
     # annotation to `absent` for all Config Connector resources created in the cluster in the future.
     # It prevents Config Connector from populating unspecified fields into the spec.
     stateIntoSpec: Absent

   Ersetzen Sie Folgendes:
   • SERVICE_ACCOUNT_NAME durch den Namen Ihres Dienstkontos.
   • PROJECT_ID durch Ihre Projekt-ID,
2. Wenden Sie die Konfiguration mit kubectl apply auf Ihren Cluster an:

     kubectl apply -f configconnector.yaml

Speicherort für Ressourcen angeben

Config Connector kann Ressourcen nach Projekt, Ordner oder Organisation organisieren. Dies entspricht dem Organisieren von Ressourcen mit Google Cloud.

Bevor Sie mit Config Connector Ressourcen erstellen, müssen Sie festlegen, wo die Ressourcen angelegt werden sollen. Um zu ermitteln, wo eine Ressource erstellt werden soll, nutzt Config Connector eine Annotation in der Ressourcenkonfiguration oder in einem vorhandenen Namespace. Weitere Informationen finden Sie unter Ressourcen organisieren.

kubectl create namespace NAMESPACE

Ersetzen Sie dabei NAMESPACE durch Ihren Namespace-Namen. Beispiel: config-connector.

Wählen Sie den Tab aus, in dem Config Connector Ressourcen anlegen soll.

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/project-id=PROJECT_ID

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/folder-id=FOLDER_ID

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/organization-id=ORGANIZATION_ID

Wenn Sie Ihren Namespace mit Annotationen versehen, erstellt Config Connector Ressourcen im entsprechenden Projekt, im entsprechenden Ordner oder in der entsprechenden Organisation. Weitere Informationen dazu, wie Config Connector Kubernetes-Namespaces nutzt, finden Sie unter Kubernetes-Namespaces und Google Cloud -Projekte.

Installation prüfen

Config Connector führt alle seine Komponenten in einem Namespace mit dem Namen cnrm-system aus. Mit dem folgenden Befehl können Sie prüfen, ob die Pods bereit sind:

kubectl wait -n cnrm-system \
      --for=condition=Ready pod --all

Wenn Config Connector korrekt installiert ist, sieht die Ausgabe etwa so aus:

pod/cnrm-controller-manager-0 condition met

Config Connector aktualisieren

Upgrades des Config Connector-Add-ons Ihres Clusters werden von Google Cloudverwaltet.

Die Ressourcen in Ihrem Cluster bleiben bei Upgrades erhalten.

Informationen dazu, wie Google Cloud Config Connector-Add-on-Upgrades verwaltet werden, oder Informationen zum Abrufen der neuesten Config Connector-Version

So verwaltet Google Cloud Config Connector-Add-on-Upgrades

Die Config Connector-Version, die ein GKE-Cluster erhält, hängt ausschließlich von der Nebenversion des GKE-Clusters ab. Beispiel:

Wenn Versionen infrage kommen, Google Cloud werden die neuesten GKE-Nebenversionen einer neu veröffentlichten Config Connector-Version zugeordnet. Dies geschieht für alle GKE-Nebenversionen, die neu genug sind, um nicht in den Release-Versionen „Regular“ oder „Stable“ verfügbar zu sein.

Da die Config Connector-Version, die ein Cluster erhält, von der GKE-Nebenversion des Clusters abhängt, gibt es zwei Fälle, in denen das Config Connector-Add-on eines Clusters automatisch von Google Cloudaktualisiert wird:

1. Der Cluster wird auf eine neue GKE-Nebenversion aktualisiert, die einer neueren Config Connector-Version zugeordnet ist.

2. Der Cluster verwendet eine GKE-Nebenversion, die neu genug ist, um nicht in den Release-Versionen „Regular“ oder „Stable“ verfügbar zu sein, undGoogle Cloud ordnet diese GKE-Nebenversion einer neuen Config Connector-Version zu.

Wenn Google Cloud eine GKE-Nebenversion neu zuordnet und vorhandene Cluster auf eine neue Config Connector-Version aktualisiert, wird gesagt, dass für diese GKE-Nebenversion eine neue Config Connector-Version eingeführt wird.

Google Cloud stellt keine neuen Config Connector-Versionen für GKE-Nebenversionen bereit, die alt genug sind, um aus Stabilitätsgründen in den Versionen der Regular- oder Stable-Release-Versionen verfügbar zu sein, außer in Notsituationen, in denen ein weitverbreitetes Problem erkannt wurde.

Neueste Version von Config Connector abrufen

Die Version von Config Connector, die über das Config Connector-Add-on installiert wird, ist oft bis zu 12 Monate oder länger veraltet. Wenn Sie die neueste Config Connector-Version benötigen, empfehlen wir, zu Config Controller zu wechseln oder Config Connector manuell zu installieren und Upgrades selbst durchzuführen. Die Migrationsanleitungen für die einzelnen Optionen sind:

• Wenn Sie zu Config Controller wechseln möchten, folgen Sie der Config Controller-Migrationsanleitung, um Ihre vorhandenen Config Connector-Ressourcen zu einer Config Controller-Instanz zu migrieren.

• Wenn Sie Config Connector manuell installieren möchten, folgen Sie der Anleitung, um vom Config Connector-Add-on zur manuellen Installation zu wechseln.

Config Connector deinstallieren

Führen Sie folgende Schritte aus, um Config Connector zu deinstallieren:

1. Entfernen Sie mit kubectl delete die Config Connector-CRDs und die Controllerkomponenten:

   kubectl delete ConfigConnector configconnector.core.cnrm.cloud.google.com --wait=true
   

2. Deaktivieren Sie das Config Connector-Add-on in Ihrem Cluster mit der gcloud CLI oder der Google Cloud -Konsole:

   gcloud

   Zum Deaktivieren des Config Connector-Add-ons mit gcloud führen Sie folgenden Befehl aus:

   gcloud container clusters update CLUSTER_NAME --update-addons ConfigConnector=DISABLED
   

   Ersetzen Sie dabei CLUSTER_NAME durch den Namen des Clusters, in dem das Config Connector-Add-on installiert ist.

   Cloud Console

   Mit den im Folgenden aufgeführten Schritten deaktivieren Sie das Config Connector-Add-on über die Google Cloud Konsole.

   1. Rufen Sie in der Google Cloud Console die Seite „Google Kubernetes Engine-Cluster“ auf und wählen Sie den Cluster aus, den Sie aktualisieren möchten.

      Google Kubernetes Engine-Menü aufrufen

   2. Klicken Sie auf Bearbeiten. Der Bildschirm Cluster bearbeiten wird angezeigt.

   3. Klicken Sie auf Add-ons.

   4. Wählen Sie Config Connector und dann Deaktiviert aus.

   5. Klicken Sie auf Speichern, um Ihren Cluster zu aktualisieren.

Nächste Schritte

• Erste Schritte mit Config Connector.
• Informationen zur Fehlerbehebung bei Config Connector