Einführung in die Fehlerbehebung

Wenn Sie Probleme mit Config Sync haben, werden auf dieser Seite einige gängige Tools und Verfahren vorgestellt, mit denen Sie Probleme identifizieren und beheben können.

Upgrade auf eine unterstützte Version durchführen

Aktualisieren Sie Config Sync auf eine unterstützte Version. Durch ein Upgrade werden häufig häufig auftretende Probleme behoben und Sie erhalten Zugriff auf die jeweils aktuellen Funktionen. Damit Sie immer eine unterstützte Version verwenden, können Sie automatische Upgrades aktivieren (Vorschau).

nomos-Befehlszeilentool verwenden

Mit dem nomos-Befehlszeilentool erhalten Sie wichtige Einblicke in Ihre Config Sync-Einrichtung. Die in den folgenden Abschnitten beschriebenen Befehle sind besonders hilfreich, wenn Sie die Ursache des Problems ermitteln möchten oder wenn Sie mit Cloud Customer Care arbeiten müssen.

Config Sync-Status ansehen

Mit dem Befehl nomos status erhalten Sie aggregierte Daten und Fehler, damit Sie verstehen, was bei Ihrer Config Sync-Installation passiert. Die folgenden Informationen sind mit nomos status verfügbar:

  • Installationsstatus pro Cluster
  • Synchronisierungsfehler (sowohl Lesen von Git-Werten als auch Ausgleichen von Änderungen)

Fehlerbericht erstellen

Wenn Sie ein Problem mit Config Sync haben, das Unterstützung von Cloud Customer Care erfordert, können Sie mit dem Befehl nomos bugreport wertvolle Informationen zur Fehlerbehebung bereitstellen.

Dieser Befehl generiert eine zeitgestempelte Zip-Datei mit Informationen zum Kubernetes-Cluster, der in Ihrem kubectl-Kontext festgelegt ist. Die Datei enthält auch Logs aus den Config Sync-Pods. Er enthält keine Informationen aus Ressourcen, die mit Config Sync synchronisiert werden.

Dashboard „Übersicht“ aufrufen

Das Config Sync-Dashboard bietet Ihnen einen Überblick über den Status der von Config Sync verwalteten Pakete und den Status der Ressourcen in diesen Paketen. In diesem Dashboard erhalten Sie einen schnellen Überblick über den Status Ihrer Config Sync-Installation und finden Pakete, bei denen Probleme auftreten.

  • Um auf das Dashboard zuzugreifen, rufen Sie in der Google Cloud Console im Bereich Features die Seite Konfiguration auf:

    Zur Konfiguration

Monitoring und Loganalyse verwenden

Mit Monitoring Config Sync und der Untersuchung der Logs können Sie die Ursache von Fehlern ermitteln und unerwartetes Verhalten besser verstehen.

Config Sync-Messwerte verstehen

Verwenden Sie Config Sync-Messwerte, um einen Einblick in den Zustand von Config Sync zu erhalten.

RootSync- und RepoSync-Objekte überwachen

Wenn Sie Config Sync über die Google Cloud Console oder die Google Cloud CLI installieren, erstellt Config Sync automatisch ein RootSync-Objekt für Sie. Wenn Sie die Synchronisierung aus mehreren Repositories konfigurieren, können Sie RepoSync-Objekte erstellen, die Konfigurationsinformationen zu Ihren Namespace-Repositories enthalten.

Das Monitoring dieser Objekte kann wertvolle Informationen zum Status von Config Sync liefern. Weitere Informationen finden Sie unter RootSync- und RepoSync-Objekte überwachen.

Service Level Indicators (SLIs) verwenden

Verwenden Sie Config Sync-SLIs, um Benachrichtigungen zu erhalten, wenn Config Sync nicht wie vorgesehen funktioniert.

Abfragelogs

Mit dem Log-Explorer können Sie Logdaten für Config Sync abrufen, ansehen und analysieren. Diese Logs können wertvolle Verlaufsdaten enthalten, die nicht von nomos bugreport erfasst werden, wenn die Operator- oder Abgleich-Pods neu gestartet werden. Beispiele für Abfragen, mit denen Sie das Problem besser diagnostizieren können, finden Sie in den Query Config Sync-Logs.

Ressourcen mit dem kubectl-Befehlszeilentool untersuchen

Config Sync besteht aus mehreren benutzerdefinierten Ressourcen, die Sie mit kubectl-Befehlen abfragen können. Diese Befehle helfen Ihnen, den Status jedes einzelnen Config Sync-Objekts nachzuvollziehen.

Sie sollten die folgenden Informationen zu den von Config Sync verwalteten Kubernetes-Ressourcen kennen:

  • config-management-system ist der Namespace, der zum Ausführen aller zentralen Systemkomponenten von Config Sync verwendet wird.
  • configmanagement.gke.io und configsync.gke.io sind die API-Gruppen, die wir für alle benutzerdefinierten Ressourcen verwenden.

Beispiele

In den folgenden Abschnitten wird beschrieben, wie Sie Config Sync mit kubectl-Befehlen untersuchen können.

Benutzerdefinierte Ressourcen auflisten

  • Mit dem folgenden Befehl können Sie eine vollständige Liste der benutzerdefinierten Ressourcen abrufen:

    kubectl api-resources | grep -E "configmanagement.gke.io|configsync.gke.io"

  • Einzelne benutzerdefinierte Ressourcen können mit dem folgenden Befehl genutzt werden:

    kubectl get RESOURCE -o yaml.

    Ersetzen Sie RESOURCE durch den Namen der Ressource, die Sie abfragen möchten.

    Sie können beispielsweise mit der Ausgabe des folgenden Befehls den Status eines RootSync-Objekts prüfen:

    kubectl get rootsync -n config-management-system -o yaml

Token-Annotation eines Objekts prüfen

Möglicherweise möchten Sie wissen, wann ein verwaltetes Kubernetes-Objekt zuletzt von Config Sync aktualisiert wurde. Jedes verwaltete Objekt wird mit dem Hash des Git-Commits zum Zeitpunkt der letzten Änderung und dem Pfad zur Konfiguration angegeben, die die Änderung enthielt.

Führen Sie beispielsweise den folgenden Befehl aus, um die Annotation einer ClusterRoleBinding mit dem Namen namespace-readers abzurufen:

kubectl get clusterrolebinding namespace-readers

Die Ausgabe sieht in etwa so aus:

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  annotations:
    configmanagement.gke.io/source-path: cluster/namespace-reader-clusterrolebinding.yaml
    configmanagement.gke.io/token: bbb6a1e2f3db692b17201da028daff0d38797771
  name: namespace-readers
...

Weitere Informationen finden Sie unter Labels und Annotationen.

Zusätzliche Dokumentation zur Fehlerbehebung lesen

Sollten weiterhin Probleme auftreten, können Ihnen die folgenden Ressourcen weiterhelfen:

  • Wenn Sie eine Fehlermeldung erhalten haben, finden Sie auf der Fehlerreferenz Tipps zum Beheben des Fehlers.

  • Prüfen Sie, ob das Problem auf ein bekanntes Problem zurückzuführen ist.

  • Wenn Sie Probleme mit einem bestimmten Bereich haben, kann eine der Anleitungen zur Fehlerbehebung im Abschnitt Fehlerbehebung nach Problemtyp des Inhaltsverzeichnisses hilfreich sein.

Nächste Schritte