Utiliser le tableau de bord Config Sync

Cette page explique comment utiliser le tableau de bord Config Sync.

Ce tableau de bord vous offre une vue d'ensemble complète des packages gérés par Config Sync et de l'état des ressources de ces packages.

Terme clé : Un package contient toutes les configurations contenues dans chaque source de vérité. Étant donné que vous pouvez synchroniser votre cluster à partir de plusieurs sources, vous pouvez disposer de plusieurs packages par cluster.

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 a également besoin des autorisations Kubernetes pertinentes 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.

Le rôle config-sync-dashboard-reader ClusterRole accorde à l'utilisateur les autorisations get et list sur les ressources nécessaires au tableau de bord.

1. Pour créer le ClusterRole config-sync-dashboard-reader et l'appliquer au cluster, exécutez la commande suivante :

   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. 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

1. Dans la console Google Cloud, accédez à la page Configuration sous la section Fonctionnalités.

   Accéder à la page "Configuration"

2. 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 rapproché 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 synchronisation indique le nombre de packages synchronisés. Un package est synchronisé lorsque le dernier état observé 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 de 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 configuration initiale 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é.

Des tableaux supplémentaires présentent les problèmes regroupés par package et cluster, et fournissent des liens pour installer Config Sync et afficher les paramètres, ainsi que des ressources pour 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 opérationnelles.

Modifier un package

Vous pouvez également modifier vos configurations de packages dans l'onglet Packages.

Remarque : Vous ne pouvez pas modifier les packages gérés par Hub de cette manière. Pour activer la modification dans la console Google Cloud, suivez les étapes décrites dans la section Migrer votre RootSync.

Pour modifier un package, procédez comme suit :

1. À côté du nom du package que vous souhaitez modifier, sélectionnez dans la colonne Modifier le package.
2. Dans la section Détails du package, sélectionnez votre type de source dans la liste déroulante Type de source.

3. Dans la section Source, procédez comme suit :

   • Pour les sources hébergées dans un dépôt Git, renseignez les champs suivants :

     1. Dans le champ URL du dépôt, saisissez l'URL du dépôt Git que vous utilisez comme source de vérité.
     2. Facultatif : Mettez à jour le champ Révision pour vérifier si vous n'utilisez pas la valeur par défaut HEAD.
     3. Facultatif : Mettez à jour le champ Chemin d'accès si vous ne souhaitez pas synchroniser à partir du dépôt racine.
     4. 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 :

     1. Saisissez l'URL de l'image OCI que vous utilisez comme source fiable en tant qu'image.
     2. Saisissez le chemin du répertoire à synchroniser, associé au répertoire racine, dans le champ Répertoire.

4. Facultatif : Développez la section Paramètres avancés pour effectuer les opérations suivantes :

   1. Sélectionnez un type d'authentification :

      Remarque : Pour OCI, vous ne pouvez sélectionner que Workload Identity pour l'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.

   2. 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é.

   3. Saisissez une URL de proxy Git pour le proxy HTTPS à utiliser lors de la communication avec la source de vérité.

   4. 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.

5. Lorsque vous avez terminé de modifier votre package, 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 leurs paramètres 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 , puis cliquez sur Modifier la configuration.

Pour obtenir des conseils sur les paramètres de Config Sync, consultez Configurer Config Sync.

Étapes suivantes

• Découvrez comment utiliser Google Cloud CLI pour surveiller Config Sync.
• Découvrez comment utiliser l'outil de ligne de commande nomos pour surveiller Config Sync.
• Découvrez comment surveiller Config Sync à l'aide de métriques.