Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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.
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.
Führen Sie den folgenden Befehl aus, um die ClusterRole-config-sync-dashboard-reader zu erstellen und auf den Cluster anzuwenden:
Folgen Sie der Anleitung zum Konfigurieren der rollenbasierten Zugriffssteuerung in Google Kubernetes Engine (GKE) Enterprise Edition-Clustern, um die ClusterRoleBinding einzurichten.
Auf Dashboard zugreifen
Rufen Sie in der Google Cloud Console im Abschnitt Features die Seite Konfiguration auf.
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.
Führen Sie die folgenden Schritte aus, um ein Paket zu bearbeiten:
Wählen Sie neben dem Namen des Pakets, das Sie bearbeiten möchten, in der Spalte Paket bearbeiten die Option edit aus.
Wählen Sie im Abschnitt Paketdetails aus der Drop-down-Liste Quelltyp Ihren Quelltyp aus.
Geben Sie im Abschnitt Quelle Folgendes ein:
Geben Sie für Quellen, die in einem Git-Repository gehostet werden, die folgenden Felder ein:
Geben Sie die URL des Git-Repositorys, das Sie als „Source of Truth“ verwenden, als Repository-URL ein.
Optional: Aktualisieren Sie das Feld Überarbeitung, um zu prüfen, ob Sie nicht die Standardeinstellung HEAD verwenden.
Optional: Aktualisieren Sie das Feld Pfad, wenn Sie nicht aus dem Root-Repository synchronisieren möchten.
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:
Geben Sie die URL des OCI-Images, das Sie als „Source of Truth“ verwenden, als Image ein.
Geben Sie den Pfad des Verzeichnisses relativ zum Stammverzeichnis als Verzeichnis ein, von dem aus synchronisiert werden soll.
(Optional): Maximieren Sie den Abschnitt Erweiterte Einstellungen, um Folgendes abzuschließen:
Wählen Sie einen Authentifizierungstyp aus:
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.
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.
Geben Sie eine Git-Proxy-URL für den HTTPS-Proxy ein, der bei der Kommunikation mit der „Source of Truth“ verwendet werden soll.
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.
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ü more_vert und dann editKonfiguration bearbeiten aus.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-04-22 (UTC)."],[],[],null,["This page explains how to use the Config Sync dashboard.\n\nThis dashboard provides you with a comprehensive overview of the packages that\nConfig Sync manages and the status of the resources in these packages.\n| **Key Term:** A *package* contains all of the configs contained in each . Because you can sync your cluster from multiple sources, you might have multiple packages per cluster.\n\nBefore you begin\n\nIAM permissions\n\nTo access the Config Sync dashboard, the following IAM roles are required in\nthe project:\n\n- `roles/container.clusterViewer`\n- `roles/gkehub.viewer`\n\nRole-based access control\n\nThe user also needs the relevant Kubernetes permissions in each cluster. If you\ndon't want to grant users extensive permissions, such as those of the cluster\nadmin, you can create a custom RBAC role that includes the minimum permissions\nrequired to use the Config Sync dashboard.\n\nThe `config-sync-dashboard-reader` `ClusterRole` grants the user `get` and\n`list` permissions on the resources needed by the dashboard.\n\n1. To create the `config-sync-dashboard-reader` `ClusterRole` and apply it to\n the cluster, run the following command:\n\n cat \u003c\u003cEOF \u003e config-sync-dashboard-reader.yaml\n kind: ClusterRole\n apiVersion: rbac.authorization.k8s.io/v1\n metadata:\n name: config-sync-dashboard-reader\n rules:\n - apiGroups: [\"apiextensions.k8s.io\"]\n resources: [\"customresourcedefinitions\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"configmanagement.gke.io\"]\n resources: [\"configmanagements\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"configsync.gke.io\"]\n resources: [\"rootsyncs\", \"reposyncs\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"kpt.dev\"]\n resources: [\"resourcegroups\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"apps\"]\n resources: [\"deployments\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"\"]\n resources: [\"pods\", \"services\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"anthos.cloud.google.com\"]\n resources: [\"canonicalservices\"]\n verbs: [\"get\", \"list\"]\n - apiGroups: [\"networking.istio.io\"]\n resources: [\"virtualservices\"]\n verbs: [\"get\", \"list\"]\n\n EOF\n kubectl apply -f config-sync-dashboard-reader.yaml\n\n2. Follow the instructions for configuring [role-based access control](https://cloud.google.com/anthos/identity/setup/bearer-token-auth#configure_role-based_access_control)\n on Google Kubernetes Engine clusters to set up the `ClusterRoleBinding`.\n\nAccess the dashboard\n\n1. In the Google Cloud console, go to the **Config** page under the **Features** section.\n\n \u003cbr /\u003e\n\n [Go to Config](https://console.cloud.google.com/kubernetes/config_management)\n2. Select the project that you want to view.\n\nView the dashboard\n\nThe **dashboard** tab provides you an overview of the status of your\nConfig Sync installations:\n\n- **Reconciliation status** shows you how many packages are reconciled. A\n package is reconciled if the state that you want, as expressed by the\n resources in the package, has been realized.\n\n Your packages can have the following reconciliation statuses:\n - **Current**: the actual state of the package matches the state that you want. The reconcile process is considered complete until there are changes to either the state you want or the actual state.\n - **In progress**: the actual state of the package hasn't yet reached the state that you want (as expressed by the resources in the package). Newly created packages usually start with this status.\n - **Failed**: the process of reconciling the actual state with the state that you want has encountered an error or it has made insufficient progress.\n - **Unknown**: Config Sync couldn't determine the reconciliation status of a package.\n- **Synchronization status** shows you how many packages are synced. A package\n is synced when the latest observed state of the package in the source (for\n example, a Git repository) is reflected in the cluster.\n\n Your packages can have the following synchronization statuses:\n - **Synced**: the package is synced to a cluster.\n - **Pending**: the package is pending synchronization.\n - **Reconciling**: the Deployment that syncs a package is being reconciled.\n - **Stalled**: the Deployment that syncs a package is stalled.\n - **Error**: the package encountered an error during syncing.\n - **Unknown**: Config Sync couldn't determine the synchronization status of a package.\n- **Config Sync status** shows you the installation status of\n Config Sync on your clusters.\n\n Your clusters can have the following status related to Config Sync:\n - **Enabled**: clusters that have Config Sync enabled.\n - **Not enabled**: clusters that don't have Config Sync enabled.\n - **Pending**: clusters that have Config Sync enabled, but are undergoing changes. This status usually occurs during first-time configuration or when updating to a new version.\n - **Error**: clusters that have Config Sync enabled, but there's an issue and Config Sync isn't working.\n - **Unknown**: Config Sync's status can't be determined.\n\nAdditional tables show you issues grouped by package and cluster, provide links\nto install Config Sync and view settings, and resources for getting started.\n\nView package status\n\nThe **Packages** tab enables you to view in-depth details about individual\npackages and clusters. Use this tab to better understand potential causes behind\nsync errors and unhealthy resources.\n\nEdit a package\n\nYou can also use the **Packages** tab to edit your package configurations.\n\nTo edit a package, complete the following steps:\n\n1. Beside the name of the package that you want to edit, select *edit* in the **Edit package** column\n2. In the **Package details** section, from the **Source type** drop-down list, select your source type.\n3. In the **Source** section, complete the following:\n\n - For sources hosted in a Git repository, enter the following fields:\n\n 1. Enter the URL of the Git repository that you're using as a source of truth as the **Repository URL**.\n 2. Optional: Update the **Revision** field to check out if you're not using the default `HEAD`.\n 3. Optional: Update the **Path** field if you don't want to sync from the root repository.\n 4. Optional: Update the **Branch** field if you're not using the default `main` branch.\n - For sources hosted in an OCI image, enter the following fields:\n\n 1. Enter the URL of the OCI image that you're using as a source of truth as the **Image**.\n 2. Enter the path of the directory to sync from, relative to the root directory, as the **Directory**.\n4. (Optional): Expand the **Advanced settings** section to complete the following:\n\n 1. Select an **Authentication type**:\n\n | **Note:** for OCI, you can only select **Workload Identity** for authentication.\n - **None**: Use no authentication.\n - **SSH**: Use an SSH key pair.\n - **Cookiefile** : Use a `cookiefile`.\n - **Token**: Use a token.\n - **Google Cloud Repository** : Use a Google service account to access a Cloud Source Repositories repository. Only select this option if Workload Identity Federation for GKE is *not* enabled in your cluster.\n - **Workload Identity**: Use a Google service account to access a Cloud Source Repositories repository.\n 2. Enter a number in seconds to set the **Sync wait time**, which determines\n how long Config Sync waits between syncing from the source of truth.\n\n 3. Enter a **Git proxy** URL for the HTTPS proxy to be used when\n communicating with the source of truth.\n\n 4. Choose **Hierarchy** to change the **Source format**.\n\n The default value **Unstructured** is recommended in most cases since it\n lets you organize your source of truth however you want.\n5. When you are finished editing your package, click **Save**.\n\n You are redirected to the Config Sync **Packages** page. After a few minutes, you should see **Synced** in the **Sync status**\n column for the package that you configured.\n\nView settings\n\nThe **Settings** tab shows you a list of clusters, along with information\nabout their Config Sync settings and fleet settings.\n\nYou can also use this tab to upgrade Config Sync on a cluster:\n\n- Beside the name of the cluster that you want to upgrade, select the context menu *more_vert* and then select *edit* **Edit Config**.\n\nFor guidance on Config Sync settings, see [Configure Config Sync](/kubernetes-engine/enterprise/config-sync/docs/how-to/installing-config-sync#configuring-config-sync).\n\nWhat's next\n\n- Learn about [using the Google Cloud CLI](/kubernetes-engine/enterprise/config-sync/docs/how-to/config-sync-status-gcloud) to monitor Config Sync.\n- Learn about [using the nomos command-line tool](/kubernetes-engine/enterprise/config-sync/docs/how-to/nomos-command) to monitor Config Sync.\n- Learn how to [Monitor Config Sync with\n metrics](/kubernetes-engine/enterprise/config-sync/docs/how-to/monitoring-config-sync)."]]
