Pub/Sub メッセージを使用してイベントを受信する（gcloud CLI）
このクイックスタートでは、Eventarc を使用して Google Kubernetes Engine（GKE）サービスを Pub/Sub トピック イベントを受信する宛先として設定する方法について説明します。
このクイックスタートでは、以下の作業を行います。
- API の有効化やサービス アカウントの設定などの準備作業を完了する。
- GKE クラスタを作成する。
- Eventarc で GKE の宛先を初期化する。
- イベントを受信する GKE サービスをデプロイする。
- Pub/Sub トピックを GKE サービスに接続する Eventarc トリガーを作成する。
- Pub/Sub イベントを生成して表示する。
始める前に
- Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。
- Google Cloud CLI をインストールします。
-
gcloud CLI を初期化するには:
gcloud init
-
Google Cloud プロジェクトを作成または選択します。
-
Google Cloud プロジェクトを作成します。
gcloud projects create PROJECT_ID
PROJECT_IDは、作成する Google Cloud プロジェクトの名前に置き換えます。 -
作成した Google Cloud プロジェクトを選択します。
gcloud config set project PROJECT_ID
PROJECT_IDは、実際の Google Cloud プロジェクト名に置き換えます。
-
- Google Cloud CLI をインストールします。
-
gcloud CLI を初期化するには:
gcloud init
-
Google Cloud プロジェクトを作成または選択します。
-
Google Cloud プロジェクトを作成します。
gcloud projects create PROJECT_ID
PROJECT_IDは、作成する Google Cloud プロジェクトの名前に置き換えます。 -
作成した Google Cloud プロジェクトを選択します。
gcloud config set project PROJECT_ID
PROJECT_IDは、実際の Google Cloud プロジェクト名に置き換えます。
-
- Google Cloud CLI のコンポーネントを更新します。
gcloud components update
- Eventarc、Resource Manager、Google Kubernetes Engine の各 API を有効にします。
gcloud services enable eventarc.googleapis.com \ cloudresourcemanager.googleapis.com \ container.googleapis.com
- このクイックスタートで使用する構成変数を設定します。
PROJECT_ID=$(gcloud config get-value project) CLUSTER_NAME=events-cluster SERVICE_NAME=hello-gke LOCATION=us-central1
-
プロジェクト作成者には、オーナーロール（
roles/owner）が付与されます。デフォルトでは、この Identity and Access Management（IAM）ロールには、ほとんどの Google Cloud リソースへの完全アクセス権に必要な権限が含まれており、この手順は省略できます。プロジェクト作成者でない場合は、プロジェクトで適切なプリンシパルに必要な権限を付与する必要があります。プリンシパルは Google アカウント（エンドユーザーの場合）やサービス アカウント（アプリケーションとコンピューティング ワークロードの場合）になることもあります。詳細については、イベントの宛先のロールと権限のページをご覧ください。
必要な権限
このクイックスタートを完了するために必要な権限を取得するには、プロジェクトに対して次の IAM ロールを付与するよう管理者に依頼してください。
- Eventarc 管理者（
roles/eventarc.admin） - Kubernetes Engine 管理者（
roles/container.admin） - ログ表示アクセス者（
roles/logging.viewAccessor） - プロジェクト IAM 管理者（
roles/resourcemanager.projectIamAdmin） - Pub/Sub パブリッシャー（
roles/pubsub.publisher） - サービス アカウント管理者（
roles/iam.serviceAccountAdmin） - サービス アカウント ユーザー（
roles/iam.serviceAccountUser） - Service Usage 管理者 （
roles/serviceusage.serviceUsageAdmin）
ロールの付与の詳細については、アクセスの管理をご覧ください。
- Eventarc 管理者（
Compute Engine を使用する Google Cloud サービスを有効にするか、使用すると、Compute Engine のデフォルトのサービス アカウントが自動的に作成されます。
テスト目的で、このサービス アカウントを Eventarc トリガーに関連付けて、トリガーの ID を示すこともできます。トリガーの作成時に使用するメールの形式に注意してください。
PROJECT_NUMBER-compute@developer.gserviceaccount.com
PROJECT_NUMBERは、実際の Google Cloud プロジェクトの番号に置き換えます。プロジェクト番号は、Google Cloud コンソールの [ようこそ] ページで確認できます。また、次のコマンドで確認することもできます。gcloud projects describe PROJECT_ID --format='value(projectNumber)'
Compute Engine サービス アカウントには、プロジェクトの編集者ロール（
roles/editor）が自動的に付与されます。ただし、自動ロール付与が無効になっている場合は、該当するロールと権限の手順に沿って新しいサービス アカウントを作成し、必要なロールを付与してください。- プロジェクトの 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 - 2021 年 4 月 8 日以前に、認証済みの Pub/Sub push リクエストをサポートするために Cloud Pub/Sub サービス エージェントを有効にした場合は、サービス アカウント トークン作成者のロール（
roles/iam.serviceAccountTokenCreator）を Google マネージド サービス アカウントに付与します。それ以外の場合、このロールはデフォルトで付与されます。gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
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 サービス エージェントに権限を付与します。
Eventarc 用に GKE の宛先を有効にします。
gcloud eventarc gke-destinations init
必要なロールをバインドするよう求められたら、「
y」と入力します。サービス アカウントに次のロールが割り当てられます。
compute.viewercontainer.developeriam.serviceAccountAdmin
GKE サービスの宛先を作成する
ビルド済みのイメージ gcr.io/cloudrun/hello を使用して、イベントを受信してログに記録する GKE サービスをデプロイします。
Kubernetes は、
kubeconfigという名前の YAML ファイルを使用して、kubectlのクラスタ認証情報を格納します。GKE クラスタのkubectlを指すように、認証情報とエンドポイント情報を使用してkubeconfigファイルを更新します。gcloud container clusters get-credentials $CLUSTER_NAME \ --region $LOCATIONKubernetes Deployment を作成します。
kubectl create deployment $SERVICE_NAME \ --image=gcr.io/cloudrun/helloこれを Kubernetes Service として公開します。
kubectl expose deployment $SERVICE_NAME \ --type ClusterIP \ --port 80 \ --target-port 8080
Eventarc トリガーを作成する
Pub/Sub トピックにメッセージが公開されると、Eventarc トリガーによって hello-gke GKE サービスにメッセージが送信されます。
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 プロジェクト IDTOPIC_ID: 既存の Pub/Sub トピックの ID。これにより、既存の Pub/Sub トピックにgke-trigger-pubsubというトリガーが作成されます。
トリガーが正常に作成されたことを確認します。トリガーが完全に機能するまで 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 のログでメッセージを確認できます。
Pub/Sub トピックを検索して、環境変数として設定します。
TOPIC=$(gcloud eventarc triggers describe gke-trigger-pubsub \ --location=us-central1 \ --format='value(transport.pubsub.topic)')Pub/Sub トピックにメッセージを送信してイベントを生成します。
gcloud pubsub topics publish $TOPIC --message="Hello World"
GKE サービスがイベントのメッセージをログに記録します。
イベント メッセージを表示するには:
Pod ID を見つけます。
kubectl get pods
出力例を以下に示します。
NAME READY STATUS RESTARTS AGE hello-gke-645964f578-2mjjt 1/1 Running 0 35s
次のステップで使用する Pod の
NAMEをコピーします。Pod のログを確認します。
kubectl logs NAME
NAMEは、コピーした Pod の名前に置き換えます。次のようなログエントリを探します。
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"[...]}
クリーンアップ
サービスが使用されていない場合、Cloud Run の料金は発生しませんが、Container Registry へのコンテナ イメージの保存、Eventarc リソース、Pub/Sub メッセージ、GKE クラスタに対して Cloud Run の料金が発生する場合があります。
イメージの削除、Pub/Sub トピックの削除、Pub/Sub サブスクリプションの削除、GKE クラスタの削除を行うことができます。
Eventarc トリガーを削除するには:
gcloud eventarc triggers delete gke-trigger-pubsub
また、Google Cloud プロジェクトを削除して、料金が発生しないようにすることもできます。Google Cloud プロジェクトを削除すると、そのプロジェクト内で使用されているすべてのリソースに対する課金が停止します。
gcloud projects delete PROJECT_ID_OR_NUMBER
PROJECT_ID_OR_NUMBER は、プロジェクト ID またはプロジェクト番号に置き換えます。