Utilizzare lo strumento a riga di comando nomos

Lo strumento a riga di comando nomos è uno strumento facoltativo per Config Sync che puoi utilizzare per ottenere lo stato di Config Sync e lo stato della sincronizzazione della tua fonte attendibile. Lo strumentonomos fornisce i seguenti comandi:

Prerequisiti

Prima di poter utilizzare lo strumento nomos per interagire con un cluster, Config Sync deve essere già installato sul cluster di destinazione. Devi anche installare e configurare lo strumento a riga di comando kubectl. Se interagisci con i cluster Google Kubernetes Engine, assicurati di installare anche gke-gcloud-auth-plugin.

Lo strumento nomos supporta l'anteprima e la convalida delle configurazioni Kustomize e dei grafici Helm. Prima di poter utilizzare questa funzionalità, installa Kustomize e Helm nella tua workstation locale. Se la tua fonte di riferimento contiene solo configurazioni completamente visualizzate, Kustomize e Helm sono facoltativi.

Installa lo strumento nomos

Lo strumento nomos è un file binario compilato dal codice Go e puoi installarlo localmente, ad esempio su una workstation o un laptop.

Lo strumento nomos non è incluso quando installi Config Sync. Puoi installare lo strumento nomos installando Google Cloud CLI. Se utilizzi Cloud Shell, Google Cloud CLI è preinstallato.

Se non hai Google Cloud CLI, ti consigliamo di utilizzare gcloud components install nomos per installare lo strumento nomos. L'installazione dello strumento nomos con Google Cloud CLI consente di utilizzare gcloud components update per aggiornare lo strumento nomos alla versione più recente.

Per informazioni su metodi alternativi per installare lo strumento nomos, consulta Download.

Utilizzo di base

Per la sintassi di base dei comandi, utilizza l'argomento --help:

nomos --help

Lo strumento nomos legge dalla copia locale della tua fonte attendibile. Utilizza il flag --path per specificare la posizione del livello più alto dell'origine attendibile. Per impostazione predefinita, --path è impostato su . o sulla directory corrente. Ad esempio:

nomos vet --path=PATH_TO_SOURCE --source-format unstructured

Controllare lo stato di Config Sync

Puoi monitorare lo stato di Config Sync su tutti i cluster registrati utilizzando il comando nomos status. Per ogni cluster, nomos status genera un report sull'hash del commit applicato per ultimo al cluster e su eventuali errori che si sono verificati durante il tentativo di applicazione di modifiche recenti.

Puoi anche utilizzare nomos status per verificare se le risorse gestite da Config Sync sono pronte. nomos status riporta lo stato di ogni singola risorsa nella colonna STATUS della sezione Managed resources dell'output.

L'esempio seguente mostra alcune delle diverse condizioni che il comando nomos status potrebbe segnalare:

nomos status

Output di esempio:

MANAGED_CLUSTER_1
  --------------------
  <root>   git@github.com:foo-corp/acme@main
  SYNCED   f52a11e4
  Managed resources:
   NAMESPACE   NAME                                                                   STATUS
               k8snoexternalservices.constraints.gatekeeper.sh/no-internet-services   Current
               namespace/hello                                                        Current

MANAGED_CLUSTER_2
  --------------------
  <root>   git@github.com:foo-corp/acme@main
  PENDING  9edf8444

MANAGED_CLUSTER_3
  --------------------
  <root>   git@github.com:foo-corp/acme@main
  ERROR    f52a11e4
  Error:   KNV1021: No CustomResourceDefinition is defined for the resource in the cluster.

MANGED_CLUSTER_4
  --------------------
  NOT INSTALLED

MANAGED_CLUSTER_5
  --------------------
  <root>   git@github.com:foo-corp/acme/admin@main
  SYNCED   f52a11e4
  Managed resources:
   NAMESPACE   NAME                                                                   STATUS
                namespace/gamestore                                                   Current
                namespace/monitoring                                                  Current
   gamestore    reposync.configsync.gke.io/repo-sync                                  Current
   gamestore    rolebinding.rbac.authorization.k8s.io/gamestore-admin                 Current
   gamestore    rolebinding.rbac.authorization.k8s.io/gamestore-webstore-admin        Current
   monitoring   deployment.apps/prometheus-operator                                   Current
   monitoring   prometheus.monitoring.coreos.com/acm                                  Current
   monitoring   service/prometheus-acm                                                Current
   monitoring   service/prometheus-operator                                           Current
   monitoring   serviceaccount/prometheus-acm                                         Current
   monitoring   serviceaccount/prometheus-operator                                    Current
   monitoring   servicemonitor.monitoring.coreos.com/acm-service                      Current
  --------------------
  bookstore  git@github.com:foo-corp/acme/bookstore@v1
  SYNCED     34d1a8c8
  Managed resources:
   NAMESPACE   NAME                                 STATUS
   gamestore   configmap/store-inventory            Current
   gamestore   webstore.marketplace.com/gameplace   Current

In questo output:

• MANAGED_CLUSTER_1 ha sincronizzato la modifica più recente con la fonte di riferimento e tutte le risorse gestite hanno lo stato Current. Uno stato Current indica che lo stato della risorsa corrisponde a quello che vuoi.
• La sincronizzazione di MANAGED_CLUSTER_2 è ancora in corso.
• MANAGED_CLUSTER_3 presenta un errore che ha impedito l'applicazione della modifica. In questo esempio, MANAGED_CLUSTER_3 presenta l'errore KNV1021 perché manca un CustomResourceDefinition (CRD) installato negli altri cluster.
• MANAGED_CLUSTER_4 non ha installato Config Sync.
• MANAGED_CLUSTER_5 è in fase di sincronizzazione da due repository Git. La fonte di verità <root> appartiene all'amministratore del cluster, mentre la fonte di verità bookstore potrebbe appartenere a un team di sviluppo di applicazioni.

Stati delle risorse gestite

Lo stato delle risorse gestite può essere uno dei seguenti valori:

• InProgress: lo stato effettivo della risorsa non ha ancora raggiunto lo stato specificato nel manifest della risorsa. Questo stato indica che la riconciliazione delle risorse non è ancora completata. Le risorse appena create in genere iniziano con questo stato, anche se alcune risorse come i ConfigMap sono Current immediatamente.

• Failed: la procedura di riconciliazione dello stato effettivo con lo stato che vuoi ha rilevato un errore o non ha registrato progressi sufficienti.

• Current: lo stato effettivo della risorsa corrisponde a quello che vuoi. Il processo di riconciliazione è considerato completo fino a quando non vengono apportate modifiche allo stato desiderato o a quello effettivo.

• Terminating: la risorsa è in fase di eliminazione.

• NotFound: la risorsa non esiste nel cluster.

• Unknown: Config Sync non è in grado di determinare lo stato della risorsa.

Per disattivare la visualizzazione dello stato a livello di risorsa, aggiungi --resources=false al nomos status comando.

Informazioni sull'ultimo commit sincronizzato

Il comando nomos status mostra l'hash del commit più recente applicato al cluster nell'output in status.sync.commit. Per ottenere questo valore, esegui una query sull'oggetto RootSync o RepoSync e controlla il campo status.sync.

Ad esempio, per eseguire una query su un oggetto RootSync, esegui il seguente comando:

kubectl get rootsyncs.configsync.gke.io -n config-management-system root-sync -o yaml

Output di esempio:

apiVersion: configsync.gke.io/v1beta1
kind: RootSync
status:
  sync:
    commit: f1739af550912034139aca51e382dc50c4036ae0
    lastUpdate: "2021-04-20T00:25:01Z"

Per eseguire una query su un oggetto RepoSync, esegui il seguente comando:

kubectl get reposync.configsync.gke.io -n NAMESPACE repo-sync -o yaml

Sostituisci NAMESPACE con lo spazio dei nomi in cui hai creato la verità oggettiva dello spazio dei nomi.

Output di esempio:

apiVersion: configsync.gke.io/v1beta1
kind: RepoSync
status:
  sync:
    commit: ed95b50dd918cf65d8908f7561cb8d8d1f179c2f
    lastUpdate: "2021-04-20T00:25:20Z"

Questo commit rappresenta il commit più recente eseguito sul cluster. Tuttavia, non tutte le risorse del cluster sono interessate da ogni commit. Per visualizzare il commit più recente per una risorsa specifica, esegui una query sulla risorsa specifica e controlla metadata.annotations.configmanagement.gke.io/token. Ad esempio:

kubectl get clusterroles CLUSTER_ROLE_NAME -o yaml

Sostituisci CLUSTER_ROLE_NAME con il nome del ruolo del cluster su cui vuoi eseguire una query.

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  annotations:
    configmanagement.gke.io/token: ed95b50dd918cf65d8908f7561cb8d8d1f179c2f

flag di stato Nomos

Per personalizzare il comando nomos status, aggiungi i seguenti flag:

Autorizzazioni obbligatorie

Se sei un proprietario del progetto, disponi del ruolo RBAC cluster-admin e puoi utilizzare il comando nomos status per tutti i cluster del progetto senza aggiungere altre autorizzazioni. Se non disponi del ruolo cluster-admin, puoi utilizzare nomos status creando il seguente ClusterRole:

1. Crea un file denominato nomos-status-reader.yaml e copia al suo interno il seguente ClusterRole. Le regole necessarie variano a seconda che tu stia utilizzando gli oggetti RootSync e RepoSync.

   Utilizzare gli oggetti RootSync e RepoSync

   # nomos-status-reader.yaml
   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: nomos-status-reader
   rules:
   - apiGroups: ["configsync.gke.io"]
     resources: ["reposyncs", "rootsyncs"]
     verbs: ["get"]
   - nonResourceURLs: ["/"]
     verbs: ["get"]
   

   Non utilizzare gli oggetti RootSync e RepoSync

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: nomos-status-reader
   rules:
   - apiGroups: ["configmanagement.gke.io"]
     resources: ["configmanagements", "repos"]
     verbs: ["get", "list"]
   - nonResourceURLs: ["/"]
     verbs: ["get"]
   

2. Applica il file nomos-status-reader.yaml:

   kubectl apply -f nomos-status-reader.yaml
   

Verificare la presenza di errori nella fonte attendibile

Prima di eseguire il commit di una configurazione nella fonte attendibile, utilizza il comando nomos vet per controllare la sintassi e la validità delle configurazioni nella fonte attendibile:

nomos vet --source-format unstructured

Se vengono rilevati errori di sintassi, il comando nomos vet esce con uno stato diverso da zero e registra i messaggi di errore in STDERR.

nomos vet flags

Per personalizzare il comando nomos vet, aggiungi i seguenti flag:

Convalida lato server

Se il comando nomos vet non è in grado di determinare se il tipo è nel namespace, lo strumento nomos si connette al server API. Poiché lo strumento nomos per impostazione predefinita comprende i tipi di Kubernetes di base e i CRD di Config Sync, tenta di collegarsi al server API solo se sono presenti CR che non hanno un corrispondente dichiarato CRD. In questo caso, se al server API non è stato applicato il CRD, il comando nomos vet restituisce l'errore KNV1021. Per disabilitare questo controllo e eliminare gli errori dovuti ai CRD mancanti, passa il flag --no-api-server-check.

Memorizzazione nella cache dei metadati del server API

Anziché eliminare i controlli del server API, puoi memorizzare nella cache i dati sul server API per il comando nomos vet. Per memorizzare nella cache il tuo api-resources, completa i seguenti passaggi:

1. Connettiti a un cluster che contenga tutti i CRD necessari per la tua origine attendibile. Non è necessario che nel cluster sia abilitato Config Sync.
2. Vai alla cartella policyDir della tua fonte attendibile. Si tratta della stessa directory specificata nella risorsa ConfigManagement o RootSync.
3. Esegui il seguente comando: kubectl api-resources > api-resources.txt Questo comando crea un file denominato api-resources.txt che contiene l'output esatto di kubectl api-resources.

D'ora in poi, le esecuzioni di nomos vet all'interno della fonte attendibile sono consapevoli di queste definizioni di tipo. Se il file api-resources.txt viene rimosso o rinominato, nomos vet non riesce a trovarlo. nomos vet tenterà comunque di connettersi al cluster se trova manifest per tipi non dichiarati in api-resources.txt (a meno che non venga passato --no-api-server-check).

Il file api-resources.txt influisce solo sul funzionamento dello strumento nomos. Non modifica in alcun modo il comportamento di Config Sync.

È consentito avere voci aggiuntive nel file api-resources.txt per tipi che non sono presenti nella versione di riferimento sottoposta a convalida. nomos vet importa le definizioni, ma non le utilizza.

Aggiorna api-resources.txt

Dopo aver verificato che tutti i CRD che ti interessano siano presenti nel cluster, esegui il seguente comando:

kubectl api-resources > api-resources.txt

Verificare automaticamente la presenza di errori di sintassi al momento del commit

Se effettui il commit di un file con errori JSON o YAML, Config Sync non applica la modifica. Tuttavia, puoi impedire che questi tipi di errori accedano alla verità oggettiva utilizzando gli hook lato client o lato server.

Utilizzare nomos vet in un hook pre-commit

Puoi configurare un hook pre-commit che esegue il comando nomos vet per verificare la presenza di errori di sintassi quando esegui il commit di una modifica alla clonazione Git locale del tuo repository. Se un hook pre-commit esce con uno stato diverso da zero, l'operazione git commit non va a buon fine.

Per eseguire il comando nomos vet come hook pre-commit, modifica il file .git/hooks/pre-commit nella tua origine attendibile (tieni presente che .git inizia con un carattere .). Potresti dover creare il file manualmente. Aggiungi il comando nomos vet a una nuova riga nello script. L'argomento --path è facoltativo. Imposta l'argomento --source-format sul formato dell'origine del repository.

nomos vet --path=/path/to/repo --source-format unstructured

Assicurati che il file pre-commit sia eseguibile:

chmod +x .git/hooks/pre-commit

Ora, quando esegui un comando git commit nel clone della tua origine attendibile, nomos vet viene eseguito automaticamente.

I contenuti della directory .git/ non vengono monitorati dalla stessa verità oggettiva e non possono essere sottoposti a commit nella stessa posizione. Puoi creare una directory nella fonte di attendibilità per gli hook Git e gli utenti che la utilizzano possono copiare gli hook nella posizione appropriata nel loro clone locale.

Utilizzare nomos vet in un hook lato server

Git fornisce un meccanismo per eseguire controlli sul server anziché sul client durante un'operazione git push. Se il controllo non va a buon fine, anche git push non va a buon fine. Questi hook lato server non possono essere ignorati dal client. Il metodo per configurare gli hook lato server dipende da come è ospitato il server Git. Per ulteriori informazioni, consulta uno dei seguenti link o la documentazione del tuo servizio di hosting Git.

• GitHub
• Cloud Source Repositories
• Bitbucket
• GitLab
• Server Git ospitato autonomamente

Visualizza tutte le configurazioni nella fonte di riferimento

Puoi utilizzare il comando nomos hydrate per visualizzare i contenuti combinati della tua fonte attendibile su ogni cluster registrato.

Se esegui nomos hydrate senza opzioni, viene creata una directory compiled/ nella directory di lavoro corrente. All'interno di questa directory viene creata una sottodirectory per ogni cluster registrato, con le configurazioni completamente risolte che l'operatore applicherà al cluster.

Questo comando può anche convertire una fonte attendibile gerarchica in una o più fonti attendibili non strutturate utilizzando i contenuti della directory compiled/.

nomos hydrate flags

Per personalizzare il comando nomos hydrate, aggiungi i seguenti flag:

Creare una segnalazione di bug

Se hai un problema con Config Sync che richiede l'aiuto dell'assistenza Google Cloud, puoi fornire informazioni utili per il debug utilizzando il comando nomos bugreport. Puoi utilizzare questo comando per una singola fonte attendibile e più repository.

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 sulle risorse sincronizzate con Config Sync. Per ulteriori informazioni sui contenuti del file ZIP, consulta il riferimento relativo ai report di bug di Nomos.

Limitazioni

Il comando nomos bugreport non va a buon fine e genera un file ZIP incompleto se un singolo file supera 1 GB. Questo accade spesso a causa di file di log di grandi dimensioni.

La tabella seguente include le cause più comuni dei file di log di grandi dimensioni e come risolverle:

Esegui la migrazione da un oggetto ConfigManagement a un oggetto RootSync

Puoi eseguire il comando nomos migrate per eseguire la migrazione dall'oggetto ConfigManagement a un oggetto RootSync per attivare le API RootSync e RepoSync.

Se hai utilizzato spec.enableLegacyFields per avviare un RootSync, segui la guida per disattivare i campi precedenti invece di utilizzare nomos migrate. I campi legacy non sono supportati a partire dalla versione 1.19.0.

nomos migrate supporta la simulazione per l'anteprima del processo di migrazione.

nomos migrate modifica direttamente l'oggetto ConfigManagement sul cluster. Per evitare che le modifiche apportate tramite nomos migrate vengano annullate, assicurati che l'oggetto ConfigManagement non sia sottoposto a check-in nella tua origine attendibile.

nomos migrate --contexts=KUBECONFIG_CONTEXTS --dry-run

Se il risultato della prova non presenta problemi, puoi eseguire la migrazione dell'oggetto ConfigManagement utilizzando nomos migrate:

nomos migrate --contexts=KUBECONFIG_CONTEXTS

L'output è simile al seguente:

--------------------
Enabling the multi-repo mode on cluster "my_managed_cluster-1" ...
- A RootSync object is generated and saved in "/tmp/nomos-migrate/my_managed_cluster-1/root-sync.yaml".
- The original ConfigManagement object is saved in "/tmp/nomos-migrate/my_managed_cluster-1/cm-original.yaml".
- The ConfigManagement object is updated and saved in "/tmp/nomos-migrate/my_managed_cluster-1/cm-multi.yaml".
- Resources for the multi-repo mode have been saved in a temp folder. If the migration process is terminated, it can be recovered manually by running the following commands:
  kubectl apply -f /tmp/nomos-migrate/my_managed_cluster-1/cm-multi.yaml && \
  kubectl wait --for condition=established crd rootsyncs.configsync.gke.io && \
  kubectl apply -f /tmp/nomos-migrate/my_managed_cluster-1/root-sync.yaml.
- Updating the ConfigManagement object ....
- Waiting for the RootSync CRD to be established ....
- The RootSync CRD has been established.
- Creating the RootSync object ....
- Waiting for the reconciler-manager Pod to be ready ....
-   Haven't detected running Pods with the label selector "app=reconciler-manager".
-   Haven't detected running Pods with the label selector "app=reconciler-manager".
-   Haven't detected running Pods with the label selector "app=reconciler-manager".
- The reconciler-manager Pod is running.
- Waiting for the root-reconciler Pod to be ready ....
-   Haven't detected running Pods with the label selector "configsync.gke.io/reconciler=root-reconciler".
-   Haven't detected running Pods with the label selector "configsync.gke.io/reconciler=root-reconciler".
-   Haven't detected running Pods with the label selector "configsync.gke.io/reconciler=root-reconciler".
- The root-reconciler Pod is running.
- The migration process is done. Please check the sync status with `nomos status`.

Finished migration on all the contexts. Please check the sync status with `nomos status`.

Esegui il rollback alla configurazione precedente

Se devi eseguire il rollback dopo aver eseguito la migrazione con nomos migrate, applica l'oggetto ConfigManagement originale. nomos migrate salva l'oggetto ConfigManagement originale in un file e stampa il nome nel terminale. Il nome del file è del tipo /tmp/nomos-migrate/CURRENT_CONTEXT/cm-original.yaml.

Per eseguire il rollback alla configurazione precedente, copia il percorso del file per cm-original.yaml e applicalo al cluster:

kubectl apply -f CM_ORIGINAL_PATH

nomos migrate flags

Per personalizzare il comando nomos migrate, aggiungi i seguenti flag:

Inizializzare una fonte attendibile gerarchica

Puoi organizzare la tua fonte attendibile in modo arbitrario se utilizzi una fonte attendibile non strutturata. Se utilizzi una fonte attendibile gerarchica, devi eseguire il comando nomos init per inizializzare una directory gerarchica:

nomos init

Viene creata la struttura di directory di base di una fonte attendibile gerarchica, incluse le directory system/, cluster/ e namespaces/.

nomos init flags

Per personalizzare nomos init, aggiungi i seguenti flag:

Risoluzione dei problemi

Su Linux, potresti visualizzare il seguente errore durante l'esecuzione di un comando nomos:

failed to create client configs: while getting config path: failed to get current user: user: Current not implemented on linux/amd64

Per risolvere il problema, crea una variabile di ambiente USER:

export USER=$(whoami)

Passaggi successivi

• Iniziare a utilizzare Config Sync