Pub/Sub メッセージを使用してイベントを受信する（gcloud CLI）

このクイックスタートでは、Eventarc を使用して Google Kubernetes Engine（GKE）サービスを Pub/Sub トピック イベントを受信する宛先として設定する方法について説明します。

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

  1. API の有効化やサービス アカウントの設定などの準備作業を完了する。
  2. GKE クラスタを作成する。
  3. Eventarc で GKE の宛先を初期化する。
  4. イベントを受信する GKE サービスをデプロイする。
  5. Pub/Sub トピックを GKE サービスに接続する Eventarc トリガーを作成する。
  6. Pub/Sub イベントを生成して表示する。

始める前に

  1. 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.

  2. Install the Google Cloud CLI.

  3. 外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

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

    gcloud init

  5. Create or select a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    • 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.

  6. Verify that billing is enabled for your Google Cloud project.

  7. Install the Google Cloud CLI.

  8. 外部 ID プロバイダ（IdP）を使用している場合は、まず連携 ID を使用して gcloud CLI にログインする必要があります。

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

    gcloud init

  10. Create or select a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    • 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.

  11. Verify that billing is enabled for your Google Cloud project.

  12. Google Cloud CLI のコンポーネントを更新します。 
    gcloud components update
  13. Eventarc、Resource Manager、Google Kubernetes Engine の各 API を有効にします。
    gcloud services enable eventarc.googleapis.com \
   cloudresourcemanager.googleapis.com \
   container.googleapis.com

  14. このクイックスタートで使用する構成変数を設定します。
    PROJECT_ID=$(gcloud config get-value project)
CLUSTER_NAME=events-cluster
SERVICE_NAME=hello-gke
LOCATION=us-central1

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

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

    必要な権限

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

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

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

  16. Compute Engine のデフォルトのサービス アカウントをメモしておいてください。テスト目的で、Eventarc トリガーに関連付けて、トリガーの ID を示すためです。このサービス アカウントは、Compute Engine を使用する Google Cloud サービスを有効にするか使用すると自動的に作成されます。メールアドレスの形式は次のとおりです。

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

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

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

    本番環境では、新しいサービス アカウントを作成して、必要最小限の権限を含む、最小権限の原則に従った 1 つ以上の IAM ロールを付与することを強くおすすめします。

  17. プロジェクトの Pub/Sub サブスクライバーのロール（roles/pubsub.subscriber）を Compute Engine のデフォルト サービス アカウントに付与して、Eventarc トリガーが Pub/Sub からイベントを pull できるようにします。
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/pubsub.subscriber

  18. 2021 年 4 月 8 日以前に、認証済みの Pub/Sub push リクエストをサポートするために Cloud Pub/Sub サービス エージェントを有効にした場合は、サービス アカウント トークン作成者のロール（roles/iam.serviceAccountTokenCreator）をサービス エージェントに付与します。それ以外の場合、このロールはデフォルトで付与されます。
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
    --role=roles/iam.serviceAccountTokenCreator

    19. GKE クラスタを作成する

    GKE クラスタは、少なくとも 1 つのクラスタ コントロール プレーン マシンと、ノードと呼ばれる複数のワーカーマシンで構成されます。ノードは Compute Engine 仮想マシン（VM）インスタンスであり、自身をクラスタの一部にするために必要な Kubernetes プロセスを実行します。アプリケーションをクラスタにデプロイすると、そのアプリケーションがこれらのノードで実行されます。

    events-cluster という名前の Autopilot クラスタを作成します。

    gcloud container clusters create-auto $CLUSTER_NAME \
    --region $LOCATION

    クラスタの作成が完了するまでに数分かかることがあります。クラスタの作成が完了すると、出力は次のようになります。

    Creating cluster events-cluster...done.
Created [https://container.googleapis.com/v1/projects/MY_PROJECT/zones/us-central1/clusters/events-cluster].
[...]
STATUS: RUNNING

    これにより、 Google Cloud プロジェクト ID が MY_PROJECT のプロジェクトに、events-cluster という名前の GKE クラスタが作成されます。

    GKE の宛先を有効にする

    Eventarc は、GKE サービスをターゲットとするトリガーごとに、Pub/Sub からイベントを pull してターゲットに転送するイベント フォワーダー コンポーネントを作成します。コンポーネントを作成し、GKE クラスタでリソースを管理するには、Eventarc サービス エージェントに権限を付与します。

    1. Eventarc 用に GKE の宛先を有効にします。

      gcloud eventarc gke-destinations init

    2. 必要なロールをバインドするよう求められたら、「y」と入力します。

      サービス アカウントに次のロールが割り当てられます。

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

    GKE Service の宛先を作成する

    ビルド済みのイメージ us-docker.pkg.dev/cloudrun/container/hello を使用して、イベントを受信してログに記録する GKE Service をデプロイします。

    1. Kubernetes は、kubeconfig という名前の YAML ファイルを使用して、kubectl のクラスタ認証情報を格納します。GKE クラスタの kubectl を指すように、認証情報とエンドポイント情報を使用して kubeconfig ファイルを更新します。

      gcloud container clusters get-credentials $CLUSTER_NAME \
    --region $LOCATION

    2. Kubernetes Deployment を作成します。

      kubectl create deployment $SERVICE_NAME \
    --image=us-docker.pkg.dev/cloudrun/container/hello

    3. これを Kubernetes Service として公開します。

      kubectl expose deployment $SERVICE_NAME \
    --type ClusterIP \
    --port 80 \
    --target-port 8080

    Eventarc トリガーを作成する

    Pub/Sub トピックにメッセージが公開されると、Eventarc トリガーによって hello-gke GKE サービスにメッセージが送信されます。

    1. Pub/Sub メッセージをリッスンする GKE トリガーを作成します。

      新しい Pub/Sub トピック

      gcloud eventarc triggers create gke-trigger-pubsub \
    --location="$LOCATION" \
    --destination-gke-cluster=$CLUSTER_NAME \
    --destination-gke-location=$LOCATION \
    --destination-gke-namespace=default \
    --destination-gke-service=$SERVICE_NAME \
    --destination-gke-path=/ \
    --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
    --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com"

      これにより、新しい Pub/Sub トピックと gke-trigger-pubsub というトリガーが作成されます。

      既存の Pub/Sub トピック

      gcloud eventarc triggers create gke-trigger-pubsub \
    --location="$LOCATION" \
    --destination-gke-cluster=$CLUSTER_NAME \
    --destination-gke-location=$LOCATION \
    --destination-gke-namespace=default \
    --destination-gke-service=$SERVICE_NAME \
    --destination-gke-path=/ \
    --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
    --service-account="PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
    --transport-topic=projects/PROJECT_ID/topics/TOPIC_ID

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

      • PROJECT_ID: 実際の Google Cloudプロジェクト ID
      • TOPIC_ID: 既存の Pub/Sub トピックの ID。これにより、既存の Pub/Sub トピックに gke-trigger-pubsub というトリガーが作成されます。

    2. トリガーが正常に作成されたことを確認します。トリガーが完全に機能するまで 2 分ほどかかることがあります。

       gcloud eventarc triggers list

      出力例を以下に示します。

      NAME: gke-trigger-pubsub
TYPE: google.cloud.pubsub.topic.v1.messagePublished
DESTINATION: GKE: hello-gke
ACTIVE: Yes
LOCATION: us-central1

    イベントを生成して表示する

    Pub/Sub トピックにメッセージを公開することで、GKE サービスをトリガーするイベントを生成できます。その後、Pod のログでメッセージを確認できます。

    1. Pub/Sub トピックを検索して、環境変数として設定します。

      TOPIC=$(gcloud eventarc triggers describe gke-trigger-pubsub \
    --location=us-central1 \
    --format='value(transport.pubsub.topic)')

    2. Pub/Sub トピックにメッセージを送信してイベントを生成します。

      gcloud pubsub topics publish $TOPIC --message="Hello World"

      GKE サービスがイベントのメッセージをログに記録します。

    3. イベント メッセージを表示するには:

      1. Pod ID を見つけます。

        kubectl get pods

        出力例を以下に示します。

        NAME                                         READY   STATUS             RESTARTS   AGE
hello-gke-645964f578-2mjjt                   1/1     Running            0          35s

        次のステップで使用する Pod の NAME をコピーします。

      2. Pod のログを確認します。

        kubectl logs NAME

        NAME は、コピーした Pod の名前に置き換えます。

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

        2022/02/24 22:23:49 Hello from Cloud Run! The container started successfully and is listening for HTTP requests on $PORT
{"severity":"INFO","eventType":"google.cloud.pubsub.topic.v1.messagePublished","message":"Received event of type google.cloud.pubsub.topic.v1.messagePublished. Event data: Hello World"[...]}

    クリーンアップ

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

    次のことが可能です。

    1. Eventarc トリガーを削除する。

      これにより、関連する Pub/Sub トピックも削除されます。

    2. GKE クラスタを削除する。

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

    Delete a Google Cloud project:

    gcloud projects delete PROJECT_ID

    複数のチュートリアルとクイックスタートを実施する予定がある場合は、プロジェクトを再利用すると、プロジェクトの割り当て上限を超えないようにできます。

    次のステップ

    Cloud Audit Logs を使用してイベントを受信する（Google Cloud CLI）