配置 HTTP 通知

Cloud Build 可以通过向您的所需渠道（例如 Slack 或 SMTP 服务器）发送通知来通知您构建更新。本页介绍如何使用 HTTP 通知程序配置通知。

准备工作

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

    Enable the APIs

配置 HTTP 通知

以下部分介绍如何使用 HTTP 通知程序来手动配置 HTTP 通知，以向指定的收件人网址发送 POST 请求。如果您希望改为自动配置，请参阅自动配置通知。

如需配置 HTTP 通知，请执行以下操作：

如需使用HTTP 通知程序向给定收件人网址发送 POST 请求，请执行以下操作：

  1. 向 Cloud Run 服务账号授予读取 Cloud Storage 存储桶中内容的权限：

    1. 转到 Google Cloud 控制台中的 IAM 页面：

      打开 IAM 页面

    2. 找到与您的项目关联的 Compute Engine 默认服务账号：

      您的 Compute Engine 默认服务账号将如下所示：

      project-number-compute@developer.gserviceaccount.com

    3. 点击您的 Compute Engine 默认服务账号所在行中的铅笔图标。您会看到修改访问权限标签页。

    4. 点击添加其他角色。

    5. 添加以下角色：

      • Storage Object Viewer

    6. 点击保存。

  2. 编写通知程序配置文件以配置您的 HTTP 通知程序并过滤构建事件：

    在以下示例通知程序配置文件中，filter 字段使用通用表达式语言和可用变量 build 来过滤状态为 SUCCESS 的构建事件：

    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://example-gcs-bucket/http.json

    其中：

    • buildStatus 是用户定义的参数。此参数采用 $(build.status) 的值，即 build 的状态。
    • url 是此示例中用于指定请求网址的配置变量。
    • url 是您想要指定为收件人服务器的网址。

    • uri 字段引用 http.json 文件。此文件引用了 Cloud Storage 上托管的 JSON 模板，表示 webhook 端点的 json 载荷。

      如需查看模板文件的示例，请参阅 cloud-build-notifiers 代码库中的 http.json 文件。

    如需查看此示例，请参阅 HTTP 通知程序的通知程序配置文件。

    如需了解可用于过滤的其他字段，请参阅构建资源。如需了解其他过滤示例，请参阅使用 CEL 过滤构建事件。

  3. 将通知程序配置文件上传到 Cloud Storage 存储分区

    1. 如果没有 Cloud Storage 存储分区，请运行以下命令创建一个存储分区，其中 bucket-name 是您想要为存储分区指定的名称（须遵循命名要求部分）。

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

    2. 将通知程序配置文件上传到您的存储分区：

      gcloud storage cp config-file-name gs://bucket-name/config-file-name

      其中：

      • bucket-name 是您的存储分区的名称。
      • config-file-name 是通知程序配置文件的名称。

  4. 将通知程序部署到 Cloud Run：

     gcloud run deploy service-name \
   --image=us-east1-docker.pkg.dev/gcb-release/cloud-build-notifiers/http:latest \
   --update-env-vars=CONFIG_PATH=config-path,PROJECT_ID=project-id

    其中：

    • service-name 是您要将映像部署到的 Cloud Run 服务的名称。

    • config-path 是 HTTP 通知程序 gs://bucket-name/config-file-name 的配置文件的路径。

    • project-id 是您的 Google Cloud 项目的 ID。

    gcloud run deploy 命令会从 Cloud Build 拥有的 Artifact Registry 拉取最新版本的托管映像。Cloud Build 支持通知程序映像 9 个月。9 个月后，Cloud Build 会删除映像版本。如果您想使用旧的映像版本，则需要在 gcloud run deploy 命令的 image 属性中指定映像标记的完整语义版本。您可以在 Artifact Registry 中找到以前的映像版本和标记。

  5. 授予 Pub/Sub 在项目中创建身份验证令牌的权限：

     gcloud projects add-iam-policy-binding project-id \
   --member=serviceAccount:service-project-number@gcp-sa-pubsub.iam.gserviceaccount.com \
   --role=roles/iam.serviceAccountTokenCreator

    其中：

    • project-id 是您的 Google Cloud 项目的 ID。
    • project-number 是您的 Google Cloud 项目编号。

  6. 创建一个服务账号以表示您的 Pub/Sub 订阅身份：

    gcloud iam service-accounts create cloud-run-pubsub-invoker \
  --display-name "Cloud Run Pub/Sub Invoker"

    您可以使用 cloud-run-pubsub-invoker或使用在您的 Google Cloud 项目中唯一的名称。

  7. 向 cloud-run-pubsub-invoker 服务账号授予 Cloud Run Invoker 权限：

    gcloud run services add-iam-policy-binding service-name \
   --member=serviceAccount:cloud-run-pubsub-invoker@project-id.iam.gserviceaccount.com \
   --role=roles/run.invoker

    其中：

    • service-name 是您要将映像部署到的 Cloud Run 服务的名称。
    • project-id 是您的 Google Cloud 项目的 ID。

  8. 创建 cloud-builds 主题以接收通知程序的构建更新消息：

    gcloud pubsub topics create cloud-builds

  9. 为通知程序创建 Pub/Sub 推送订阅者：

     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

    其中：

    • subscriber-id 是您要为订阅指定的名称。
    • service-url是 Cloud Run 为新服务生成的网址。
    • project-id 是您的 Google Cloud 项目的 ID。

您的 Cloud Build 项目的通知现已设置完毕。下一个 调用构建时，给定网址上的收件人 HTTP 服务器将收到 与 Build 匹配的 JSON 载荷 资源。

使用 CEL 过滤构建事件

Cloud Build 在构建资源中列出的字段上搭配使用 CEL 与变量 build，以便访问与构建事件关联的字段，例如触发器 ID、图片列表或替换值。您可以使用 filter 字符串，通过构建资源中列出的任何字段，来过滤通构建配置文件中的构建事件。要查找与您的字段相关的确切语法，请参阅 cloudbuild.proto 文件。

按触发器 ID 过滤

要按触发器 ID 过滤，请使用 build.build_trigger_id 在 filter 字段中指定触发器 ID 的值，其中 trigger-id 是字符串形式的触发器 ID：

filter: build.build_trigger_id == trigger-id

按状态过滤

要按状态过滤，请使用 build.status 在 filter 字段中指定要过滤的构建状态。

以下示例展示了如何使用 filter 字段过滤状态为 SUCCESS 的构建事件：

filter: build.status == Build.Status.SUCCESS

您也可以过滤具有不同状态的构建。以下示例展示了如何使用 filter 字段过滤状态为 SUCCESS、FAILURE 或 TIMEOUT 的构建事件：

filter: build.status in [Build.Status.SUCCESS, Build.Status.FAILURE, Build.Status.TIMEOUT]

要查看您可以作为过滤依据的其他状态值，请参阅“构建资源参考”下的状态。

按标记过滤

要按标记过滤，请使用 build.tags 在 filter 字段中指定标记的值，其中 tag-name 是标记的名称：

filter: tag-name in build.tags

您可以使用 size 根据构建事件中指定的标记数量进行过滤。在以下示例中，filter 字段会过滤仅指定了两个标记且其中一个标记指定为 v1 的构建事件：

filter: size(build.tags) == 2 && "v1" in build.tags

按图片过滤

如需按映像过滤，请使用 build.images 在 filter 字段中指定映像的值，其中 image-name 是 Artifact Registry 中列出的映像的全名，例如 us-east1-docker.pkg.dev/my-project/docker-repo/image-one：

filter: image-name in build.images

在以下示例中，filter 会过滤将 us-east1-docker.pkg.dev/my-project/docker-repo/image-one 或 us-east1-docker.pkg.dev/my-project/docker-repo/image-two 指定为映像名称的构建事件：

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

按时间过滤

您可以在 filter 字段中指定以下某个选项，以根据构建的创建时间、开始时间或结束时间过滤构建事件：build.create_time、build.start_time 或 build.finish_time。

在以下示例中，filter 字段会使用 timestamp 来过滤创建构建的请求时间为 2020 年 7 月 20 日上午 6:00 的构建事件。

filter: build.create_time == timestamp("2020-07-20:T06:00:00Z")

您还可以按时间比较过滤构建事件。在以下示例中，filter 字段会使用 timestamp 过滤开始时间介于 2020 年 7 月 20 日上午 6:00 到 2020 年 7 月 30 日上午 6:00 之间的构建事件。

filter: timestamp("2020-07-20:T06:00:00Z") >= build.start_time && build.start_time <= timestamp("2020-07-30:T06:00:00Z")

如需详细了解 CEL 中的时区表示方式，请参阅时区的语言定义。

要按构建的持续时间进行过滤，您可以使用 duration 比较时间戳。 在以下示例中，filter 字段会使用 duration 过滤包含至少运行了五分钟的构建的构建事件：

filter: build.finish_time - build.start_time >= duration("5m")

按替换过滤

您可以使用 build.substitutions 在 filter 字段中指定替换变量，从而按替换进行过滤。在以下示例中，filter 字段会列出包含替代变量 substitution-variable 的构建，并检查 substitution-variable 是否与指定的 substitution-value 匹配：

filter: build.substitutions[substitution-variable] == substitution-value

其中：

  • substitution-variable 是替代变量的名称。
  • substitution-value 是替代变量值的名称。

您还可以按默认替换变量值进行过滤。在下面的示例中，filter 字段列出分支名称为 master 的构建，以及代码库名称为 github.com/user/my-example-repo 的构建。默认替换变量 BRANCH_NAME 和 REPO_NAME 将作为密钥传递给 build.substitutions：

filter: build.substitutions["BRANCH_NAME"] == "master" && build.substitutions["REPO_NAME"] == "github.com/user/my-example-repo"

如果要使用正则表达式过滤字符串，则可以使用内置的 matches 函数。在以下示例中，filter 字段过滤状态为 FAILURE 或 TIMEOUT 的构建，并且有一个构建替代变量 TAG_NAME，以及一个与正则表达式 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}$")

要查看默认替换值的列表，请参阅使用默认替换。

后续步骤