Convalida configurazioni

Questo tutorial mostra come convalidare le configurazioni con Cloud Build quando utilizzi i cluster della versione Google Kubernetes Engine (GKE) Enterprise. La stessa configurazione funziona in qualsiasi altro sistema CI/CD basato su container, ad esempio CircleCI, con modifiche minime.

Ti consigliamo di convalidare eventuali modifiche alla configurazione nella pipeline CI/CD, oltre a verificare la validità delle configurazioni, eseguendo il comando nomos vet.

Obiettivi

• Crea un file di configurazione di Cloud Build che indichi a Config Sync di utilizzare nomos vet nelle configurazioni del repository.
• Crea un trigger di Cloud Build in modo che le tue configurazioni vengano controllate ogni volta che viene apportata una modifica al ramo di sviluppo.

Costi

In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:

• Config Sync (parte di GKE Enterprise)
• Cloud Build

Per generare una stima dei costi in base all'utilizzo previsto, utilizza il Calcolatore prezzi. I nuovi utenti di Google Cloud possono essere idonei a una prova senza costi aggiuntivi.

Una volta completate le attività descritte in questo documento, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori informazioni, consulta la pagina Pulizia.

Prima di iniziare

1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

2. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   Vai al selettore progetti

3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

4. Attiva l'API Cloud Build.

   Abilita l'API

5. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   Vai al selettore progetti

6. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

7. Attiva l'API Cloud Build.

   Abilita l'API

8. Crea o accedi a un cluster GKE Enterprise che soddisfa i requisiti di Config Sync. Per maggiori dettagli su come creare un cluster di questo tipo, consulta la guida introduttiva all'utilizzo di Config Sync.

Concedi l'autorizzazione all'account di servizio Cloud Build

Concedi all'account di servizio Cloud Build l'autorizzazione ad accedere al cluster GKE Enterprise.

gcloud

Per aggiungere il ruolo Kubernetes Engine Developer all'account di servizio Cloud Build, esegui questo comando:

PROJECT_ID=$(gcloud config get-value project)
PROJECT_NUM=$(gcloud projects list --filter="$PROJECT_ID" --format="value(PROJECT_NUMBER)")
gcloud projects add-iam-policy-binding $PROJECT_ID \
    --member=serviceAccount:$[e-mail] \
    --role=roles/container.developer

Console

1. Apri la pagina IAM nella console Google Cloud.

   Vai alla pagina IAM

2. Nella colonna member (membro), individua la riga con l'account di servizio Cloud Build:

   [e-mail]
   

3. Nella riga, fai clic su Modifica entità.

4. Fai clic su Aggiungi un altro ruolo.

5. Nell'elenco Seleziona un ruolo, seleziona Kubernetes Engine Developer, quindi fai clic su Salva.

crea una configurazione di Cloud Build

Crea un file di configurazione di Cloud Build e archivialo nella directory radice del repository contenente i file di configurazione (ad esempio my-repo/cloudbuild.yaml).

steps:
- name: 'gcr.io/cloud-builders/kubectl'
  args: ['config', 'current-context']
  volumes:
  - name: 'kube'
    path: '/kube'
  env:
  - 'KUBECONFIG=/kube/config'
  - 'CLOUDSDK_COMPUTE_ZONE=ZONE'
  - 'CLOUDSDK_CONTAINER_CLUSTER=CLUSTER_NAME'
  - 'CLOUDSDK_CONTAINER_USE_APPLICATION_DEFAULT_CREDENTIALS=true'
- name: 'bash'
  args: ['chmod', '444', '/kube/config']
  volumes:
  - name: 'kube'
    path: '/kube'
- name: 'gcr.io/config-management-release/nomos:stable'
  args: ['nomos', 'vet', '--path', '/workspace/POLICY_DIR']
  volumes:
  - name: 'kube'
    path: '/kube'
  env:
  - 'KUBECONFIG=/kube/config'
  timeout: 30s

Sostituisci quanto segue:

• ZONE: la zona in cui è in esecuzione il cluster
• CLUSTER_NAME: il nome del cluster
• POLICY_DIR: il percorso all'interno del repository Git che rappresenta il livello più alto del repository da sincronizzare

Questa configurazione prevede tre passaggi:

1. Esegui kubectl config current-context per generare il file kubeconfig necessario per l'autenticazione nel cluster GKE my-cluster. L'utente root genera questo file con autorizzazioni limitate.
2. Esegui chmod 444 /kube/config per rendere il file leggibile nel passaggio successivo.
3. Esegui nomos vet sul repository Git che viene clonato automaticamente in /workspace. Se utilizzi un repository non strutturato, esegui invece nomos vet --source-format=unstructured.

Crea un trigger di build

L'esempio seguente crea un trigger che viene eseguito per ogni commit nel ramo master di un repository Cloud Source Repositories.

1. Apri la pagina Attivatori nella console Google Cloud.

   Vai alla pagina Trigger

2. Fai clic su Connetti repository.

3. Seleziona GitHub (con mirroring), quindi fai clic su Continua.

4. Seleziona il repository, quindi fai clic su Connetti repository.

5. Fai clic su Aggiungi attivatore.

6. Inserisci o seleziona la voce corrispondente in ogni campo descritto nella seguente tabella:

   Campo	Voce
   Evento	Push al ramo
   Ramo	^master$
   Configurazione	File di configurazione di Cloud Build (yaml o json)
   Posizione file di configurazione Cloud Build	/ cloudbuild.yaml

7. Fai clic su Crea per salvare il trigger di build.

Testa il trigger di build

Verifica manualmente la configurazione eseguendo l'attivatore:

1. Apri la pagina Attivatori nella console Google Cloud.

   Vai alla pagina Trigger

2. Trova il trigger che hai creato e fai clic su Esegui trigger.

   Viene visualizzato il messaggio "Build avviata sul ramo principale".

3. Fai clic su Mostra.

   I passaggi di Cloud Build appaiono verdi se configurati correttamente.

Configurazioni Cloud Build non valide

Non è possibile eseguire un trigger se il file di configurazione di Cloud Build non è valido.

Per verificarlo, aggiorna la configurazione di Cloud Build nel repository con il file seguente. Osserva il rientro non valido alla riga 6:

steps:
- name: 'gcr.io/cloud-builders/kubectl'
  args: ['config', 'current-context']
  volumes:
  - name: 'kube'
  path: '/kube'
  env:
  - 'KUBECONFIG=/kube/config'
  - 'CLOUDSDK_COMPUTE_ZONE=ZONE'
  - 'CLOUDSDK_CONTAINER_CLUSTER=CLUSTER_NAME'
  - 'CLOUDSDK_CONTAINER_USE_APPLICATION_DEFAULT_CREDENTIALS=true'
- name: 'bash'
  args: ['chmod', '444', '/kube/config']
  volumes:
  - name: 'kube'
    path: '/kube'
- name: 'gcr.io/nomos-release/nomos:stable'
  args: ['nomos', 'vet', '--path', '/workspace/POLICY_DIR']
  volumes:
  - name: 'kube'
    path: '/kube'
  env:
  - 'KUBECONFIG=/kube/config'
  timeout: 30s

Se esegui di nuovo l'attivatore manualmente, viene visualizzato il seguente messaggio di errore perché il rientro per path: alla riga 6 non è corretto:

Failed to trigger build: failed unmarshalling build config cloudbuild.yaml:
unknown field "path" in cloudbuild_go_proto.BuildStep.

Per correggere questa configurazione, fai rientrare path: nella riga 6 allo stesso livello di name: nella riga 5. Per ulteriori informazioni sulla struttura di un file di configurazione di Cloud Build, consulta Creazione di una configurazione di base di Cloud Build.

Esegui la pulizia

Elimina il progetto

Attenzione: l'eliminazione di un progetto ha i seguenti effetti:

• L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per le attività in questo documento, quando lo elimini elimini anche qualsiasi altro lavoro svolto nel progetto.
• Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un URL appspot.com, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.

Se intendi esplorare più architetture, tutorial o guide rapide, puoi riutilizzare i progetti ed evitare così di superare i limiti di quota.

Elimina un progetto Google Cloud:

gcloud projects delete PROJECT_ID

Elimina singole risorse

Per eliminare le singole risorse, completa i seguenti passaggi:

1. Elimina il file di configurazione di Cloud Build.
2. Elimina il trigger di Cloud Build che hai creato.
3. Elimina il cluster che hai utilizzato per questo tutorial.

Passaggi successivi

• Scopri di più su Cloud Build
• Interrompere temporaneamente la sincronizzazione delle configurazioni