Automatizzare le build in risposta agli eventi webhook

Cloud Build consente di definire trigger webhook, che possono autenticare e accettare eventi webhook in entrata. Questi eventi, inviati a un URL personalizzato, ti consentono di connettere direttamente sistemi esterni e sistemi di gestione del codice sorgente esterni, come Bitbucket.com, Bitbucket Server o GitLab, a Cloud Build tramite eventi webhook.

Con i trigger webhook, puoi definire un file di configurazione di compilazione incorporato anziché specificare un'origine durante la creazione del trigger. La configurazione di compilazione incorporata ti consente di controllare le operazioni Git e definire il resto della build.

Questa pagina descrive come creare trigger webhook per automatizzare le build in risposta agli eventi webhook.

Prima di iniziare

  • Abilita le API Cloud Build e Secret Manager.

    Ruoli richiesti per abilitare le API

    Per abilitare le API, devi disporre del ruolo IAM Amministratore utilizzo dei servizi (roles/serviceusage.serviceUsageAdmin), che include l'autorizzazione serviceusage.services.enable. Scopri come concedere i ruoli.

    Abilita le API

  • Per utilizzare i comandi gcloud in questa pagina, installa Google Cloud CLI.

  • Se il trigger webhook utilizza un repository Cloud Build come origine, assicurati di conoscere i repository Cloud Build.

Creare trigger webhook

Console

Per creare un trigger webhook utilizzando la console Google Cloud :

  1. Apri la pagina Trigger:

    Apri la pagina Trigger di build

  2. Seleziona il progetto nella parte superiore della pagina e fai clic su Apri.

  3. Fai clic su Crea trigger.

  4. Inserisci le seguenti impostazioni del trigger:

    • Nome: un nome per l'attivatore.

    • Regione: seleziona la regione per il trigger.

      • Se il file di configurazione della build associato al trigger specifica un pool privato, Cloud Build utilizza il pool privato per eseguire la build. In questo caso, la regione specificata nel trigger deve corrispondere alla regione in cui hai creato il pool privato.
      • Se il file di configurazione della build associato al trigger non specifica un pool privato, Cloud Build utilizza il pool predefinito per eseguire la build nella stessa regione del trigger.

    • (Facoltativo) Descrizione: una descrizione del trigger.

    • Evento: seleziona Evento webhook per configurare il trigger in modo che avvii le build in risposta agli eventi webhook in entrata.

    • URL webhook: utilizza l'URL webhook per autenticare gli eventi webhook in entrata. Per autenticare gli eventi webhook in entrata, devi disporre di un secret. Puoi creare un nuovo secret o utilizzarne uno esistente. Questo segreto è separato da quello associato alla chiave SSH.

      Per creare un secret:

      1. Seleziona Utilizza un nuovo secret (generato da Cloud Build).

      2. Fai clic su Crea secret.

        Verrà visualizzata la finestra di dialogo Crea un secret webhook.

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

      4. Fai clic su Crea secret per salvare il secret, che verrà creato e archiviato automaticamente in Secret Manager.

      Per utilizzare un secret esistente:

      1. Seleziona Utilizza un secret esistente o creane uno tuo.
      2. Nel campo Secret, seleziona il nome del secret che vuoi utilizzare dal menu a discesa o segui le istruzioni per aggiungere un secret tramite ID risorsa.

      3. Nel campo Versione del secret, seleziona la versione del secret dal menu a discesa.

        Se utilizzi un secret esistente, potresti dover concedere manualmente il ruolo Funzione di accesso ai secret di Secret Manager al tuo account di servizio Cloud Build, service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Per saperne di più, vedi Concessione del ruolo Secret Manager al service account.

        Dopo aver creato o selezionato il secret, visualizzerai un'anteprima dell'URL webhook. L'URL conterrà una chiave API generata da Cloud Build e il tuo secret. Se Cloud Build non riesce a recuperare la chiave API, puoi aggiungerla manualmente all'URL o scoprire come ottenere una chiave API se non ne hai ancora una.

        Puoi utilizzare l'URL per richiamare un evento webhook effettuando una richiesta HTTP utilizzando il metodo POST.

        Dopo aver completato questi passaggi, il ruolo Secret Manager Secret Accessor viene concesso automaticamente all'agente di servizio Cloud Build, service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Se non vedi questo ruolo aggiunto automaticamente al tuo service agent, completa i seguenti passaggi descritti in Concessione del ruolo Secret Manager al tuo service account.

    • Origine (facoltativo): se specifichi una configurazione di build incorporata, non è necessario specificare un'origine. In caso contrario, segui questi passaggi:

      • Generazione del repository: seleziona 2ª generazione.

      • Repository: dall'elenco dei repository disponibili, seleziona quello da cui vuoi eseguire la build. La regione del tuo repository deve corrispondere a quella del trigger.

      • Ramo o Tag: specifica un'espressione regolare con il valore del ramo o del tag da soddisfare. Per informazioni sulla sintassi accettabile delle espressioni regolari, vedi sintassi RE2.

      • Controllo dei commenti: se hai selezionato Richiesta di pull come Evento, scegli una delle seguenti opzioni per controllare se il trigger richiama automaticamente una build:

        • Obbligatorio tranne che per proprietari e collaboratori: quando una richiesta pull viene creata o aggiornata da un proprietario o collaboratore del repository, le build vengono eseguite automaticamente. Se un collaboratore esterno avvia l'azione, le build vengono eseguite solo dopo che un proprietario o un collaboratore commenta /gcbrun nella richiesta di pull.

        • Obbligatorio: quando una richiesta di pull viene creata o aggiornata da un collaboratore, le build vengono eseguite solo dopo che un proprietario o un collaboratore ha commentato /gcbrun la richiesta di pull. Le build vengono eseguite ogni volta che viene apportata una modifica a una richiesta di pull.

        • Non richiesto: quando una richiesta di pull viene creata o aggiornata da qualsiasi collaboratore, le build vengono eseguite automaticamente.

    • Configurazione: seleziona il file di configurazione della build che si trova nel repository remoto o crea un file di configurazione della build incorporato da utilizzare per la build. Se non hai specificato un repository di origine, devi selezionare un file di configurazione della build in linea come opzione di configurazione:

      • Tipo: seleziona il tipo di configurazione da utilizzare per la build.

        • File di configurazione di Cloud Build (yaml o json): utilizza un file di configurazione della build per la configurazione.
        • Dockerfile: utilizza un Dockerfile per la configurazione.
        • Buildpack: utilizza i buildpack per la configurazione.

      • Posizione: specifica la posizione per la configurazione.

        • Repository: se il file di configurazione si trova nel repository remoto, fornisci la posizione del file di configurazione della build, della directory Dockerfile o della directory dei buildpack. Se il tipo di configurazione della build è Dockerfile o un buildpack, devi fornire un nome per l'immagine risultante e, facoltativamente, un timeout per la build. Dopo aver fornito il nome dell'immagine Dockerfile o del buildpack, vedrai un'anteprima del comando docker build o pack che verrà eseguito dalla build.
        • (Facoltativo) Variabili di ambiente Buildpack: se hai selezionato buildpacks come tipo di configurazione, fai clic su Aggiungi variabile di ambiente Pack per specificare le variabili di ambiente e i valori di Buildpack. Per saperne di più sulle variabili di ambiente di buildpack, consulta Variabili di ambiente.

        • Inline: se hai selezionato File di configurazione di Cloud Build (yaml o json) come opzione di configurazione, puoi specificare la configurazione di compilazione in linea. Fai clic su Apri editor per scrivere il file di configurazione della build nella consoleGoogle Cloud utilizzando la sintassi YAML o JSON. Fai clic su Fine per salvare la configurazione della build.

      Nell'esempio seguente, il file di configurazione della build incorporato registra la stringa "hello world":

       steps:
 - name: 'ubuntu'
   args: ['echo', 'hello world']

    • Sostituzioni (facoltativo): se hai selezionato il file di configurazione della build come opzione di configurazione della build o hai creato un file di configurazione della build incorporato, puoi scegliere di definire variabili di sostituzione specifiche del trigger utilizzando questo campo. Puoi anche ottenere dati utilizzando i binding del payload quando definisci i valori delle variabili di sostituzione.

    • Filtri (facoltativo): puoi creare una regola all'interno di un trigger che determina se il trigger esegue o meno una build in base alle variabili di sostituzione.

  5. Fai clic su Crea per creare il trigger di build.

gcloud

Per creare un trigger webhook:

gcloud builds triggers create webhook \
  --trigger-config=TRIGGER_CONFIG_PATH \
  --name=TRIGGER_NAME \
  --description=DESCRIPTION \
  --region=REGION \
  --secret=projects/PROJECT_ID/secrets/SECRET_NAME/versions/SECRET_VERSION \
  --service-account=SERVICE_ACCOUNT \ 
  --repository=projects/PROJECT_ID/locations/REGION/connections/CONNECTION_NAME/repositories/REPO_NAME \ 
  --build-config=PATH_TO_BUILD_CONFIG \
  --inline-config=PATH_TO_INLINE_BUILD_CONFIG \
  --dockerfile=DOCKERFILE \
  --dockerfile-dir=DOCKERFILE_DIR \
  --dockerfile-image=DOCKERFILE_IMAGE \
  --tag=TAG_NAME \
  --branch=BRANCH_NAME \
  --substitutions=_SUB_ONE=SUBSTITUTION \
  --subscription-filter=FILTER \
  --require-approval

Dove:

  • TRIGGER_CONFIG_PATH È il percorso di un file di configurazione del trigger. Se utilizzi un file di configurazione del trigger, i campi name, description, region, secret, service-account, subscription-filter e substitution devono rimanere indefiniti. Per saperne di più, consulta BuildTrigger nella documentazione di riferimento di Cloud Build.
  • TRIGGER_NAME è il nome del trigger.
  • DESCRIPTION (Facoltativo) è una descrizione del trigger.
  • REGION è la regione per il trigger. Questo valore deve essere una regione diversa da "global".
  • SECRET_NAME è il nome del secret archiviato in Secret Manager.
  • SECRET_VERSION è la versione associata al tuo secret così come è archiviato in Secret Manager.
  • SERVICE_ACCOUNT è il account di servizio utilizzato per eseguire tutte le operazioni controllate dall'utente relative al trigger di build. Se non definisci un account di servizio, Cloud Build utilizza il service account Cloud Build predefinito.
  • PROJECT_ID è l'ID progetto Google Cloud .
  • CONNECTION_NAME è il nome della connessione host.
  • REPO_NAME è il nome del tuo repository.
  • PATH_TO_BUILD_CONFIG è il percorso di un file di configurazione della build. Utilizza questo parametro se il trigger fa riferimento a un file di configurazione della build in un repository Cloud Build. Se imposti questo parametro, non puoi definire un inline-config o utilizzare parametri per un Dockerfile.
  • PATH_TO_INLINE_BUILD_CONFIG è il percorso di una configurazione di build in linea. Utilizza questo parametro se il trigger fa riferimento a un file di configurazione di build locale. Se imposti questo parametro, non puoi definire un build-config o utilizzare parametri per un Dockerfile.
  • DOCKERFILE è il percorso di un Dockerfile. Utilizza questo parametro se il trigger fa riferimento a un Dockerfile. Se imposti i parametri Dockerfile, non puoi definire un build-config o un inline-config.
  • DOCKERFILE_DIR è la directory del Dockerfile.
  • DOCKERFILE_IMAGE è il nome dell'immagine Docker che Cloud Build crea.
  • BRANCH_NAME è il nome del ramo se vuoi impostare il trigger per la build su un ramo. Se imposti questo parametro, non puoi definire un tag.
  • TAG_NAME è il nome del tag se vuoi impostare l'attivazione in base a un tag. Se imposti questo parametro, non puoi definire un branch.
  • SUBSTITUTION (facoltativo) sono parametri da sostituire nella specifica della build. Ad esempio, _SUB_ONE='$(body.message.test)',_SUB_TWO='$(body.message.output)'.
  • FILTER (facoltativo) è un'espressione di filtro CEL per il trigger, ad esempio '_SUB_ONE == "prod"'.
  • (Facoltativo) Quando --require-approval è presente nel comando, Cloud Build richiede l'approvazione manuale per le build attivate.

Richiamare un evento webhook

Utilizza il seguente comando per richiamare un evento webhook:

curl -X POST -H "Content-type: application/json" "https://cloudbuild.googleapis.com/v1/projects/${PROJECT_ID}/locations/${REGION}/triggers/${TRIGGER_NAME}:webhook?key=${API_KEY}&secret=${SECRET_VALUE}&trigger=${TRIGGER_NAME}&projectId=${PROJECT_ID}" -d "{}"

(Facoltativo) Concedi il ruolo Secret Manager al tuo account di servizio

Quando configuri il secret durante la creazione del trigger webhook, nella maggior parte dei casi, Cloud Build concede automaticamente il ruolo Funzione di accesso ai secret di Secret Manager ai service account che richiedono il ruolo. Tuttavia, se utilizzi un secret esistente, potresti anche dover concedere manualmente il ruolo Secret Manager Secret Accessor al account di servizio Cloud Build:

  1. Apri la pagina IAM nella console Google Cloud :

    Apri la pagina IAM

  2. (Facoltativo) Per visualizzare gli account forniti da Google, seleziona la casella di controllo Includi concessioni di ruoli fornite da Google.

  3. Prendi nota del account di servizio di build a cui vuoi concedere il ruolo.

  4. Apri la pagina Secret Manager nella console Google Cloud :

    Apri la pagina Secret Manager

  5. Fai clic sul nome del secret.

    Viene visualizzata la pagina Dettagli secret.

    1. Fai clic sulla scheda Autorizzazioni.

    2. Fai clic su Concedi l'accesso.

      Verrà visualizzato il riquadro Concedi l'accesso.

    3. Nella sezione Aggiungi entità, aggiungi l'email associata al account di servizio di compilazione.

    4. Nella sezione Assegna i ruoli, seleziona Secret Manager > Secret Manager Secret Accessor.

    5. Fai clic su Salva.

(Facoltativo) Ottieni una chiave API

Per autenticare un evento webhook in entrata, è necessaria una chiave API. Questa chiave API fa parte del segreto che scegli quando configuri il trigger webhook. Se non hai ancora una chiave API o se Cloud Build non è riuscito a recuperarne una durante la configurazione del secret nella console Google Cloud , puoi creare manualmente una chiave API:

Per ottenere una chiave API:

  1. Apri la pagina Credenziali nella console Google Cloud :

    Apri la pagina Credenziali

  2. Fai clic su Crea credenziali.

  3. Fai clic su Chiave API.

    Verrà visualizzata una finestra di dialogo con la chiave API creata. Prendi nota della tua chiave API.

  4. Se vuoi limitare la chiave per le applicazioni di prodotto, fai clic su Limita chiave per completare i passaggi aggiuntivi per proteggere la chiave. In caso contrario, fai clic su Chiudi.

    Per scoprire come limitare la chiave, vedi Applicare le limitazioni relative alle chiavi API.

Passaggi successivi