将 Firebase Alerts 事件路由到 GKE

Eventarc 触发器声明您对某个事件或一系列事件感兴趣。如需配置事件路由，您可以为触发器指定过滤条件，包括事件来源以及在 Google Kubernetes Engine (GKE) 集群中运行的目标 GKE 服务。请注意，目标只能包含在具有公共端点的（公共或专用）GKE 集群中运行的服务。如需定位具有专用端点的 GKE 集群中的服务，请将事件路由到内部 HTTP 端点。

Eventarc 通过 HTTP 请求以 CloudEvents 格式将事件传送到事件接收器。

以下说明介绍如何配置到 GKE 服务的事件路由（由直接Firebase Alerts 事件触发）。如需了解详情，请参阅支持的直接事件列表。

准备工作

您必须在运行目标服务的 GKE 集群上启用 Workload Identity Federation for GKE。正确设置事件转发器需要使用 Workload Identity Federation for GKE，由于 Workload Identity Federation for GKE 增强的安全属性和可管理性，因此它是从 GKE 中运行的应用访问 Google Cloud 服务的推荐方法。

Eventarc 事件到 GKE 目标架构

Workload Identity Federation for GKE

在 GKE 上运行的应用可能需要访问 Google Cloud API。Workload Identity Federation for GKE 支持 GKE 集群中的 Kubernetes 服务账号充当 IAM 服务账号。访问 Google Cloud API 时，使用已配置的 Kubernetes 服务账号的 Pod 会自动以 IAM 服务账号身份进行身份验证。利用 Workload Identity Federation for GKE，您可以为集群中的每个应用分配不同的精细身份和授权。请注意，您必须向 Eventarc 触发器的服务账号授予特定权限。在本文档中，请参阅创建服务账号的步骤。

如需详细了解如何在 GKE 集群上启用和配置 Workload Identity Federation for GKE，请参阅使用 Workload Identity Federation for GKE。

事件转发器

Eventarc 的事件转发器会从 Eventarc 拉取新事件并将其转发到 GKE 目标。此组件充当 Pub/Sub 传输层与 GKE 服务之间的中介。它适用于现有服务，还支持信令服务（包括未在全代管式集群外部公开的服务），同时简化设置和维护。 在网络级层，如需接收 GKE 服务中的事件，您无需向外部流量开放服务，因为所有事件都从位于同一 GKE 集群中的来源传送。

请注意，事件转发器的生命周期由 Eventarc 管理，如果您不小心删除了事件转发器，Eventarc 将恢复此组件。

对于指向 GKE 目标的每个触发器，事件转发器（专门配置的 gke-forwarder Pod）会执行以下操作：

  1. 事件转发器使用 Pub/Sub API 打开与触发器传输器（Pub/Sub 主题和订阅）的 StreamingPull 连接，并在事件可用时接收事件。

  2. 事件转发器将事件转换为正确的 CloudEvents 格式，对其进行编码并将其作为 HTTP POST 请求传送到目标 GKE 服务。

Eventarc 服务代理需要运行并定期更新 gke-forwarder 实例的权限。您必须为每个项目授予一次此权限。如需了解详情，请参阅本文档中的启用 GKE 目标。

准备创建触发器

对于以 GKE 服务为目标的每个触发器，Eventarc 会创建一个事件转发器组件。Eventarc 需要具有在 GKE 集群中安装组件和管理资源的权限。在为 GKE 目标创建 Eventarc 触发器之前，请务必完成以下任务。

控制台

  1. 在 Google Cloud 控制台的“项目选择器”页面上，选择或创建 Google Cloud 项目。

    转到“项目选择器”

  2. 启用 Eventarc API、Eventarc Publishing API、Google Kubernetes Engine API 和 Resource Manager API。

    启用 API

  3. 如果适用，请启用与直接事件相关的 API。例如，对于 Firebase Alerts 事件，请启用Firebase Alerts API。

  4. 如果您还没有用户管理的服务账号，请创建一个，然后为其授予必要的角色和权限，以便 Eventarc 可以管理目标服务的事件。

    1. 在 Google Cloud 控制台中，进入创建服务账号页面。

      转到“创建服务账号”

    2. 选择您的项目。

    3. 在服务账号名称字段中，输入一个名称。Google Cloud 控制台会根据此名称填充服务账号 ID 字段。

      在服务账号说明字段中，输入说明。例如 Service account for event trigger。

    4. 点击创建并继续。

    5. 如需提供适当的访问权限，请在选择角色列表中，选择要向服务账号授予的所需 Identity and Access Management (IAM) 角色。如需了解详情，请参阅 GKE 目标的角色和权限。

      如需添加其他角色，请点击 添加其他角色，然后添加其他各个角色。

    6. 点击继续。

    7. 如需完成账号的创建过程，请点击完成。

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. 启用 Eventarc API、Eventarc Publishing API、Google Kubernetes Engine API 和 Resource Manager API。

    gcloud services enable eventarc.googleapis.com \
    eventarcpublishing.googleapis.com \
    container.googleapis.com \
    cloudresourcemanager.googleapis.com

  3. 如果适用，请启用与直接事件相关的 API。例如，对于 Firebase Alerts 事件，请启用 firestore.googleapis.com。

  4. 如果您还没有用户管理的服务账号，请创建一个，然后为其授予必要的角色和权限，以便 Eventarc 可以管理目标 GKE 目标的事件。

    1. 创建服务账号：

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      将 SERVICE_ACCOUNT_NAME 替换为服务账号的名称。该名称必须介于 6 到 30 个字符之间，且可以包含小写字母数字字符和短划线。在服务账号创建完毕后，无法再更改其名称。

    2. 授予所需的 Identity and Access Management (IAM) 角色或权限。如需了解详情，请参阅 GKE 目标的角色和权限。

启用 GKE 目标

如需允许 Eventarc 管理 GKE 集群中的资源，请启用 GKE 目标，并将 Eventarc 服务代理与所需的角色绑定。

  1. 为 Eventarc 启用 GKE 目标：

    gcloud eventarc gke-destinations init

  2. 在系统提示绑定所需角色时，输入 y。

    绑定以下角色：

    • roles/compute.viewer
    • roles/container.developer
    • roles/iam.serviceAccountAdmin

创建触发器

您可以使用 Google Cloud CLI 或通过 Google Cloud 控制台创建 Eventarc 触发器。

控制台

  1. 在 Google Cloud 控制台中，进入 Eventarc 触发器页面。

    转到“触发器”

  2. 点击 创建触发器。
  3. 输入触发器名称。

    这是触发器的 ID，必须以字母开头。最多可包含 63 个小写字母、数字或连字符。

  4. 在触发器类型部分，选择 Google 来源。
  5. 在事件提供方列表中，选择 Firebase Alerts。

    请注意，关联的 Google Cloud 文档中使用的事件提供方名称可能没有 Cloud 或 Google Cloud 前缀。例如，在控制台中，Memorystore for Redis 称为 Google Cloud Memorystore for Redis。

  6. 在事件类型列表中，从“直接”事件中选择事件类型。
  7. 如需指定事件载荷的编码，请在事件数据内容类型列表中选择 application/json 或 application/protobuf。

    请注意，采用 JSON 格式的事件载荷大于采用 Protobuf 格式的事件载荷。这可能会影响可靠性，具体取决于您的事件目标及其事件大小限制。如需了解详情，请参阅已知问题。

  8. 在区域列表中，选择 global（全球）。

    如需了解详情，请参阅 Eventarc 位置。

  9. 在属性 1 字段中，alerttype 资源 ID 充当事件过滤条件。选择此过滤条件的运算符：
  10. 在属性值 1 字段中，输入以下值之一：
    • appDistribution.inAppFeedback：测试人员在给定应用中提交应用内反馈时发送事件
    • appDistribution.newTesterIosDevice：为给定应用注册新的 iOS 测试人员设备时发送事件
    • billing.planAutomatedUpdate：在 Firebase 项目的结算方案自动更新时发送事件；例如，当某个方案因付款问题而降级时
    • billing.planUpdate：在用户修改 Firebase 项目的结算方案时发送事件；例如，当结算账号附加到项目或与项目分离时
    • crashlytics.missingSymbolFile：在 Firebase Crashlytics 确定没有适当的调试符号来对传入的崩溃报告进行符号化解析时发送事件
    • crashlytics.newAnrIssue：在应用遇到新的应用无响应 (ANR) 错误（而非任何后续相同事件）时发送事件
    • crashlytics.newFatalIssue：在应用遇到新的严重崩溃（而非任何后续相同事件）时发送事件
    • crashlytics.newNonfatalIssue：在应用遇到新的非严重错误（而非任何后续相同事件）时发送事件
    • crashlytics.regression：在应用因遇到已针对先前的应用版本标记为已解决的问题而发生崩溃时发送事件
    • crashlytics.stabilityDigest：在 Crashlytics 中出现热门问题通知时发送事件
    • crashlytics.velocity：在单个问题导致大量应用会话崩溃时发送事件
    • performance.threshold：当指标性能超出设定的阈值时发送事件
  11. （可选）您可以过滤特定 Firebase 应用 ID 的事件。 点击 添加过滤条件并指定 appid。
  12. 选择将调用您的服务或工作流的服务账号。

    或者，您可以创建新的服务账号。

    这用于指定与触发器相关联且您之前向其授予 Eventarc 所需的特定角色的 Identity and Access Management (IAM) 服务账号电子邮件。

  13. 在事件目的地列表中，选择 Kubernetes Engine。
  14. 选择一项服务。

    这是接收触发器事件的服务的名称。该服务必须与触发器位于同一项目中，并在事件生成时，接收作为 HTTP POST 请求发送到其根网址路径 (/) 的事件。

  15. （可选）您可以指定将传入请求发送到的服务网址路径。

    这是触发器的事件应该发送到的目的地服务上的相对路径。例如：/、/route、route、route/subroute。

  16. 点击创建。

    17. 创建触发器之后，您便无法修改事件来源过滤条件。请创建新触发器，并删除旧触发器。 如需了解详情，请参阅管理触发器。

gcloud

您可以通过运行包含必需和可选标志的 gcloud eventarc triggers create 命令来创建触发器。

gcloud eventarc triggers create TRIGGER \
    --location=global \
    --destination-gke-cluster=DESTINATION_GKE_CLUSTER \
    --destination-gke-location=DESTINATION_GKE_LOCATION \
    --destination-gke-namespace=DESTINATION_GKE_NAMESPACE \
    --destination-gke-service=DESTINATION_GKE_SERVICE \
    --destination-gke-path=DESTINATION_GKE_PATH \
    --event-filters="type=google.firebase.firebasealerts.alerts.v1.published" \
    --event-filters="alerttype=ALERT_TYPE" \
    --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

替换以下内容：

  • TRIGGER：触发器的 ID 或完全限定标识符
  • DESTINATION_GKE_CLUSTER：运行接收事件的目标 GKE 服务的 GKE 集群的名称。
  • DESTINATION_GKE_LOCATION：（可选）在其中运行目标 GKE 服务的 GKE 集群的 Compute Engine 区域。如果未指定，系统会假定该集群是区域级集群，并且与触发器位于同一区域。
  • DESTINATION_GKE_NAMESPACE：（可选）运行目标 GKE 服务的命名空间。如果未指定，则使用 default 命名空间。
  • DESTINATION_GKE_SERVICE：接收触发器事件的 GKE 服务名称。该服务可以位于任何 GKE 支持位置，无需与触发器位于同一位置。但是，该服务必须与触发器位于同一项目中，并在事件生成时，接收作为 HTTP POST 请求发送到其根网址路径 (/) 的事件。
  • DESTINATION_GKE_PATH：（可选）您在目标 GKE 服务上指定的相对路径，触发器的事件应发送到该路径。例如：/、/route、route、route/subroute。
  • ALERT_TYPE：Firebase 提醒的类型，可以是以下值之一：
    • appDistribution.inAppFeedback：测试人员在给定应用中提交应用内反馈时发送事件
    • appDistribution.newTesterIosDevice：为给定应用注册新的 iOS 测试人员设备时发送事件
    • billing.planAutomatedUpdate：在 Firebase 项目的结算方案自动更新时发送事件；例如，当某个方案因付款问题而降级时
    • billing.planUpdate：在用户修改 Firebase 项目的结算方案时发送事件；例如，当结算账号附加到项目或与项目分离时
    • crashlytics.missingSymbolFile：在 Firebase Crashlytics 确定没有适当的调试符号来对传入的崩溃报告进行符号化解析时发送事件
    • crashlytics.newAnrIssue：在应用遇到新的应用无响应 (ANR) 错误（而非任何后续相同事件）时发送事件
    • crashlytics.newFatalIssue：在应用遇到新的严重崩溃（而非任何后续相同事件）时发送事件
    • crashlytics.newNonfatalIssue：在应用遇到新的非严重错误（而非任何后续相同事件）时发送事件
    • crashlytics.regression：在应用因遇到已针对先前的应用版本标记为已解决的问题而发生崩溃时发送事件
    • crashlytics.stabilityDigest：在 Crashlytics 中出现热门问题通知时发送事件
    • crashlytics.velocity：在单个问题导致大量应用会话崩溃时发送事件
    • performance.threshold：当指标性能超出设定的阈值时发送事件
    ALERT_TYPE 的运算符必须是以下项之一：
    • 等于；例如 --event-filters="alerttype=appDistribution.inAppFeedback"。
    • 路径模式：例如 --event-filters-path-pattern="alerttype=appDistribution.*" 或 --event-filters-path-pattern="alerttype=crashlytics.new*"。

      如需了解详情，请参阅了解路径模式。

  • EVENT_DATA_CONTENT_TYPE：（可选）事件载荷的编码。可以为 application/json 或 application/protobuf。默认编码为 application/json。

    请注意，采用 JSON 格式的事件载荷大于采用 Protobuf 格式的事件载荷。这可能会影响可靠性，具体取决于您的事件目标及其事件大小限制。如需了解详情，请参阅已知问题。

  • SERVICE_ACCOUNT_NAME：用户管理的服务账号的名称。
  • PROJECT_ID：您的 Google Cloud 项目 ID。

注意：

  • --location 标志必须是 global。如需了解详情，请参阅 Eventarc 位置。
  • 这些标志是必需的：
    • --event-filters="type=google.firebase.firebasealerts.alerts.v1.published"
    • --event-filters="alerttype=ALERT_TYPE" 或 --event-filters-path-pattern="alerttype=ALERT_TYPE"
  • （可选）您可以使用 --event-filters="appid=APP_ID" 标志并指定完全匹配项来过滤特定 Firebase 应用 ID 的事件。
  • 触发器创建后，事件过滤条件类型便无法更改。对于其他事件类型，您必须创建新触发器并删除旧触发器。
  • --service-account 标志用于指定与触发器关联的 Identity and Access Management (IAM) 服务账号电子邮件地址。

示例：

gcloud eventarc triggers create helloworld-trigger \
    --location=us-central1 \
    --destination-gke-cluster=gke-events-cluster \
    --destination-gke-location=us-central1-a \
    --destination-gke-namespace=default \
    --destination-gke-service=helloworld-events \
    --destination-gke-path=/ \
    --event-filters="type=google.firebase.firebasealerts.alerts.v1.published" \
    --event-filters="alerttype=crashlytics.velocity" \
    --service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"

此命令会为标识为 google.firebase.firebasealerts.alerts.v1.published 的事件和 crashlytics.velocity 提醒类型创建名为 helloworld-trigger 的触发器。

Terraform

您可以使用 Terraform 为 GKE 目标创建触发器。如需了解详情，请参阅使用 Terraform 创建触发器。

列出触发器

如需确认触发器已创建，您可以使用 Google Cloud CLI 或通过 Google Cloud 控制台列出 Eventarc 触发器。

控制台

  1. 在 Google Cloud 控制台中，进入 Eventarc 触发器页面。

    转到“触发器”

    此页面会列出所有位置的触发器，并包含名称、区域、事件提供方、目标位置等详细信息。

  2. 如需过滤触发器，请执行以下操作：

    1. 点击 过滤或过滤触发器字段。
    2. 在属性列表中，选择要作为触发器过滤条件的选项。

    您可以选择单个属性，或使用逻辑运算符 OR 添加更多属性。

  3. 如需对触发器进行排序，请点击任意受支持的列标题旁边的 排序。

gcloud

运行以下命令可列出触发器：

gcloud eventarc triggers list --location=-

此命令会列出所有位置的触发器，并包含名称、类型、目标位置和状态等详细信息。

后续步骤