HTTP-Benachrichtigungen konfigurieren

Cloud Build kann Ihnen Benachrichtigungen an ausgewählte 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 HTTP-Notifier konfigurieren.

Hinweise

• Enable the Cloud Build, Cloud Run, and Pub/Sub APIs.

  Roles required to enable APIs

  To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

  Enable the APIs

• Installieren Sie die Google Cloud CLI.

HTTP-Benachrichtigungen konfigurieren

Im folgenden Abschnitt wird erläutert, wie Sie HTTP-Benachrichtigungen manuell mit dem HTTP-Notifier konfigurieren, um POST-Anfragen an eine bestimmte Empfänger-URL zu senden. Wenn Sie stattdessen die Konfiguration automatisieren möchten, finden Sie weitere Informationen unter Konfiguration für Benachrichtigungen automatisieren.

So konfigurieren Sie HTTP-Benachrichtigungen:

So verwenden Sie den HTTP-Notifier, um POST-Anfragen an eine bestimmte Empfänger-URL zu senden:

1. Gewähren Sie Ihrem Cloud Run-Dienstkonto die Berechtigung zum Lesen aus Cloud Storage-Buckets:

   1. Rufen Sie in der Google Cloud -Console die IAM-Seite auf:

      Seite "IAM" öffnen

   2. Suchen Sie das Compute Engine-Standarddienstkonto, das mit Ihrem Projekt verknüpft ist:

      Ihr Compute Engine-Standarddienstkonto sieht in etwa so aus:

      [e-mail]
      

   3. Klicken Sie in der Zeile mit dem Compute Engine-Standarddienstkonto auf das Stiftsymbol. Der Tab Zugriff bearbeiten wird angezeigt.

   4. Klicken Sie auf Weitere Rolle hinzufügen.

   5. Fügen Sie die folgende Rolle hinzu:

      • Storage-Objekt-Betrachter
      Hinweis: Wenn Sie Berechtigungen auf Bucket-Ebene statt auf Projektebene gewähren möchten, fügen Sie die Rolle Inhaber alter Storage-Objekte zum Bucket hinzu, wenn Sie diesen erstellen. Weitere Informationen finden Sie unter Rollen auf Projektebene im Vergleich zu Rollen auf Bucket-Ebene.

   6. Klicken Sie auf Speichern.

2. Schreiben Sie eine Konfigurationsdatei, um Ihren HTTP-Notifier zu konfigurieren und Build-Ereignisse zu filtern:

   In der folgenden Beispiel-Notifier-Konfigurationsdatei wird im Feld filter die Common Expression Language mit der verfügbaren Variable build verwendet, um Build-Ereignisse mit dem Status SUCCESS zu filtern:

   apiVersion: cloud-build-notifiers/v1
   kind: HTTPNotifier
   metadata:
     name: example-http-notifier
   spec:
     notification:
       filter: build.status == Build.Status.SUCCESS
       params:
         buildStatus: $(build.status)
       delivery:
         # The `http(s)://` protocol prefix is required.
         url: url
       template:
         type: golang
         uri: gs://bucket_name/http.json
   

   Wobei:

   • buildStatus ist ein benutzerdefinierter Parameter. Dieser Parameter übernimmt den Wert von $(build.status), dem Status des Builds.
   • url ist die Konfigurationsvariable, die in diesem Beispiel verwendet wird, um die URL für Ihre Anfrage anzugeben.
   • bucket-name ist der Name des Buckets.
   • url ist die URL, die Sie als Empfängerserver angeben möchten.

   • Das Feld uri verweist auf die Datei http.json. Diese Datei verweist auf eine in Cloud Storage gehostete JSON-Vorlage und stellt die JSON-Nutzlast für den Webhook-Endpunkt dar.

     Experimentell – Customizing notifications using templates

     Diese Funktion unterliegt den „Pre-GA-Angebotsbedingungen“ im Abschnitt „Allgemeine Dienstbedingungen“ der dienstspezifischen Nutzungsbedingungen. Pre-GA-Funktionen sind „wie gesehen“ verfügbar und bieten möglicherweise nur eingeschränkten Support. Weitere Informationen finden Sie in den Beschreibungen der Produkteinführungsphasen.

     Ein Beispiel für eine Vorlagendatei finden Sie im Repository „cloud-build-notifiers“ in der Datei http.json.

   Das Beispiel finden Sie in der entsprechenden Konfigurationsdatei für den HTTP-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.

3. Laden Sie die Notifier-Konfigurationsdatei in einen Cloud Storage-Bucket hoch:

   1. Wenn Sie keinen Cloud Storage-Bucket haben, führen Sie den folgenden Befehl aus, um einen Bucket zu erstellen. Dabei ist bucket-name der Name, den Sie Ihrem Bucket gemäß den Vorgaben für die Benennung geben sollten.

      gcloud storage buckets create gs://bucket-name/
      

   2. 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 der Konfigurationsdatei für den Notifier.

4. Stellen Sie den Notifier in Cloud Run bereit.

    gcloud run deploy service-name \
      --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/http:latest \
      --no-allow-unauthenticated \
      --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 HTTP-Benachrichtigungen gs://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 Attribut image Ihres gcloud run deploy-Befehls angeben. Ältere Image-Versionen und Tags finden Sie in Artifact Registry.

   Hinweis: Bei der Ausführung dieses Befehls werden Sie möglicherweise aufgefordert, zusätzliche Argumente wie --region oder --platform anzugeben. Weitere Informationen zu den Parametern, die Sie an den Befehl gcloud run deploy übergeben können, finden Sie unter In Cloud Run bereitstellen. Wenn Sie den Notifier mit diesem Befehl nicht bereitstellen können, lesen Sie die Anleitung zur Fehlerbehebung in Cloud Run. Hier finden Sie Lösungen zum Beheben von Bereitstellungsfehlern.

5. Gewähren Sie Pub/Sub-Berechtigungen zum Erstellen von Authentifizierungstokens in Ihrem Google Cloud Projekt:

    gcloud projects add-iam-policy-binding project-id \
      --member=serviceAccount:[e-mail] \
      --role=roles/iam.serviceAccountTokenCreator
   

   Wobei:

   • project-id ist die ID des Google Cloud -Projekts.
   • project-number ist Ihre Google Cloud Projektnummer.
   Hinweis: Wenn das Pub/Sub-Dienstkonto in Ihrem Projekt nicht vorhanden ist, lesen Sie den Abschnitt Abos erstellen und verwenden.

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

7. Weisen Sie dem Dienstkonto cloud-run-pubsub-invoker die Cloud Run-Berechtigung Invoker zu:

   gcloud run services add-iam-policy-binding service-name \
      --member=serviceAccount:[e-mail] \
      --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.

8. Erstellen Sie das Thema cloud-builds, um Build-Update-Nachrichten für Ihren Notifier zu erhalten:

   gcloud pubsub topics create cloud-builds
   

   Sie können auch einen benutzerdefinierten Themennamen in Ihrer Build-Konfigurationsdatei definieren, damit Nachrichten stattdessen an das benutzerdefinierte Thema gesendet werden. In diesem Fall würden Sie ein Thema mit demselben benutzerdefinierten Namen erstellen:

   gcloud pubsub topics create topic-name
   

   Weitere Informationen finden Sie unter Pub/Sub-Themen für Build-Benachrichtigungen.

9. 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=[e-mail]
   

   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. Beim nächsten Aufruf eines Builds empfängt der HTTP-Server des Empfängers unter der angegebenen URL JSON-Nutzlasten, die mit der Ressource Build übereinstimmen, 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, die dem Feld zugeordnet ist, finden Sie in der Datei cloudbuild.proto.

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

Hinweis: Die Trigger-ID ist nicht der Name des Triggers. Führen Sie den folgenden Befehl aus, um die Trigger-ID abzurufen: gcloud beta builds triggers describe trigger-name, wobei trigger-name der Name Ihres Triggers ist. Der Befehl listet die Felder auf, die dem Trigger zugeordnet sind, einschließlich der 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

Wenn Sie nach Images filtern möchten, geben Sie den Wert Ihres Images im Feld filter mit build.images an, wobei image-name der vollständige Name des Images 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, in denen entweder us-east1-docker.pkg.dev/my-project/docker-repo/image-one oder us-east1-docker.pkg.dev/my-project/docker-repo/image-two als Bildnamen angegeben ist:

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")

Hinweis :Zeitstempel werden im RFC 3339-UTC-"Zulu"-Format mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen angegeben.

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

• Informationen zu Cloud Build-Benachrichtigungen
• Build-Benachrichtigungen abonnieren
• Build-Konfigurationsdatei für Cloud Build schreiben