バスと登録を作成してイベントをパブリッシュし、受信する（gcloud CLI）

バスと登録を作成してイベントをパブリッシュし、受信する（gcloud CLI）

詳細設定

このクイックスタートでは、 Google Cloudプロジェクトで Eventarc Advanced バスを作成して登録し、イベント メッセージをパブリッシュして受信する方法について説明します。

• バスを使用すると、システム内のメッセージ フローを一元化し、ルーターとして機能します。メッセージ ソースからイベント メッセージを受信するか、プロバイダによって公開されたイベント メッセージを受信し、登録に従って評価します。

• 登録は、特定のバスへのサブスクリプションを識別し、メッセージの一致条件を定義します。これにより、メッセージは 1 つ以上の宛先にルーティングされます。

このクイックスタートでは、以下の操作を行います。

1. Artifact Registry 標準リポジトリを作成します。

2. イベント レシーバ サービスを Cloud Run にデプロイする。

3. Eventarc Advanced バスを作成します。

4. Eventarc Advanced 登録を作成します。

5. イベント メッセージをバスにパブリッシュします。

6. Cloud Run のログでイベントデータを確認します。

このクイックスタートでは gcloud CLI を使用します。 Google Cloud コンソールを使用して手順を完了するには、バスと登録を作成してイベントをパブリッシュして受信する（コンソール）をご覧ください。

始める前に

組織で定義されているセキュリティの制約により、次の手順を完了できない場合があります。トラブルシューティング情報については、制約のある 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.

Install the Google Cloud CLI.

外部 ID プロバイダ（IdP）を使用している場合は、まずフェデレーション ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

Create or select a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Verify that billing is enabled for your Google Cloud project.

Enable the Artifact Registry, Cloud Build, Cloud Run, Compute Engine, and Eventarc APIs:

gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com compute.googleapis.com eventarc.googleapis.com eventarcpublishing.googleapis.com run.googleapis.com

Install the Google Cloud CLI.

外部 ID プロバイダ（IdP）を使用している場合は、まずフェデレーション ID を使用して gcloud CLI にログインする必要があります。

gcloud CLI を初期化するには、次のコマンドを実行します。

gcloud init

Create or select a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Verify that billing is enabled for your Google Cloud project.

Enable the Artifact Registry, Cloud Build, Cloud Run, Compute Engine, and Eventarc APIs:

gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com compute.googleapis.com eventarc.googleapis.com eventarcpublishing.googleapis.com run.googleapis.com

1. gcloud コンポーネントを更新します。

   gcloud components update

2. アカウントを使用してログインします。

   gcloud auth login

3. このクイックスタートで使用する構成変数を設定します。

   REGION=REGION

   REGION は、バスのサポートされているロケーションに置き換えます。

4. プロジェクト作成者には、基本オーナーロール（roles/owner）が付与されます。デフォルトでは、この Identity and Access Management（IAM）ロールには、ほとんどの Google Cloudリソースへのフルアクセスに必要な権限が含まれており、この手順は省略できます。

   プロジェクト作成者でない場合は、プロジェクトで適切なプリンシパルに必要な権限を付与する必要があります。プリンシパルは Google アカウント（エンドユーザーの場合）やサービス アカウント（アプリケーションとコンピューティング ワークロードの場合）になることもあります。

   デフォルトでは、Cloud Build の権限には、Artifact Registry アーティファクトをアップロードおよびダウンロードするための権限が含まれています。

   必要な権限

   このクイックスタートを完了するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。

   • Cloud Build 編集者（roles/cloudbuild.builds.editor）
   • Cloud Run 管理者（roles/run.admin）
   • Eventarc デベロッパー （roles/eventarc.developer）
   • Eventarc メッセージバス管理者 （roles/eventarc.messageBusAdmin）
   • ログ表示アクセス者（roles/logging.viewAccessor）
   • プロジェクト IAM 管理者（roles/resourcemanager.projectIamAdmin）
   • サービス アカウント管理者（roles/iam.serviceAccountAdmin）
   • サービス アカウント ユーザー（roles/iam.serviceAccountUser）
   • Service Usage 管理者（roles/serviceusage.serviceUsageAdmin）

   ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

   必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

5. プロジェクトの次のロールを Compute Engine のデフォルト サービス アカウントに付与します。これらのロールは、コンテナ イメージをビルドしてデプロイするときに必要です。
   • Artifact Registry 書き込みロール: Artifact Registry アーティファクトをアップロードする
   • ログ書き込み: Cloud Logging にログを書き込みます
   • Storage オブジェクト ユーザー: Cloud Storage オブジェクトにアクセスします

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/artifactregistry.writer
   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/logging.logWriter
   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/storage.objectUser

   PROJECT_NUMBER は、使用する Google Cloudプロジェクト番号に置き換えます。プロジェクト番号は、 Google Cloud コンソールの [ようこそ] ページで確認できます。また、次のコマンドでも確認できます。

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

6. デフォルトでは、Cloud Run サービスを呼び出すことができるのは、プロジェクト オーナー、プロジェクト編集者、Cloud Run 管理者、Cloud Run 起動元のみです。認証を設定するには、 Google Cloud プロジェクトの Cloud Run 起動元ロール（run.invoker）をサービス アカウントに付与します。
   1. サービス アカウントを作成します。テスト目的で、このサービス アカウントを Eventarc Advanced パイプラインに関連付けて、パイプラインの ID を示します。

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      SERVICE_ACCOUNT_NAME をサービス アカウントの名前に置き換えます。
   2. サービス アカウントに roles/run.invoker IAM ロールを付与します。

      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
          --role=roles/run.invoker

   Cloud Run サービスにアクセスできるユーザーは、次のいずれかの方法で構成できます。

   • サービス アカウントまたはグループを選択して、サービスへのアクセスを許可する権限を付与します。すべてのリクエストには、いずれかの承認済みサービス アカウント用に Google によって署名された OpenID Connect トークンを含む HTTP 認証ヘッダーが必要です。このクイックスタートでは、この方法でアクセスを構成します。
   • allUsers に権限を付与して、認証されていないアクセスを許可します。

   詳細については、Cloud Run のアクセス制御をご覧ください。

Artifact Registry 標準リポジトリを作成する

コンテナ イメージを保存する Artifact Registry 標準リポジトリを作成します。

gcloud artifacts repositories create REPOSITORY \
    --repository-format=docker \
    --location=$REGION

REPOSITORY は、Artifact Registry リポジトリの一意の名前（my-repo など）に置き換えます。

イベント レシーバ サービスを Cloud Run にデプロイする

イベントの内容をログに記録する Cloud Run サービスをデプロイします。Pub/Sub トピック、Workflows、HTTP エンドポイントなど、他のイベント宛先もサポートされています。詳細については、イベント プロバイダと宛先をご覧ください。

1. GitHub リポジトリのクローンを作成します。

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

2. Cloud Run のサンプルコードが含まれているディレクトリに移動します。

   cd eventarc-samples/eventarc-advanced-quickstart/

3. Docker コンテナ イメージをビルドし、イメージをリポジトリに push します。

   gcloud builds submit \
       --tag $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/log-events:v1

4. コンテナ イメージを Cloud Run にデプロイします。

   gcloud run deploy SERVICE_NAME \
       --image $REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY/log-events:v1 \
       --platform managed \
       --ingress all \
       --no-allow-unauthenticated \
       --region=$REGION

   SERVICE_NAME は、サービスの名前に置き換えます（例: my-service）。

   all の Ingress 設定では、インターネットから run.app URL に直接送信されるリクエストを含むすべてのリクエストが許可されます。詳細については、Cloud Run のネットワーク上り（内向き）を制限するをご覧ください。

   --no-allow-unauthenticated フラグは、認証された呼び出しのみを許可するようにサービスを構成します。

Cloud Run サービスの URL が表示されたら、デプロイは完了しています。後のステップで使用できるように、この URL をメモします。

Eventarc Advanced バスを作成する

バスは、メッセージ ソースからイベント メッセージを受信するか、プロバイダによって公開されたイベント メッセージを受信し、メッセージ ルーターとして機能します。

詳細については、メッセージを転送するバスを作成するをご覧ください。

注: サポートされているリージョンごとに、 Google Cloud プロジェクトごとに 1 つのバスを作成できます。

gcloud eventarc message-buses create コマンドを使用して、プロジェクトに Eventarc Advanced バスを作成します。

gcloud eventarc message-buses create BUS_NAME \
    --location=$REGION

BUS_NAME は、バスの ID または完全修飾 ID に置き換えます（例: my-bus）。

Eventarc Advanced の登録を作成する

登録により、宛先にルーティングされるメッセージが決定され、イベント メッセージの宛先を構成するために使用されるパイプラインも指定されます。

詳細については、イベントを受信する登録を作成するをご覧ください。

注: パイプラインの作成には 10 分以上かかる場合があります。

gcloud CLI を使用する場合は、まずパイプラインを作成してから登録を作成します。

1. gcloud eventarc pipelines create コマンドを使用してパイプラインを作成します。

   gcloud eventarc pipelines create PIPELINE_NAME \
       --destinations=http_endpoint_uri='CLOUD_RUN_SERVICE_URL',google_oidc_authentication_service_account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
       --location=$REGION

   次のように置き換えます。

   • PIPELINE_NAME: パイプラインの ID または完全修飾名。
   • CLOUD_RUN_SERVICE_URL: Cloud Run サービスの完全修飾 URL（例: https://SERVICE_NAME-abcdef-uc.a.run.app）。これは、イベント メッセージの宛先です。

   google_oidc_authentication_service_account キーは、OIDC トークンの生成に使用されるサービス アカウントのメールアドレスを指定します。

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=$REGION

   次のように置き換えます。

   • ENROLLMENT_NAME: 登録の ID または完全修飾名。

   • MATCH_EXPRESSION: この登録のCEL を使用したマッチング式。例:

     "message.type == 'hello-world-type'"
     

イベント メッセージをバスにパブリッシュする

バスにメッセージを直接パブリッシュするには、gcloud eventarc message-buses publish コマンドを使用するか、Eventarc Publishing REST API にリクエストを送信します。詳細については、イベントを直接パブリッシュするをご覧ください。

メッセージは、イベントデータを一般的な方法で記述するための仕様である CloudEvents 形式である必要があります。data 要素は、イベントのペイロードです。このフィールドには、整形式の JSON を指定できます。CloudEvents コンテキスト属性の詳細については、イベント形式をご覧ください。

以下は、Eventarc Advanced バスにイベントを直接パブリッシュする例です。

例 1

gcloud CLI と --event-data などのイベント属性フラグを使用して、イベントをバスにパブリッシュできます。

gcloud 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

例 2

gcloud CLI と --json-message フラグを使用して、イベントを JSON メッセージとしてバスにパブリッシュできます。

gcloud 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"}}'

イベントを公開すると、「イベントが正常に公開されました」というメッセージが表示されます。

Cloud Run のログでイベントデータを表示する

Eventarc Advanced バスにイベントをパブリッシュした後、Cloud Run サービスのログを調べて、イベントが想定どおりに受信されたことを確認できます。

1. gcloud logging read コマンドを使用して、ログエントリをフィルタして出力を返します。

   gcloud logging read 'textPayload: "hello-world-data"'
   

2. 次のようなログエントリを探します。

   insertId: 670808e70002b5c6477709ae
   labels:
   instanceId: 007989f2a10a4a33c21024f2c8e06a9de65d9b4fdc2ee27697a50379b3fab2f975b9233dc357d50b06270829b9b479d5a1ee54a10fa2cb2d98c5f77a0895e2be0f9e6e4b20
   logName: projects/PROJECT_ID/logs/run.googleapis.com%2Fstderr
   receiveTimestamp: '2024-10-10T17:03:35.424659450Z'
   resource:
   labels:
   ...
   type: cloud_run_revision
   textPayload: "[2024-10-21 15:33:19,581] INFO in server: Body: b'{\"value\":\"hello-world-data\"\
     }'"
   timestamp: '2024-10-10T17:03:35.177606Z'
   

   注: ログエントリが表示されない場合は、数分待ってから gcloud logging read コマンドを再試行してください。

Eventarc Advanced バスと登録が正常に作成され、イベント メッセージがバスに公開され、イベント レシーバ サービスのログで期待される結果が確認されました。

クリーンアップ

このクイックスタートに記載されているタスクの完了後、作成したリソースを削除すると、それ以上の請求は発生しません。

1. Artifact Registry リポジトリを削除します。

2. Cloud Run サービスを削除する。

3. Eventarc Advanced リソースを削除します。

   1. 登録を削除する。

   2. パイプラインを削除する。

   3. バスを削除する。

また、 Google Cloud プロジェクトを削除して、料金が発生しないようにすることもできます。 Google Cloud プロジェクトを削除すると、そのプロジェクト内で使用されているすべてのリソースに対する課金が停止します。

注意: プロジェクトを削除すると、次のような影響があります。

• プロジェクト内のすべてのものが削除されます。このドキュメントのタスクで既存のプロジェクトを使用した場合、それを削除すると、そのプロジェクトで行った他の作業もすべて削除されます。
• カスタム プロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタム プロジェクト ID を作成した可能性があります。そのプロジェクト ID を使用した URL（たとえば、appspot.com）を保持するには、プロジェクト全体ではなくプロジェクト内の選択したリソースだけを削除します。

複数のアーキテクチャ、チュートリアル、クイックスタートを実施する予定がある場合は、プロジェクトを再利用すると、プロジェクトの割り当て上限の超過を回避できます。

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

次のステップ

• Google ソースからイベントを公開する
• イベントを直接公開する
• 受信したイベントを変換する
• 受信したイベントの形式を設定する