Cloud Build può inviarti notifiche sugli aggiornamenti delle build ai canali selezionati, come Slack o il server SMTP. Questa pagina spiega come configurare le notifiche utilizzando il notificatore Slack.
Prima di iniziare
Abilita le API Cloud Build, Compute Engine, Cloud Run, Pub/Sub e Secret Manager.
Ruoli richiesti per abilitare le API
Per abilitare le API, devi disporre dell'autorizzazione
serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore utilizzo servizi (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli.
- Installa la Google Cloud CLI.
Configurazione delle notifiche Slack
La sezione seguente spiega come configurare manualmente le notifiche Slack utilizzando il notificatore Slack. Se preferisci automatizzare la configurazione, consulta Automatizzazione della configurazione per le notifiche.
Per configurare le notifiche Slack:
Crea un'app Slack per il tuo workspace Slack.
Attiva webhook in arrivo per pubblicare messaggi da Cloud Build a Slack.
Vai all'app Slack per individuare l'URL del webhook in arrivo. L'URL sarà simile al seguente:
http://hooks.slack.com/services/...Archivia l'URL del webhook in arrivo in Secret Manager:
Apri la pagina Secret Manager nella Google Cloud console:
Fai clic su Crea secret.
Inserisci un nome per il secret.
In Valore secret, aggiungi l'URL del webhook in arrivo per l'app Slack.
Per salvare il secret, fai clic su Crea secret.
Anche se il account di servizio Cloud Run potrebbe avere il ruolo Editor per il tuo progetto, il ruolo Editor non è sufficiente per accedere al secret in Secret Manager. Per concedere al account di servizio Cloud Run l'accesso al secret:
Vai alla pagina IAM nella Google Cloud console:
Individua il service account predefinito di Compute Engine associato al tuo progetto:
Il service account predefinito di Compute Engine sarà simile al seguente:
project-number-compute@developer.gserviceaccount.comPrendi nota del service account predefinito di Compute Engine.
Apri la pagina Secret Manager nella Google Cloud console:
Fai clic sul nome del secret che contiene il secret per l'app Slack.
Nella scheda Autorizzazioni, fai clic su Aggiungi membro.
Aggiungi il service account predefinito di Compute Engine associato al tuo progetto come membro.
Seleziona l'autorizzazione Secret Manager Secret Accessor come ruolo.
Fai clic su Salva.
Concedi al account di servizio Cloud Run l'autorizzazione a leggere dai bucket Cloud Storage:
Vai alla pagina IAM nella Google Cloud console:
Individua il service account predefinito di Compute Engine associato al tuo progetto:
Il service account predefinito di Compute Engine sarà simile al seguente:
project-number-compute@developer.gserviceaccount.comFai clic sull'icona a forma di matita nella riga contenente il service account predefinito di Compute Engine. Verrà visualizzata la scheda Accesso in modifica.
Fai clic su Aggiungi un altro ruolo.
Aggiungi il seguente ruolo:
- Storage Object Viewer
Fai clic su Salva.
Scrivi un file di configurazione del notificatore per configurare il notificatore Slack e filtrare gli eventi di build:
Nel seguente file di configurazione del notificatore di esempio, il campo
filterutilizza Common Expression Language con la variabile disponibile,build, per filtrare gli eventi di build con lo statoSUCCESS:apiVersion: cloud-build-notifiers/v1 kind: SlackNotifier metadata: name: example-slack-notifier spec: notification: filter: build.status == Build.Status.SUCCESS params: buildStatus: $(build.status) delivery: webhookUrl: secretRef: WEBHOOK_URL_SECRET_NAME template: type: golang uri: gs://BUCKET_NAME/slack.json secrets: - name: WEBHOOK_URL_SECRET_NAME value: projects/PROJECT_ID/secrets/SECRET_NAME/versions/latestDove:
buildStatusè un parametro definito dall'utente. Questo parametro assume il valore di $(build.status), lo stato della build.WEBHOOK_URL_SECRET_NAMEè il nome del secret di Secret Manager che contiene il percorso dell'URL webhook Slack. Il nome della variabile specificato qui deve corrispondere al camponameinsecretsin questo file YAML.BUCKET_NAMEè il nome del bucket.PROJECT_IDè l'ID del tuo Google Cloud progetto.SECRET_NAMEè il nome del secret che contiene l'URL del webhook Slack.Il campo
urifa riferimento al fileslack.json. Questo file contiene un modello JSON ospitato su Cloud Storage e rappresenta il messaggio di notifica al tuo spazio Slack.Il file del modello JSON utilizza le funzionalità di blockkit di Slack. Per visualizzare un esempio di file modello, consulta il
slack.jsonfile nel repository cloud-build-notifiers.
Per visualizzare l'esempio, consulta il file di configurazione del notificatore per il notificatore Slack.
Per altri campi in base ai quali puoi filtrare, consulta la risorsa Build. Per altri esempi di filtri, consulta Utilizzo di CEL per filtrare gli eventi di build.
Carica il file di configurazione del notificatore in un bucket Cloud Storage:
Se non hai un bucket Cloud Storage, esegui il seguente comando per crearne uno, dove BUCKET_NAME è il nome che vuoi assegnare al bucket, soggetto ai requisiti di denominazione.
gcloud storage buckets create gs://BUCKET_NAME/Carica il file di configurazione del notificatore nel bucket:
gcloud storage cp CONFIG_FILE_NAME gs://BUCKET_NAME/CONFIG_FILE_NAMEDove:
BUCKET_NAMEè il nome del bucket.CONFIG_FILE_NAMEè il nome del file di configurazione.
Esegui il deployment del notificatore in Cloud Run:
gcloud run deploy SERVICE_NAME \ --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/slack:latest \ --no-allow-unauthenticated \ --update-env-vars=CONFIG_PATH=CONFIG_PATH,PROJECT_ID=PROJECT_IDDove:
SERVICE_NAMEè il nome del servizio Cloud Run in cui stai eseguendo il deployment dell'immagine.CONFIG_PATHè il percorso del file di configurazione del notificatore per il notificatore Slack,gs://BUCKET_NAME/CONFIG_FILE_NAME.PROJECT_IDè l'ID del tuo Google Cloud progetto.
Il comando
gcloud run deployesegue il pull dell'ultima versione dell'immagine ospitata da Artifact Registry di proprietà di Cloud Build. Cloud Build supporta le immagini del notificatore per nove mesi. Dopo nove mesi, Cloud Build elimina la versione dell'immagine. Se vuoi utilizzare una versione precedente dell'immagine, devi specificare la versione semantica completa del tag dell'immagine nell'attributoimagedel comandogcloud run deploy. Le versioni e i tag delle immagini precedenti sono disponibili in Artifact Registry.Crea un account di servizio per rappresentare l'identità della sottoscrizione Pub/Sub:
gcloud iam service-accounts create SUB_IDENTITY_SERVICE_ACCOUNT \ --display-name "SUB_IDENTITY_SERVICE_ACCOUNT_DISPLAY_NAME"Dove:
SUB_IDENTITY_SERVICE_ACCOUNTè un nome per il account di servizio.SUB_IDENTITY_SERVICE_ACCOUNT_DISPLAY_NAMEè un nome visualizzato per il account di servizio.
Concedi al account di servizio di identità della sottoscrizione Pub/Sub le autorizzazioni necessarie per creare token di autenticazione nel tuo Google Cloud progetto.
gcloud iam service-accounts add-iam-policy-binding \ SUB_IDENTITY_SERVICE_ACCOUNT@PROJECT_ID.iiam.gserviceaccount.com \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreatorDove:
PROJECT_IDè l'ID del tuo Google Cloud progetto.PROJECT_NUMBERè il numero del tuo progetto Google Cloud .
Concedi al account di servizio SUB_IDENTITY_SERVICE_ACCOUNT il ruolo
Invokerdi Cloud Run:gcloud run services add-iam-policy-binding SERVICE_NAME \ --member=serviceAccount:SUB_IDENTITY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \ --role=roles/run.invokerDove:
SERVICE_NAMEè il nome del servizio Cloud Run in cui stai eseguendo il deployment dell'immagine.PROJECT_IDè l'ID del tuo Google Cloud progetto.
Crea l'argomento
cloud-buildsper ricevere i messaggi di aggiornamento della build per il notificatore:gcloud pubsub topics create cloud-buildsPuoi anche definire un nome dell'argomento personalizzato nel file di configurazione della build in modo che i messaggi vengano inviati all'argomento personalizzato. In questo caso, devi creare un argomento con lo stesso nome dell'argomento personalizzato:
gcloud pubsub topics create topic-namePer saperne di più, consulta Argomenti Pub/Sub per le notifiche di build.
Crea un sottoscrittore push Pub/Sub per il notificatore:
gcloud pubsub subscriptions create subscriber-id \
--topic=cloud-builds \
--push-endpoint=SERVICE_URL \
--push-auth-service-account=SUB_IDENTITY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com
Dove:
+ SUBSCRIBER_ID è il nome che vuoi assegnare alla sottoscrizione.
+ SERVICE_URL è l'URL generato da Cloud Run per il nuovo servizio.
+ PROJECT_ID è l'ID del tuo Google Cloud progetto.
Note: By default, [subscriptions expire after 31 days of inactivity](/pubsub/docs/subscription-overview#lifecycle).
You can adjust or disable the expiration period by including the
[`--expiration-period` flag](/sdk/gcloud/reference/pubsub/subscriptions/create#--expiration-period)
when creating the subscription.
Le notifiche per il tuo progetto Cloud Build sono ora configurate. La prossima volta che richiami una build, riceverai una notifica in Slack se la build corrisponde al filtro configurato.
Utilizzo di CEL per filtrare gli eventi di build
Cloud Build utilizza CEL con la variabile build nei campi
elencati nella risorsa Build
per accedere ai campi associati all'evento di build, come
l'ID trigger, l'elenco delle immagini o i valori di sostituzione. Puoi utilizzare la filter
stringa per filtrare gli eventi di build nel file di configurazione della build utilizzando
qualsiasi campo elencato nella risorsa Build. Per trovare la sintassi esatta associata al campo, consulta il
cloudbuild.proto
file.
Filtrare in base all'ID trigger
Per filtrare in base all'ID trigger, specifica il valore dell'ID trigger nel campo filter utilizzando build.build_trigger_id, dove trigger-id è l'ID trigger come stringa:
filter: build.build_trigger_id == trigger-id
Filtrare in base allo stato
Per filtrare in base allo stato, specifica lo stato della build in base al quale vuoi filtrare nel campo filter utilizzando build.status.
L'esempio seguente mostra come filtrare gli eventi di build con lo stato SUCCESS utilizzando il campo filter:
filter: build.status == Build.Status.SUCCESS
Puoi anche filtrare le build con stati diversi. L'esempio seguente mostra come filtrare gli eventi di build con lo stato SUCCESS, FAILURE o TIMEOUT utilizzando il campo filter:
filter: build.status in [Build.Status.SUCCESS, Build.Status.FAILURE, Build.Status.TIMEOUT]
Per visualizzare altri valori di stato in base ai quali puoi filtrare, consulta Stato nella documentazione di riferimento della risorsa Build.
Filtrare in base al tag
Per filtrare in base al tag, specifica il valore del tag nel campo filter utilizzando build.tags, dove tag-name è il nome del tag:
filter: tag-name in build.tags
Puoi filtrare in base al numero di tag specificati nell'evento di build utilizzando size. Nell'esempio seguente, il campo filter filtra gli eventi di build che hanno esattamente due tag specificati con un tag specificato come v1:
filter: size(build.tags) == 2 && "v1" in build.tags
Filtrare in base alle immagini
Per filtrare in base alle immagini, specifica il valore dell'immagine nel campo filter utilizzando build.images, dove image-name è il nome completo dell'immagine come elencato in Artifact Registry, ad esempio us-east1-docker.pkg.dev/my-project/docker-repo/image-one:
filter: image-name in build.images
Nell'esempio seguente, il campo filter filtra gli eventi di build che hanno us-east1-docker.pkg.dev/my-project/docker-repo/image-one o us-east1-docker.pkg.dev/my-project/docker-repo/image-two specificati come nomi delle immagini:
filter: "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images || "us-east1-docker.pkg.dev/my-project/docker-repo/image-one" in build.images
Filtrare in base all'ora
Puoi filtrare gli eventi di build in base all'ora di creazione, all'ora di inizio o all'ora di fine di una build specificando una delle seguenti opzioni nel campo filter: build.create_time, build.start_time o build.finish_time.
Nell'esempio seguente, il campo filter utilizza timestamp per filtrare gli eventi di build con un'ora di richiesta per creare la build il 20 luglio 2020 alle 06:00:
filter: build.create_time == timestamp("2020-07-20:T06:00:00Z")
Puoi anche filtrare gli eventi di build in base ai confronti temporali. Nell'esempio seguente, il campo filter utilizza timestamp per filtrare gli eventi di build con un'ora di inizio compresa tra il 20 luglio 2020 alle 06:00 e il 30 luglio 2020 alle 06:00.
filter: timestamp("2020-07-20:T06:00:00Z") >= build.start_time && build.start_time <= timestamp("2020-07-30:T06:00:00Z")
Per saperne di più su come vengono espressi i fusi orari in CEL, consulta la definizione del linguaggio per i fusi orari.
Per filtrare in base alla durata di una build, puoi utilizzare duration per confrontare i timestamp.
Nell'esempio seguente, il campo filter utilizza duration per filtrare gli eventi di build con build che vengono eseguite per almeno cinque minuti:
filter: build.finish_time - build.start_time >= duration("5m")
Filtrare in base alla sostituzione
Puoi filtrare in base alla sostituzione specificando la variabile di sostituzione nel campo filter utilizzando build.substitutions. Nell'esempio seguente,
il campo filter elenca le build che contengono la variabile di sostituzione
substitution-variable e controlla se substitution-variable corrisponde al substitution-value:
filter: build.substitutions[substitution-variable] == substitution-value
Dove:
substitution-variableè il nome della variabile di sostituzione.substitution-valueè il nome del valore di sostituzione.
Puoi anche filtrare in base ai valori delle variabili di sostituzione predefinite. Nell'esempio seguente, il campo filter elenca le build con il nome del ramo master e le build con il nome del repository github.com/user/my-example-repo. Le variabili di sostituzione predefinite BRANCH_NAME e REPO_NAME vengono passate come chiavi a build.substitutions:
filter: build.substitutions["BRANCH_NAME"] == "master" && build.substitutions["REPO_NAME"] == "github.com/user/my-example-repo"
Se vuoi filtrare le stringhe utilizzando le espressioni regolari, puoi utilizzare la funzione integrata matches. Nell'esempio seguente, il campo filter filtra le build con lo stato FAILURE o TIMEOUT e che hanno anche una variabile di sostituzione della build TAG_NAME con un valore che corrisponde all'espressione regolare v{DIGIT}.{DIGIT}.{3 DIGITS}).
filter: build.status in [Build.Status.FAILURE, Build.Status.TIMEOUT] && build.substitutions["TAG_NAME"].matches("^v\\d{1}\\.\\d{1}\\.\\d{3}$")
Per visualizzare un elenco dei valori di sostituzione predefiniti, consulta Utilizzo delle sostituzioni predefinite.
Passaggi successivi
- Scopri di più sui notificatori di Cloud Build.
- Scopri come sottoscrivere le notifiche di build.
- Scopri come scrivere un file di configurazione di compilazione di Cloud Build.