使用 Pub/Sub 消息接收事件 (gcloud CLI)

使用 Pub/Sub 消息接收事件 (gcloud CLI)

本快速入门介绍如何部署使用 Pub/Sub 接收事件的未经身份验证的 Cloud Run 服务。

注意：所有 Cloud Run 服务在默认情况下都会以私密方式部署，这意味着，如果不在请求中提供身份验证凭据，就无法访问这些服务。对于采用网域限定共享组织政策的项目，请使用经过身份验证的 Cloud Run 目标服务，而不是允许公开（未经身份验证）访问的服务。

在本快速入门中，您将执行以下操作：

1. 将事件接收器服务部署到 Cloud Run。

2. 创建 Eventarc 触发器。

3. 向 Pub/Sub 主题发布消息以生成事件，并在 Cloud Run 日志中查看事件。

准备工作

您的组织定义的安全限制条件可能会导致您无法完成以下步骤。如需了解相关问题排查信息，请参阅在受限的 Google Cloud 环境中开发应用。

1. 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手，请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金，用于运行、测试和部署工作负载。
2. 安装 Google Cloud CLI。

3. 如需初始化 gcloud CLI，请运行以下命令：

   gcloud init

4. 创建或选择 Google Cloud 项目。

   注意：如果您不打算保留在此过程中创建的资源，请创建新的项目，而不要选择现有的项目。完成本教程介绍的步骤后，您可以删除所创建的项目，并移除与该项目关联的所有资源。

   • 创建 Google Cloud 项目：

     gcloud projects create PROJECT_ID

     将 PROJECT_ID 替换为您要创建的 Google Cloud 项目的名称。

   • 选择您创建的 Google Cloud 项目：

     gcloud config set project PROJECT_ID

     将 PROJECT_ID 替换为您的 Google Cloud 项目 名称。

5. 确保您的 Google Cloud 项目已启用结算功能。

6. Enable the Cloud Run, Cloud Logging, Cloud Build, Pub/Sub, and Eventarc APIs:

   gcloud services enable run.googleapis.com logging.googleapis.com cloudbuild.googleapis.com pubsub.googleapis.com eventarc.googleapis.com

7. 安装 Google Cloud CLI。

8. 如需初始化 gcloud CLI，请运行以下命令：

   gcloud init

9. 创建或选择 Google Cloud 项目。

   注意：如果您不打算保留在此过程中创建的资源，请创建新的项目，而不要选择现有的项目。完成本教程介绍的步骤后，您可以删除所创建的项目，并移除与该项目关联的所有资源。

   • 创建 Google Cloud 项目：

     gcloud projects create PROJECT_ID

     将 PROJECT_ID 替换为您要创建的 Google Cloud 项目的名称。

   • 选择您创建的 Google Cloud 项目：

     gcloud config set project PROJECT_ID

     将 PROJECT_ID 替换为您的 Google Cloud 项目 名称。

10. 确保您的 Google Cloud 项目已启用结算功能。

11. Enable the Cloud Run, Cloud Logging, Cloud Build, Pub/Sub, and Eventarc APIs:

    gcloud services enable run.googleapis.com logging.googleapis.com cloudbuild.googleapis.com pubsub.googleapis.com eventarc.googleapis.com

12. 更新 Google Cloud CLI 组件：

    gcloud components update

13. 使用您的账号登录：

    gcloud auth login

14. 设置本快速入门中使用的配置变量：

    gcloud config set run/region us-central1
    gcloud config set run/platform managed
    gcloud config set eventarc/location us-central1
    

15. 如果您是项目创建者，则会被授予基本 Owner 角色 (roles/owner)。默认情况下，此 Identity and Access Management (IAM) 角色可提供完全访问大多数 Google Cloud 资源所需的权限，您可以跳过此步骤。

    如果您不是项目创建者，则必须向主账号授予项目的必需权限。例如，主账号可以是 Google 账号（针对最终用户）或服务账号（针对应用和计算工作负载）。如需了解详情，请参阅事件目标位置的角色和权限页面。

    所需权限

    如需获得完成本快速入门所需的权限，请让您的管理员为您授予项目的以下 IAM 角色：

    • Cloud Build Editor (roles/cloudbuild.builds.editor)
    • Cloud Run Admin (roles/run.admin)
    • Eventarc Admin (roles/eventarc.admin)
    • Logs View Accessor (roles/logging.viewAccessor)
    • Project IAM Admin (roles/resourcemanager.projectIamAdmin)
    • Pub/Sub Publisher (roles/pubsub.publisher)
    • Service Account Admin (roles/iam.serviceAccountAdmin)
    • Service Account User (roles/iam.serviceAccountUser)
    • Service Usage Admin (roles/serviceusage.serviceUsageAdmin)
    • Storage Admin (roles/storage.admin)

    如需详细了解如何授予角色，请参阅管理访问权限。

    您也可以通过自定义角色或其他预定义角色来获取所需的权限。

16. 如果您在 2021 年 4 月 8 日或之前启用了 Cloud Pub/Sub 服务代理，以支持经过身份验证的 Pub/Sub 推送请求，请向 Google 管理的服务账号授予 Service Account Token Creator 角色 (roles/iam.serviceAccountTokenCreator)。否则，系统会默认授予此角色：

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

将 PROJECT_NUMBER 替换为您的 Google Cloud 项目编号。您可以在 Google Cloud 控制台的欢迎页面上或者通过运行以下命令找到项目编号：

gcloud projects describe PROJECT_ID --format='value(projectNumber)'

将事件接收器部署到 Cloud Run

部署接收和记录事件的 Cloud Run 服务。

1. 克隆代码库：

   Node.js

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   Python

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   Go

   git clone https://github.com/GoogleCloudPlatform/golang-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   Java

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   Ruby

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

   C#

   git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git

   或者，您也可以下载该示例的 zip 文件并将其解压缩。

2. 切换到包含 Cloud Run 示例代码的目录：

   Node.js

   cd nodejs-docs-samples/eventarc/pubsub/

   Python

   cd python-docs-samples/eventarc/pubsub/

   Go

   cd golang-samples/eventarc/pubsub/

   Java

   cd java-docs-samples/eventarc/pubsub/

   Ruby

   cd ruby-docs-samples/eventarc/pubsub/

   C#

   cd dotnet-docs-samples/eventarc/pubsub/

3. 构建容器并将其上传到 Cloud Build：

   gcloud builds submit --tag gcr.io/$(gcloud config get-value project)/events-pubsub
   

4. 将容器映像部署到 Cloud Run：

   gcloud run deploy helloworld-events-pubsub-quickstart \
       --image gcr.io/$(gcloud config get-value project)/events-pubsub \
       --allow-unauthenticated
   

当您看到服务网址时，表示部署完成。

创建 Eventarc 触发器

当消息发布到 Pub/Sub 主题时，事件触发器会将消息发送到部署在 Cloud Run 上的事件接收器服务。

1. 创建一个触发器来监听 Pub/Sub 消息：

   新的 Pub/Sub 主题

   gcloud eventarc triggers create events-pubsub-trigger \
       --destination-run-service=helloworld-events-pubsub-quickstart \
       --destination-run-region=us-central1 \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished"
   

   这会创建一个新的 Pub/Sub 主题和一个名为 events-pubsub-trigger 的触发器。

   现有 Pub/Sub 主题

   gcloud eventarc triggers create events-pubsub-trigger \
       --destination-run-service=helloworld-events-pubsub-quickstart \
       --destination-run-region=us-central1 \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --transport-topic=projects/PROJECT_ID/topics/TOPIC_ID
   

   替换以下内容：

   • PROJECT_ID：您的 Google Cloud 项目 ID
   • TOPIC_ID：现有 Pub/Sub 主题的 ID

   这将为现有 Pub/Sub 主题创建一个名为 events-pubsub-trigger 的触发器。

   请注意，首次在 Google Cloud 项目中创建 Eventarc 触发器时，预配 Eventarc 服务代理可能会有延迟。通常，您可以尝试再次创建触发器，以解决此问题。如需了解详情，请参阅权限遭拒错误。

2. 确认触发器已成功创建：

   gcloud eventarc triggers list --location=us-central1
   

   events-pubsub-trigger 列出的目标位置是 Cloud Run 服务 helloworld-events-pubsub-quickstart。

注意：尽管触发器会立即创建，但它最长可能需要两分钟才能完全正常运行。

生成并查看 Pub/Sub 主题事件

您可以通过向 Pub/Sub 主题发布消息来生成 Eventarc 事件。

1. 查找 Pub/Sub 主题并将其设置为环境变量：

   export RUN_TOPIC=$(gcloud eventarc triggers describe events-pubsub-trigger \
       --format='value(transport.pubsub.topic)')
   

2. 向 Pub/Sub 主题发布消息以生成事件：

   gcloud pubsub topics publish $RUN_TOPIC --message "Runner"
   

   事件会被路由到 Cloud Run 服务，该服务会记录事件消息。

3. 如需查看服务创建的与事件相关的日志条目，请运行以下命令：

   gcloud logging read 'textPayload: "Hello, Runner!"'
   

4. 查找类似如下的日志条目：

   "textPayload": "Hello, Runner! ID: 7479199264356846"
   

   注意：如果您没有看到日志条目，请等待几分钟，然后重试 gcloud logging read 命令。触发器创建后可能最长需要两分钟才能开始过滤事件。

恭喜！您已成功将事件接收器服务部署到 Cloud Run，创建 Eventarc 触发器，在 Pub/Sub 中生成事件并在 Cloud Run 日志中查看该事件。

清理

虽然当服务未在使用时 Cloud Run 不会产生费用，但您可能仍然需要为在 Container Registry 中存储容器映像、Eventarc 资源以及 Pub/Sub 消息付费。

您可以删除映像、删除 Pub/Sub 主题以及删除 Pub/Sub 订阅。要删除 Eventarc 触发器，请运行以下命令：

gcloud eventarc triggers delete events-pubsub-trigger

或者，您也可以删除 Google Cloud 项目，以避免产生费用。删除 Google Cloud 项目后，系统会停止对该项目中使用的所有资源计费。

警告：删除项目会产生以下影响

• 项目中的所有内容都会被删除。如果您将现有项目用于本文档中的任务，则删除该项目后，还将删除您已在该项目中完成的任何其他工作。
• 自定义项目 ID 丢失。创建此项目时，您可能创建了要在将来使用的自定义项目 ID。要保留使用该项目 ID 的网址（例如 appspot.com 网址），请删除项目内的所选资源，而不是删除整个项目。

删除 Google Cloud 项目：

gcloud projects delete PROJECT_ID

后续步骤

• 使用经过身份验证的 Cloud Run 服务接收 Pub/Sub 事件
• 构建容器
• 开发 Cloud Run 服务