Introduzione alla risoluzione dei problemi

Se riscontri problemi con Config Sync, questa pagina illustra alcuni strumenti e procedure comuni che possono aiutarti a identificare e risolvere i problemi riscontrati.

Esegui l'upgrade a una versione supportata

Valuta la possibilità di eseguire l'upgrade di Config Sync a una versione supportata. L'upgrade spesso risolve i problemi comuni e ti dà accesso alle funzionalità più recenti. Per assicurarti di utilizzare sempre una versione supportata, puoi attivare l'upgrade automatico (anteprima).

Utilizza lo strumento a riga di comando nomos

Lo strumento a riga di comando nomos fornisce insight essenziali sulla configurazione di Config Sync. I comandi descritti nelle seguenti sezioni sono particolarmente utili quando stai cercando di determinare l'origine del problema o quando devi collaborare con l'assistenza clienti Google Cloud.

Visualizza lo stato di Config Sync

Il comando nomos status fornisce dati ed errori aggregati per aiutarti a capire cosa succede con l'installazione di Config Sync. Con nomos status sono disponibili le seguenti informazioni:

  • Stato dell'installazione per cluster
  • Errori di sincronizzazione (le lettura da Git e la riconciliazione delle modifiche)

Crea una segnalazione di bug

Se hai un problema con Config Sync che richiede l'aiuto dell'assistenza clienti Google Cloud, puoi fornire utili informazioni di debug utilizzando il comando nomos bugreport.

Questo comando genera un file ZIP con timestamp con informazioni sul cluster Kubernetes impostato nel tuo contesto kubectl. Il file contiene anche i log dei pod di Config Sync. Non contiene informazioni sulle risorse sincronizzate con Config Sync.

Visualizza la dashboard della panoramica

La dashboard di Config Sync fornisce una panoramica dello stato dei pacchetti gestiti da Config Sync e delle risorse contenute in questi pacchetti. Esplorare questa dashboard può aiutarti a ottenere una rapida panoramica dello stato dell'installazione di Config Sync e a scoprire eventuali pacchetti che presentano problemi.

  • Per accedere alla dashboard, nella console Google Cloud vai alla pagina Configurazione nella sezione Funzionalità:

    Vai a Configurazione

Usa il monitoraggio e l'analisi dei log

Il monitoraggio di Config Sync e l'esplorazione dei log possono aiutarti a determinare l'origine dei bug e a comprendere meglio eventuali comportamenti imprevisti.

Informazioni sulle metriche di Config Sync

Utilizza le metriche di Config Sync per avere visibilità sull'integrità di Config Sync.

Monitoraggio di oggetti RootSync e RepoSync

Quando installi Config Sync utilizzando la console Google Cloud o Google Cloud CLI, Config Sync crea automaticamente un oggetto RootSync. Quando configuri la sincronizzazione da più repository, puoi creare oggetti RepoSync contenenti informazioni di configurazione sui repository dello spazio dei nomi.

Il monitoraggio di questi oggetti può rivelare informazioni preziose sullo stato di Config Sync. Per scoprire di più, consulta Monitorare gli oggetti RootSync e RepoSync.

Utilizzare gli indicatori del livello del servizio (SLI)

Per ricevere notifiche quando Config Sync non funziona come previsto, utilizza gli SLI di Config Sync.

Log delle query

Puoi utilizzare Esplora log per recuperare, visualizzare e analizzare i dati dei log per Config Sync. Questi log possono contenere dati storici preziosi che non vengono acquisiti da nomos bugreport al riavvio dei pod dell'operatore o del riconciliazione. Per esempi di query che potrebbero aiutarti a diagnosticare il problema, consulta Log di Query Config Sync.

Esamina le risorse con lo strumento a riga di comando kubectl

Config Sync è composto da più risorse personalizzate su cui puoi eseguire query utilizzando i comandi kubectl. Questi comandi consentono di comprendere lo stato di ciascuno degli oggetti di Config Sync.

Dovresti conoscere le seguenti informazioni sulle risorse Kubernetes gestite da Config Sync:

  • config-management-system è lo spazio dei nomi che utilizziamo per eseguire tutti i componenti di sistema principali di Config Sync.
  • configmanagement.gke.io e configsync.gke.io sono i gruppi API che utilizziamo per tutte le risorse personalizzate.

Esempi

Le seguenti sezioni mostrano come utilizzare i comandi kubectl per esaminare Config Sync.

Elenca risorse personalizzate

  • Puoi ottenere un elenco completo delle risorse personalizzate eseguendo questo comando:

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

  • Puoi utilizzare le singole risorse personalizzate eseguendo questo comando:

    kubectl get RESOURCE -o yaml.

    Sostituisci RESOURCE con il nome della risorsa su cui vuoi eseguire una query.

    Ad esempio, l'output del comando seguente consente di controllare lo stato di un oggetto RootSync:

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

Controllare l'annotazione del token di un oggetto

Potrebbe essere utile sapere quando un oggetto Kubernetes gestito è stato aggiornato l'ultima volta da Config Sync. Ogni oggetto gestito è annotato con l'hash del commit Git quando è stato modificato l'ultima volta e il percorso della configurazione che conteneva la modifica.

Ad esempio, per ottenere l'annotazione di un ClusterRoleBinding denominato namespace-readers, esegui questo comando:

kubectl get clusterrolebinding namespace-readers

L'output è simile al seguente:

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

Per scoprire di più, consulta la sezione Etichette e annotazioni.

Leggi la documentazione aggiuntiva per la risoluzione dei problemi

Se i problemi persistono, le seguenti risorse potrebbero essere utili:

  • Se hai ricevuto un messaggio di errore, consulta la pagina di riferimento sull'errore per informazioni su come risolverlo.

  • Verifica se il problema che stai riscontrando è causato da un problema noto.

  • Se hai difficoltà con un'area specifica, potrebbe esserti utile una delle guide alla risoluzione dei problemi mirate elencate nella sezione Risoluzione dei problemi in base al tipo di problema del sommario.

Passaggi successivi