Esegui il deployment di un flusso di lavoro da un repository Git utilizzando Cloud Build

Puoi utilizzare un trigger di Cloud Build per avviare automaticamente una build ed eseguire il deployment di un flusso di lavoro da un repository Git. Puoi configurare il trigger per eseguire il deployment del flusso di lavoro su qualsiasi modifica al repository di origine o eseguire il deployment del flusso di lavoro solo quando la modifica soddisfa criteri specifici.

Questo approccio può aiutarti a gestire il ciclo di vita del deployment. Ad esempio, puoi eseguire il deployment delle modifiche a un flusso di lavoro in un ambiente di gestione temporanea, eseguire test nell'ambiente e quindi implementare in modo incrementale queste modifiche nell'ambiente di produzione.

Prima di iniziare

Queste istruzioni presuppongono che tu disponga del ruolo Editor Cloud Build (roles/cloudbuild.builds.editor) nel progetto Google Cloud, in modo da poter creare trigger. Occorre anche un flusso di lavoro in un repository di origine come GitHub o Bitbucket.

Console

  1. Abilitare le API Cloud Build e Workflows.

    Abilita le API

  2. Concedi il ruolo Amministratore Workflows (roles/workflows.admin) all'account di servizio Cloud Build:

    1. Nella console Google Cloud, vai alla pagina IAM.

      Vai a IAM

    2. Seleziona il progetto.

    3. Nella riga relativa all'account di servizio Cloud Build (PROJECT_NUMBER@cloudbuild.gserviceaccount.com), fai clic su Modifica entità.

    4. Fai clic su Aggiungi un altro ruolo.

    5. Nell'elenco Ruolo, seleziona il ruolo Amministratore flussi di lavoro.

    6. Fai clic su Salva.

  3. Concedi il ruolo Utente account di servizio (roles/iam.serviceAccountUser) per l'account di servizio predefinito di Compute Engine all'account di servizio Cloud Build. Una volta abilitata l'API Compute Engine, l'account di servizio predefinito di Compute Engine è PROJECT_NUMBER-compute@developer.gserviceaccount.com.

    1. Nella console Google Cloud, vai alla pagina Account di servizio.

      Vai ad Account di servizio

    2. Seleziona il progetto.

    3. Fai clic sull'indirizzo email dell'account di servizio predefinito di Compute Engine (PROJECT_NUMBER-compute@developer.gserviceaccount.com).

    4. Fai clic sulla scheda Autorizzazioni.

    5. Fai clic sul pulsante Concedi l'accesso.

    6. Per aggiungere una nuova entità, inserisci l'indirizzo email del tuo account di servizio (SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com).

    7. Nell'elenco Seleziona un ruolo, seleziona il ruolo Account di servizio > Utente account di servizio.

    8. Fai clic su Salva.

gcloud

  1. Abilitare le API Cloud Build e Workflows.

    gcloud services enable cloudbuild.googleapis.com \
  workflows.googleapis.com

  2. Concedi il ruolo Amministratore Workflows (roles/workflows.admin) all'account di servizio Cloud Build:

    PROJECT_NUMBER=$(gcloud projects describe PROJECT_ID --format='value(projectNumber)')
gcloud projects add-iam-policy-binding PROJECT_ID \
  --member=serviceAccount:$PROJECT_NUMBER@cloudbuild.gserviceaccount.com \
  --role=roles/workflows.admin

    Sostituisci PROJECT_ID con l'ID del tuo progetto Google Cloud.

  3. Concedi il ruolo Utente account di servizio (roles/iam.serviceAccountUser) per l'account di servizio predefinito di Compute Engine all'account di servizio Cloud Build. Una volta abilitata l'API Compute Engine, l'account di servizio predefinito di Compute Engine è PROJECT_NUMBER-compute@developer.gserviceaccount.com.

    gcloud iam service-accounts add-iam-policy-binding \
  $PROJECT_NUMBER-compute@developer.gserviceaccount.com \
  --member=serviceAccount:$PROJECT_NUMBER@cloudbuild.gserviceaccount.com \
  --role=roles/iam.serviceAccountUser

Connettiti al repository di codice sorgente

Devi connettere Cloud Build al tuo repository di codice sorgente per consentire a Cloud Build di automatizzare le build in risposta agli eventi che si verificano nel repository.

Completa i seguenti passaggi per connetterti a GitHub o Bitbucket:

  1. Nella console Google Cloud, vai alla pagina Trigger di Cloud Build:

    Vai ai trigger

  2. Se necessario, seleziona il progetto e fai clic su Apri.

  3. Nell'elenco Regione, seleziona la regione in cui vuoi creare il trigger.

  4. Fai clic su Connetti repository.

  5. Seleziona il repository di codice sorgente in cui hai archiviato il codice sorgente.

    Ad esempio: GitHub (App GitHub di Cloud Build)

  6. Fai clic su Continua.

  7. Esegui l'autenticazione nel repository di codice sorgente con il tuo nome utente e la tua password.

    Se accedi a GitHub, per continuare ti viene chiesto di autorizzare l'app GitHub di Google Cloud Build ad accedere al tuo account GitHub.

  8. Dall'elenco dei repository disponibili, seleziona il repository che ti interessa, quindi fai clic su OK.

    Per i repository esterni come GitHub e Bitbucket, devi disporre delle autorizzazioni a livello di proprietario per il progetto Google Cloud in cui stai lavorando.

  9. Leggi il disclaimer e seleziona la casella di controllo accanto per indicare che accetti i termini.

  10. Fai clic su Connetti.

  11. Per continuare a creare un trigger di build per automatizzare le build per il codice sorgente nel repository, fai clic su Crea un trigger. In caso contrario, fai clic su Fine.

crea un file di configurazione di Cloud Build

Un file di configurazione di compilazione definisce i campi necessari quando si utilizza un trigger di build per avviare una build. Crea il file di configurazione nella directory principale del progetto e scrivilo con YAML o JSON.

Ad esempio, il seguente file di configurazione esegue il deployment di un flusso di lavoro di test ed esegue un flusso di lavoro di test, dopodiché utilizza uno script per verificare l'output. Se il test ha esito positivo, viene eseguito il deployment del flusso di lavoro:

steps:
# Deploy the test workflow with the commit sha
- id: 'deploy-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'deploy', '$_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA', '--source', 'gitops/workflow.yaml']

# Run the test workflow and capture the output
- id: 'run-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  entrypoint: 'bash'
  args: ['-c', 'gcloud workflows run $_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA > /workspace/testoutput.log']

# Delete the test workflow
- id: 'delete-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'delete', '$_WORKFLOW_NAME-$BRANCH_NAME-$SHORT_SHA', '--quiet']

# Check the test output
- id: 'check-test-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  entrypoint: 'bash'
  args: ['gitops/test-$BRANCH_NAME.sh']

# Deploy the workflow
- id: 'deploy-workflow'
  name: 'gcr.io/cloud-builders/gcloud'
  args: ['workflows', 'deploy', '$_WORKFLOW_NAME-$BRANCH_NAME', '--source', 'gitops/workflow.yaml']

Le variabili di sostituzione $BRANCH_NAME e $SHORT_SHA vengono compilate da Cloud Build quando una build viene attivata da un repository Git. Rappresentano rispettivamente il nome del ramo e i primi sette caratteri dell'ID commit associato alla build.

La variabile di sostituzione $_WORKFLOW_NAME consente di riutilizzare un file di configurazione con valori di variabili diversi. Puoi specificarne il valore quando crei il trigger di build.

Per maggiori informazioni, consulta Creare un file di configurazione di compilazione.

Crea un trigger di build

Puoi automatizzare il deployment del flusso di lavoro creando un trigger di Cloud Build.

Per creare un trigger di build per il file di configurazione nella sezione precedente:

  1. Nella console Google Cloud, vai alla pagina Trigger di Cloud Build:

    Vai ai trigger

  2. Fai clic su Crea trigger.

  3. Nel campo Nome, inserisci un nome per l'attivatore.

  4. Per Evento, seleziona l'evento che deve richiamare il trigger.

    Ad esempio: Push a un ramo

  5. In Origine, seleziona il repository e il nome del ramo o del tag che avvia l'attivatore. Puoi usare un'espressione regolare per specificare una corrispondenza con un ramo o un tag.

    Ad esempio: GoogleCloudPlatform/workflows-demos (repository) e ^main$|^staging$ (corrisponde ai rami main e staging)

  6. Espandi la sezione Mostra filtri dei file inclusi e ignorati e specifica il flusso di lavoro come file incluso in modo che, quando viene modificato, venga richiamata una build.

    Ad esempio: gitops/workflow.yaml

  7. In Configurazione, seleziona File di configurazione di Cloud Build (YAML o JSON) come tipo e Repository come posizione.

  8. Nel campo Posizione file di configurazione di Cloud Build, specifica la posizione del file.

    Ad esempio: gitops/cloudbuild.yaml

  9. Facoltativamente, per aggiungere una variabile di sostituzione, fai clic su Aggiungi variabile e specifica una combinazione di chiave e valore.

    Ad esempio: _WORKFLOW_NAME (variabile) e workflows-gitops (valore)

  10. Per salvare il trigger di build, fai clic su Crea.

Quando viene eseguito il push di qualsiasi modifica a un flusso di lavoro nel ramo specificato del repository Git, viene attivato automaticamente Cloud Build per eseguire il deployment del flusso di lavoro.

Per maggiori informazioni, consulta Creare e gestire i trigger di build.

Testa il trigger di build

Puoi testare il trigger di build e il file di configurazione delle sezioni precedenti.

  1. Nel ramo staging del repository Git, modifica workflow.yaml e cambia Hello World in Bye World:

    main:
  steps:
    - init:
        assign:
          - message: "Hello World"
    - returnResult:
        return: ${message}

  2. Esegui il commit della modifica ed esegui il push nel ramo staging.

    git add workflow.yaml
git commit -m "Update workflow.yaml in staging"
git push

    Il trigger di Cloud Build esegue e avvia una build.

  3. Per verificare il successo della build, vai alla pagina Cronologia build nella console Google Cloud:

    Vai a Cronologia build

    Al termine, Cloud Build fornisce uno stato generale per la build e per ogni singolo passaggio della build. Per maggiori informazioni, consulta Visualizzare i risultati della build.

  4. Per confermare che sia stato eseguito il deployment di un flusso di lavoro gestione temporanea, vai alla pagina Flussi di lavoro nella console Google Cloud:

    Vai a Workflows

    Dovresti vedere un flusso di lavoro denominato workflows-gitops-staging nell'elenco.

  5. Per eseguire il deployment del flusso di lavoro gestione temporanea in produzione, unisci il ramo staging al ramo main:

    git checkout main
git merge staging
git push

    Tieni presente che, poiché test-main.sh prevede Hello World nell'output del flusso di lavoro, la build avrà esito negativo:

    RESULT_EXPECTED="result: '\"Hello World\"'"
RESULT_ACTUAL=$(grep "result: " $FILE)
if [[ $RESULT_EXPECTED == $RESULT_ACTUAL ]]; then
  echo "Result test passed"
else
  echo "Result test failed. Expected: $RESULT_EXPECTED Actual: $RESULT_ACTUAL"; exit 1;
fi

  6. Per eseguire correttamente il deployment di un flusso di lavoro di produzione, nel ramo staging, modifica di nuovo workflow.yaml e cambia la stringa in Hello World.

  7. Esegui il commit della modifica ed esegui il push della modifica nel ramo staging, quindi unisci il ramo staging al ramo main.

  8. Per confermare che sia stato eseguito il deployment di un flusso di lavoro di produzione, vai alla pagina Flussi di lavoro nella console Google Cloud:

    Vai a Workflows

    Dovresti vedere un flusso di lavoro denominato workflows-gitops-main nell'elenco.

Passaggi successivi