Introduzione alla risoluzione dei problemi

Se riscontri difficoltà con Config Sync, questa pagina ti presenta alcuni strumenti e procedure comuni che possono aiutarti a identificare e risolvere i problemi che riscontri.

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 consente di accedere alle funzionalità più recenti.

Utilizzare lo strumento a riga di comando nomos

Lo strumento a riga di comando nomos fornisce informazioni essenziali sulla configurazione di Config Sync. I comandi descritti nelle sezioni seguenti sono particolarmente utili quando cerchi di determinare l'origine del problema o quando devi collaborare coassistenza clienti Google Cloudre.

Visualizzare lo stato di Config Sync

Il comando nomos status fornisce dati e errori aggregati per aiutarti a capire cosa sta succedendo con l'installazione di Config Sync. Le seguenti informazioni sono disponibili con nomos status:

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

Creare una segnalazione di bug

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

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

Visualizzare la dashboard di panoramica

La dashboard Config Sync fornisce una panoramica dello stato dei pacchetti gestiti da Config Sync e dello stato delle risorse in questi pacchetti. L'esplorazione di 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 Google Cloud console vai alla pagina Config nella sezione Funzionalità:

    Vai a Configurazione

Utilizzare il monitoraggio e l'analisi dei log

Il monitoraggio di Config Sync e l'esplorazione dei relativi log possono aiutarti a determinare l'origine dei bug e a comprendere meglio qualsiasi comportamento imprevisto.

Comprendere le metriche di Config Sync

Utilizza le metriche di Config Sync per ottenere 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 per te. Quando configuri la sincronizzazione da più repository, puoi creare oggetti RepoSync che contengono informazioni di configurazione sui repository di spazi dei nomi.

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

Utilizzare gli indicatori del livello del servizio (SLI)

Per ricevere notifiche quando Config Sync non funziona come previsto, utilizza gli indicatori di livello del servizio (SLI) di Config Sync.

Esegui query sui log

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 quando i pod dell'operatore o del riconciliatore vengono riavviati. Per esempi di query che potrebbero aiutarti a diagnosticare il problema, consulta Eseguire query sui log di Config Sync.

Esaminare le risorse con lo strumento a riga di comando kubectl

Config Sync è composto da più risorse personalizzate che puoi interrogare utilizzando i comandi kubectl. Questi comandi ti aiutano a comprendere lo stato di ciascuno degli oggetti di Config Sync.

Devi 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 di API che utilizziamo per tutte le risorse personalizzate.

Esempi

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

Elenca risorse personalizzate

  • Per ottenere un elenco completo delle risorse personalizzate, esegui questo comando:

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

  • Le singole risorse personalizzate possono essere utilizzate eseguendo questo comando:

    kubectl get RESOURCE -o yaml.

    Sostituisci RESOURCE con il nome della risorsa che vuoi interrogare.

    Ad esempio, l'output del seguente comando 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

Potresti voler 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 il seguente 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 ulteriori informazioni, consulta Etichette e annotazioni.

Leggi l'ulteriore documentazione per la risoluzione dei problemi

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

  • Se hai ricevuto un messaggio di errore, consulta la pagina Riferimento agli errori per suggerimenti su come risolvere l'errore.

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

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

Passaggi successivi