RootSync- und RepoSync-Objekte überwachen

Auf dieser Seite werden verschiedene Möglichkeiten zum Überwachen der RootSync- und RepoSync-Objekte beschrieben. Sie können beispielsweise prüfen, ob Ihr letzter Commit in einer Source of Truth auf einen Cluster angewendet und erfolgreich abgeglichen wurde.

Synchronisierte Commits ansehen

Wenn Sie prüfen möchten, welcher Commit mit dem Cluster synchronisiert wird, prüfen Sie das Feld .status.sync im RootSync- oder RepoSync-Objekt.

Führen Sie den folgenden Befehl aus, um synchronisierte Commits für ein RootSync-Objekt aufzurufen:
```
kubectl get rootsync ROOT_SYNC_NAME -n config-management-system
```
Ersetzen Sie ROOT_SYNC_NAME durch den Namen des RootSync-Objekts.
Führen Sie den folgenden Befehl aus, um synchronisierte Commits für ein RepoSync-Objekt aufzurufen:
```
kubectl get reposync REPO_SYNC_NAME -n REPO_SYNC_NAMESPACE
```
Ersetzen Sie Folgendes:
- REPO_SYNC_NAME: der Name des RepoSync-Objekts.
- REPO_SYNC_NAMESPACE: Der Namespace, in dem Sie Ihr Namespace-Repository erstellt haben.

Die Ausgabe für diese Befehle zeigt den Wert des Quell-Commits und des synchronisierten Commits. Wenn Sie beispielsweise den Befehl für die RepoSync ausgeführt haben, sieht die Ausgabe in etwa so aus:

NAME        RENDERINGCOMMIT                            SOURCECOMMIT                               SYNCCOMMIT
root-sync   66882815f0ef5517df27e864fb1315e97756ab72   66882815f0ef5517df27e864fb1315e97756ab72   66882815f0ef5517df27e864fb1315e97756ab72

Der Wert in der Spalte RENDERINGCOMMIT ist der Commit, der von hydration-controller verarbeitet wird. Wenn kein Rendering erforderlich ist, entspricht der Wert der Spalte SOURCECOMMIT. Der Wert in der Spalte SOURCECOMMIT ist der Commit aus der „Source of Truth“, der mit dem Cluster synchronisiert werden soll. Der Wert in der Spalte SYNCCOMMIT ist der Commit, der aktuell im Cluster bereitgestellt ist. Wenn die beiden Werte in den Spalten SOURCECOMMIT und SYNCCOMMIT identisch sind, wurde das erwartete Commit im Cluster bereitgestellt.

Prüfen, ob Ressourcen im Commit abgeglichen wurden

Da ResourceGroups den Abgleichsstatus der verwalteten Ressourcen erfassen, die in der Source of Truth deklariert sind, können Sie prüfen, ob die Ressourcen im Commit abgeglichen wurden.

Das ResourceGroup-Objekt hat denselben Namespace und Namen wie das RootSync- oder RepoSync-Objekt. Für das Objekt RootSync mit dem Namen root-sync im Namespace config-management-system ist das entsprechende ResourceGroup-Objekt beispielsweise root-sync im Namespace config-management-system.

So rufen Sie das „ResourceGroup“-Objekt für ein RootSync-Objekt ab:

kubectl get resourcegroup ROOT_SYNC_NAME -n config-management-system -o yaml

So rufen Sie das „ResourceGroup“-Objekt für ein RepoSync-Objekt ab:
```
kubectl get resourcegroup REPO_SYNC_NAME -n REPO_SYNC_NAMESPACE -o yaml
```
Ersetzen Sie Folgendes:
- ROOT_SYNC_NAME: der Name des ResourceGroup-Objekts, das Sie aufrufen möchten.
- REPO_SYNC_NAME: der Name des ResourceGroup-Objekts, das Sie aufrufen möchten.
- REPO_SYNC_NAMESPACE: der Name des ResourceGroup-Objekts, das Sie aufrufen möchten.

Prüfen Sie in der Ausgabe, ob die Ressourcen im Commit abgeglichen wurden:

Der .status.observedGeneration entspricht dem Wert des Felds .metadata.generation im ResourceGroup-Objekt.
Die Bedingung Stalled und Reconciling haben beide status als "False".
Jedes Element im Feld .status.resourceStatuses hat den Status Current.

Fehler ansehen

RootSync- und RepoSync-Objekte verwenden das Feld status, um Fehler zu verfolgen, die beim Synchronisieren der Konfigurationen aus der „Source of Truth“ mit einem Cluster auftreten.

Führen Sie den folgenden Befehl aus, um den Status eines RootSync-Objekts abzurufen:
```
kubectl get rootsync ROOT_SYNC_NAME -n config-management-system -o yaml
```
Ersetzen Sie ROOT_SYNC_NAME durch den Namen des RootSync-Objekts.
Führen Sie den folgenden Befehl aus, um den Status eines RepoSync-Objekts abzurufen:
```
kubectl get reposync REPO_SYNC_NAME -n NAMESPACE -o yaml
```
Ersetzen Sie Folgendes:
- REPO_SYNC_NAME: der Name des RepoSync-Objekts.
- NAMESPACE: Der Namespace, in dem Sie Ihr Namespace-Repository erstellt haben.

Weitere Informationen zu den untergeordneten Feldern im Feld status finden Sie unter Status der Objekte.

Objektdetails ansehen

Verwenden Sie den Befehl kubectl describe, um Details zu den Objekten RootSync und RepoSync aufzurufen und weitere Informationen zu möglichen Fehlern zu erhalten.

Die Ausgabe dieses Befehls enthält Ereignisse, die besonders hilfreich beim Debugging von Problemen sind, z. B. bei Containern mit Arbeitsspeichereinschränkungen (OOMKilled), Planungsfehlern oder Image-Abruffehlern.

Für ein besseres lesbares Format wandeln Sie die Ausgabe in das YAML-Format um. Dazu hängen Sie -o yaml an die folgenden Befehle an. Dieses Format ist besonders hilfreich, wenn Sie bestimmte Parameter, Annotationen oder Ressourcenspezifikationen untersuchen müssen.

Führen Sie den folgenden Befehl aus, um Details zu einem RootSync-Objekt anzusehen:
```
kubectl describe rootsync ROOT_SYNC_NAME -n config-management-system
```
Ersetzen Sie ROOT_SYNC_NAME durch den Namen des RootSync-Objekts.
Führen Sie den folgenden Befehl aus, um Details zu einem RepoSync-Objekt anzusehen:
```
kubectl describe reposync REPO_SYNC_NAME -n NAMESPACE
```
Ersetzen Sie Folgendes:
- REPO_SYNC_NAME: der Name des RepoSync-Objekts.
- NAMESPACE: Der Namespace, in dem Sie Ihr Namespace-Repository erstellt haben.

Prüfen, ob eine Ressource bereit ist

Wenn Sie wissen möchten, ob die mit dem Cluster synchronisierten Ressourcen bereit sind, sehen Sie sich den Abgleichsstatus an. Beispielsweise kann durch das Anzeigen des Abgleichsstatus angezeigt werden, ob ein synchronisiertes Deployment zur Verarbeitung von Traffic bereit ist.

Für eine mit dem Cluster synchronisierte „Source of Truth“ werden die Abgleichsstatus aller Ressourcen in einer Ressource namens „ResourceGroup“ zusammengefasst. Für jedes RootSync- oder RepoSync-Objekt wird eine ResourceGroup generiert, um die auf den Cluster angewendeten Ressourcen zu erfassen und ihren Status zusammenzufassen.

Führen Sie den folgenden Befehl aus, um den Abgleichsstatus für das Objekt RootSync aufzurufen:
```
kubectl get resourcegroup.kpt.dev ROOT_SYNC_NAME -n config-management-system -o yaml
```
Ersetzen Sie ROOT_SYNC_NAME durch den Namen des RootSync-Objekts.
Führen Sie den folgenden Befehl aus, um den Abgleichsstatus für das Objekt RepoSync aufzurufen:
```
kubectl get resourcegroup.kpt.dev REPO_SYNC_NAME -n NAMESPACE -o yaml
```
Ersetzen Sie Folgendes:
- REPO_SYNC_NAME: der Name des RepoSync-Objekts.
- NAMESPACE: Der Namespace, in dem Sie Ihr Namespace-Repository erstellt haben.

In der Ausgabe werden alle Ressourcenstatus der Ressourcengruppen angezeigt. Die folgende Ausgabe zeigt beispielsweise, dass ein Deployment mit dem Namen nginx-deployment bereit ist:

resourceStatuses:
- group: apps
  kind: Deployment
  name: nginx-deployment
  namespace: default
  status: Current

Logs ansehen

Für jedes RootSync- und RepoSync-Objekt, das Sie erstellen, erstellt Config Sync ein Abgleich-Deployment zur Synchronisierung. In diesem Abschnitt wird erläutert, wie Sie die Logs für diese Abgleiche aufrufen. Das Aufrufen der Logs kann beim Beheben eines Problems hilfreich sein. Es enthält zusätzliche Informationen zu Fortschritt, Warnungen und Fehlern, die über den Objektstatus RootSync und RepoSync hinausgehen.

Führen Sie den folgenden Befehl aus, um die Logs für den Abgleich RootSync oder RepoSync aufzurufen:
```
kubectl logs -n config-management-system deployment/RECONCILER_NAME CONTAINER_NAME
```
Ersetzen Sie Folgendes:
- RECONCILER_NAME: der Abgleichsname des RootSync- oder RepoSync-Objekts.
  - Für RootSync lautet der Abgleichsname root-reconciler-ROOT_SYNC_NAME oder root-reconciler, wenn der Name von RootSync root-sync ist.
  - Für RepoSync lautet der Name des Abgleichs ns-reconciler-NAMESPACE-REPO_SYNC_NAME-REPO_SYNC_NAME_LENGTH oder ns-reconciler-NAMESPACE, wenn der Name von RepoSync repo-sync ist. Dabei ist NAMESPACE der Namespace, in dem Sie das RepoSync-Objekt erstellt haben.
- CONTAINER_NAME: Der Containername muss einer der folgenden Werte sein: reconciler, git-sync, hydration-controller, oci-sync oder helm-sync. Weitere Informationen zu diesen Containern finden Sie unter Abgleichscontainer.

Logebene für RootSync- oder RepoSync-Abgleich konfigurieren

Konfigurieren Sie die Log-Verbosität, um weitere Informationen in die Containerlogs aufzunehmen. Standardmäßig haben die meisten Container den Standardwert 0 für die Log-Verbosität. Ausgenommen hiervon sind die Container git-sync und otel-agent, die den Standardwert 5 haben.

Beachten Sie beim Ändern der Logausführlichkeit, dass eine höhere Logausführlichkeit höhere Logging-Kosten zur Folge hat, da ein größeres Datenvolumen aufgezeichnet wird.

Zum Ändern der Logausführlichkeit verwenden Sie das Feld .spec.override.logLevels, wie im folgenden Beispiel gezeigt:

apiVersion: configsync.gke.io/v1beta1
kind: RootSync
metadata:
  name: root-sync
  namespace: config-management-system
spec:
  override:
    logLevels:
    - containerName: "reconciler"
      logLevel: 0
    - containerName: "git-sync"
       logLevel: 10

Der Wert im Feld containerName muss einer der folgenden Werte sein: reconciler, git-sync, hydration-controller, oci-sync oder helm-sync.

Führen Sie den folgenden Befehl aus, um zu prüfen, ob die Logausführlichkeit konfiguriert wurde:

kubectl get deployment.apps/root-reconciler -n config-management-system -o yaml

Die Logausführlichkeit ist eine der args in spec.template.spec.containers[] und hat das Format -v=0, wobei 0 die aktuelle Logausführlichkeit ist. In diesem Beispiel würde ein Log-Ausführlichkeitswert von 0 nur kritische Ereignisse protokolliert.