將 Firebase 即時資料庫事件轉送至工作流程

Eventarc 觸發條件會宣告您對特定事件或一組事件感興趣。您可以指定觸發條件的篩選器 (包括事件來源) 和目標工作流程，設定事件轉送。

系統會透過 HTTP 要求，以 CloudEvents 格式傳送事件。Workflows 服務會將事件轉換為 JSON 物件 (遵循 CloudEvents 規格)，並將事件做為工作流程執行階段引數傳遞至工作流程執行作業。請確保事件大小不超過 512 KB。 如果事件大於 Workflows 引數大小上限，就不會觸發工作流程執行作業。

請參閱下列操作說明，瞭解如何設定事件路徑，以便在收到直接Firebase Realtime Database 事件時觸發工作流程執行作業。詳情請參閱支援的直接事件清單。

準備建立觸發條件

為目標工作流程建立 Eventarc 觸發程序前，請先完成下列工作。

主控台

  1. 在 Google Cloud 控制台的專案選擇器頁面中，選取或建立 Google Cloud 專案。

    前往專案選取器

  2. 啟用 Eventarc、Eventarc Publishing、Workflows 和 Workflow Executions API。

    啟用 API

  3. 如有需要，請啟用與直接事件相關的 API。舉例來說，如要使用 Firebase Realtime Database 活動，請啟用Firebase Realtime Database API。

  4. 如果沒有，請建立使用者代管的服務帳戶，然後授予必要的角色和權限，讓 Eventarc 管理目標工作流程的事件。

    1. 前往 Google Cloud 控制台的「Service Accounts」(服務帳戶) 頁面。

      前往「Service Accounts」(服務帳戶)

    2. 選取專案。

    3. 在「Service account name」(服務帳戶名稱) 欄位中輸入名稱。 Google Cloud 控制台會根據這個名稱填入「服務帳戶 ID」欄位。

      在「服務帳戶說明」欄位中輸入說明。例如：Service account for event trigger。

    4. 按一下「建立並繼續」。

    5. 如要提供適當的存取權，請在「Select a role」(請選擇角色) 清單中，選取要授予服務帳戶的必要 Identity and Access Management (IAM) 角色。詳情請參閱「工作流程目標的角色和權限」。

      如要新增其他角色，請按一下「新增其他角色」，然後新增每個其他角色。

    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、Eventarc Publishing、Workflows 和 Workflow Executions API：

    gcloud services enable eventarc.googleapis.com \
    eventarcpublishing.googleapis.com \
    workflows.googleapis.com \
    workflowexecutions.googleapis.com

  3. 如有需要，請啟用與直接事件相關的 API。舉例來說，如要啟用 Firebase Realtime Database 活動，請啟用firebasedatabase.googleapis.com。

  4. 如果沒有，請建立使用者代管的服務帳戶，然後授予必要角色和權限，讓 Eventarc 管理目標工作流程的事件。

    1. 建立服務帳戶：

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      將 SERVICE_ACCOUNT_NAME 改為服務帳戶名稱。長度必須介於 6 至 30 個字元之間，可以使用小寫英數字元和破折號。建立服務帳戶後，就無法變更名稱。

    2. 授予必要的 Identity and Access Management (IAM) 角色或權限。詳情請參閱「工作流程目標的角色和權限」。

建立觸發條件

您可以透過 Google Cloud CLI (gcloud 或 Terraform) 或 Google Cloud 控制台，建立以已部署工作流程做為事件接收端的 Eventarc 觸發程序。

主控台

  1. 在 Google Cloud 控制台中，前往 Eventarc「Triggers」(觸發條件) 頁面。

    前往「Triggers」(觸發條件)

  2. 按一下「建立觸發條件」。
  3. 輸入觸發條件名稱。

    這是觸發條件的 ID，開頭必須是英文字母。最多可包含 63 個小寫英文字母、數字或連字號。

  4. 在「Trigger type」(觸發條件類型) 中，選取「Google sources」(Google 來源)。
  5. 在「Event provider」(事件提供者) 清單中，選取「Firebase Realtime Database」。

    請注意，相關Google Cloud 文件中使用的事件提供者名稱可能沒有 Cloud 或 Google Cloud 前置字元。舉例來說，在控制台中，「Memorystore for Redis」稱為「Memorystore for Redis」Google Cloud 。

  6. 在「Event type」(事件類型) 清單中，從「Direct」(直接) 事件選取事件類型。
  7. 在「事件資料內容類型」清單中，選取事件酬載的編碼。

    如果是來自 Firebase Realtime Database的直接事件，則必須為 application/json。

  8. 在「Region」(區域) 清單中，選取與產生事件的Google Cloud 服務相同的區域。

    詳情請參閱「Eventarc 區域」。

  9. 在「Attribute 1」(屬性 1) 欄位中，執行個體 資源 ID 會做為事件篩選器。選取這個篩選器的運算子：
  10. 在「屬性值 1」欄位中，輸入要接收事件的資料庫執行個體名稱。視您在上一步中選擇的運算子而定，屬性值應為確切名稱或路徑模式格式。
  11. 在 ref 屬性中，選取「路徑模式」運算子。
  12. 在「屬性值 2」欄位中，輸入要接收事件的資料庫執行個體路徑 (如果該路徑或任何子路徑中的資料已建立、更新或刪除)。
  13. 選取要叫用服務或工作流程的服務帳戶。

    或者，您也可以建立新的服務帳戶。

    這會指定與觸發程序相關聯的 Identity and Access Management (IAM) 服務帳戶電子郵件，您先前已授予該帳戶 Eventarc 所需的特定角色。

  14. 在「Event destination」(事件目的地) 清單中，選取「Workflows」。
  15. 選取工作流程。

    這是要將事件傳送至的工作流程名稱。工作流程執行的事件會經過轉換，並以執行階段引數的形式傳遞至工作流程。

    詳情請參閱 建立 Workflows 的觸發條件。

  16. 如要新增標籤，請按一下 「新增標籤」。標籤是鍵/值組合，可協助您整理Google Cloud 資源。詳情請參閱「什麼是標籤？」
  17. 點選「建立」。

    18. 觸發條件建立後，事件來源篩選器就無法修改。 請改為建立新的觸發條件，並刪除舊的觸發條件。詳情請參閱「管理觸發條件」。

gcloud

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-workflow=DESTINATION_WORKFLOW  \
    --destination-workflow-location=DESTINATION_WORKFLOW_LOCATION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="instance=INSTANCE" \
    --event-filters-path-pattern="ref=REF" \
    --service-account="MY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com"

更改下列內容：

  • TRIGGER：觸發條件的 ID 或完整 ID。

  • LOCATION：Eventarc 觸發程序的所在位置。或者，您也可以設定 eventarc/location 屬性，例如 gcloud config set eventarc/location us-central1。Eventarc 的 Firebase 即時資料庫觸發條件僅適用於下列位置：

    • us-central1
    • europe-west1
    • asia-southeast1

    請注意，觸發程序必須與 Firebase 即時資料庫執行個體位於同一位置。詳情請參閱Realtime Database 位置。

  • DESTINATION_WORKFLOW：已部署的工作流程 ID，用於接收觸發條件的事件。工作流程可位於任何 Workflows 支援的位置，不一定要與觸發程序位於相同位置。不過，工作流程必須與觸發程序位於相同專案中。
  • DESTINATION_WORKFLOW_LOCATION (選用)：部署目的地工作流程的位置。如未指定，系統會假設工作流程與觸發程序位於相同位置。

  • EVENT_FILTER_TYPE：Firebase 即時資料庫事件的 ID，可以是下列其中一項：

    • google.firebase.database.ref.v1.created：在資料庫中建立資料時傳送的事件
    • google.firebase.database.ref.v1.updated：資料庫中的資料更新時，系統會傳送事件
    • google.firebase.database.ref.v1.deleted：在資料庫中刪除資料時傳送的事件
    • google.firebase.database.ref.v1.written：在資料庫中建立、更新或刪除資料時，系統會傳送事件

  • INSTANCE：單一資料庫執行個體，運算子可以是下列其中一種：

    • 相等，例如 --event-filters="instance=INSTANCE"
    • 路徑模式，例如 --event-filters-path-pattern="instance=INSTANCE"。詳情請參閱「瞭解路徑模式」。

  • REF：資料庫執行個體中的路徑，您希望在該路徑或任何子項中建立、更新或刪除資料時，從該路徑接收事件。

  • SERVICE_ACCOUNT_NAME：您建立的 IAM 服務帳戶名稱，並已授予 Workflows 所需的特定角色。
  • PROJECT_ID：您的 Google Cloud 專案 ID

注意：

  • 如果是來自 Firebase Realtime Database的直接事件，事件酬載的編碼為 application/json。
  • 必須使用下列旗標：
    • --event-filters="type=EVENT_FILTER_TYPE"
    • --event-filters="instance=INSTANCE"或--event-filters-path-pattern="instance=INSTANCE"
    • --event-filters-path-pattern="ref=REF"
  • 建立觸發條件後，就無法變更事件篩選器類型。如要使用其他事件類型，請建立新的觸發條件。
  • --service-account： Eventarc 觸發條件將用來叫用工作流程執行的 IAM 服務帳戶電子郵件地址。強烈建議您使用僅具備必要權限的服務帳戶，存取所需資源。如要進一步瞭解服務帳戶，請參閱「建立及管理服務帳戶」。
  • 根據預設，為 Eventarc 建立的 Pub/Sub 訂閱項目會持續存在，不會因活動而異，也不會過期。如要變更閒置時間長度，請參閱「訂閱屬性」。

範例：

gcloud eventarc triggers create rd-workflows-trigger \
    --location=us-central1 \
    --destination-workflow=my-workflow \
    --destination-workflow-location=europe-west4 \
    --event-filters="type=google.firebase.database.ref.v1.created" \
    --event-filters="instance=test-instance" \
    --event-filters-path-pattern="ref=users/*" \
    --service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"

這個指令會為標示為 google.firebase.database.ref.v1.created 的事件建立名為 rd-workflows-trigger 的觸發條件。

Terraform

您可以使用 Terraform 建立工作流程的觸發條件。詳情請參閱「使用 Eventarc 和 Terraform 觸發工作流程」。

列出觸發條件

如要確認是否已建立觸發程序，請使用 Google Cloud CLI 或 Google Cloud 控制台列出 Eventarc 觸發程序。

主控台

  1. 在 Google Cloud 控制台中，前往 Eventarc「Triggers」(觸發條件) 頁面。

    前往「Triggers」(觸發條件)

    這個頁面會列出所有位置的觸發條件，並包含名稱、區域、事件供應商、目的地等詳細資料。

  2. 如要篩選觸發條件，請按照下列步驟操作：

    1. 按一下「篩選器」或「篩選器觸發條件」欄位。
    2. 在「屬性」清單中，選取要用來篩選觸發條件的選項。

    您可以選取單一屬性，或使用邏輯運算子 OR 新增更多屬性。

  3. 如要排序觸發條件，請按一下任何支援的欄標題旁的「排序」。

gcloud

執行下列指令來列出觸發條件：

gcloud eventarc triggers list --location=-

這個指令會列出所有位置的觸發條件，並包含名稱、類型、目的地和狀態等詳細資料。

後續步驟