建立匯流排和註冊項目,發布及接收事件 (控制台)
本快速入門說明如何在 Google Cloud專案中建立 Eventarc Advanced 匯流排和註冊項目,並發布及接收事件訊息。
匯流排可讓您集中管理系統中的訊息流程,並充當路由器。它會接收來自訊息來源或由提供者發布的事件訊息,並根據註冊項目進行評估。
註冊可用於識別特定匯流排的訂閱項目,並定義訊息的比對條件,讓訊息能依據這些條件轉送至一或多個目的地。
在本快速入門導覽課程中,您將:
建立子網路並啟用私人 Google 存取權。
建立網路連結。
建立 Artifact Registry 標準存放區。
將事件接收器服務部署至 Cloud Run。
建立 Eventarc Advanced 匯流排。
建立 Eventarc Advanced 註冊。
將事件訊息發布至匯流排。
在 Cloud Run 記錄檔中查看事件資料。
您可以使用 Google Cloud 控制台完成本快速入門中的大部分步驟。如要使用 Google Cloud CLI 完成所有步驟,請參閱「建立匯流排和註冊,以便發布及接收事件 (gcloud CLI)」一文。
事前準備
貴機構定義的安全性限制,可能會導致您無法完成下列步驟。如需疑難排解資訊,請參閱「在受限的 Google Cloud 環境中開發應用程式」。
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Artifact Registry, Cloud Build, Cloud Run, Compute Engine, and Eventarc APIs.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Artifact Registry, Cloud Build, Cloud Run, Compute Engine, and Eventarc APIs.
- 這個快速入門課程中的幾個步驟需要使用 gcloud CLI:
- 在下列其中一個開發環境中設定 gcloud CLI:
Cloud Shell
如要使用已設定 gcloud CLI 的線上終端機,請啟用 Cloud Shell:
系統會在本頁底部啟動 Cloud Shell 工作階段,並顯示指令列提示。工作階段可能要幾秒鐘的時間才能初始化。
本機殼層
如要使用本機開發環境,請按照下列步驟操作:
- 選取 Google Cloud 專案:
gcloud config set project PROJECT_ID
將
PROJECT_ID
替換為您的 Google Cloud 專案名稱。 - 更新
gcloud
元件:gcloud components update
- 使用自己的帳戶登入:
gcloud auth login
- 設定本快速入門導覽課程中使用的設定變數:
REGION=us-central1
- 在下列其中一個開發環境中設定 gcloud CLI:
-
如果您是專案建立者,系統會授予您基本擁有者角色 (
roles/owner
)。根據預設,這個身分與存取權管理 (IAM) 角色會包含完整存取大多數 Google Cloud資源所需的權限,因此您可以略過這個步驟。如果您不是專案建立者,則必須將必要權限授予專案中的適當實體。舉例來說,主體可以是 Google 帳戶 (適用於使用者),也可以是服務帳戶 (適用於應用程式和運算工作負載)。
請注意,根據預設,Cloud Build 權限包含上傳及下載 Artifact Registry 構件權限。
所需權限
如要取得完成這份快速入門課程所需的權限,請要求管理員為您授予專案的下列 IAM 角色:
-
Cloud Build 編輯器 (
roles/cloudbuild.builds.editor
) -
Cloud Run 管理員 (
roles/run.admin
) -
Eventarc Developer (
roles/eventarc.developer
) -
Eventarc 訊息匯流排管理員 (
roles/eventarc.messageBusAdmin
) -
記錄檔檢視存取者 (
roles/logging.viewAccessor
) -
專案 IAM 管理員 (
roles/resourcemanager.projectIamAdmin
) -
服務帳戶管理員 (
roles/iam.serviceAccountAdmin
) -
服務帳戶使用者 (
roles/iam.serviceAccountUser
) -
服務使用情形管理員 (
roles/serviceusage.serviceUsageAdmin
)
如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。
-
Cloud Build 編輯器 (
- 將專案的角色授予 Compute Engine 預設服務帳戶。您必須具備這些角色,才能建構及部署容器映像檔。
- 前往 Google Cloud 控制台的「IAM」頁面。
如果服務帳戶已在資源上擁有角色,請找出包含實體的資料列,藉此修改服務帳戶的角色。
或
如要將角色授予服務帳戶 (在資源上沒有任何角色),請按一下
「授予存取權」,然後使用下列表單輸入 Compute Engine 預設服務帳戶的 ID:PROJECT_NUMBER-compute@developer.gserviceaccount.com
將
PROJECT_NUMBER
替換為您的 Google Cloud專案編號。您可以在 Google Cloud 控制台的「歡迎」頁面中找到專案編號。- 按一下對應資料列中的 「編輯主體」。
- 按一下「Add role」(新增角色) 或「Add another role」(新增其他角色) 。
- 在「請選取角色」清單中,篩選並選取下列角色:
- Artifact Registry Writer:上傳 Artifact Registry 構件
- Logs Writer:將記錄寫入 Cloud Logging
- Storage Object User:可存取 Cloud Storage 物件
- 按一下 [儲存]。
- 前往 Google Cloud 控制台的「IAM」頁面。
- 根據預設,只有專案擁有者、專案編輯者、Cloud Run 管理員和叫用者可以叫用 Cloud Run 服務。如要設定驗證機制,請將 Google Cloud 專案的 Cloud Run 叫用者角色授予服務帳戶。為了測試,您會將這個服務帳戶附加至 Eventarc Advanced 管道,以代表管道的身分。
- 前往 Google Cloud 控制台的「Service accounts」(服務帳戶) 頁面。
- 按一下 「建立服務帳戶」。
- 輸入服務帳戶名稱。
- 按一下「建立並繼續」。
- 在「Select a role」(請選擇角色) 清單中,篩選並選取「Cloud Run Invoker」(Cloud Run 叫用者) 角色。
- 按一下 [完成]。
請注意,您可以透過下列任一方式設定可存取 Cloud Run 服務的使用者:
- 將權限授予特定服務帳戶或群組,允許存取服務。所有要求都必須包含 HTTP 授權標頭,其中包含 Google 為某個已授權服務帳戶簽署的 OpenID Connect 權杖。這是本快速入門導覽課程中的存取權設定方式。
- 授予
allUsers
權限,允許未經驗證的存取權。
詳情請參閱「Cloud Run 的存取權控管」一文。
- 前往 Google Cloud 控制台的「Service accounts」(服務帳戶) 頁面。
建立子網路並啟用私人 Google 存取權
除非您建立禁止這項功能的組織政策,否則新 Google Cloud專案一開始會設有預設的虛擬私有雲 (VPC) 網路 (自動模式虛擬私有雲網路),其中在每個區域都有一個子網路。子網路具有相關聯的 IP 位址範圍。
由於您是使用 DNS 位址將訊息路由至 Cloud Run 目的地,因此必須在網路附件中使用的子網路上啟用 私人 Google 存取權,否則無法解析 DNS 位址。如要進一步瞭解私人網路和 Cloud Run,請參閱「接收來自 VPC 網路的要求」。
在專案的預設網路中建立子網路,並啟用私人 Google 存取權:
在 Google Cloud 控制台中,前往「VPC Networks」(虛擬私有雲網路) 頁面。
在虛擬私有雲網路清單中,按一下「預設」名稱。
在「虛擬私有雲網路詳細資料」頁面中,按一下「子網路」分頁標籤。
按一下「新增子網路」。
在「Add a subnet」(新增子網路) 窗格中,執行下列操作:
- 輸入「名稱」,例如
my-subnet
。 - 在「Region」(區域) 清單中選取「us-central1」。
- 輸入子網路的「主要 IPv4 範圍」,例如
10.8.0.0/24
。 - 在「Private Google Access」部分,選取「啟用」。
- 接受其他所有預設值。
- 按一下「新增」。
- 輸入「名稱」,例如
子網路 IP 範圍不得重複,也不能與虛擬私有雲網路和對等互連虛擬私有雲網路中的其他範圍重疊。如要進一步瞭解子網路類型和有效的子網路範圍,請參閱「子網路」。
建立網路連結
網路連結是一種資源,可讓供應商虛擬私有雲網路與用戶虛擬私有雲網路建立連線。發布事件時,Eventarc Advanced 會使用網路連結,與虛擬私有雲網路中託管的端點建立連線。
在包含事件目的地端點的相同網路和區域中建立網路連結,並自動接受來自任何參照網路連結的 Private Service Connect 介面 的連線:
在 Google Cloud 控制台中,前往「Private Service Connect」。
按一下「網路附件」分頁標籤。
按一下
「建立網路連結」。輸入「名稱」,例如
my-network-attachment
。在「Network」(網路) 清單中,選取「default」(預設)。
在「Region」(區域) 清單中,選取「us-central1 (Iowa)」(us-central1 (愛荷華州))。
在「Subnetwork」清單中,選取先前建立的子網路。
按一下「自動接受所有專案的連線」。
按一下「Create network attachment」(建立網路連結)。
建立 Artifact Registry 標準存放區
建立 Artifact Registry 標準存放區來儲存容器映像檔。
在 Google Cloud 控制台中,前往「Repositories」頁面。
按一下「Create repository」。
輸入「名稱」,例如
my-repo
。專案中的每個存放區位置的存放區名稱都必須不重複。
在存放區「格式」中,選取「Docker」。
在「Region」(區域) 清單中,選取「us-central1 (Iowa)」(us-central1 (愛荷華州))。
接受其他所有預設值。
按一下 [建立]。
將事件接收器服務部署至 Cloud Run
部署可記錄事件內容的 Cloud Run 服務。這項服務只能透過相同專案內的虛擬私有雲網路存取,而且服務 URL 無法直接存取,因為服務只允許經過驗證的叫用要求。
在終端機中複製 GitHub 存放區:
git clone https://github.com/GoogleCloudPlatform/eventarc-samples.git
變更為包含 Cloud Run 範例程式碼的目錄:
cd eventarc-samples/eventarc-advanced-quickstart/
建構 Docker 容器映像檔,並將映像檔推送至存放區:
gcloud builds submit \ --tag $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/log-events:v1
將
REPOSITORY
替換為 Artifact Registry 存放區的名稱。將容器映像檔部署至 Cloud Run:
前往 Google Cloud 控制台的「Cloud Run」頁面。
依序按一下 >「服務」。
「部署容器」選取「透過現有的容器映像檔部署單一修訂版本」。
針對「容器映像檔網址」,按一下「選取」,指定先前建立的 Artifact Registry 容器映像檔。
您可以視需要變更服務名稱,例如變更為
my-service
。在「Region」(區域) 清單中,選取「us-central1 (Iowa)」(us-central1 (愛荷華州))。
在「驗證」部分,選取「需要驗證」。
在「Ingress」部分,選取「Internal」。
接受其他所有預設值。
按一下「建立」,然後等待部署完成。
建立 Eventarc Advanced 匯流排
匯流排會接收來自訊息來源或由供應者發布的事件訊息,並充當訊息路由器。
詳情請參閱「建立匯流程來轉送訊息」。
在 Google Cloud 控制台中,依序前往「Eventarc」>「Bus」頁面。
按一下「建立匯入資料集」
。在「Create a bus」(建立中繼) 頁面中執行下列操作:
- 輸入匯流排名稱,例如
my-bus
。 - 在「Region」(區域) 清單中,選取「us-central1 (Iowa)」(us-central1 (愛荷華州))。
- 輸入匯流排名稱,例如
接受其他所有預設值。
按一下 [建立]。
建立 Eventarc Advanced 註冊
註冊項目會決定要將哪些訊息轉送至目的地,並指定用於為事件訊息設定目的地的管道。
詳情請參閱「建立註冊項目以接收事件」。
使用 Google Cloud 控制台時,您可以同時建立註冊和管道。
如要建立註冊,請在 Google Cloud 控制台中依序前往「Eventarc」>「管道」頁面。
按一下「建立管道」
。在「管道詳細資料」窗格中執行下列操作:
- 輸入管道名稱,例如
my-pipeline
。 - 在「Region」(區域) 清單中,選取「us-central1 (Iowa)」(us-central1 (愛荷華州))。管道必須與匯流排位於相同區域。
- 接受其他所有預設值。
- 按一下「繼續」。
- 輸入管道名稱,例如
在「註冊」窗格中,執行下列操作:
- 按一下「新增註冊」。
- 輸入註冊名稱,例如
my-enrollment
。 - 在「Eventarc Advanced Bus」清單中,選取先前建立的匯流排。
在 CEL 運算式欄位中,使用 CEL 編寫評估運算式。例如:
message.type == "hello-world-type"
按一下 [完成]。
按一下「繼續」。
在「事件中介服務」窗格中,再次按一下「繼續」。
在「Destination」窗格中執行下列操作:
在「Destination type」清單中,選取「Cloud Run service (via HTTP)」,然後選取先前建立的 Cloud Run 服務。
在「Network attachment」清單中,選取先前建立的網路連結。
勾選「Enable authentication」(啟用驗證) 核取方塊。
在「Auth header」清單中,選取「OIDC token」。
在「Service account」清單中,選取先前建立的服務帳戶,並用於叫用目的地服務。這個服務帳戶電子郵件地址會用於產生 OIDC 權杖。
按一下 [建立]。
將事件訊息發布至匯流排
如要直接將訊息發布至匯流排,您可以使用 gcloud beta eventarc message-buses publish
指令,或傳送要求至 Eventarc Publishing REST API。詳情請參閱「直接發布事件」。
訊息必須採用 CloudEvents 格式,這是一種用於以常見方式描述事件資料的規格。data
元素是事件的酬載。任何正確格式的 JSON 都可以放入這個欄位。如要進一步瞭解 CloudEvents 內容屬性,請參閱「事件格式」。
使用 gcloud CLI 和 --event-data
以及其他事件屬性標記,將事件發布至 Eventarc Advanced 匯流排:
gcloud beta eventarc message-buses publish BUS_NAME \
--event-data='{"key": "hello-world-data"}' \
--event-id=hello-world-id-1234 \
--event-source=hello-world-source \
--event-type=hello-world-type \
--event-attributes="datacontenttype=application/json" \
--location=$REGION
或者,您也可以使用 gcloud CLI 和 --json-message
標記,將事件以 JSON 訊息格式發布至 Eventarc Advanced 匯流排:
gcloud beta eventarc message-buses publish BUS_NAME \
--location=$REGION \
--json-message='{"id": "hello-world-id-1234", "type":
"hello-world-type", "source":
"hello-world-source", "specversion": "1.0", "data":
{"key": "hello-world-data"}}'
發布事件後,您應該會收到「Event published successfully」(事件已成功發布) 訊息。
在 Cloud Run 記錄中查看事件資料
將事件發布至 Eventarc Advanced 匯流排後,您可以查看 Cloud Run 服務的記錄檔,確認事件是否如預期收到。
前往 Google Cloud 控制台的「Cloud Run」頁面。
在「Services」頁面中,按一下服務名稱。
按一下 [Logs] (記錄) 分頁標籤。
您可以篩選記錄項目並傳回輸出內容。例如,您可以搜尋
hello-world-data
。尋找類似下列內容的記錄項目:
2025-02-27 08:36:44.350 EST [2025-02-27 13:36:44,352] INFO in server: Body: b'{"key": "hello-world-data"}'
您已成功建立 Eventarc Advanced 匯流排和註冊項目、將事件訊息發布至匯流排,並在事件接收器服務的記錄中驗證預期結果。
清除所用資源
完成本快速入門課程中說明的工作後,您可以刪除已建立的資源,避免系統繼續向您收取費用:
刪除 Eventarc Advanced 資源:
您也可以刪除 Google Cloud 專案,避免產生費用。刪除 Google Cloud 專案後,系統就會停止對專案使用的所有資源收取費用。
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.