Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Cette page explique comment utiliser le tableau de bord Config Sync.
Ce tableau de bord vous offre un aperçu complet des packages gérés par Config Sync et de l'état des ressources qu'ils contiennent.
Avant de commencer
Autorisations IAM
Pour accéder au tableau de bord Config Sync, les rôles IAM suivants sont requis dans le projet :
roles/container.clusterViewer
roles/gkehub.viewer
Contrôle des accès basé sur les rôles
L'utilisateur doit également disposer des autorisations Kubernetes appropriées dans chaque cluster. Si vous ne souhaitez pas accorder aux utilisateurs des autorisations étendues, telles que celles de l'administrateur de cluster, vous pouvez créer un rôle RBAC personnalisé qui inclut les autorisations minimales requises pour utiliser le tableau de bord Config Sync.
L'autorisation config-sync-dashboard-readerClusterRole accorde à l'utilisateur les autorisations get et list sur les ressources nécessaires au tableau de bord.
Pour créer le ClusterRoleconfig-sync-dashboard-reader et l'appliquer au cluster, exécutez la commande suivante :
Suivez les instructions de configuration du contrôle des accès basé sur les rôles sur les clusters Google Kubernetes Engine (GKE) Enterprise pour configurer ClusterRoleBinding.
Accéder au tableau de bord
Dans la console Google Cloud , accédez à la page Configuration sous la section Fonctionnalités.
Sélectionnez le projet que vous souhaitez afficher.
Consulter le tableau de bord
L'onglet Tableau de bord offre un aperçu de l'état de vos installations Config Sync :
L'état de la rapprochement indique le nombre de packages qui sont rapprochés. Un package est réconcilié si l'état souhaité, tel qu'exprimé par les ressources du package, a été réalisé.
Vos packages peuvent être associés aux états de rapprochement suivants :
Actue : l'état réel du package correspond à l'état souhaité. Le processus de rapprochement est considéré comme étant terminé tant que des modifications n'ont pas été apportées à l'état souhaité ou réel.
En cours : l'état réel du package n'a pas encore atteint l'état souhaité (tel qu'indiqué par les ressources du package).
Les packages nouvellement créés commencent généralement par cet état.
Échoué : le processus de rapprochement de l'état réel avec l'état souhaité a rencontré une erreur ou la progression est insuffisante.
Inconnu : Config Sync n'a pas pu déterminer l'état de rapprochement d'un package.
L'état de la synchronisation indique le nombre de packages synchronisés. Un package est synchronisé lorsque le dernier état observé du package dans la source (par exemple, un dépôt Git) est reflété dans le cluster.
Vos packages peuvent présenter les états de synchronisation suivants :
Synchronisé : le package est synchronisé avec un cluster.
En attente : le package est en attente de synchronisation.
Rapprochement : le déploiement qui synchronise un package est en cours de rapprochement.
Bloqué : le déploiement qui synchronise un package est bloqué.
Erreur : le package a rencontré une erreur lors de la synchronisation.
Inconnu : Config Sync n'a pas pu déterminer l'état de synchronisation d'un package.
L'état Config Sync indique l'état d'installation de Config Sync sur vos clusters.
Vos clusters peuvent avoir l'état suivant lié à Config Sync :
Activé : clusters sur lesquels Config Sync est activé.
Non activé : clusters sur lesquels Config Sync n'est pas activé.
En attente : clusters sur lesquels Config Sync est activé, mais en cours de modification. Cet état se produit généralement lors de la première configuration ou lors de la mise à jour vers une nouvelle version.
Erreur : clusters sur lesquels Config Sync est activé, mais il y a un problème et Config Sync ne fonctionne pas.
Inconnu : l'état de Config Sync ne peut pas être déterminé.
D'autres tableaux affichent les problèmes regroupés par package et par cluster, fournissent des liens pour installer Config Sync et afficher les paramètres, ainsi que des ressources pour vous aider à démarrer.
Afficher l'état du package
L'onglet Packages vous permet d'afficher des détails sur les packages et les clusters individuels. Utilisez cet onglet pour mieux comprendre les causes potentielles des erreurs de synchronisation et des ressources non saines.
Modifier un package
Vous pouvez également utiliser l'onglet Packages pour modifier les configurations de vos packages.
Pour modifier un package, procédez comme suit :
À côté du nom du package que vous souhaitez modifier, sélectionnez edit dans la colonne Modifier le package.
Dans la section Détails du package, dans la liste déroulante Type de source, sélectionnez votre type de source.
Dans la section Source, procédez comme suit :
Pour les sources hébergées dans un dépôt Git, renseignez les champs suivants :
Dans le champ URL du dépôt, saisissez l'URL du dépôt Git que vous utilisez comme source de vérité.
Facultatif : Mettez à jour le champ Révision pour vérifier si vous n'utilisez pas la valeur par défaut HEAD.
Facultatif : Mettez à jour le champ Chemin d'accès si vous ne souhaitez pas synchroniser à partir du dépôt racine.
Facultatif : mettez à jour le champ Branche si vous n'utilisez pas la branche main par défaut.
Pour les sources hébergées dans une image OCI, saisissez les champs suivants :
Saisissez l'URL de l'image OCI que vous utilisez comme source fiable en tant qu'image.
Saisissez le chemin du répertoire à synchroniser, associé au répertoire racine, dans le champ Répertoire.
Facultatif : Développez la section Paramètres avancés pour effectuer les opérations suivantes :
Sélectionnez un type d'authentification :
Aucune : n'utilisez aucune authentification
SSH : utilisez une paire de clés SSH.
Cookiefile : utilisez un fichier cookiefile.
Jeton : utilisez un jeton.
Google Cloud Repository : utilisez un compte de service Google pour accéder à Cloud Source Repositories. Ne sélectionnez cette option que si Workload Identity Federation for GKE n'est pas activé dans votre cluster.
Workload Identity : utilisez un compte de service Google pour accéder à un dépôt Cloud Source Repositories.
Saisissez un nombre de secondes pour définir le temps d'attente de synchronisation, qui détermine la durée d'attente de Config Sync entre la synchronisation à partir de la source de vérité.
Saisissez une URL de proxy Git pour le proxy HTTPS à utiliser lors de la communication avec la source de vérité.
Sélectionnez Hiérarchie pour modifier le format source.
La valeur par défaut Non structuré est recommandée dans la plupart des cas, car elle vous permet d'organiser votre source de vérité comme vous le souhaitez.
Lorsque vous avez terminé de modifier votre forfait, cliquez sur Enregistrer.
Vous êtes redirigé vers la page Packages de Config Sync. Après quelques minutes, Synchronisé doit s'afficher dans la colonne État de synchronisation du package que vous avez configuré.
Afficher les paramètres
L'onglet Paramètres affiche la liste des clusters, ainsi que des informations sur leurs paramètres Config Sync et de parc.
Vous pouvez également utiliser cet onglet pour mettre à niveau Config Sync sur un cluster :
À côté du nom du cluster que vous souhaitez mettre à niveau, sélectionnez le menu contextuel more_vert, puis editModifier la configuration.
Pour obtenir des conseils sur les paramètres de Config Sync, consultez Configurer Config Sync.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/01 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/01 (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)."]]
