Monitoraggio di oggetti RootSync e RepoSync

Questa pagina mostra diversi modi per monitorare gli oggetti RootSync e RepoSync. Ad esempio, potresti voler verificare se l'ultimo commit in una fonte attendibile è stato applicato a un cluster e riconciliato correttamente.

Visualizzare i commit sincronizzati

Puoi controllare quale commit è sincronizzato con il cluster controllando il campo .status.sync nell'oggetto RootSync o RepoSync.

  • Per visualizzare i commit sincronizzati per un oggetto RootSync, esegui il comando seguente:

    kubectl get rootsync ROOT_SYNC_NAME -n config-management-system

    Sostituisci ROOT_SYNC_NAME con il nome dell'oggetto RootSync.

  • Per visualizzare i commit sincronizzati per un oggetto RepoSync, esegui il comando seguente:

    kubectl get reposync REPO_SYNC_NAME -n REPO_SYNC_NAMESPACE

    Sostituisci quanto segue:

    • REPO_SYNC_NAME: il nome dell'oggetto RepoSync.
    • REPO_SYNC_NAMESPACE: lo spazio dei nomi in cui hai creato il repository dello spazio dei nomi.

L'output di questi comandi mostra il valore del commit di origine e del commit sincronizzato. Ad esempio, se hai eseguito il comando per RepoSync, vedrai un output simile al seguente:

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

Il valore nella colonna RENDERINGCOMMIT è il commit elaborato da hydration-controller. Se non è necessario il rendering, il valore è lo stesso della colonna SOURCECOMMIT. Il valore nella colonna SOURCECOMMIT è il commit della fonte attendibile che deve essere sincronizzato con il cluster. Il valore nella colonna SYNCCOMMIT è il commit di cui è stato eseguito il deployment nel cluster. Se i due valori nelle colonne SOURCECOMMIT e SYNCCOMMIT sono uguali, il commit previsto è stato eseguito nel cluster.

Confermare che le risorse nel commit sono riconciliate

Poiché i ResourceGroup acquisiscono lo stato di riconciliazione delle risorse gestite dichiarate nella fonte attendibile, puoi esaminarli per verificare se le risorse nel commit sono riconciliate.

L'oggetto ResourceGroup ha lo stesso spazio dei nomi e lo stesso nome dell'oggetto RootSync o RepoSync. Ad esempio, per l'oggetto RootSync con il nome root-sync nello spazio dei nomi config-management-system, l'oggetto ResourceGroup corrispondente è anche root-sync nello spazio dei nomi config-management-system.

  • Per ottenere l'oggetto ResourceGroup per un oggetto RootSync:

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

  • Per ottenere l'oggetto ResourceGroup per un oggetto RepoSync:

    kubectl get resourcegroup REPO_SYNC_NAME -n REPO_SYNC_NAMESPACE -o yaml

    Sostituisci quanto segue:

    • ROOT_SYNC_NAME: il nome dell'oggetto ResourceGroup che vuoi cercare.
    • REPO_SYNC_NAME: il nome dell'oggetto ResourceGroup che vuoi cercare.
    • REPO_SYNC_NAMESPACE: il nome dell'oggetto ResourceGroup che vuoi cercare.

Per verificare che le risorse nel commit siano riconciliate, cerca quanto segue nell'output:

  • Il valore di .status.observedGeneration è uguale al valore del campo .metadata.generation nell'oggetto ResourceGroup.
  • La condizione Stalled ha un status di "False".
  • Ogni elemento in .status.resourceStatuses ha un actuation di Succeeded, un reconcile di Succeeded e uno status di Current.

Visualizzare errori

Gli oggetti RootSync e RepoSync utilizzano il campo status per monitorare gli errori riscontrati durante la sincronizzazione delle configurazioni dalla fonte attendibile a un cluster.

  • Per visualizzare lo stato di un oggetto RootSync, esegui il comando seguente:

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

    Sostituisci ROOT_SYNC_NAME con il nome dell'oggetto RootSync.

  • Per visualizzare lo stato di un oggetto RepoSync, esegui il comando seguente:

    kubectl get reposync REPO_SYNC_NAME -n NAMESPACE -o yaml

    Sostituisci quanto segue:

    • REPO_SYNC_NAME: il nome dell'oggetto RepoSync.
    • NAMESPACE: lo spazio dei nomi in cui hai creato il repository dello spazio dei nomi.

Per saperne di più sui sottocampi del campo status, consulta Stato degli oggetti.

Visualizzare i dettagli dell'oggetto

Per visualizzare i dettagli degli oggetti RootSync e RepoSync e scoprire ulteriori informazioni su potenziali errori, utilizza il comando kubectl describe.

L'output di questo comando include gli eventi, che possono essere particolarmente utili per il debug di problemi come i container che devono affrontare vincoli di memoria (OOMKilled), errori di pianificazione o errori di pull delle immagini.

Per un formato più leggibile, converti l'output in YAML aggiungendo -o yaml ai comandi seguenti. Questo formato è particolarmente utile quando devi esaminare parametri, annotazioni o specifiche delle risorse specifici.

  • Per visualizzare i dettagli di un oggetto RootSync, esegui il comando seguente:

    kubectl describe rootsync ROOT_SYNC_NAME -n config-management-system

    Sostituisci ROOT_SYNC_NAME con il nome dell'oggetto RootSync.

  • Per visualizzare i dettagli di un oggetto RepoSync, esegui il comando seguente:

    kubectl describe reposync REPO_SYNC_NAME -n NAMESPACE

    Sostituisci quanto segue:

    • REPO_SYNC_NAME: il nome dell'oggetto RepoSync.
    • NAMESPACE: lo spazio dei nomi in cui hai creato il repository dello spazio dei nomi.

Verificare se una risorsa è pronta

Per sapere se le risorse sincronizzate con il cluster sono pronte, visualizza lo stato di riconciliazione. Ad esempio, la visualizzazione dello stato di riconciliazione può indicare se un deployment sincronizzato è pronto per gestire il traffico.

Per una fonte attendibile sincronizzata con il cluster, gli stati di riconciliazione di tutte le risorse vengono aggregati in una risorsa denominata ResourceGroup. Per ogni oggetto RootSync o RepoSync, viene generato un ResourceGroup per acquisire l'insieme di risorse applicate al cluster e aggregarne gli stati.

  • Per visualizzare lo stato di riconciliazione dell'oggetto RootSync, esegui il comando seguente:

    kubectl get resourcegroup.kpt.dev ROOT_SYNC_NAME -n config-management-system -o yaml

    Sostituisci ROOT_SYNC_NAME con il nome dell'oggetto RootSync.

  • Per visualizzare lo stato di riconciliazione dell'oggetto RepoSync, esegui il comando seguente:

    kubectl get resourcegroup.kpt.dev REPO_SYNC_NAME -n NAMESPACE -o yaml

    Sostituisci quanto segue:

    • REPO_SYNC_NAME: il nome dell'oggetto RepoSync.
    • NAMESPACE: lo spazio dei nomi in cui hai creato il repository dello spazio dei nomi.

Nell'output vengono visualizzati tutti gli stati delle risorse ResourceGroup. Ad esempio, l'output seguente mostra che un deployment denominato nginx-deployment è pronto:

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

Visualizzare i log

Per ogni oggetto RootSync e RepoSync che crei, Config Sync crea un deployment di riconciliazione per eseguire la sincronizzazione. Questa sezione spiega come visualizzare i log di questi riconciliatori. La visualizzazione dei log può essere utile per il debug di un problema, in quanto fornisce informazioni aggiuntive su progressi, avvisi ed errori oltre a quelle disponibili nello stato dell'oggetto RootSync e RepoSync.

  • Per visualizzare i log del riconciliatore RootSync o RepoSync, esegui il comando seguente:

    kubectl logs -n config-management-system deployment/RECONCILER_NAME CONTAINER_NAME

    Sostituisci quanto segue:

    • RECONCILER_NAME: il nome del riconciliatore dell'oggetto RootSync o RepoSync.

      • Per RootSync, il nome del riconciliatore è root-reconciler-ROOT_SYNC_NAME o root-reconciler se il nome di RootSync è root-sync.

      • Per RepoSync, il nome del riconciliatore è ns-reconciler-NAMESPACE-REPO_SYNC_NAME-REPO_SYNC_NAME_LENGTH o ns-reconciler-NAMESPACE se il nome di RepoSync è repo-sync, dove NAMESPACE è lo spazio dei nomi in cui hai creato l'oggetto RepoSync.

    • CONTAINER_NAME: il nome del container deve essere uno dei seguenti valori: reconciler, git-sync, hydration-controller, oci-sync o helm-sync. Per saperne di più su questi container, consulta Container di riconciliazione.

Configurare il livello di log del riconciliatore RootSync o RepoSync

Per includere ulteriori informazioni nei log dei container, configura la verbosità dei log. Per impostazione predefinita, la maggior parte dei container ha un valore predefinito di 0 per la verbosità dei log. Le eccezioni sono i container git-sync e otel-agent, che hanno un valore predefinito di 5.

Quando modifichi la verbosità dei log, tieni presente che l'aumento della verbosità dei log comporta costi di logging più elevati perché viene registrato un volume maggiore di dati.

Per modificare la verbosità dei log, utilizza il campo .spec.override.logLevels, come mostrato nell'esempio seguente:

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

Il valore nel campo containerName deve essere uno dei seguenti: reconciler, git-sync, hydration-controller, oci-sync o helm-sync.

Per verificare che la verbosità dei log sia configurata, esegui il comando seguente:

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

La verbosità dei log è disponibile come uno degli args all'interno di spec.template.spec.containers[] e ha un aspetto simile a -v=0, dove 0 è la verbosità dei log corrente. In questo esempio, un valore di verbosità dei log pari a 0 registrerebbe solo gli eventi critici.