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 per ogni modifica al repository di codice sorgente o 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 staging, eseguire test su questo ambiente e poi implementare gradualmente queste modifiche nell'ambiente di produzione.

Prima di iniziare

Queste istruzioni presuppongono che tu abbia il ruolo Editor build Cloud (roles/cloudbuild.builds.editor) nel tuo Google Cloud progetto in modo da poter creare trigger. Ti serve anche un flusso di lavoro in un repository di codice sorgente come GitHub o Bitbucket.

Console

  1. Abilita le API Cloud Build e Workflows.

    Abilita le API

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

    1. Nella Google Cloud console vai alla pagina IAM.

      Vai a IAM

    2. Seleziona il progetto.

    3. Nella riga del 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 di Workflows.

    6. Fai clic su Salva.

  3. Concedi il ruolo Utente account di servizio (roles/iam.serviceAccountUser) sul service account predefinito Compute Engine al service account Cloud Build. Quando hai abilitato l'API Compute Engine, il account di servizio predefinito Compute Engine è PROJECT_NUMBER-compute@developer.gserviceaccount.com.

    1. Nella Google Cloud console, vai alla pagina Service account.

      Vai a Service account

    2. Seleziona il progetto.

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

    4. Fai clic sulla scheda Autorizzazioni.

    5. Fai clic sul pulsante Concedi 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 Service account > Utente account di servizio.

    8. Fai clic su Salva.

gcloud

  1. Abilita le API Cloud Build e Workflows.

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

  2. Concedi il ruolo Amministratore di Workflows (roles/workflows.admin) al 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 Google Cloud progetto.

  3. Concedi il ruolo Utente account di servizio (roles/iam.serviceAccountUser) sul service account predefinito Compute Engine al service account Cloud Build. Quando hai abilitato l'API Compute Engine, il account di servizio predefinito 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

Connetti al repository di codice sorgente

Devi connettere Cloud Build al repository di codice sorgente in modo che Cloud Build possa automatizzare le build in risposta agli eventi che si verificano nel repository.

Completa i passaggi indicati di seguito per connetterti a GitHub o Bitbucket:

  1. Nella Google Cloud console, 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. Autenticati al repository di codice sorgente con il tuo nome utente e la tua password.

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

  8. Nell'elenco dei repository disponibili, seleziona il repository desiderato e fai clic su OK.

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

  9. Leggi la dichiarazione di non responsabilità 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 della 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 utilizzando YAML o JSON.

Ad esempio, il seguente file di configurazione esegue il deployment e l'esecuzione di un flusso di lavoro di test, quindi utilizza uno script per controllare l'output. Se il test viene superato, 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 branch e i primi sette caratteri dell'ID commit associato alla build.

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

Per saperne di più, consulta Crea un file di configurazione della 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 Google Cloud console, vai alla pagina Trigger di Cloud Build:

    Vai ai trigger

  2. Fai clic su Crea trigger.

  3. Nel campo Nome, inserisci un nome per il trigger.

  4. In Evento, seleziona l'evento per richiamare il trigger.

    Ad esempio: Push a un ramo

  5. In Origine, seleziona il repository e il nome del branch o del tag che avvierà il trigger. Puoi utilizzare un'espressione regolare per specificare una corrispondenza con un branch o un tag.

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

  6. Espandi la sezione Mostra i 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 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 vengono eseguite il push delle modifiche a un flusso di lavoro nel branch specificato del repository Git, Cloud Build viene attivato automaticamente per eseguire il deployment del flusso di lavoro.

Per saperne di più, consulta Crea e gestisci trigger di build.

Testa il trigger di build

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

  1. Nel branch 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 e il push della modifica al branch staging.

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

    Il trigger di Cloud Build viene eseguito e avvia una build.

  3. Per verificare l'esito positivo della build, nella Google Cloud console vai a la pagina Cronologia build:

    Vai alla cronologia build

    Al termine di una build, Cloud Build fornisce uno stato generale per la build e per ogni singolo passaggio di build. Per saperne di più, consulta Visualizza i risultati della build.

  4. Per verificare che sia stato eseguito il deployment di un flusso di lavoro di staging, nella Google Cloud console, vai alla pagina Workflows:

    Vai a Flussi di lavoro

    Dovresti visualizzare un flusso di lavoro denominato workflows-gitops-staging.

  5. Per eseguire il deployment del flusso di lavoro di staging in produzione, unisci il branch staging al branch 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 non andrà a buon fine:

    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 branch staging, modifica di nuovo workflow.yaml e riporta la stringa a Hello World.

  7. Esegui il commit e il push della modifica al branch staging, quindi unisci il branch staging al branch main.

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

    Vai a Flussi di lavoro

    Dovresti visualizzare un flusso di lavoro denominato workflows-gitops-main.

Passaggi successivi