Questa pagina è stata tradotta dall'API Cloud Translation.

Crea snapshot per diagnosticare i problemi del cluster

Quando si verifica un problema con uno dei cluster, puoi ottenere aiuto dall'assistenza clienti Google Cloud. L 'assistenza clienti potrebbe chiederti di creare un'istantanea del cluster da utilizzare per diagnosticare il problema. Uno snapshot acquisisce i file di configurazione del cluster e dei nodi, e pacchettizza le informazioni in un unico file tar.

Questo documento descrive come creare snapshot predefiniti o più snapshot personalizzati di un cluster. Viene inoltre spiegato come creare snapshot quando si verificano errori specifici in un cluster.

Se hai bisogno di ulteriore aiuto, contatta l'assistenza clienti Google Cloud.

Snapshot predefiniti

Le seguenti sezioni descrivono i contenuti di uno snapshot standard e come crearne uno. Per informazioni sugli snapshot personalizzati, consulta la sezione sugli snapshot personalizzati.

Quali informazioni contiene uno snapshot predefinito?

Lo snapshot di un cluster è un file tar dei file di configurazione e dei log relativi al cluster. In particolare, la configurazione predefinita del comando acquisisce le seguenti informazioni sul cluster:

la versione di Kubernetes.
Stato delle risorse Kubernetes negli spazi dei nomi kube-system e gke-system: cluster, macchina, nodi, servizi, endpoint, ConfigMap, ReplicaSet, CroJob, pod e i proprietari di questi pod, inclusi Deployment, DaemonSet e StatefulSet.
Dettagli relativi alla configurazione di ogni nodo, inclusi indirizzi IP, regole iptables, punti di montaggio, file system, connessioni di rete e processi in esecuzione.
Informazioni sul runtime VM in GDC e su eventuali VM e risorse relative alle VM in esecuzione nel cluster. Per saperne di più sui dati raccolti per impostazione predefinita e su come creare snapshot specifici delle VM, consulta Informazioni sulle VM negli snapshot in questo documento.
Log dal comando bmctl check cluster --snapshot.

Le informazioni sulle credenziali di un cluster non sono incluse nello snapshot predefinito. Se l'assistenza clienti Google Cloud richiede queste informazioni, consulta Recupero delle informazioni sul cluster.

Per un elenco completo delle informazioni raccolte quando esegui il comando snapshot, consulta una sezione seguente contenente informazioni dettagliate sul file di configurazione. Questo file di configurazione mostra quali comandi vengono eseguiti quando si acquisisce uno snapshot predefinito.

Crea uno snapshot predefinito

Il comando bmctl check cluster crea uno snapshot di un cluster. Puoi utilizzare questo comando per eseguire una delle seguenti azioni:

Creare uno snapshot e caricarlo automaticamente in un bucket Cloud Storage.
Crea uno snapshot di un cluster e salva il file snapshot sulla macchina locale su cui stai eseguendo il comando.

Metodo 1: crea uno snapshot predefinito e caricalo automaticamente nel bucket Cloud Storage

Per creare e caricare uno snapshot in un bucket Cloud Storage, segui questi passaggi:

Configura l'API e l'account di servizio come descritto in Configurare un account di servizio che può accedere a un bucket Cloud Storage.

Si tratta di un passaggio da eseguire una sola volta.
Esegui questo comando bmctl per creare e caricare automaticamente uno snapshot in un bucket Cloud Storage:
```
bmctl check cluster --snapshot --cluster=CLUSTER_NAME \
    --admin-kubeconfig=ADMIN_KUBECONFIG \
    --service-account-key-file SA_KEY_FILE
```
Sostituisci le voci seguenti con informazioni specifiche per l'ambiente del tuo cluster:
- CLUSTER_NAME: il nome del cluster di cui vuoi eseguire uno snapshot.
- ADMIN_KUBECONFIG: il percorso del file kubeconfig del cluster di amministrazione.
- SA_KEY_FILE: il percorso del file chiave JSON scaricato per l'account di servizio creato nel passaggio precedente. Se non utilizzi il flag --service-account-key-file, il comando utilizza le credenziali associate alla variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS. Specificare in modo esplicito le credenziali dell'account di servizio con il flag ha la precedenza.
Questo comando genera un file tar dello snapshot e lo salva localmente. Se l'account di servizio è configurato correttamente, il comando carica anche il file tar dello snapshot in un bucket in Cloud Storage. Il comando cerca nel progetto un bucket di archiviazione il cui nome inizia con "anthos-snapshot-". Se esiste un bucket di questo tipo, il comando carica lo snapshot in quel bucket. Se il comando non trova un bucket con un nome corrispondente, crea un nuovo bucket con il nome anthos-snapshot-UUID, dove UUID è un identificatore univoco universale di 32 cifre.

Nota: puoi utilizzare il flag --upload-to per fornire un nome bucket specifico in cui viene caricato lo snapshot.
Condividi l'accesso con l'assistenza clienti Google Cloud come descritto in Consentire all'assistenza clienti Google Cloud di visualizzare lo snapshot del cluster caricato.

Metodo 2: crea snapshot predefiniti solo sulla macchina locale

Utilizza il flag --local per assicurarti che lo snapshot del cluster venga salvato solo in locale. Puoi acquisire lo stato dei cluster creati con il seguente comando:

bmctl check cluster --snapshot --cluster=CLUSTER_NAME \
    --admin-kubeconfig=ADMIN_KUBECONFIG --local

Sostituisci quanto segue:

CLUSTER_NAME: il nome del cluster di destinazione.
ADMIN_KUBECONFIG: il percorso del file kubeconfig del cluster di amministrazione.

Questo comando restituisce un file tar sulla tua macchina locale. Il nome di questo file tar è nel formato snapshot-CLUSTER_NAME-TIMESTAMP.tar.gz, dove TIMESTAMP indica la data e l'ora di creazione del file. Questo file tar include informazioni di debug pertinenti sui componenti di sistema e sulle macchine di un cluster.

Quando esegui questo comando, vengono raccolte informazioni sui pod dai seguenti spazi dei nomi: gke-system, gke-connect, capi-system, capi-webhook-system, cert-manager e capi-kubeadm-bootstrap-system

Tuttavia, puoi ampliare l'ambito delle informazioni diagnostiche raccolte utilizzando il flag --snapshot-scenario all. Questo flag aumenta l'ambito dello snapshot di diagnostica per includere tutti i pod in un cluster:

bmctl check cluster --snapshot --snapshot-scenario all \
    --cluster=CLUSTER_NAME \
    --kubeconfig=KUBECONFIG_PATH \
    --local

Scenari di snapshot

Il comando bmctl check cluster --snapshot supporta due scenari. Per specificare uno scenario, utilizza il flag --scenario. Nell'elenco seguente vengono mostrati i valori possibili:

system: raccogli uno snapshot dei componenti di sistema, inclusi i log.
all: raccogli uno snapshot di tutti i pod, inclusi i log.

Puoi utilizzare ciascuno dei due scenari con un cluster di amministrazione o un cluster utente. L'esempio seguente crea uno snapshot del cluster di amministrazione utilizzando lo scenario system:

bmctl check cluster --snapshot --snapshot-scenario system \
    --cluster=ADMIN_CLUSTER_NAME \
    --kubeconfig=ADMIN_KUBECONFIG_PATH

L'esempio seguente crea uno snapshot di un cluster utente utilizzando lo scenario all:

bmctl check cluster --snapshot --snapshot-scenario all \
    --cluster=USER_CLUSTER_NAME \
    --kubeconfig=USER_KUBECONFIG_PATH

Esegui una prova per uno snapshot

Quando utilizzi il flag --snapshot-dry-run, il comando non crea uno snapshot. Mostra invece le azioni eseguite dal comando snapshot e restituisce un file di configurazione dello snapshot. Per informazioni sul file di configurazione dello snapshot, consulta Come creare uno snapshot personalizzato.

Per eseguire uno snapshot dry run sul cluster di amministrazione, inserisci questo comando:

bmctl check cluster --snapshot --snapshot-dry-run \
    --cluster=ADMIN_CLUSTER_NAME \
    --kubeconfig=ADMIN_KUBECONFIG_PATH

Per eseguire uno snapshot dry run su un cluster utente, inserisci questo comando:

bmctl check cluster --snapshot --snapshot-dry-run \
    --cluster=USER_CLUSTER_NAME \
    --kubeconfig=USER_KUBECONFIG_PATH

Ottieni i log di un periodo specifico

Puoi utilizzare il flag --since per recuperare i log di un periodo di tempo che ti interessa particolarmente. In questo modo, puoi creare snapshot di logging più piccoli e mirati, che si sono verificati negli ultimi secondi, minuti o ore.

Ad esempio, il seguente comando bmctl crea uno snapshot dei log che si sono verificati nelle ultime tre ore:

bmctl check cluster --snapshot --since=3h \
    --cluster=CLUSTER_NAME \
    --kubeconfig=ADMIN_KUBECONFIG_PATH

Specifica una directory in cui salvare temporaneamente lo snapshot

Puoi utilizzare il flag --snapshot-temp-output-dir per specificare una directory in cui salvare temporaneamente lo snapshot:

bmctl check cluster --snapshot --snapshot-temp-output-dir=TEMP_OUTPUT_DIR \
    --cluster=CLUSTER_NAME \
    --kubeconfig=ADMIN_KUBECONFIG_PATH

Se non specifichi una directory, lo snapshot viene salvato temporaneamente nella directory /tmp. Ad esempio, è una buona idea utilizzare l'opzione --snapshot-temp-output-dir se lo spazio nella directory /tmp predefinita è limitato.

Elimina log della console

Puoi utilizzare il flag --quiet per impedire la visualizzazione dei messaggi di log nella console durante l'esecuzione di uno snapshot. I log della console vengono invece salvati nel file "bmctl_diagnose_snapshot.log" come parte dello snapshot.

Esegui questo comando per impedire la visualizzazione dei messaggi di log nella console:

bmctl check cluster --snapshot --quiet \
    --cluster=CLUSTER_NAME \
    --kubeconfig=ADMIN_KUBECONFIG_PATH

Snapshot personalizzati

Ti consigliamo di creare uno snapshot personalizzato di un cluster per i seguenti motivi:

Per includere ulteriori informazioni sul cluster rispetto a quelle fornite nello snapshot predefinito.
Per escludere alcune informazioni presenti nello snapshot predefinito.

Crea uno snapshot personalizzato

La creazione di uno snapshot personalizzato richiede l'utilizzo di un file di configurazione snapshot. I passaggi seguenti spiegano come creare il file di configurazione, modificarlo e utilizzarlo per creare uno snapshot personalizzato di un cluster:

Crea un file di configurazione dello snapshot eseguendo questo comando sul cluster e scrivendo l'output in un file:

bmctl check cluster \
    --snapshot --snapshot-dry-run --cluster CLUSTER_NAME \
    --kubeconfig KUBECONFIG_PATH

Definisci il tipo di informazioni da visualizzare nello snapshot personalizzato. Per farlo, modifica il file di configurazione dello snapshot creato al passaggio 1. Ad esempio, se vuoi che lo snapshot contenga ulteriori informazioni, ad esempio da quanto tempo è stato eseguito un determinato nodo, aggiungi il comando Linux uptime alla sezione pertinente del file di configurazione.

Il seguente snippet di un file di configurazione mostra come fare in modo che il comando snapshot fornisca informazioni uptime sul nodo 10.200.0.3. Queste informazioni non vengono visualizzate in uno snapshot standard.
```
...
nodeCommands:
- nodes:
  - 10.200.0.3
  commands:
  - uptime
...
```
Dopo aver modificato il file di configurazione per definire il tipo di snapshot, crea lo snapshot personalizzato eseguendo questo comando:
```
bmctl check cluster --snapshot --snapshot-config SNAPSHOT_CONFIG_FILE \
    --cluster CLUSTER_NAME--kubeconfig KUBECONFIG_PATH
```
Il flag --snapshot-config indica al comando bmctl di utilizzare i contenuti del file di configurazione dello snapshot per definire le informazioni da visualizzare nello snapshot.

Il file di configurazione nel dettaglio

Il seguente file di configurazione dello snapshot di esempio mostra i comandi e i file standard utilizzati per creare uno snapshot, ma puoi aggiungere altri comandi e file quando sono necessarie ulteriori informazioni diagnostiche:

numOfParallelThreads: 10
excludeWords:
- password
nodeCommands:
- nodes:
  - 10.200.0.3
  - 10.200.0.4
  commands:
  - uptime
  - df --all --inodes
  - ip addr
  - ip neigh
  - iptables-save --counters
  - mount
  - ip route list table all
  - top -bn1 || true
  - docker info || true
  - docker ps -a || true
  - crictl ps -a || true
  - docker ps -a | grep anthos-baremetal-haproxy | cut -d ' ' -f1 | head -n 1 | xargs
    sudo docker logs || true
  - docker ps -a | grep anthos-baremetal-keepalived | cut -d ' ' -f1 | head -n 1 |
    xargs sudo docker logs || true
  - crictl ps -a | grep anthos-baremetal-haproxy | cut -d ' ' -f1 | head -n 1 | xargs
    sudo crictl logs || true
  - crictl ps -a | grep anthos-baremetal-keepalived | cut -d ' ' -f1 | head -n 1 |
    xargs sudo crictl logs || true
  - ps -edF
  - ps -eo pid,tid,ppid,class,rtprio,ni,pri,psr,pcpu,stat,wchan:14,comm,args,cgroup
  - conntrack --count
  - dmesg
  - systemctl status -l docker || true
  - journalctl --utc -u docker
  - journalctl --utc -u docker-monitor.service
  - systemctl status -l kubelet
  - journalctl --utc -u kubelet
  - journalctl --utc -u kubelet-monitor.service
  - journalctl --utc --boot --dmesg
  - journalctl --utc -u node-problem-detector
  - systemctl status -l containerd || true
  - journalctl --utc -u containerd
  - systemctl status -l docker.haproxy || true
  - journalctl --utc -u docker.haproxy
  - systemctl status -l docker.keepalived || true
  - journalctl --utc -u docker.keepalived
  - systemctl status -l container.haproxy || true
  - journalctl --utc -u container.haproxy
  - systemctl status -l container.keepalived || true
  - journalctl --utc -u container.keepalived
nodeFiles:
- nodes:
  - 10.200.0.3
  - 10.200.0.4
  files:
  - /proc/sys/fs/file-nr
  - /proc/sys/net/netfilter/nf_conntrack_max
  - /proc/sys/net/ipv4/conf/all/rp_filter
  - /lib/systemd/system/kubelet.service
  - /etc/systemd/system/kubelet.service.d/10-kubeadm.conf
  - /lib/systemd/system/docker.service || true
  - /etc/systemd/system/containerd.service || true
  - /etc/docker/daemon.json || true
  - /etc/containerd/config.toml || true
  - /etc/systemd/system/container.keepalived.service || true
  - /etc/systemd/system/container.haproxy.service || true
  - /etc/systemd/system/docker.keepalived.service || true
  - /etc/systemd/system/docker.haproxy.service || true
nodeSSHKey: ~/.ssh/id_rsa # path to your ssh key file

Le seguenti voci nel file di configurazione sono probabilmente diverse da quelle visualizzate nel precedente file di configurazione di esempio:

Gli indirizzi IP dei nodi nelle sezioni nodeCommands e nodeFiles
Il percorso dell'oggetto nodeSSHKey del cluster

Campi nel file di configurazione

Un file di configurazione di snapshot è in formato YAML. Il file di configurazione include i seguenti campi:

numOfParallelThreads: la routine snapshot in genere esegue numerosi comandi. Più thread paralleli consentono un'esecuzione più rapida della routine. Ti consigliamo di impostare numOfParallelThreads su 10 come mostrato nel file di configurazione di esempio precedente. Se gli snapshot richiedono troppo tempo, aumenta questo valore.
excludeWords: lo snapshot contiene una grande quantità di dati per i nodi del cluster. Utilizza excludeWords per ridurre i rischi per la sicurezza quando condividi lo snapshot. Ad esempio, escludi password in modo che le stringhe della password corrispondenti non possano essere identificate.
nodeCommands: questa sezione specifica le seguenti informazioni:
- nodes: un elenco di indirizzi IP per i nodi del cluster da cui vuoi raccogliere informazioni. Per creare uno snapshot quando il cluster di amministrazione non è raggiungibile, specifica almeno un indirizzo IP del nodo.
- commands: un elenco di comandi (e argomenti) da eseguire su ciascun nodo. L'output di ogni comando è incluso nello snapshot.
nodeFiles: questa sezione specifica le seguenti informazioni:
- nodes: un elenco di indirizzi IP dei nodi del cluster da cui vuoi raccogliere i file. Per creare uno snapshot quando il cluster di amministrazione non è raggiungibile, specifica almeno un indirizzo IP del nodo.
- files: un elenco di file da recuperare da ciascun nodo. Quando i file specificati vengono trovati su un nodo, vengono inclusi nello snapshot.
nodeSSHKey: percorso del file della chiave SSH. Se il cluster di amministrazione non è raggiungibile, questo campo è obbligatorio.

Crea snapshot quando si verificano errori specifici

Per creare correttamente uno snapshot al verificarsi di determinati eventi, ad esempio un upgrade bloccato, potrebbero essere necessari ulteriori passaggi o parametri di comando.

Crea uno snapshot predefinito in caso di installazioni o upgrade bloccati

Durante l'installazione o l'upgrade di cluster di amministrazione, ibridi o autonomi, bmctl a volte può bloccarsi in punti in cui sono visibili i seguenti output:

In attesa che kubeconfig del cluster sia pronto.
In attesa che il cluster sia pronto.
In attesa che i pool di nodi siano pronti.
In attesa del completamento dell'upgrade.

Se noti un'installazione bloccata o un upgrade, puoi acquisire uno snapshot di un cluster utilizzando il cluster di bootstrap, come mostrato nell'esempio seguente:

bmctl check cluster --snapshot --cluster=CLUSTER_NAME \
    --kubeconfig=WORKSPACE_DIR/.kindkubeconfig

Crea un'istantanea personalizzata durante le installazioni o gli upgrade in fase di stallo

I passaggi seguenti mostrano come creare uno snapshot personalizzato di un cluster quando un'installazione o un upgrade è bloccato:

Recupera un file di configurazione snapshot del cluster dagli archivi.
Modifica il file di configurazione dello snapshot in modo che quest'ultimo contenga le informazioni desiderate.

Crea lo snapshot personalizzato eseguendo questo comando:

bmctl check cluster --snapshot
    --snapshot-config=SNAPSHOT_CONFIG_FILE \
    --cluster=CLUSTER_NAME
    --kubeconfig=WORKSPACE_DIR/.kindkubeconfig

Crea uno snapshot personalizzato quando il cluster di amministrazione non è raggiungibile

Quando il cluster di amministrazione non è raggiungibile, puoi acquisire uno snapshot personalizzato del cluster eseguendo questo comando:

bmctl check cluster --snapshot --cluster CLUSTER_NAME
    --node-ssh-key SSH_KEY_FILE
    --nodes NODE_1_IP_ADDRESS, NODE_2_IP_ADDRESS, ...

Nel comando, sostituisci le voci seguenti con informazioni specifiche per l'ambiente cluster:

CLUSTER_NAME: il nome del cluster di cui vuoi acquisire uno snapshot.
SSH_KEY_FILE: il percorso del file della chiave SSH del nodo.
NODE_x_IP_ADDRESS: l'indirizzo IP di un nodo del cluster su cui vuoi informazioni.

In alternativa, puoi elencare gli indirizzi IP dei nodi su righe separate:

bmctl check cluster
    --snapshot --cluster CLUSTER_NAME \
    --node-ssh-key SSH_KEY_FILE \
    --nodes NODE_1_IP_ADDRESS \
    --nodes NODE_2_IP_ADDRESS
  ...

Informazioni sulle VM negli snapshot

Se utilizzi il runtime VM su GDC per creare e gestire macchine virtuali (VM) su Google Distributed Cloud, puoi raccogliere informazioni diagnostiche pertinenti negli snapshot. Gli snapshot sono una risorsa fondamentale per diagnosticare e risolvere i problemi delle VM.

Che cosa viene raccolto per impostazione predefinita

Quando crei uno snapshot predefinito, questo contiene le informazioni sul runtime VM in GDC e sulle risorse correlate. Il runtime VM su GDC è in bundle con Google Distributed Cloud e la risorsa personalizzata VMRuntime è disponibile sui tuoi cluster che eseguono carichi di lavoro. Anche se non hai abilitato il runtime VM in GDC, lo snapshot contiene comunque la descrizione YAML della risorsa personalizzata VMRuntime.

Se hai abilitato il runtime VM su GDC, gli snapshot contengono informazioni sullo stato e sulla configurazione per le risorse relative alla VM (quando gli oggetti sono presenti) nel tuo cluster. Le risorse correlate alle VM includono oggetti Kubernetes, come pod, deployment, DaemonSet e ConfigMap.

Oggetti nello spazio dei nomi `vm-system`

Le informazioni su stato e configurazione dei seguenti oggetti si trovano in kubectlCommands/vm-system nello snapshot generato:

KubeVirt
VirtualMachineType
VMHighAvailabilityPolicy

Oggetti in altri spazi dei nomi

Quando crei una VM (VirtualMachine), puoi specificare lo spazio dei nomi. Se non specifichi uno spazio dei nomi, la VM ottiene lo spazio dei nomi default. Gli altri oggetti in questa sezione, ad esempio VirtualMachineInstance, sono tutti associati allo spazio dei nomi per la VM corrispondente.

Le informazioni su stato e configurazione dei seguenti oggetti si trovano in kubectlCommands/VM_NAMESPACE nello snapshot generato. Se non hai impostato uno spazio dei nomi specifico per la VM, le informazioni si trovano in kubectlCommands/default:

VirtualMachine
VirtualMachineInstance
VirtualMachineDisk
GuestEnvironmentData
VirtualMachineAccessRequest
VirtualMachinePasswordResetRequest

Oggetti senza spazio dei nomi

I seguenti oggetti non hanno uno spazio dei nomi, quindi le informazioni corrispondenti si trovano direttamente in kubectlCommands nello snapshot generato:

VMRuntime
DataVolume
CDI
GPUAllocation

Utilizza un file di configurazione snapshot solo per acquisire i dettagli della VM

Se stai diagnosticando i problemi relativi alle VM in modo specifico, puoi utilizzare un file di configurazione degli snapshot per limitare le informazioni raccolte solo ai dettagli relativi alla VM e personalizzare le informazioni raccolte sulla VM.

Il seguente file di configurazione dello snapshot illustra come creare uno snapshot specifico della VM. Puoi includere comandi aggiuntivi per raccogliere maggiori informazioni per lo snapshot.

---
kubectlCommands:
- commands:
    - kubectl get vm -o wide
    - kubectl get vmi -o wide
    - kubectl get gvm -o wide
    - kubectl get vm -o yaml
    - kubectl get vmi -o yaml
    - kubectl get gvm -o yaml
    - kubectl describe vm
    - kubectl describe vmi
    - kubectl describe gvm
  namespaces:
    - .*
- commands:
    - kubectl get virtualmachinetype -o wide
    - kubectl get virtualmachinedisk -o wide
    - kubectl get virtualmachinetype -o yaml
    - kubectl get virtualmachinedisk -o yaml
    - kubectl describe virtualmachinetype
    - kubectl describe virtualmachinedisk
  namespaces:
    - vm-system

Per ulteriori informazioni sull'utilizzo dei file di configurazione degli snapshot, consulta Snapshot personalizzati in questo documento.

Passaggi successivi