Cloud Build kann Ihnen Benachrichtigungen an gewünschte Kanäle wie Slack oder Ihren SMTP-Server senden, um Sie über Build-Updates zu informieren. Auf dieser Seite wird erläutert, wie Sie Benachrichtigungen mit dem SMTP-Notifier konfigurieren.
Hinweise
-
Enable the Cloud Build, Compute Engine, Cloud Run, Pub/Sub, and Secret Manager APIs.
- Installieren Sie die Google Cloud CLI.
E-Mail-Benachrichtigungen konfigurieren
Zum Senden von E-Mail-Benachrichtigungen benötigen Sie einen aktiven SMTP-Server und Zugriff auf ein Konto auf diesem Server, einschließlich Nutzername und Passwort, die zum Senden von Benachrichtigungen verwendet werden. Sie können einen beliebigen
vorhandenen SMTP-Server verwenden,
benötigen Zugriff auf den Servernamen und den Port. Zum Beispiel der Servername für
Gmail ist smtp.gmail.com
und der Port ist 587
. Prüfen Sie, ob Ihr SMTP-
die Zustellkontingente des Servers in der Lage sind, das E-Mail-Volumen zu bewältigen, das Sie voraussichtlich generieren werden.
Im folgenden Abschnitt wird erläutert, wie Sie E-Mail-Benachrichtigungen manuell mit dem SMTP-Notifier konfigurieren können. Wenn Sie stattdessen die Konfiguration automatisieren möchten, finden Sie weitere Informationen unter Konfiguration für Benachrichtigungen automatisieren.
So konfigurieren Sie E-Mail-Benachrichtigungen:
Speichern Sie das Passwort des E-Mail-Kontos des Absenders in Secret Manager. Hinweis: Bei Gmail müssen Sie das App-Passwort anstelle des Anmeldepassworts für das Konto verwenden.
Öffnen Sie in der Google Cloud Console die Seite „Secret Manager“:
Klicken Sie auf Secret erstellen.
Geben Sie einen Namen für das Secret ein.
Fügen Sie unter Secret-Wert das E-Mail-Konto-Passwort des Absenders hinzu.
Klicken Sie zum Speichern Ihres Secrets auf Secret erstellen.
Ihr Cloud Run-Dienstkonto hat möglicherweise die Rolle Bearbeiter für Ihr Projekt. Die Rolle Bearbeiter reicht jedoch nicht für den Zugriff auf Ihr Secret in Secret Manager aus. Sie müssen Ihrem Cloud Run-Dienstkonto Zugriff auf Ihr Secret gewähren:
Rufen Sie in der Google Cloud Console die IAM-Seite auf:
Suchen Sie das Compute Engine-Standarddienstkonto, das mit Ihrem Projekt verknüpft ist:
Ihr Compute Engine-Standarddienstkonto sieht in etwa so aus:
project-number-compute@developer.gserviceaccount.com
Notieren Sie sich das Compute Engine-Standarddienstkonto.
Öffnen Sie in der Google Cloud Console die Seite „Secret Manager“:
Klicken Sie auf den Secret-Namen, der das Secret für das Passwort des E-Mail-Kontos.
Klicken Sie im Tab Berechtigungen auf Mitglied hinzufügen.
Fügen Sie das mit Ihrem Projekt verknüpfte Compute Engine-Standarddienstkonto als Mitglied hinzu.
Wählen Sie die Berechtigung Zugriffsfunktion für Secret Manager-Secret als Rolle aus.
Klicken Sie auf Speichern.
Gewähren Sie Ihrem Cloud Run-Dienstkonto die Berechtigung zum Lesen aus Cloud Storage-Buckets:
Rufen Sie in der Google Cloud Console die IAM-Seite auf:
Suchen Sie das Compute Engine-Standarddienstkonto, das mit Ihrem Projekt verknüpft ist:
Ihr Compute Engine-Standarddienstkonto sieht in etwa so aus:
project-number-compute@developer.gserviceaccount.com
Klicken Sie auf das Stiftsymbol in der Zeile mit Ihrem Compute Engine-Standarddienstkonto. Der Tab Bearbeitungszugriff wird angezeigt.
Klicken Sie auf Weitere Rolle hinzufügen.
Fügen Sie die folgende Rolle hinzu:
- Storage-Objekt-Betrachter
Klicken Sie auf Speichern.
Schreiben Sie eine Notifier-Konfigurationsdatei, um Ihren SMTP-Notifier zu konfigurieren und nach Build-Ereignissen zu filtern:
In der folgenden Konfigurationsdatei für Notifier wird im Feld
filter
die Option Common Expression Language mit der verfügbaren Variablebuild
verwendet, um Build-Ereignisse mit dem StatusSUCCESS
zu filtern:apiVersion: cloud-build-notifiers/v1 kind: SMTPNotifier metadata: name: example-smtp-notifier spec: notification: filter: build.status == Build.Status.SUCCESS params: buildStatus: $(build.status) delivery: server: server-host-name port: "port" sender: sender-email from: from-email recipients: - recipient-email # optional: more emails here password: secretRef: smtp-password template: type: golang uri: gs://example-gcs-bucket/smtp.html secrets: - name: smtp-password value: projects/project-id/secrets/secret-name/versions/latest
Wobei:
buildStatus
ist ein benutzerdefinierter Parameter. Dieser Parameter übernimmt den Wert von $(build.status), dem Status des Builds.server-host-name
ist die Adresse Ihres SMTP-Servers.port
ist der Port, der SMTP-Anfragen verarbeitet. Dieser Wert sollte als String angegeben werden.sender-email
ist die E-Mail-Adresse des Absenderkontos, die dem angegebenen server-host-name angezeigt wird.from-email
ist die E-Mail-Adresse, die für Empfänger angezeigt wird.recipient-email
ist eine Liste mit einer oder mehreren E-Mail-Adressen, um Nachrichten vom Absender zu empfangen.smtp-password
ist die Konfigurationsvariable, die in diesem Beispiel verwendet wird, um auf das im Secret Manager gespeicherte E-Mail-Konto-Passwort des Absenders zu verweisen. Der hier angegebene Variablenname sollte dem Feldname
untersecrets
entsprechen.project-id
ist die ID des Google Cloud-Projekts.secret-name
ist der Name Ihres Secrets, das das Passwort für das E-Mail-Konto des Absenders enthält.Das Feld
uri
verweist auf die Dateismtp.html
. Diese Datei verweist auf eine HTML-Vorlage, die in Cloud Storage gehostet wird, und stellt Ihre Benachrichtigungs-E-Mail dar.
Das Beispiel finden Sie in der Konfigurationsdatei für Notifier für die SMTP-Notifier.
Weitere Felder, nach denen Sie filtern können, finden Sie in der Ressource Build. Weitere Filterbeispiele finden Sie unter CEL zum Filtern von Build-Ereignissen verwenden.
Laden Sie die Notifier-Konfigurationsdatei in einen Cloud Storage-Bucket hoch:
Wenn Sie keinen Cloud Storage-Bucket haben, führen Sie den folgenden Befehl aus, Erstellen Sie einen Bucket, wobei
bucket-name
der Name ist, den Sie Ihrem Bucket entsprechend den Benennungsanforderungen.gcloud storage buckets create gs://bucket-name/
Laden Sie die Konfigurationsdatei für den Notifier in Ihren Bucket hoch:
gcloud storage cp config-file-name gs://bucket-name/config-file-name
Hierbei gilt:
bucket-name
ist der Name des Buckets.config-file-name
ist der Name Ihrer Konfigurationsdatei.
Stellen Sie den Notifier in Cloud Run bereit.
gcloud run deploy service-name \ --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/smtp:latest \ --update-env-vars=CONFIG_PATH=config-path,PROJECT_ID=project-id
Hierbei gilt:
service-name
ist der Name des Cloud Run-Dienstes, in dem Sie das Image bereitstellen.config-path
ist der Pfad zur Notifier-Konfigurationsdatei für Ihre SMPT-Benachrichtigungengs://bucket-name/config-file-name
.project-id
ist die ID des Google Cloud-Projekts.
Der Befehl
gcloud run deploy
ruft die neueste Version des gehosteten Images aus der Cloud Build-Artifact Registry ab. Cloud Build unterstützt Notifier-Images neun Monate lang. Nach neun Monaten löscht Cloud Build die Image-Version. Wenn Sie eine frühere Image-Version verwenden möchten, müssen Sie die vollständige semantische Version des Image-Tags im Attributimage
Ihresgcloud run deploy
-Befehls angeben. Ältere Image-Versionen und Tags finden Sie in Artifact Registry.Gewähren Sie Pub/Sub-Berechtigungen zum Erstellen von Authentifizierungstokens in Ihrem Projekt:
gcloud projects add-iam-policy-binding project-id \ --member=serviceAccount:service-project-number@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
Wobei:
project-id
ist die ID des Google Cloud-Projekts.project-number
ist die Nummer Ihres Google Cloud-Projekts.
Erstellen Sie ein Dienstkonto, das die Pub/Sub-Abonnementidentität darstellen soll:
gcloud iam service-accounts create cloud-run-pubsub-invoker \ --display-name "Cloud Run Pub/Sub Invoker"
Sie können
cloud-run-pubsub-invoker
oder einen innerhalb Ihres Google Cloud-Projekts eindeutigen Namen verwenden.Weisen Sie dem Dienstkonto
cloud-run-pubsub-invoker
die Cloud Run-BerechtigungInvoker
zu:gcloud run services add-iam-policy-binding service-name \ --member=serviceAccount:cloud-run-pubsub-invoker@project-id.iam.gserviceaccount.com \ --role=roles/run.invoker
Hierbei gilt:
service-name
ist der Name des Cloud Run-Dienstes, in dem Sie das Image bereitstellen.project-id
ist die ID des Google Cloud-Projekts.
Erstellen Sie das Thema
cloud-builds
, um Build-Update-Nachrichten für Ihren Notifier zu erhalten:gcloud pubsub topics create cloud-builds
Erstellen Sie einen Pub/Sub-Push-Abonnenten für Ihren Notifier:
gcloud pubsub subscriptions create subscriber-id \ --topic=cloud-builds \ --push-endpoint=service-url \ --push-auth-service-account=cloud-run-pubsub-invoker@project-id.iam.gserviceaccount.com
Hierbei gilt:
subscriber-id
ist der Name, den Sie Ihrem Abo geben möchten.service-url
ist die von Cloud Run generierte URL für Ihren neuen Dienst.project-id
ist die ID des Google Cloud-Projekts.
Benachrichtigungen sind nun für Ihr Cloud Build-Projekt eingerichtet. Wenn Sie das nächste Mal einen Build aufrufen, erhält der angegebene recipients
eine E-Mail mit einer Benachrichtigung, wenn der Build dem von Ihnen konfigurierten Filter entspricht.
Build-Ereignisse mit CEL filtern
Cloud Build verwendet CEL mit der Variablen build
für Felder in der Ressource Build, um auf Felder zuzugreifen, die mit Ihrem Build-Ereignis verknüpft sind, z. B. Ihre Trigger-ID, Image-Liste oder Ersatzwerte. Sie können den String filter
verwenden, um Build-Ereignisse in Ihrer Build-Konfigurationsdatei mit einem Feld zu filtern, das in der Ressource Build aufgeführt ist. Die genaue Syntax für Ihr Feld finden Sie auf der
cloudbuild.proto
-Datei.
Nach Trigger-ID filtern
Wenn Sie nach Trigger-ID filtern möchten, geben Sie den Wert Ihrer Trigger-ID im Feld filter
mit build.build_trigger_id
an. Dabei ist trigger-id
Ihre Trigger-ID als String:
filter: build.build_trigger_id == trigger-id
Nach Status filtern
Geben Sie im Feld filter
mithilfe von build.status
den Build-Status an, nach dem der Filter gefiltert werden soll.
Das folgende Beispiel zeigt, wie Sie Build-Ereignisse mit dem Status SUCCESS
mithilfe des Felds filter
filtern:
filter: build.status == Build.Status.SUCCESS
Sie können auch Builds mit unterschiedlichen Status filtern. Das folgende Beispiel zeigt, wie Build-Ereignisse mit dem Status SUCCESS
, FAILURE
oder TIMEOUT
mit dem Feld filter
gefiltert werden:
filter: build.status in [Build.Status.SUCCESS, Build.Status.FAILURE, Build.Status.TIMEOUT]
Weitere Statuswerte, nach denen Sie filtern können, finden Sie in der Referenz zu Build-Ressourcen unter Status.
Nach Tag filtern
Geben Sie zum Filtern nach Tag den Wert Ihres Tags im Feld filter
mit build.tags
ein, wobei tag-name
der Name des Tags ist:
filter: tag-name in build.tags
Mit size
können Sie nach der Anzahl der in Ihrem Build-Ereignis angegebenen Tags filtern. Im folgenden Beispiel filtert das Feld filter
Build-Ereignisse, bei denen genau zwei Tags angegeben sind, wobei ein Tag als v1
angegeben ist:
filter: size(build.tags) == 2 && "v1" in build.tags
Nach Images filtern
Geben Sie den Wert des Bildes im Feld filter
ein, um nach Bildern zu filtern
mit build.images
, wobei image-name
der vollständige Name ist
wie in Artifact Registry aufgeführt, z. B.
us-east1-docker.pkg.dev/my-project/docker-repo/image-one
:
filter: image-name in build.images
Im folgenden Beispiel filtert filter
nach Build-Ereignissen, die
entweder us-east1-docker.pkg.dev/my-project/docker-repo/image-one
oder
us-east1-docker.pkg.dev/my-project/docker-repo/image-two
angegeben als
Image-Namen:
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
Nach Zeitraum filtern
Sie können Build-Ereignisse nach der Erstellungszeit, dem Beginn oder dem Ende eines Builds filtern. Geben Sie dazu in Ihrem Feld filter
eine der folgenden Optionen an: build.create_time
, build.start_time
oder build.finish_time
zurück.
Im folgenden Beispiel verwendet das Feld filter
timestamp
, um Build-Ereignisse mit einer Anfragezeit zu filtern, um den Build am 20. Juli 2020 um 6:00 Uhr zu erstellen:
filter: build.create_time == timestamp("2020-07-20:T06:00:00Z")
Sie können Build-Ereignisse auch nach Zeitvergleichen filtern. Im folgenden Beispiel verwendet das Feld filter
timestamp
, um Build-Ereignisse mit einer Startzeit zwischen dem 20. Juli 2020, 6:00 Uhr und dem 30. Juli 2020 um 6:00 Uhr zu filtern. , um die Option zu aktivieren.
filter: timestamp("2020-07-20:T06:00:00Z") >= build.start_time && build.start_time <= timestamp("2020-07-30:T06:00:00Z")
Weitere Informationen dazu, wie Zeitzonen in CEL ausgedrückt werden, finden Sie in der Sprachdefinition für Zeitzonen.
Zum Filtern nach der Dauer eines Builds können Sie duration
verwenden, um Zeitstempel zu vergleichen.
Im folgenden Beispiel verwendet das Feld filter
duration
, um Build-Ereignisse mit Builds zu filtern, die mindestens fünf Minuten lang ausgeführt werden:
filter: build.finish_time - build.start_time >= duration("5m")
Nach Substitution filtern
Sie können nach Substitution filtern, wenn Sie die Substitutionsvariable im Feld filter
mit build.substitutions
angeben. Im folgenden Beispiel listet das Feld filter
Builds auf, die die Substitutionsvariable substitution-variable enthalten, und prüft, ob substitution-variable mit dem angegebenen substitution-value übereinstimmt:
filter: build.substitutions[substitution-variable] == substitution-value
Hierbei gilt:
substitution-variable
ist der Name der Substitutionsvariablen.substitution-value
ist der Name Ihres Substitutionswerts.
Sie können auch nach Standardwerten für Substitutionsvariablen filtern. Im folgenden Beispiel werden im Feld filter
Builds mit dem Zweignamen master
und Builds mit dem Repository-Namen github.com/user/my-example-repo
aufgelistet. Die Standardsubstitutionsvariablen BRANCH_NAME
und REPO_NAME
werden als Schlüssel an build.substitutions
übergeben:
filter: build.substitutions["BRANCH_NAME"] == "master" && build.substitutions["REPO_NAME"] == "github.com/user/my-example-repo"
Wenn Sie mithilfe von regulären Ausdrücken nach Strings filtern möchten, können Sie die integrierte Funktion matches
verwenden. Im folgenden Beispiel filtert das Feld filter
nach Builds mit dem Status FAILURE oder TIMEOUT und einer Build-Substitutionsvariablen TAG_NAME
mit einem Wert, der dem regulären Ausdruck v{DIGIT}.{DIGIT}.{3 DIGITS})
entspricht.
filter: build.status in [Build.Status.FAILURE, Build.Status.TIMEOUT] && build.substitutions["TAG_NAME"].matches("^v\\d{1}\\.\\d{1}\\.\\d{3}$")`
Eine Liste der Standardsubstitutionswerte finden Sie unter Standardsubstitutionen verwenden.
Nächste Schritte
- Cloud Build-Benachrichtigungen
- Build-Benachrichtigungen abonnieren
- Build-Konfigurationsdatei für Cloud Build schreiben