Automatizzare le build in risposta a eventi webhook

Cloud Build ti consente di definire trigger webhook, che possono autenticare e accettare eventi webhook in entrata. Questi eventi, inviati a un URL personalizzato, 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 della build 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

  • 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 del trigger:

    • Nome: un nome per il trigger.

    • 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 a quella 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.

        • Secret: avrai bisogno di un secret per autenticare gli eventi webhook in entrata. Puoi creare un nuovo secret o utilizzarne uno esistente. Questo segreto è separato da quello 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.

            Verrà visualizzata la finestra popup 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:

          5. Seleziona Utilizza un secret esistente o creane uno tuo.

          6. Nel campo Secret, seleziona il nome del secret da utilizzare dal menu a discesa o segui le istruzioni per aggiungere un secret tramite ID risorsa.

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

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

          Dopo aver creato o selezionato il secret, vedrai 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.

          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 "{}"

          Dopo aver completato questi passaggi, il ruolo Secret Manager Secret Accessor verrà concesso automaticamente al tuo 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.

      • (Facoltativo) Origine: seleziona l'origine da creare quando viene eseguito il trigger webhook. Se specifichi una configurazione di build incorporata, non è necessario specificare l'origine seguente. Puoi specificare 1ª generazione o 2ª generazione come origine. Per saperne di più, consulta Repository Cloud Build.

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

        • Branch 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 (solo app GitHub) come Evento, scegli una delle seguenti opzioni per controllare se una build verrà eseguita automaticamente dal trigger:

          • Obbligatorio tranne che per proprietari e collaboratori: quando una richiesta pull viene creata o aggiornata da un proprietario o un collaboratore del repository, le build vengono eseguite automaticamente dal trigger. Se un collaboratore esterno avvia l'azione, le build verranno eseguite solo dopo che un proprietario o un collaboratore avrà commentato /gcbrun la 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 pull viene creata o aggiornata da qualsiasi collaboratore, le build vengono eseguite automaticamente dai trigger.

      • 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 di compilazione 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.
          • Buildpacks: 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 scoprire di più sulle variabili di ambiente 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 della build 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 eseguirà o meno una build in base alle variabili di sostituzione.

      1. 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.

      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 delle chiavi API.

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

    Cloud Build concede automaticamente il ruolo Funzione di 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 al account di servizio necessario, completa i seguenti passaggi per aggiungere manualmente il ruolo in modo che il account di servizio abbia accesso al tuo secret:

    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 accesso.

        Viene visualizzato il riquadro Concedi l'accesso.

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

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

      5. Fai clic su Salva.

    Passaggi successivi