创建注册以接收事件

流水线

1. 打开终端。

2. 使用 gcloud eventarc pipelines create 命令创建流水线：

   gcloud eventarc pipelines create PIPELINE_NAME \
       --destinations=DESTINATION_KEY \
       --location=LOCATION

   替换以下内容：

   • PIPELINE_NAME：流水线的 ID 或完全限定名称

   • DESTINATION_KEY：一个或多个键值对，用于为流水线配置目标

     您必须只设置以下其中一个键：

     • http_endpoint_uri - 目标 URI。主机可以是可从虚拟私有云 (VPC) 网络寻址的静态 IP，也可以是可使用 Cloud DNS 解析的服务的内部域名系统 (DNS) 主机名。（可选）您也可以设置 http_endpoint_message_binding_template 以指定消息绑定。

       您可以使用此键来定位 Cloud Run 服务网址，该网址将以 HTTP POST 请求的形式接收事件。使用首次部署 Cloud Run 托管的服务时提供的稳定的自动分配 run.app 网址。或者，您也可以指定一个 BigQuery 表，该表将接收 HTTP POST 请求形式的事件。定义消息绑定，以构建针对 BigQuery API 的 HTTP 请求。

       您还可以使用此目标类型为 Cloud Run 函数（第 1 代和当前版本）指定 HTTP 端点。当您为 Cloud Run 函数指定 HTTP 触发器时，系统会为函数分配一个网址，用于接收请求。

     • message_bus - Eventarc Advanced 总线的 ID。 总线必须部署在与流水线相同的项目和区域中。

     • pubsub_topic - Pub/Sub 主题的 ID。必须先创建主题，然后才能将消息路由到该主题；如果使用主题架构，请务必对事件消息进行适当的转换。

     • workflow - Workflows 工作流的 ID。 您可以触发工作流的执行，即单次运行工作流定义中包含的逻辑。工作流必须部署在与流水线相同的项目中。

     如需启用身份验证，您可以设置以下其中一个键：

     • google_oidc_authentication_service_account - 用于生成 OIDC 令牌的服务账号电子邮件，该令牌可用于许多场景，其中包括您打算自行验证令牌的端点。（可选）您可以设置 google_oidc_authentication_audience 以指定此令牌的目标受众群体。通常，它应与目标流水线的网址匹配。如果它尚未指定，那么系统会使用整个网址（包括所有请求参数）。

       请注意，Cloud Run 会对每个请求执行 IAM 检查，您可以使用 run.routes.invoke 权限通过以下任一方式配置谁可以访问您的 Cloud Run 服务：

       • 向选定的服务账号或群组授予此权限，以允许访问服务。所有请求都必须具有 HTTP 授权标头，其中包含由 Google 为其中一个已获授权的服务账号签名的 OpenID Connect 令牌。

       • 向所有用户授予此权限，以允许未经身份验证的访问。

       如需了解详情，请参阅 Cloud Run 的访问权限控制。

     • oauth_token_authentication_service_account - 用于生成 OAuth 令牌的服务账号电子邮件，通常，只有在调用 *.googleapis.com 上托管的 Google API 时，才应使用该令牌。（可选）您可以设置 oauth_token_authentication_scope 以指定此令牌的范围；否则，它将默认为 https://www.googleapis.com/auth/cloud-platform。对于Google Cloud 服务，最佳实践是使用 https://www.googleapis.com/auth/cloud-platform 范围，其中包括所有 Google Cloud API 以及可提供精细访问权限控制的 Identity and Access Management (IAM)。

       请注意，所有对其他 Eventarc Advanced 总线、Pub/Sub 或 Workflows 的请求都必须具有 HTTP 授权标头，其中包含由 Google 为其中一个已获授权的服务账号签名的 OAuth 令牌。

       详细了解令牌类型。

     可选：您可以设置以下其中一个键：

     • output_payload_format_avro_schema_definition
     • output_payload_format_json

     • output_payload_format_protobuf_schema_definition

       请注意，如果您设置了输出格式，则还必须指定输入格式（请参阅以下 input-payload-format-* 标志）。

     可选：如果您没有将 http_endpoint_uri 用作目标键，则可以设置以下键：

     • project - 目标资源的 Google Cloud 项目 ID；默认情况下，系统会使用流水线的项目 ID。
     • location - 目标资源的位置；默认情况下，系统会使用流水线的位置。

   • LOCATION：受支持的 Eventarc Advanced 区域

     或者，您也可以设置 gcloud CLI 位置属性：

     gcloud config set eventarc/location LOCATION
     

   可选：您可以使用以下标志：

   • --async - 立即从命令返回，而无需等待正在进行的操作完成。
   • --crypto-key - 指定客户管理的加密密钥的完全限定名称；如果它尚未指定，那么系统将使用 Google-owned and managed keys 。
   • --logging-config - 配置日志记录级别，这必须是以下之一：NONE、DEBUG、INFO、NOTICE、WARNING、ERROR、CRITICAL、ALERT、EMERGENCY。

   • --mediations - 应用转换；transformation_template 是唯一受支持的模板，并且每个流水线仅支持一个中介；例如：

     --mediations=transformation_template='message.removeFields(["id\ ","credit_card_number","age"])'

     请注意，如果您要应用转换，则必须使用以下某个标志来指定输入格式。

   • 以下其中一项可指定输入格式：

     • --input-payload-format-avro-schema-definition
     • --input-payload-format-json
     • --input-payload-format-protobuf-schema-definition

   • --max-retry-attempts、--max-retry-delay 和 --min-retry-delay，用于重试事件

   例如：

   gcloud eventarc pipelines create my-pipeline \
       --destinations=http_endpoint_uri='https://example-endpoint.com',oauth_token_authentication_service_account=example-service-account@example-project.gserviceaccount.iam.com,oauth_token_authentication_scope='https://www.googleapis.com/auth/cloud-platform',output_payload_format_avro_schema_definition='{"type": "record","name": "my_record", "fields": [{"name": "my_field", "type":"string"}]}' \
       --input-payload-format-avro-schema-definition='{"type":"record", "name": "my_record", "fields": [{"name": "my_field","type": "string"}]}' \
       --location=us-central1 \
       --async
   

   如需了解详情和查看示例，请参阅 gcloud CLI 文档。

注册

1. 打开终端。

2. 使用 gcloud eventarc enrollments create 命令创建注册：

   gcloud eventarc enrollments create ENROLLMENT_NAME \
       --cel-match=MATCH_EXPRESSION \
       --destination-pipeline=PIPELINE_NAME \
       --message-bus=BUS_NAME \
       --message-bus-project=PROJECT_ID \
       --location=LOCATION

   替换以下内容：

   • ENROLLMENT_NAME：注册的 ID 或完全限定名称
   • MATCH_EXPRESSION：此注册的匹配表达式（使用 CEL）- 例如 "message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'"
   • PIPELINE_NAME：用于此注册的目标流水线 ID 或其完全限定名称
   • BUS_NAME：Eventarc Advanced 总线的 ID 或其完全限定名称
   • PROJECT_ID：该总线的 Google Cloud 项目 ID

   • LOCATION：受支持的 Eventarc Advanced 区域

     或者，您也可以设置 gcloud CLI 位置属性：

     gcloud config set eventarc/location LOCATION
     

   可选：您可以使用以下标志：

   • --async - 立即从命令返回，而无需等待正在进行的操作完成

   例如：

   gcloud eventarc enrollments create my-enrollment \
       --cel-match="message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'" \
       --destination-pipeline=my-pipeline \
       --message-bus=my-message-bus \
       --message-bus-project=another-google-cloud-project \
       --location=us-central1 \
       --async
   

流水线

如需创建流水线，请使用 projects.locations.pipelines.create 方法。

在使用任何请求数据之前，请先进行以下替换：

• name：流水线的完整资源名称，格式为 projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME

  替换以下内容：

  • PROJECT_ID：流水线项目的 Google Cloud项目 ID
  • LOCATION：要部署流水线的区域，例如 us-central1
  • PIPELINE_NAME：流水线的名称
• LABEL_KEY 和 LABEL_VALUE：可选。标签键值对映射，可帮助您整理 Google Cloud 资源。如需了解详情，请参阅什么是标签？
• ANNOTATION_KEY 和 ANNOTATION_VALUE：可选。自由形式文本的注解键值对的映射。您可以使用它们来附加与资源关联的任意信息。如需了解详情，请参阅注解。
• LOG_SEVERITY：可选。日志条目中所述事件的最低严重性。以下之一：NONE、DEBUG、INFO、NOTICE、WARNING、ERROR、CRITICAL、ALERT、EMERGENCY。默认值为 NONE。如需了解详情，请参阅 LogSeverity。
• destinations：消息将转发到的目标。（可选）您可以设置 messageBindingTemplate 以指定消息绑定。 如需了解详情，请参阅 Destination 目标。仅支持一个目的地：
  • httpEndpoint：目标 URI (HTTP_URI)。主机可以是可从虚拟私有云 (VPC) 网络寻址的静态 IP，也可以是可使用 Cloud DNS 解析的服务的内部域名系统 (DNS) 主机名。

    例如，您可以指定一个 Cloud Run 服务网址，该网址将以 HTTP POST 请求的形式接收事件。使用首次部署 Cloud Run 托管的服务时提供的稳定的自动分配 run.app 网址。或者，您也可以指定一个 BigQuery 表，该表将接收作为 HTTP POST 请求的事件。定义消息绑定，以构建 BigQuery API 的 HTTP 请求。

    您还可以使用此目标类型为 Cloud Run functions 函数（第 1 代和当前版本）指定 HTTP 端点。当您为 Cloud Run 函数指定 HTTP 触发器时，系统会为函数分配一个网址，用于接收请求。

  • messageBus：Eventarc Advanced 总线。总线必须部署在与流水线相同的项目和区域中。
  • topic：一个 Pub/Sub 主题，必须先在与流水线相同的项目中创建该主题。如果使用主题架构，请务必对事件消息进行适当的转换。
  • workflow：Workflows 工作流。您可以触发工作流的执行，即单次运行工作流定义中包含的逻辑。工作流必须部署在与流水线相同的项目中。
• SERVICE_ACCOUNT_EMAIL：用于生成 OIDC 令牌的服务账号电子邮件的名称，该令牌可用于许多场景，其中包括您打算自行验证令牌的端点。（可选）您可以设置 audience 以指定此令牌的目标受众群体。通常，它应与目标流水线的网址匹配。如果它尚未指定，那么系统会使用整个网址（包括所有请求参数）。

  或者，您可以使用 oauthToken 指定用于生成 OAuth 令牌的服务账号电子邮件，通常，只有在调用 *.googleapis.com 上托管的 Google API 时，才应使用该令牌。（可选）您可以设置 scope 以指定此令牌的范围；否则，它将默认为 https://www.googleapis.com/auth/cloud-platform。对于 Google Cloud服务，最佳实践是使用 https://www.googleapis.com/auth/cloud-platform 范围，其中包括所有 Google Cloud API 以及可提供精细访问权限控制的 Identity and Access Management (IAM)。

  请注意，所有对其他 Eventarc Advanced 总线、Pub/Sub 或 Workflows 的请求都必须具有 HTTP 授权标头，其中包含由 Google 为其中一个已获授权的服务账号签名的 OAuth 令牌。

  详细了解令牌类型。

请求 JSON 正文：

{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}

如需发送您的请求，请展开以下选项之一：

cat > request.json << 'EOF'
{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}
EOF

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelines?pipeline_id=PIPELINE_NAME"

@'
{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}
'@  | Out-File -FilePath request.json -Encoding utf8

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelines?pipeline_id=PIPELINE_NAME" | Select-Object -Expand Content

如果成功，响应正文将包含一个新创建的 Operation 实例：

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.eventarc.v1.OperationMetadata",
    "createTime": "2024-01-25T17:17:45.782370139Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

注册

如需创建注册，请使用 projects.locations.enrollments.create 方法。

在使用任何请求数据之前，请先进行以下替换：

• ENROLLMENT_NAME：注册的显示名称，例如 my_enrollment。
• MATCH_EXPRESSION：CEL 表达式，用于标识此注册适用于哪些消息。例如 message.type == 'hello-world-type'。
• destination：目标流水线的完整资源名称，格式为 projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME。

  替换以下内容：

  • PROJECT_ID：流水线项目的 Google Cloud项目 ID
  • LOCATION：部署流水线的区域，例如 us-central1。
  • PIPELINE_NAME：流水线的名称
• message_bus：标识消息来源的总线的完整资源名称，格式为 projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME。

  替换以下内容：

  • BUS_PROJECT_ID：总线项目的 Google Cloud 项目 ID
  • BUS_LOCATION：部署总线的区域，例如 us-central1
  • BUS_NAME：消息总线的名称

请求 JSON 正文：

{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}

如需发送您的请求，请展开以下选项之一：

cat > request.json << 'EOF'
{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}
EOF

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/enrollments?enrollment_id=ENROLLMENT_NAME"

@'
{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}
'@  | Out-File -FilePath request.json -Encoding utf8

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/enrollments?enrollment_id=ENROLLMENT_NAME" | Select-Object -Expand Content

如果成功，响应正文将包含一个新创建的 Operation 实例：

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.eventarc.v1.OperationMetadata",
    "createTime": "2024-01-25T17:17:45.782370139Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/enrollments/ENROLLMENT_NAME",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}