Automatizzare le build in risposta a eventi webhook

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

Con gli attivatori webhook, puoi definire un file di configurazione di compilazione incorporato invece di specificare un'origine durante la creazione dell'attivatore. La configurazione della build in linea ti consente di avere il controllo sulle operazioni di git e di definire il resto della build.

Questa pagina illustra come creare trigger webhook per automatizzare le build in risposta a eventi webhook.

Prima di iniziare

  • Enable the Cloud Build and Secret Manager APIs.

    Enable the APIs

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

Creazione di trigger webhook

Console

Per creare un trigger webhook utilizzando la console Google Cloud :

  1. Apri la pagina Trigger:

    Apri la pagina Trigger 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 di trigger:

    • Nome: un nome per l'attivatore.

    • Regione: seleziona la regione per l'attivatore.

      • Se il file di configurazione della build associato all'attivatore specifica un pool privato, Cloud Build utilizza il pool privato per eseguire la build. In questo caso, la regione specificata nell'attivatore deve corrispondere a quella in cui hai creato il pool privato.
      • Se il file di configurazione della build associato all'attivatore non specifica un pool privato, Cloud Build utilizza il pool predefinito per eseguire la build nella stessa regione dell'attivatore.

    • (Facoltativo) Descrizione: una descrizione dell'attivatore.

    • Evento: seleziona Evento webhook per configurare l'attivatore in modo che avvii le compilazioni in risposta agli eventi webhook in entrata.

    • URL webhook: utilizza l'URL webhook per autenticare gli eventi webhook in entrata.

      • Secret: ti servirà un secret per autenticare gli eventi webhook in entrata. Puoi creare un nuovo secret o utilizzarne uno esistente. Questo segreto è separato dal segreto associato alla chiave SSH.

        Per creare un nuovo secret:

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

        2. Fai clic su Crea secret.

          Viene visualizzata la finestra popup Crea un secret webhook.

        3. Nel campo Nome del 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 Accesso ai secret di Secret Manager al tuo account di servizio Cloud Build, service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Per scoprire di più, consulta Concedere il ruolo Secret Manager all'account di servizio.

      Dopo aver creato o selezionato il secret, viene visualizzata 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 tua 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 inviando una richiesta HTTP utilizzando il metodo POST.

      Utilizza il seguente comando per invocare 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 "{}"

      Dopo aver completato questi passaggi, il ruolo Accesso ai segreti service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com di Secret Manager verrà concesso automaticamente all'agente di servizio Cloud Build,service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com. Se non vedi questo ruolo aggiunto automaticamente all'agente di servizio, completa i seguenti passaggi descritti in Concedere il ruolo Secret Manager all'account di servizio.

    • (Facoltativo) Origine: seleziona l'origine da compilare quando viene eseguito l'attivatore webhook. Se specifichi una configurazione di compilazione in linea, non è necessario specificare la seguente origine. Puoi specificare 1ª generazione o 2ª generazione come origine. Per saperne di più, consulta Repository Cloud Build.

      • Repository: dall'elenco dei repository disponibili, seleziona quello che ti interessa.

      • 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, consulta la pagina sulla sintassi RE2.

      • Controllo dei commenti: se hai selezionato Richiesta di pull (solo app GitHub) come Evento, scegli una delle seguenti opzioni per controllare se una build verrà eseguita automaticamente dall'attivatore:

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

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

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

    • Configurazione: seleziona il file di configurazione della build nel tuo repository remoto o crea un file di configurazione della build in linea 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 tua configurazione.
        • Dockerfile: utilizza un Dockerfile per la configurazione.
        • Buildpack: utilizza i buildpack per la configurazione.

      • Posizione: specifica la posizione della 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 compilazione è Dockerfile o un buildpack, devi fornire un nome per l'immagine risultante e, facoltativamente, un timeout per la compilazione. Dopo aver fornito il nome dell'immagine Dockerfile o del buildpack, vedrai un'anteprima del comando docker build o pack che verrà eseguito durante la compilazione.
        • (Facoltativo) Variabili di ambiente Buildpack: se hai selezionato buildpacks come tipo di configurazione, fai clic su Aggiungi variabile di ambiente del pacchetto per specificare le variabili di ambiente e i valori del buildpack. Per scoprire di più sulle variabili di ambiente del buildpack, consulta Voci di riferimento.

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

      Nell'esempio seguente, i log del file di configurazione della build inline ripetono "hello world":

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

    • Sostituzioni (facoltative): se hai selezionato il file di configurazione della build come opzione di configurazione della build o hai creato un file di configurazione della build in linea, puoi scegliere di definire variabili di sostituzione specifiche per l'attivatore utilizzando questo campo. Puoi anche ottenere i dati utilizzando le associazioni del payload quando definisci i valori delle variabili di sostituzione.

    • Filtri (facoltativo): puoi creare una regola all'interno di un trigger che determina se l'trigger eseguirà o meno una compilazione in base alle variabili di sostituzione.

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

gcloud

(Facoltativo) Ottenere una chiave API

Per autenticare l'evento webhook in entrata, è necessaria 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.

    Viene visualizzata una finestra di dialogo con la chiave API creata. Prendi nota della chiave API.

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

    Per scoprire come limitare la chiave, consulta Applicare le restrizioni delle chiavi API.

(Facoltativo) Concedi il ruolo Secret Manager all'account di servizio

Cloud Build concede automaticamente il ruolo Accesso ai secret di Secret Manager agli account di servizio che richiedono il ruolo durante la configurazione dei secret. Se non vedi questo ruolo concesso automaticamente all'account di servizio necessario, completa i seguenti passaggi per aggiungere manualmente il ruolo in modo che l'account di servizio abbia accesso al tuo segreto:

  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 dell'account di servizio di compilazione 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 del secret.

    1. Fai clic sulla scheda Autorizzazioni.

    2. Fai clic su Concedi accesso.

      Viene visualizzato il riquadro Concedi l'accesso.

    3. Nella sezione Aggiungi entità, aggiungi l'indirizzo email associato all'account di servizio di compilazione.

    4. Nella sezione Assegna i ruoli, seleziona Secret Manager > Accesso ai segreti di Secret Manager.

    5. Fai clic su Salva.

Passaggi successivi