Config Sync-Dashboard verwenden

Auf dieser Seite wird die Verwendung des Config Sync-Dashboards erläutert.

Dieses Dashboard bietet Ihnen eine umfassende Übersicht über die von Config Sync verwalteten Pakete und den Status der Ressourcen in diesen Paketen.

Schlüsselbegriff: Ein Paket enthält alle Konfigurationen, die in den einzelnen Source of Truth-Elementen enthalten sind. Da Sie Ihren Cluster aus mehreren Quellen synchronisieren können, gibt es möglicherweise mehrere Pakete pro Cluster.

Vorbereitung

IAM-Berechtigungen

Für den Zugriff auf das Config Sync-Dashboard sind die folgenden IAM-Rollen im Projekt erforderlich:

• roles/container.clusterViewer
• roles/gkehub.viewer

Rollenbasierte Zugriffssteuerung

Der Nutzer benötigt außerdem die entsprechenden Kubernetes-Berechtigungen pro Cluster. Wenn Sie Nutzern keine umfangreichen Berechtigungen gewähren möchten, wie z. B. die des Clusteradministrators, können Sie eine benutzerdefinierte RBAC-Rolle erstellen, die die für die Verwendung des Config Sync-Dashboards erforderlichen Mindestberechtigungen enthält.

Mit der config-sync-dashboard-reader-ClusterRole werden dem Nutzer die Berechtigungen get und list für die vom Dashboard benötigten Ressourcen gewährt.

1. Führen Sie den folgenden Befehl aus, um die ClusterRole-config-sync-dashboard-reader zu erstellen und auf den Cluster anzuwenden:

   cat <<EOF > config-sync-dashboard-reader.yaml
   kind: ClusterRole
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     name: config-sync-dashboard-reader
   rules:
   - apiGroups: ["apiextensions.k8s.io"]
     resources: ["customresourcedefinitions"]
     verbs: ["get", "list"]
   - apiGroups: ["configmanagement.gke.io"]
     resources: ["configmanagements"]
     verbs: ["get", "list"]
   - apiGroups: ["configsync.gke.io"]
     resources: ["rootsyncs", "reposyncs"]
     verbs: ["get", "list"]
   - apiGroups: ["kpt.dev"]
     resources: ["resourcegroups"]
     verbs: ["get", "list"]
   - apiGroups: ["apps"]
     resources: ["deployments"]
     verbs: ["get", "list"]
   - apiGroups: [""]
     resources: ["pods", "services"]
     verbs: ["get", "list"]
   - apiGroups: ["anthos.cloud.google.com"]
     resources: ["canonicalservices"]
     verbs: ["get", "list"]
   - apiGroups: ["networking.istio.io"]
     resources: ["virtualservices"]
     verbs: ["get", "list"]
   
   EOF
   kubectl apply -f config-sync-dashboard-reader.yaml
   

2. Folgen Sie der Anleitung zum Konfigurieren der rollenbasierten Zugriffssteuerung in Google Kubernetes Engine (GKE) Enterprise Edition-Clustern, um die ClusterRoleBinding einzurichten.

Auf Dashboard zugreifen

1. Rufen Sie in der Google Cloud Console im Abschnitt Features die Seite Konfiguration auf.

   Zu „Config“

2. Wählen Sie das Projekt aus, das Sie anzeigen möchten.

Dashboard aufrufen

Auf dem Tab Dashboard erhalten Sie einen Überblick über den Status Ihrer Config Sync-Installationen:

• Unter Abgleichsstatus sehen Sie, wie viele Pakete abgeglichen wurden. Ein Paket wird abgeglichen, wenn der gewünschte Zustand, durch die Ressourcen im Paket ausgedrückt, realisiert wurde.

  Ihre Pakete können die folgenden Abgleichswerte haben:

  • Aktuell: Der tatsächliche Status des Pakets entspricht dem gewünschten Status. Der Abgleichsprozess gilt als abgeschlossen, bis Änderungen am gewünschten oder tatsächlichen Status vorgenommen werden.
  • In Bearbeitung: Der tatsächliche Status des Pakets hat noch nicht den gewünschten Status erreicht (durch die Ressourcen im Paket ausgedrückt). Neu erstellte Pakete beginnen in der Regel mit diesem Status.
  • Fehlgeschlagen: Bei dem Prozess, bei dem der tatsächliche Status mit dem gewünschten Status abgeglichen wird, ist ein Fehler aufgetreten oder er ist nicht ausreichend vorangeschritten.
  • Unbekannt: Config Sync konnte den Abgleichsstatus eines Pakets nicht ermitteln.

• Der Synchronisierungsstatus gibt an, wie viele Pakete synchronisiert wurden. Ein Paket wird synchronisiert, wenn der zuletzt beobachtete Zustand des Pakets in der Quelle (z. B. ein Git-Repository) im Cluster angezeigt wird.

  Ihre Pakete können die folgenden Synchronisierungswerte haben:

  • Synchronisiert: Das Paket ist mit einem Cluster synchronisiert.
  • Ausstehend: Für das Paket steht die Synchronisierung aus.
  • Abgleich: Die Bereitstellung, die ein Paket synchronisiert, wird abgeglichen.
  • Angehalten: Die Bereitstellung, bei der ein Paket synchronisiert wird, wurde angehalten.
  • Fehler: Im Paket ist während der Synchronisierung ein Fehler aufgetreten.
  • Unbekannt: Config Sync konnte den Synchronisierungsstatus eines Pakets nicht ermitteln.

• Der Config Sync-Status zeigt den Installationsstatus von Config Sync auf Ihren Clustern.

  Ihre Cluster können im Zusammenhang mit Config Sync folgende Statuswerte haben:

  • Aktiviert: Cluster, für die Config Sync aktiviert ist.
  • Nicht aktiviert: Cluster, für die Config Sync nicht aktiviert ist.
  • Ausstehend: Cluster, für die Config Sync aktiviert ist, für die aber Änderungen durchgeführt werden. Dieser Status tritt normalerweise während der Erstkonfiguration oder der Aktualisierung auf eine neue Version auf.
  • Fehler: Cluster, für die Config Sync aktiviert ist, bei denen aber ein Problem auftritt und Config Sync nicht arbeitet.
  • Unbekannt: Der Status von Config Sync kann nicht ermittelt werden.

Zusätzliche Tabellen zeigen nach Paket und Cluster gruppierte Probleme, enthalten Links zur Installation von Config Sync und zum Anzeigen von Einstellungen sowie Ressourcen für den Einstieg.

Paketstatus ansehen

Auf dem Tab Pakete können Sie detaillierte Informationen zu einzelnen Paketen und Clustern anzeigen lassen. Verwenden Sie diesen Tab, um mögliche Ursachen für Synchronisierungsfehler und fehlerhafte Ressourcen besser zu verstehen.

Paket bearbeiten

Sie können Ihre Paketkonfigurationen auch auf dem Tab Pakete bearbeiten.

Hinweis: Sie können von Hub verwaltete Pakete nicht auf diese Weise bearbeiten. Folgen Sie der Anleitung unter RootSync migrieren, um die Bearbeitung in der Google Cloud Console zu aktivieren.

Führen Sie die folgenden Schritte aus, um ein Paket zu bearbeiten:

1. Wählen Sie neben dem Namen des Pakets, das Sie bearbeiten möchten, in der Spalte Paket bearbeiten die Option aus.
2. Wählen Sie im Abschnitt Paketdetails aus der Drop-down-Liste Quelltyp Ihren Quelltyp aus.

3. Geben Sie im Abschnitt Quelle Folgendes ein:

   • Geben Sie für Quellen, die in einem Git-Repository gehostet werden, die folgenden Felder ein:

     1. Geben Sie die URL des Git-Repositorys, das Sie als „Source of Truth“ verwenden, als Repository-URL ein.
     2. Optional: Aktualisieren Sie das Feld Überarbeitung, um zu prüfen, ob Sie nicht die Standardeinstellung HEAD verwenden.
     3. Optional: Aktualisieren Sie das Feld Pfad, wenn Sie nicht aus dem Root-Repository synchronisieren möchten.
     4. Optional: Aktualisieren Sie das Feld Zweig, wenn Sie nicht den Standardzweig main verwenden.

   • Geben Sie für Quellen, die in einem OCI-Image gehostet werden, die folgenden Felder ein:

     1. Geben Sie die URL des OCI-Images, das Sie als „Source of Truth“ verwenden, als Image ein.
     2. Geben Sie den Pfad des Verzeichnisses relativ zum Stammverzeichnis als Verzeichnis ein, von dem aus synchronisiert werden soll.

4. (Optional): Maximieren Sie den Abschnitt Erweiterte Einstellungen, um Folgendes abzuschließen:

   1. Wählen Sie einen Authentifizierungstyp aus:

      Hinweis: Für OCI können Sie nur Workload Identity für die Authentifizierung auswählen.
      • Keine: Keine Authentifizierung verwenden.
      • SSH: Ein SSH-Schlüsselpaar verwenden.
      • Cookiefile: Ein cookiefile verwenden.
      • Token: Ein Token verwenden.
      • Google Cloud Repository: Ein Google-Dienstkonto verwenden, um auf ein Repository in Cloud Source Repository zuzugreifen. Wählen Sie diese Option nur aus, wenn Workload Identity Federation for GKE in Ihrem Cluster nicht aktiviert ist.
      • Workload Identity: Verwenden Sie ein Google-Dienstkonto, um auf ein Cloud Source Repositories-Repository zuzugreifen.

   2. Geben Sie eine Anzahl von Sekunden ein, um die Synchronisierungswartezeit festzulegen, die bestimmt, wie lange Config Sync zwischen Synchronisierungen mit der „Source of Truth“ wartet.

   3. Geben Sie eine Git-Proxy-URL für den HTTPS-Proxy ein, der bei der Kommunikation mit der „Source of Truth“ verwendet werden soll.

   4. Wählen Sie Hierarchie aus, um das Quellformat zu ändern.

      Der Standardwert Unstrukturiert wird in den meisten Fällen empfohlen, da Sie damit Ihre „Source of Truth“ nach Bedarf organisieren können.

5. Wenn Sie mit der Bearbeitung des Pakets fertig sind, klicken Sie auf Speichern.

   Sie werden zur Config Sync-Seite Pakete weitergeleitet. Nach einigen Minuten sollte für den von Ihnen konfigurierten Paket in der Spalte Synchronisierungsstatus der Wert Synchronisiert angezeigt werden.

Einstellungen anzeigen

Auf dem Tab Einstellungen werden eine Liste der Cluster und Informationen zu deren Config Sync- und Flotteneinstellungen angezeigt.

Sie können diesen Tab auch verwenden, um Config Sync auf einem Cluster zu aktualisieren:

• Wählen Sie neben dem Namen des Clusters, den Sie aktualisieren möchten, das Kontextmenü und dann Konfiguration bearbeiten aus.

Informationen zu den Config Sync-Einstellungen finden Sie unter Config Sync konfigurieren.

Nächste Schritte

• Google Cloud CLI verwenden, um Config Sync zu überwachen
• nomos-Befehlszeilentool verwenden, um Config Sync zu überwachen
• Config Sync anhand von Messwerten überwachen