Résoudre les problèmes liés à Config Connector
Cette page décrit les techniques de dépannage que vous pouvez utiliser pour résoudre les problèmes liés à Config Connector, ainsi que les problèmes courants que vous pouvez rencontrer lors de l'utilisation du produit.
Techniques de dépannage de base
Vérifier la version de Config Connector
Exécutez la commande suivante pour obtenir la version installée de Config Connector et consultez les notes de version pour vérifier que la version en cours d'exécution est compatible avec les fonctionnalités et les ressources que vous souhaitez utiliser :
kubectl get ns cnrm-system -o jsonpath='{.metadata.annotations.cnrm\.cloud\.google\.com/version}'
Vérifier l'état et les événements de la ressource
En général, vous pouvez déterminer le problème lié à vos ressources Config Connector en inspectant l'état de vos ressources dans Kubernetes. Vérifier l'état et les événements d'une ressource est particulièrement utile pour déterminer si Config Connector n'a pas réussi à la réconcilier et pourquoi.
Vérifier que Config Connector est en cours d'exécution
Pour vérifier que Config Connector est en cours d'exécution, assurez-vous que tous ses pods sont READY :
kubectl get pod -n cnrm-system
Exemple de résultat :
NAME READY STATUS RESTARTS AGE cnrm-controller-manager-0 1/1 Running 0 1h cnrm-deletiondefender-0 1/1 Running 0 1h cnrm-resource-stats-recorder-77dc8cc4b6-mgpgp 1/1 Running 0 1h cnrm-webhook-manager-58496b66f9-pqwhz 1/1 Running 0 1h cnrm-webhook-manager-58496b66f9-wdcn4 1/1 Running 0 1h
Si Config Connector est installé en mode espace de noms, vous disposez d'un pod de contrôleur (cnrm-controller-manager) pour chaque espace de noms. Ce pod est responsable de la gestion des ressources Config Connector dans cet espace de noms.
Vous pouvez vérifier l'état du pod de contrôleur responsable d'un espace de noms spécifique en exécutant la commande suivante :
kubectl get pod -n cnrm-system \
-l cnrm.cloud.google.com/scoped-namespace=NAMESPACE \
-l cnrm.cloud.google.com/component=cnrm-controller-manager
Remplacez NAMESPACE par le nom de l'espace de noms.
Consulter les journaux du contrôleur
Les journaux du pod de contrôleur contiennent des informations et des erreurs liées à la réconciliation des ressources Config Connector.
Vous pouvez consulter les journaux du pod de contrôleur en exécutant la commande suivante :
kubectl logs -n cnrm-system \
-l cnrm.cloud.google.com/component=cnrm-controller-manager \
-c manager
Si Config Connector est installé en mode espace de noms, la commande précédente affiche les journaux de tous les pods de contrôleur combinés. Vous pouvez vérifier les journaux du pod du contrôleur pour un espace de noms spécifique en exécutant la commande suivante :
kubectl logs -n cnrm-system \
-l cnrm.cloud.google.com/scoped-namespace=NAMESPACE \
-l cnrm.cloud.google.com/component=cnrm-controller-manager \
-c manager
Remplacez NAMESPACE par le nom de l'espace de noms.
Découvrez comment inspecter et interroger les journaux de Config Connector.
Abandonner et acquérir la ressource
Dans certains cas, vous devrez peut-être mettre à jour un champ immuable dans une ressource. Étant donné que vous ne pouvez pas modifier les champs immuables, vous devez abandonner la ressource, puis l'acquérir :
- Mettez à jour la configuration YAML de la ressource Config Connector et définissez l'annotation
cnrm.cloud.google.com/deletion-policysurabandon. - Appliquez la configuration YAML mise à jour pour modifier la règle de suppression de la ressource Config Connector.
- Abandonnez la ressource Config Connector.
- Mettez à jour les champs immuables à modifier dans la configuration YAML.
- Appliquez la configuration YAML mise à jour pour acquérir la ressource abandonnée.
Problèmes courants
La ressource est mise à jour toutes les 5 à 15 minutes.
Si votre ressource Config Connector passe de l'état UpToDate à l'état Updating toutes les cinq à dix minutes, il est probable que Config Connector détecte des différences involontaires entre l'état souhaité et l'état réel de la ressource, ce qui l'oblige à la mettre à jour en permanence.
Tout d'abord, vérifiez qu'aucun système externe ne modifie constamment la ressource Config Connector ou Google Cloud (par exemple, les pipelines CI/CD, les contrôleurs personnalisés, les jobs cron, etc.).
Si le comportement n'est pas dû à un système externe, vérifiez si Google Cloud modifie l'une des valeurs spécifiées dans votre ressource Config Connector. Par exemple, dans certains cas, Google Cloud modifie la mise en forme (par exemple, la mise en majuscules) des valeurs de champ, ce qui entraîne une différence entre l'état souhaité et l'état réel de votre ressource.
Obtenez l'état de la ressource Google Cloud à l'aide de l'API REST (par exemple, pour ContainerCluster) ou de Google Cloud CLI. Comparez ensuite cet état à votre ressource Config Connector. Recherchez les champs dont les valeurs ne correspondent pas, puis mettez à jour votre ressource Config Connector pour qu'elles correspondent. Recherchez en particulier les valeurs qui ont été reformatées par Google Cloud. Par exemple, consultez les problèmes GitHub #578 et #294.
Notez que cette méthode n'est pas parfaite, car les modèles de ressources Config Connector etGoogle Cloud sont différents, mais elle devrait vous permettre de détecter la plupart des différences involontaires.
Si vous ne parvenez pas à résoudre votre problème, consultez Aide supplémentaire.
Suppression d'espaces de noms bloqués à l'état "Arrêt en cours"
La suppression d'espaces de noms peut rester bloquée sur Terminating si Config Connector est installé en mode espace de noms et si le ConfigConnectorContext de l'espace de noms a été supprimé avant la suppression de toutes les ressources Config Connector de cet espace de noms. Lorsque le ConfigConnectorContext d'un espace de noms est supprimé, Config Connector est désactivé pour cet espace de noms, ce qui empêche la suppression des ressources Config Connector restantes dans cet espace de noms.
Pour résoudre ce problème, vous devez effectuer un nettoyage forcé, puis supprimer manuellement les ressources Google Cloud sous-jacentes.
Pour éviter ce problème à l'avenir, ne supprimez ConfigConnectorContext qu'une fois que toutes les ressources Config Connector de son espace de noms ont été supprimées de Kubernetes. Évitez de supprimer des espaces de noms entiers avant que toutes les ressources Config Connector de cet espace de noms aient été supprimées, car le champ ConfigConnectorContext pourrait être supprimé en premier.
Découvrez également comment la suppression d'un espace de noms contenant un projet et ses enfants ou un dossier et ses enfants peut bloquer le processus.
Suppression de ressources bloquée sur "DeleteFailed" après la suppression du projet
La suppression des ressources Config Connector peut rester bloquée à l'état DeleteFailed si leur projet Google Cloud a été supprimé au préalable.
Pour résoudre ce problème, restaurez le projet surGoogle Cloud afin de permettre à Config Connector de supprimer les ressources enfants restantes de Kubernetes. Vous pouvez également effectuer un nettoyage forcé.
Pour éviter ce problème à l'avenir, ne supprimez les projets Google Cloud qu'une fois que toutes leurs ressources Config Connector enfants ont été supprimées de Kubernetes. Évitez de supprimer des espaces de noms entiers qui peuvent contenir à la fois une ressource Project et ses ressources Config Connector enfants, car la ressource Project peut être supprimée en premier.
Métadonnées Compute Engine non définies
Si votre ressource Config Connector présente un état UpdateFailed avec un message indiquant que les métadonnées Compute Engine ne sont pas définies, cela signifie probablement que le compte de service IAM utilisé par Config Connector n'existe pas.
Exemple de message UpdateFailed :
Update call failed: error fetching live state: error reading underlying resource: summary: Error when reading or editing SpannerInstance "my-project/my-spanner- instance": Get "https://spanner.googleapis.com/v1/projects/my-project/instances/my-spanner-instance?alt=json": metadata: Compute Engine metadata "instance/service-accounts/default/token? scopes=https%!A(MISSING)%!F(MISSING)%!F(MISSING)www.googleapis.com%!F(MISSING)auth%!F(MISSING)compute%!C(MISSING)https%!A(MISSING)%!F(MISSING)%!F(MISSING)www.googleapis.com%!F(MISSIN G)auth%!F(MISSING)cloud-platform%!C(MISSING)https%!A(MISSING)%!F(MISSING)%!F(MISSING)www.googleapis.com%!F(MISSING)auth%!F(MISSING)cloud-identity%!C(MISSING)https%!A(MISSING)%!F(MISS ING)%!F(MISSING)www.googleapis.com%!F(MISSING)auth%!F(MISSING)ndev.clouddns.readwrite%!C(MISSING)https%!A(MISSING)%!F(MISSING)%!F(MISSING)www.googleapis.com%!F(MISSING)auth%!F(MISSIN G)devstorage.full_control%!C(MISSING)https%!A(MISSING)%!F(MISSING)%!F(MISSING)www.googleapis.com%!F(MISSING)auth%!F(MISSING)userinfo.email%!C(MISSING)https%!A(MISSING)%!F(MISSING)%!F (MISSING)www.googleapis.com%!F(MISSING)auth%!F(MISSING)drive.readonly" not defined, detail:
Pour résoudre le problème, assurez-vous que le compte de service IAM utilisé par Config Connector existe.
Pour éviter ce problème à l'avenir, assurez-vous de suivre les instructions d'installation de Config Connector.
Erreur 403 : La requête ne disposait pas d'un nombre suffisant de champs d'application d'authentification
Si votre ressource Config Connector présente un état UpdateFailed avec un message indiquant une erreur 403 en raison de niveaux d'authentification insuffisants, cela signifie probablement que Workload Identity n'est pas activé sur votre cluster GKE.
Exemple de message UpdateFailed :
Update call failed: error fetching live state: error reading underlying resource: summary: Error when reading or editing SpannerInstance "my-project/my-spanner-instance": googleapi: Error 403: Request had insufficient authentication scopes.
Pour examiner le problème, procédez comme suit :
Enregistrez la configuration de pod suivante sous
wi-test.yaml:apiVersion: v1 kind: Pod metadata: name: workload-identity-test namespace: cnrm-system spec: containers: - image: google/cloud-sdk:slim name: workload-identity-test command: ["sleep","infinity"] serviceAccountName: cnrm-controller-managerSi vous avez installé Config Connector en mode espace de noms,
serviceAccountNamedoit êtrecnrm-controller-manager-NAMESPACE. RemplacezNAMESPACEpar l'espace de noms que vous avez utilisé lors de l'installation.Créez le pod dans votre cluster GKE :
kubectl apply -f wi-test.yamlOuvrez une session interactive dans le pod :
kubectl exec -it workload-identity-test \ --namespace cnrm-system \ -- /bin/bashAffichez votre identité :
gcloud auth listVérifiez que l'identité répertoriée correspond au compte de service Google associé à vos ressources.
Si le compte de service Compute Engine par défaut s'affiche à la place, cela signifie que la fédération d'identité de charge de travail pour GKE n'est pas activée sur votre cluster GKE et/ou votre pool de nœuds.
Quittez la session interactive, puis supprimez le pod de votre cluster GKE :
kubectl delete pod workload-identity-test \ --namespace cnrm-system
Pour résoudre ce problème, utilisez un cluster GKE avec la fédération d'identité de charge de travail pour GKE activée.
Si la même erreur s'affiche toujours sur un cluster GKE sur lequel la fédération d'identité de charge de travail pour GKE est activée, assurez-vous de ne pas avoir oublié d'activer également la fédération d'identité de charge de travail pour GKE sur les pools de nœuds du cluster. En savoir plus sur l'activation de la fédération d'identité de charge de travail pour GKE sur des pools de nœuds existants Nous vous recommandons d'activer la fédération d'identité de charge de travail pour GKE sur tous les pools de nœuds de votre cluster, car Config Connector peut s'exécuter sur n'importe lequel d'entre eux.
403 Forbidden : l'appelant n'est pas autorisé. Consultez la documentation sur Workload Identity Federation for GKE.
Si votre ressource Config Connector présente un état UpdateFailed avec un message indiquant une erreur 403 due à la fédération d'identité de charge de travail pour GKE, cela signifie probablement que le compte de service Kubernetes de Config Connector ne dispose pas des autorisations IAM appropriées pour emprunter l'identité de votre compte de service IAM en tant qu'utilisateur de la fédération d'identité de charge de travail pour GKE.
Exemple de message UpdateFailed :
Update call failed: error fetching live state: error reading underlying resource: summary: Error when reading or editing SpannerInstance "my-project/my-spanner- instance": Get "https://spanner.googleapis.com/v1/projects/my-project/instances/my-spanner-instance?alt=json": compute: Received 403 `Unable to generate access token; IAM returned 403 Forbidden: The caller does not have permission This error could be caused by a missing IAM policy binding on the target IAM service account. For more information, refer to the Workload Identity Federation for GKE documentation: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity#creating_a_relationship_between_ksas_and_gsas
Pour résoudre le problème et l'éviter à l'avenir, consultez les instructions d'installation de Config Connector.
Erreur 403 : l'appelant ne dispose pas de l'autorisation IAM
Si votre ressource Config Connector présente un état UpdateFailed avec un message indiquant que l'appelant ne dispose pas d'une autorisation IAM, cela signifie probablement que le compte de service IAM utilisé par Config Connector ne dispose pas de l'autorisation IAM indiquée dans le message, qui est nécessaire pour gérer la ressource Google Cloud .
Exemple de message UpdateFailed :
Update call failed: error fetching live state: error reading underlying resource: summary: Error when reading or editing SpannerInstance "my-project/my-spanner- instance": googleapi: Error 403: Caller is missing IAM permission spanner.instances.get on resource projects/my-project/instances/my-spanner-instance., detail:
Si la même erreur s'affiche toujours après avoir accordé les autorisations IAM appropriées à votre compte de service IAM, vérifiez que votre ressource est créée dans le bon projet. Vérifiez le champ spec.projectRef de la ressource Config Connector (ou son annotation cnrm.cloud.google.com/project-id si la ressource n'accepte pas de champ spec.projectRef) et assurez-vous que la ressource fait référence au bon projet. Notez que Config Connector utilise le nom de l'espace de noms comme ID de projet si ni la ressource ni l'espace de noms ne spécifient de projet cible.
Découvrez comment configurer le projet cible pour les ressources à portée de projet.
Si la même erreur s'affiche toujours, vérifiez si Workload Identity Federation pour GKE est activé sur votre cluster GKE.
Pour éviter ce problème à l'avenir, assurez-vous de suivre les instructions d'installation de Config Connector.
Version non compatible avec les installations de modules complémentaires Config Connector
Si vous ne parvenez pas à activer le module complémentaire Config Connector, le message d'erreur suivant s'affiche : Node version 1.15.x-gke.x s unsupported. Pour résoudre cette erreur, vérifiez que la version du cluster GKE répond aux exigences en termes de version et de fonctionnalités.
Pour obtenir toutes les versions valides de vos clusters, exécutez la commande suivante :
gcloud container get-server-config --format "yaml(validMasterVersions)" \
--zone ZONE
Remplacez ZONE par la zone Compute Engine.
Choisissez une version répondant aux exigences dans la liste.
Le message d'erreur s'affiche également si Workload Identity Federation for GKE ou GKE Monitoring sont désactivés. Assurez-vous que ces fonctionnalités sont activées pour corriger l'erreur.
Impossible de modifier des champs immuables
Config Connector refuse les mises à jour des champs immuables lors de l'admission.
Par exemple, la mise à jour d'un champ immuable avec kubectl apply entraîne l'échec immédiat de la commande.
Cela signifie que les outils qui réappliquent continuellement les ressources (par exemple, GitOps) peuvent se retrouver bloqués lors de la mise à jour d'une ressource s'ils ne gèrent pas les erreurs d'admission.
Étant donné que Config Connector n'autorise pas la modification des champs immuables, la seule façon d'effectuer une telle modification est de supprimer et de recréer la ressource.
Erreur lors de la mise à jour des champs immuables lorsqu'aucune mise à jour n'est effectuée
Vous pouvez rencontrer les erreurs suivantes dans l'état de la ressource Config Connector peu de temps après avoir créé ou acquis une ressource Google Cloud à l'aide de Config Connector :
Update call failed: error applying desired state: infeasible update: ({true \<nil\>}) would require recreation(exemple)Update call failed: cannot make changes to immutable field(s)(exemple)
Cela ne signifie pas forcément que vous avez réellement mis à jour la ressource. La raison peut être que l'API Google Cloud a modifié un champ immuable que vous gérez dans la ressource Config Connector. Cela a entraîné une incohérence entre l'état souhaité et l'état réel des champs immuables.
Pour résoudre le problème, mettez à jour les valeurs de ces champs immuables dans la ressource Config Connector afin qu'elles correspondent à l'état réel. Pour ce faire, procédez comme suit :
- Mettez à jour la configuration YAML de la ressource Config Connector et définissez l'annotation
cnrm.cloud.google.com/deletion-policysurabandon. - Appliquez la configuration YAML mise à jour pour modifier la règle de suppression de la ressource Config Connector.
- Abandonnez la ressource Config Connector.
- Imprimez l'état actif de la ressource Google Cloud correspondante à l'aide de la gcloud CLI.
- Identifiez les différences entre la sortie de la gcloud CLI et la configuration YAML de la ressource Config Connector, puis mettez à jour ces champs dans la configuration YAML.
- Appliquez la configuration YAML mise à jour pour acquérir la ressource abandonnée.
La ressource n'a pas d'état
Si vos ressources ne comportent pas de champ status, il est probable que Config Connector ne fonctionne pas correctement. Vérifiez que Config Connector est en cours d'exécution.
Aucune correspondance pour le genre "Foo"
Lorsque cette erreur se produit, cela signifie que l'objet CRD pour le genre de ressource Foo n'est pas installé sur votre cluster Kubernetes.
Vérifiez que le type est un type de ressource compatible avec Config Connector.
Si le genre est compatible, cela signifie que votre installation Config Connector est obsolète ou incorrecte.
Si vous avez installé Config Connector à l'aide du module complémentaire GKE, votre installation devrait être mise à niveau automatiquement. Si vous avez installé Config Connector manuellement, vous devez effectuer une mise à niveau manuelle.
Consultez le dépôt GitHub pour déterminer les types de ressources compatibles avec les différentes versions de Config Connector (par exemple, voici les types compatibles avec Config Connector v1.44.0).
Les libellés ne sont pas propagés à la ressource Google Cloud .
Config Connector propage les libellés trouvés dans metadata.labels à la ressourceGoogle Cloud sous-jacente. Toutefois, notez que les libellés ne sont pas compatibles avec toutes les ressources Google Cloud. Consultez la documentation de l'API REST de la ressource (par exemple, la documentation de l'API pour PubSubTopic) pour voir si elle est compatible avec les libellés.
Échec de l'appel du webhook x509 : le certificat s'appuie sur l'ancien champ "Nom commun"
Si un message d'erreur semblable à l'exemple suivant s'affiche, vous rencontrez peut-être un problème lié aux certificats :
Error from server (InternalError): error when creating "/mnt/set-weaver-dns-record.yml": Internal error occurred: failed calling webhook "annotation-defaulter.cnrm.cloud.google.com": Post "https://cnrm-validating-webhook.cnrm-system.svc:443/annotation-defaulter?timeout=30s": x509: certificate relies on legacy Common Name field, use SANs or temporarily enable Common Name matching with GODEBUG=x509ignoreCN=0
Pour contourner ce problème, supprimez les certificats et les pods concernés :
kubectl delete -n cnrm-system secrets cnrm-webhook-cert-abandon-on-uninstall
kubectl delete -n cnrm-system secrets cnrm-webhook-cert-cnrm-validating-webhook
kubectl delete -n cnrm-system pods -l "cnrm.cloud.google.com/component=cnrm-webhook-manager"
Une fois ces ressources supprimées, le bon certificat est régénéré.
Pour en savoir plus sur cette erreur, consultez ce problème sur GitHub.
Erreur due à des caractères spéciaux dans le nom de la ressource
Les caractères spéciaux ne sont pas autorisés dans le champ metadata.name de Kubernetes.
Si une erreur semblable à l'exemple suivant s'affiche, cela signifie que la valeur metadata.name de la ressource contient probablement des caractères spéciaux :
a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*')
Par exemple, la ressource SQLUser suivante contient un caractère non valide dans metadata.name :
apiVersion: sql.cnrm.cloud.google.com/v1beta1
kind: SQLUser
metadata:
name: [email protected]
spec:
instanceRef:
name: test-cloudsql-db
type: "CLOUD_IAM_USER"
Si vous essayez de créer cette ressource, l'erreur suivante s'affiche :
Error from server (Invalid): error when creating "sqlusercrd.yaml": SQLUser.sql.cnrm.cloud.google.com "[email protected]" is invalid: metadata.name: Invalid value: "[email protected]": a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*')
Si vous souhaitez donner à votre ressource un nom qui n'est pas un nom Kubernetes valide, mais qui est un nom de ressource Google Cloud valide, vous pouvez utiliser le champ resourceID, comme illustré dans l'exemple suivant :
apiVersion: sql.cnrm.cloud.google.com/v1beta1
kind: SQLUser
metadata:
name: 'test'
spec:
instanceRef:
name: sqlinstance-sample-postgresql
host: "%"
type: CLOUD_IAM_USER
resourceID: [email protected]
Cette configuration amène Config Connector à utiliser resourceID au lieu de metadata.name comme nom de la ressource.
Impossible de supprimer des champs de la spécification de ressource
La suppression d'un champ de la spécification d'une ressource Config Connector (en mettant à jour le fichier .yaml de la ressource et en l'appliquant à nouveau, ou en utilisant kubectl edit pour modifier la spécification de la ressource) ne supprime pas réellement ce champ de la spécification de la ressource Config Connector ni de la ressource Google Cloud sous-jacente.
En revanche, la suppression d'un champ de la spécification le rend géré en externe.
Si vous souhaitez remplacer la valeur d'un champ par une valeur vide ou par défaut dans la ressourceGoogle Cloud sous-jacente, vous devez définir la valeur du champ sur zéro dans la spécification de la ressource Config Connector :
Pour un champ de type liste, définissez le champ sur une liste vide à l'aide de
[].L'exemple suivant montre le champ
targetServiceAccountsque nous voulons supprimer :spec: targetServiceAccounts: - external: "[email protected]" - external: "[email protected]"Pour supprimer ce champ, définissez la valeur sur "empty" (vide) :
spec: targetServiceAccounts: []Pour un champ de type primitif, définissez le champ sur "vide" à l'aide de l'une des méthodes suivantes :
Type Valeur vide chaîne "" Bool "false" entier 0 L'exemple suivant montre le champ
identityNamespaceque nous voulons supprimer :spec: workloadIdentityConfig: identityNamespace: "foo-project.svc.id.goog"Pour supprimer ce champ, définissez la valeur sur "empty" (vide) :
spec: workloadIdentityConfig: identityNamespace: ""Pour les champs de type objet, il n'existe actuellement aucun moyen simple de définir un champ de type objet entier sur "NULL" dans Config Connector. Vous pouvez essayer de définir les sous-champs du type d'objet comme vides ou par défaut en suivant les conseils ci-dessus, puis vérifier si cela fonctionne.
KNV2005 : le synchroniseur met à jour la ressource de manière excessive
Si vous utilisez Config Sync et que vous rencontrez des erreurs KNV2005 pour les ressources Config Connector, il est probable que Config Sync et Config Connector soient en conflit sur la ressource.
Exemple de message de journal :
KNV2005: detected excessive object updates, approximately 6 times per minute. This may indicate Config Sync is fighting with another controller over the object.
On dit que Config Sync et Config Connector sont en "conflit" sur une ressource s'ils mettent à jour les mêmes champs avec des valeurs différentes. La mise à jour de l'un déclenche l'action de l'autre et la mise à jour de la ressource, ce qui déclenche l'action de l'autre et la mise à jour de la ressource, et ainsi de suite.
Les combats ne posent pas de problème pour la plupart des domaines. Les champs spécifiés dans Config Sync ne sont pas modifiés par Config Connector, tandis que les champs non spécifiés dans Config Sync et définis par défaut par Config Connector sont ignorés par Config Sync. Par conséquent, pour la plupart des champs, Config Sync et Config Connector ne devraient jamais mettre à jour le même champ avec des valeurs différentes.
Il existe une exception : les champs de liste. Tout comme Config Connector peut définir des sous-champs par défaut dans les champs d'objet, il peut également définir des sous-champs par défaut dans les objets à l'intérieur des listes. Toutefois, étant donné que les champs de liste dans les ressources Config Connector sont atomiques, la définition de valeurs par défaut pour les sous-champs est considérée comme une modification de la valeur de la liste dans son ensemble.
Par conséquent, Config Sync et Config Connector finiront par entrer en conflit si Config Sync définit un champ de liste et que Config Connector définit par défaut des sous-champs dans cette liste.
Pour contourner ce problème, vous disposez des options suivantes :
Mettez à jour le fichier manifeste de ressources dans le dépôt Config Sync pour qu'il corresponde à la valeur que Config Connector tente de définir pour la ressource.
Pour ce faire, vous pouvez par exemple arrêter temporairement la synchronisation des configurations, attendre que Config Connector ait terminé de réconcilier la ressource, puis mettre à jour le fichier manifeste de votre ressource pour qu'il corresponde à la ressource sur le serveur d'API Kubernetes.
Empêchez Config Sync de réagir aux mises à jour de la ressource sur le serveur d'API Kubernetes en définissant l'annotation
client.lifecycle.config.k8s.io/mutationsurignore. Découvrez comment demander à Config Sync d'ignorer les mutations d'objets.Empêchez Config Connector de mettre à jour entièrement la spécification de la ressource en définissant l'annotation
cnrm.cloud.google.com/state-into-specsurabsentsur la ressource. Cette annotation n'est pas compatible avec toutes les ressources. Pour vérifier si votre ressource est compatible avec l'annotation, consultez la page de référence de la ressource correspondante. En savoir plus sur l'annotation
failed calling webhook
Il est possible que Config Connector soit dans un état qui vous empêche de le désinstaller. Cela se produit généralement lorsque vous utilisez le module complémentaire Config Connector et que vous désactivez Config Connector avant de supprimer les CRD Config Connector. Lorsque vous essayez de désinstaller le logiciel, vous recevez un message d'erreur semblable à celui-ci :
error during reconciliation: error building deployment objects: error finalizing the deletion of Config Connector system components deployed by ConfigConnector controller: error waiting for CRDs to be deleted: error deleting CRD accesscontextmanageraccesslevels.accesscontextmanager.cnrm.cloud.google.com: Internal error occurred: failed calling webhook "abandon-on-uninstall.cnrm.cloud.google.com": failed to call webhook: Post "https://abandon-on-uninstall.cnrm-system.svc:443/abandon-on-uninstall?timeout=3s": service "abandon-on-uninstall" not found
Pour résoudre cette erreur, vous devez d'abord supprimer manuellement les Webhooks :
kubectl delete validatingwebhookconfiguration abandon-on-uninstall.cnrm.cloud.google.com --ignore-not-found --wait=true
kubectl delete validatingwebhookconfiguration validating-webhook.cnrm.cloud.google.com --ignore-not-found --wait=true
kubectl delete mutatingwebhookconfiguration mutating-webhook.cnrm.cloud.google.com --ignore-not-found --wait=true
Vous pouvez ensuite désinstaller Config Connector.
Erreur de mise à jour avec IAMPolicy, IAMPartialPolicy et IAMPolicyMember
Si vous supprimez une ressource Config Connector IAMServiceAccount avant de nettoyer les ressources IAMPolicy, IAMPartialPolicy et IAMPolicyMember qui dépendent de ce compte de service, Config Connector ne pourra pas localiser le compte de service référencé dans ces ressources IAM lors de la réconciliation. L'état UpdateFailed s'affiche alors, accompagné d'un message d'erreur semblable à celui-ci :
Update call failed: error setting policy member: error applying changes: summary: Request `Create IAM Members roles/[MYROLE] serviceAccount:[NAME]@[PROJECT_ID].iam.gserviceaccount.com for project \"projects/[PROJECT_ID]\"` returned error: Error applying IAM policy for project \"projects/[PROJECT_ID]\": Error setting IAM policy for project \"projects/[PROJECT_ID]\": googleapi: Error 400: Service account [NAME]@[PROJECT_ID].iam.gserviceaccount.com does not exist., badRequest
Pour résoudre ce problème, vérifiez vos comptes de service et voyez si le compte de service requis pour ces ressources IAM a été supprimé.
Si le compte de service est supprimé, nettoyez également les ressources IAM Config Connector associées. Pour IAMPolicyMember, supprimez l'intégralité de la ressource. Pour IAMPolicy et IAMParitialPolicy, ne supprimez que les liaisons impliquant le compte de service supprimé.
Toutefois, ce nettoyage ne supprime pas immédiatement les liaisons de rôle Google Cloud . Les liaisons de rôle Google Cloud sont conservées pendant 60 jours en raison de la période de conservation du compte de service supprimé.
Pour en savoir plus, consultez la documentation IAM sur la suppression d'un compte de service. Google Cloud
Pour éviter ce problème, vous devez toujours nettoyer les ressources Config Connector IAMPolicy, IAMPartialPolicy et IAMPolicyMember avant de supprimer le IAMServiceAccount référencé.
Ressource supprimée par Config Connector
Config Connector ne supprime jamais vos ressources sans cause externe.
Par exemple, l'exécution de kubectl delete, l'utilisation d'outils de gestion de la configuration tels qu'Argo CD ou l'utilisation d'un client API personnalisé peuvent entraîner la suppression de ressources.
Une idée fausse courante est que Config Connector a initié et supprimé certaines ressources de votre cluster. Par exemple, si vous utilisez Config Connector, vous pouvez remarquer des demandes de suppression du gestionnaire de contrôleurs Config Connector pour certaines ressources à partir des messages du journal de conteneur ou des journaux d'audit du cluster Kubernetes. Ces demandes de suppression sont le résultat de déclencheurs externes, et Config Connector tente de les réconcilier.
Pour déterminer pourquoi une ressource a été supprimée, vous devez examiner la première demande de suppression qui lui a été envoyée. La meilleure façon d'examiner ce problème est d'analyser les journaux d'audit du cluster Kubernetes.
Par exemple, si vous utilisez GKE, vous pouvez utiliser Cloud Logging pour interroger les journaux d'audit des clusters GKE. Par exemple, si vous souhaitez rechercher les demandes de suppression initiales pour une ressource BigQueryDataset nommée foo dans l'espace de noms bar, vous exécuterez une requête semblable à la suivante :
resource.type="k8s_cluster"
resource.labels.project_id="my-project-id"
resource.labels.cluster_name="my-cluster-name"
protoPayload.methodName="com.google.cloud.cnrm.bigquery.v1beta1.bigquerydatasets.delete"
protoPayload.resourceName="bigquery.cnrm.cloud.google.com/v1beta1/namespaces/bar/bigquerydatasets/foo"
À l'aide de cette requête, vous recherchez la première demande de suppression, puis vous vérifiez authenticationInfo.principalEmail de ce message du journal de suppression pour déterminer la cause de la suppression.
Arrêt OOMKilled du pod de contrôleur
Si une erreur OOMKilled s'affiche sur un pod de contrôleur Config Connector, cela signifie qu'un conteneur ou l'ensemble du pod a été arrêté, car il a utilisé plus de mémoire que ce qui était autorisé.
Vous pouvez le vérifier en exécutant la commande kubectl describe. L'état du pod peut être OOMKilled ou Terminating.
De plus, l'examen minutieux des journaux d'événements du pod peut révéler toute occurrence d'événements liés à OOM.
kubectl describe pod POD_NAME -n cnrm-system
Remplacez POD_NAME par le pod pour lequel vous résolvez le problème.
Pour résoudre ce problème, vous pouvez utiliser la ressource personnalisée ControllerResource afin d'augmenter la demande de mémoire et la limite de mémoire pour le pod.
PodSecurityPolicy empêche les mises à niveau
Après avoir basculé du module complémentaire Config Connector vers une installation manuelle et mis à niveau Config Connector vers une nouvelle version, l'utilisation de PodSecurityPolicies peut empêcher la mise à jour des pods cnrm.
Pour confirmer que les PodSecurityPolicies empêchent votre mise à niveau, vérifiez les événements config-connector-operator et recherchez une erreur semblable à la suivante :
create Pod configconnector-operator-0 in StatefulSet configconnector-operator failed error: pods "configconnector-operator-0" is forbidden: PodSecurityPolicy: unable to admit pod: [pod.metadata.annotations[seccomp.security.alpha.kubernetes.io/pod]: Forbidden: seccomp may not be set pod.metadata.annotations[container.seccomp.security.alpha.kubernetes.io/manager]: Forbidden: seccomp may not be set]
Pour résoudre ce problème, vous devez spécifier l'annotation sur la règle PodSecurityPolicy qui correspond à l'annotation mentionnée dans l'erreur. Dans l'exemple précédent, l'annotation est seccomp.security.alpha.kubernetes.io.
Nettoyage forcé
Si vos ressources Config Connector sont bloquées lors de la suppression et que vous souhaitez simplement vous en débarrasser de votre cluster Kubernetes, vous pouvez forcer leur suppression en supprimant leurs finalizers.
Vous pouvez supprimer les finaliseurs d'une ressource en la modifiant à l'aide de kubectl
edit, en supprimant le champ metadata.finalizers, puis en enregistrant le fichier pour conserver vos modifications sur le serveur d'API Kubernetes.
Étant donné que la suppression des finaliseurs d'une ressource permet de supprimer immédiatement la ressource du cluster Kubernetes, il est possible (mais pas certain) que Config Connector n'ait pas la possibilité de terminer la suppression de la ressourceGoogle Cloud sous-jacente. Cela signifie que vous devrez peut-être supprimer manuellement vos ressources Google Cloud par la suite.
Surveillance
Métriques
Journalisation
Tous les pods Config Connector génèrent des journaux structurés au format JSON.
Les journaux des pods de contrôleur sont particulièrement utiles pour déboguer les problèmes de rapprochement des ressources.
Vous pouvez interroger les journaux de ressources spécifiques en filtrant les champs suivants dans les messages de journal :
logger: contient le type de ressource en minuscules. Par exemple, les ressourcesPubSubTopicont unloggerdepubsubtopic-controller.resource.namespace: contient l'espace de noms de la ressource.resource.name: contient le nom de la ressource.
Utiliser Cloud Logging pour interroger les journaux de manière avancée
Si vous utilisez GKE, vous pouvez utiliser Cloud Logging pour interroger les journaux d'une ressource spécifique en exécutant la requête suivante :
# Filter to include only logs coming from the controller Pods
resource.type="k8s_container"
resource.labels.container_name="manager"
resource.labels.namespace_name="cnrm-system"
labels.k8s-pod/cnrm_cloud_google_com/component="cnrm-controller-manager"
# Filter to include only logs coming from a particular GKE cluster
resource.labels.cluster_name="GKE_CLUSTER_NAME"
resource.labels.location="GKE_CLUSTER_LOCATION"
# Filter to include only logs for a particular Config Connector resource
jsonPayload.logger="RESOURCE_KIND-controller"
jsonPayload.resource.namespace="RESOURCE_NAMESPACE"
jsonPayload.resource.name="RESOURCE_NAME"
Remplacez les éléments suivants :
GKE_CLUSTER_NAMEpar le nom du cluster GKE exécutant Config ConnectorGKE_CLUSTER_LOCATIONpar l'emplacement du cluster GKE exécutant Config Connector. Exemple :us-central1RESOURCE_KINDavec le type de ressource en minuscules. Par exemple,pubsubtopic.RESOURCE_NAMESPACEpar l'espace de noms de la ressource.RESOURCE_NAMEpar le nom de la ressource.
Aide supplémentaire
Pour obtenir de l'aide supplémentaire, vous pouvez signaler un problème sur GitHub ou contacter l'assistanceGoogle Cloud .