Cloud Build ti consente di definire i trigger webhook che possono autenticare e accettare gli eventi webhook in arrivo. Questi eventi, inviati a un URL personalizzato, consentono di connettere direttamente sistemi esterni e sistemi di gestione del codice sorgente esterno, come Bitbucket.com, Bitbucket Server o GLaLab, a Cloud Build tramite eventi webhook.
Con i trigger webhook, puoi definire un file di configurazione di compilazione in linea invece di specificare un'origine quando crei il trigger. La configurazione di compilazione in linea ti consente di avere il controllo sulle operazioni git e definire il resto della build.
Questa pagina illustra come creare trigger webhook per automatizzare le build in risposta agli eventi webhook.
Prima di iniziare
-
Abilita le API Cloud Build and Secret Manager.
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:
Apri la pagina Trigger:
Seleziona il progetto nella parte superiore della pagina e fai clic su Apri.
Fai clic su Crea trigger.
Inserisci le seguenti impostazioni di attivazione:
- Nome: un nome per l'attivatore.
Regione: seleziona la regione per l'attivatore.
- Se il file di configurazione di compilazione 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 di compilazione 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 per l'attivatore.
Evento: seleziona Evento webhook per configurare il trigger per avviare le build in risposta agli eventi dei webhook in arrivo.
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 arrivo. Puoi creare un nuovo secret o utilizzarne uno esistente. Questo secret è separato dal secret associato alla chiave SSH.
Per creare un nuovo secret:
- Seleziona Utilizza un nuovo secret (generato da Cloud Build).
Fai clic su Crea secret.
Verrà visualizzata la finestra popup Crea un secret webhook.
Nel campo Nome secret, inserisci un nome per il secret.
Fai clic su Crea secret per salvare il secret, che verrà creato e archiviato automaticamente in Secret Manager.
Per utilizzare un secret esistente:
- Seleziona Utilizza un secret esistente o creane uno personalizzato.
- 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.
- Nel campo Versione secret, seleziona la versione del tuo 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ù, consulta Concedere il ruolo Secret Manager al tuo account di servizio.
Dopo aver creato o selezionato il secret, visualizzerai un'anteprima dell'URL webhook. Il tuo URL conterrà una chiave API generata da Cloud Build e dal tuo secret. Se Cloud Build non è in grado di 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 effettuando una richiesta HTTP utilizzando il metodo POST.
Utilizza il comando seguente per richiamare un evento webhook:
curl -X POST -H "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 Funzione di accesso ai secret di Secret Manager verrà concesso automaticamente al tuo account di servizio Cloud Build,
service-${PROJECT_NUMBER}@gcp-sa-cloudbuild.iam.gserviceaccount.com
. Se non vedi questo ruolo aggiunto automaticamente al tuo account di servizio, completa i seguenti passaggi descritti in Concessione del ruolo Secret Manager all'account di servizio.(Facoltativo) Origine: seleziona l'origine da creare quando viene eseguito il trigger del webhook. Se specifichi una configurazione di build in linea, non è necessario specificare l'origine seguente. Puoi specificare 1a generazione o 2a generazione come origine. Per saperne di più, consulta Repository di Cloud Build.
Repository: dall'elenco dei repository disponibili, seleziona il repository desiderato.
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 sintassi RE2.
Controllo dei commenti: se hai selezionato Richiesta 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 di pull viene creata o aggiornata da un proprietario o da 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 ha commentato
/gcbrun
sulla 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 commenta
/gcbrun
sulla 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 dai trigger.
Configurazione: seleziona il file di configurazione della build che si trova nel tuo repository remoto o crea un file di configurazione della build in linea da utilizzare per la tua 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 tua build.
- File di configurazione di Cloud Build (yaml o json): utilizza un file di configurazione di compilazione per la configurazione.
- Dockerfile: utilizza un
Dockerfile
per la configurazione. - Buildpack: utilizza i buildpack per la configurazione.
Località: specifica il percorso della configurazione.
- Repository: se il file di configurazione si trova nel tuo repository remoto, fornisci la posizione del file di configurazione della build, della directory
Dockerfile
o della directory buildpacks. Se il tipo di configurazione di build èDockerfile
o un buildpack, dovrai fornire un nome per l'immagine risultante e, facoltativamente, un timeout per la build. Dopo aver fornito il nome dell'immagineDockerfile
o buildpack, vedrai un'anteprima del comandodocker build
opack
che verrà eseguita 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 e i valori dell'ambiente buildpack. Per ulteriori informazioni sulle variabili di ambiente buildpack, consulta la sezione Variabili di ambiente. In linea: se hai selezionato File di configurazione Cloud Build (yaml o json) come opzione di configurazione, puoi specificare la configurazione di build in linea. Fai clic su Apri editor per scrivere il file di configurazione della build nella console Google Cloud utilizzando la sintassi YAML o JSON. Fai clic su Fine per salvare la configurazione della build.
- Repository: se il file di configurazione si trova nel tuo repository remoto, fornisci la posizione del file di configurazione della build, della directory
Nell'esempio seguente, i log del file di configurazione di compilazione in linea ripropongono "hello world":
steps: - name: 'ubuntu' args: ['echo', 'hello world']
- Tipo: seleziona il tipo di configurazione da utilizzare per la tua build.
(Facoltativo) Sostituzioni: 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 del trigger utilizzando questo campo. Per ottenere i dati puoi anche utilizzare le associazione di payload quando definisci i valori delle variabili di sostituzione.
(Facoltativo) Filtri: puoi creare una regola all'interno di un trigger che determini se l'attivatore eseguirà o meno una build in base alle variabili di sostituzione.
Fai clic su Crea per creare il trigger di build.
gcloud
(Facoltativo) Ottenere una chiave API
Per autenticare l'evento webhook in arrivo, è necessaria una chiave API.
Per ottenere una chiave API:
Apri la pagina Credenziali nella console Google Cloud:
Fai clic su Crea credenziali.
Fai clic su Chiave API.
Viene visualizzata una finestra di dialogo con la chiave API creata. Prendi nota della tua chiave API.
Se vuoi limitare la chiave per le applicazioni del prodotto, fai clic su Limita chiave per completare ulteriori passaggi per proteggere la chiave. In caso contrario, fai clic su Chiudi.
Per scoprire come limitare la chiave, consulta la sezione Applicare le restrizioni delle chiavi API.
(Facoltativo) Concessione del ruolo Secret Manager al tuo account di servizio
Cloud Build concede automaticamente il ruolo Funzione di accesso a Secret Manager agli account di servizio che lo richiedono durante la configurazione del secret. Se non vedi che questo ruolo viene concesso automaticamente all'account di servizio necessario, segui questi passaggi per aggiungere manualmente il ruolo in modo che l'account di servizio abbia accesso al secret:
Apri la pagina IAM nella console Google Cloud:
Prendi nota del tuo account di servizio Cloud Build a cui vuoi concedere il ruolo.
Apri la pagina Secret Manager nella console Google Cloud:
Fai clic sul nome del secret.
Visualizzerai la pagina Dettagli secret.
Fai clic sulla scheda Autorizzazioni.
Fai clic su Concedi l'accesso.
Viene visualizzato il riquadro Concedi l'accesso.
Nella sezione Aggiungi entità, aggiungi l'indirizzo email associato al tuo account di servizio Cloud Build.
Nella sezione Assegna ruoli, seleziona Secret Manager > Funzione di accesso a Secret Manager.
Fai clic su Salva.
Passaggi successivi
- Scopri come creare e gestire i trigger.
- Scopri come creare repository ospitati su Bitbucket Server.
- Scopri come avviare le build manualmente.
- Scopri come visualizzare i risultati della build.
- Scopri come risolvere gli errori di build.