VPC ネットワークの内部 HTTP エンドポイントで Pub/Sub イベントを受信する

このチュートリアルでは、Eventarc を使用して Pub/Sub メッセージイベントを受信する Virtual Private Cloud（VPC）ネットワークの内部 HTTP エンドポイントを作成する方法について説明します。このイベントの宛先の詳細については、VPC ネットワークの内部 HTTP エンドポイントにイベントをルーティングするをご覧ください。

ターミナルまたは Cloud Shell で Google Cloud CLI を使用して、次のコマンドを実行できます。

目標

このチュートリアルの内容は次のとおりです。

VPC ネットワークを作成して、クラウドベースのリソースとサービスにネットワーキングを提供します。VPC ネットワークは、Google Cloud の他のネットワークから論理的に分離されています。
サブネットを作成します。各 VPC ネットワークは、サブネットと呼ばれる 1 つ以上の IP アドレス範囲で構成されています。サブネットはリージョンリソースであり、IP アドレス範囲が関連付けられています。
VPC ネットワーク内の VM（仮想マシン）インスタンスとの間で送受信されるトラフィックを許可または拒否できるように、VPC ファイアウォールルールを作成します。
プロデューサー VPC ネットワークがコンシューマー VPC ネットワークへの接続を開始できるようにネットワークアタッチメントを作成します。
VPC ネットワークに Compute Engine VM インスタンスを作成します。
VM インスタンスにイベントレシーバーサービスとしてウェブサーバーをデプロイします。
Pub/Sub イベントを VM インスタンスのイベントレシーバーに転送する Eventarc トリガーを作成します。
VM インスタンスとの SSH 接続を確立します。
Pub/Sub トピックにメッセージを公開してイベントを生成し、ブラウザで SSH ツールでイベントの本文を表示します。

費用

このドキュメントでは、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.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud 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.

Make sure that billing is enabled for your Google Cloud project.

Enable the Compute Engine, Eventarc, and Pub/Sub APIs:

gcloud services enable compute.googleapis.com eventarc.googleapis.com pubsub.googleapis.com

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud 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.

Make sure that billing is enabled for your Google Cloud project.

Enable the Compute Engine, Eventarc, and Pub/Sub APIs:

gcloud services enable compute.googleapis.com eventarc.googleapis.com pubsub.googleapis.com

Google Cloud CLI のコンポーネントを更新します。
```
gcloud components update
```
アカウントを使用してログインします。
```
gcloud auth login
```
このクイックスタートで使用する構成変数を設定します。
```
REGION=us-central1
ZONE=us-central1-a
```
プロジェクト作成者には、オーナーロール（roles/owner）が付与されます。デフォルトでは、この Identity and Access Management（IAM）ロールには、ほとんどの Google Cloud リソースへの完全アクセス権に必要な権限が含まれており、この手順は省略できます。

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

このクイックスタートを完了するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。
- Compute ネットワーク管理者（roles/compute.networkAdmin）
- Compute セキュリティ管理者（roles/compute.securityAdmin）
- Eventarc 管理者（roles/eventarc.admin）
- ログ表示アクセス者（roles/logging.viewAccessor）
- プロジェクト IAM 管理者（roles/resourcemanager.projectIamAdmin）
- Pub/Sub パブリッシャー（roles/pubsub.publisher）
- サービスアカウント管理者（roles/iam.serviceAccountAdmin）
- サービスアカウントユーザー（roles/iam.serviceAccountUser）
- Service Usage 管理者（roles/serviceusage.serviceUsageAdmin）
ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
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
```
次のように置き換えます。
- PROJECT_ID: 実際の Google Cloud プロジェクト ID
- PROJECT_NUMBER: Google Cloud プロジェクト番号。プロジェクト番号は、Google Cloud コンソールの [ようこそ] ページで確認できます。また、次のコマンドを実行して確認することもできます。
```
gcloud projects describe PROJECT_ID --format='value(projectNumber)'
```

カスタムモードの VPC ネットワークを作成する

VPC ネットワークは、Google の本番環境ネットワーク内に仮想的に実装された物理ネットワークです。Compute Engine VM インスタンスへの接続を提供します。

カスタムモード VPC ネットワークが作成されるときに、サブネットは自動的には作成されません。サブネットと IP 範囲は管理者が完全に制御できます。

gcloud compute networks create NETWORK_NAME \
    --subnet-mode=custom \
    --bgp-routing-mode=regional \
    --mtu=1460

NETWORK_NAME は、VPC ネットワークの名前に置き換えます。

次の点にご注意ください。

新しく作成した各ネットワークには、同じプロジェクト内で一意の名前を付ける必要があります。
Border Gateway Protocol（BGP）ルーティングモードは、ネットワーク内の Cloud Router の動作を制御します。これは global または regional のいずれかに設定できます。デフォルトは regional です。
最大伝送単位（MTU）は、ネットワークの最大パケットサイズです。MTU は、1300 から 8896 までの任意の値に設定できます。デフォルトは 1460 です。MTU を 1460 より大きい値に設定する前に、最大伝送単位を確認してください。

詳細については、VPC ネットワークの作成と管理をご覧ください。

IPv4 専用のサブネットを作成する

ネットワークを使用するには、そのネットワークに少なくとも 1 つのサブネットが必要です。

サブネットを作成するときは、サブネットルールに従って、名前、リージョン、少なくとも 1 つのプライマリ IPv4 アドレス範囲を設定します。サブネットが定義されていないリージョンにインスタンスを作成することはできません。

gcloud compute networks subnets create SUBNET_NAME \
    --region=$REGION \
    --network=NETWORK_NAME \
    --range=10.10.10.0/24

SUBNET_NAME は、新しいサブネットの名前に置き換えます。

詳細については、サブネットをご覧ください。

VPC ファイアウォールルールを作成する

VPC ファイアウォールルールを使用すると、ポート番号、タグ、プロトコルに基づいて、VPC ネットワーク内のリソース間のトラフィックを許可または拒否できます。

VPC ファイアウォールルールはネットワークレベルで定義され、ルールが作成されたネットワークにのみ適用されます。ただし、ルールにはプロジェクトごとに一意の名前を設定する必要があります。

VPC ネットワークのファイアウォールルールを作成します。このファイアウォールルールでは、任意の IPv4 アドレス（0.0.0.0/0）からネットワーク上の任意のインスタンス（ポート 22 を使用）に送信される上り（内向き）トラフィックを許可するようにします。このルールは、イベントの配信には必要ありません。このチュートリアルでこのルールを作成する目的は、SSH を使用して VM に接続し、イベントの配信を確認できるようにすることです。
```
gcloud compute firewall-rules create RULE_NAME_ONE \
    --network=projects/PROJECT_ID/global/networks/NETWORK_NAME \
    --direction=INGRESS \
    --priority=65534 \
    --action=ALLOW \
    --source-ranges=0.0.0.0/0 \
    --rules=tcp:22
```
VPC ネットワークのファイアウォールルールを作成します。このファイアウォールルールでは、特定の IP アドレス範囲から、ネットワーク上の任意のインスタンス（ポート 80 を使用）に送信される上り（内向き）トラフィックを許可するようにします（VM 上にウェブサーバーをデプロイしてポート 80 をリッスンするためです）。
```
gcloud compute firewall-rules create RULE_NAME_TWO \
    --network=projects/PROJECT_ID/global/networks/NETWORK_NAME \
    --direction=INGRESS \
    --priority=1000 \
    --action=ALLOW \
    --source-ranges=10.10.10.0/24 \
    --rules=tcp:80
```
RULE_NAME_ONE と RULE_NAME_TWO は、ファイアウォールルールの一意の名前に置き換えます。

--source-ranges は省略可能です。これには、インバウンド接続を許可する IP アドレスブロックのリストを指定します。ファイアウォールルールに一致し、IP アドレスがこのブロックに含まれる場合に限り、ネットワーク上のインスタンスへの接続が許可されます。この場合、範囲は以前に作成したサブネットで使用されている範囲と一致します。

このフラグを使用して、Eventarc トラフィックに特化したファイアウォールルールを適用することをおすすめします。--source-ranges と --source-tags のどちらも指定されていない場合、--source-ranges はデフォルトで 0.0.0.0/0 になります。つまり、このルールはネットワーク内外から到着するすべての IPv4 接続に適用されます。

詳細については、VPC ファイアウォールルールを使用するをご覧ください。

ネットワークアタッチメントを作成する

ネットワークアタッチメントは、プロデューサー VPC ネットワークが Private Service Connect インターフェースを介してコンシューマー VPC ネットワークへの接続を開始できるようにするためのリソースです。

イベントを公開するために、Eventarc はネットワークアタッチメントを使用して、VPC ネットワークでホストされている内部 HTTP エンドポイントとの接続を確立します。

ネットワークアタッチメントを参照する Private Service Connect インターフェースからの接続を自動的に受け入れるネットワークアタッチメントを作成できます。HTTP 宛先サービスを含むネットワークとリージョンにネットワークアタッチメントを作成します。

gcloud compute network-attachments create ATTACHMENT_NAME \
    --region=$REGION \
    --subnets=SUBNET_NAME \
    --connection-preference=ACCEPT_AUTOMATIC

ATTACHMENT_NAME は、ネットワークアタッチメントの名前に置き換えます。

詳細については、ネットワークアタッチメントについてをご覧ください。

指定したサブネットで VM インスタンスを作成する

Compute Engine VM インスタンスは、Google のインフラストラクチャでホストされる仮想マシンです。Compute Engine インスタンス、VM インスタンス、VM という用語は同義語であり、同じ意味で使用されています。VM インスタンスには、Google Kubernetes Engine（GKE）クラスタ、App Engine フレキシブル環境インスタンス、Compute Engine VM 上に構築された他の Google Cloud プロダクトが含まれます。

イベントレシーバーサービスをデプロイできる VPC ネットワークに Compute Engine VM インスタンスを作成します。

gcloud compute instances create INSTANCE_NAME \
      --zone=$ZONE \
      --machine-type=e2-medium \
      --subnet=SUBNET_NAME

INSTANCE_NAME は VM の名前に置き換えます。

詳しくは、VM インスタンスの作成と開始をご覧ください。

VM にイベントレシーバーをデプロイする

ポート 80 でリッスンし、イベントを受信してロギングするウェブサーバーを VM にデプロイします。

Google Cloud コンソールの [SSH] ボタンを使用して VM に接続し、VM インスタンスへの SSH 接続を確立します。

SSH サーバーへの接続が確立されたら、ブラウザの SSH ターミナルを使用して VM インスタンスでコマンドを実行します。

ブラウザでの SSH ターミナルで、次の Python コードを含むテキストファイルを server.py という名前で作成します。

#!/usr/bin/env python3
from http.server import BaseHTTPRequestHandler, HTTPServer
import logging

class S(BaseHTTPRequestHandler):
    def _set_response(self):
        self.send_response(200)
        self.send_header('Content-type', 'text/html')
        self.end_headers()

    def do_GET(self):
        logging.info("GET request,\nPath: %s\nHeaders:\n%s\n", str(self.path), str(self.headers))
        self._set_response()
        self.wfile.write("GET request for {}".format(self.path).encode('utf-8'))

    def do_POST(self):
        content_length = int(self.headers['Content-Length'])
        post_data = self.rfile.read(content_length)
        logging.info("POST request,\nPath: %s\nHeaders:\n%s\n\nBody:\n%s\n",
                str(self.path), str(self.headers), post_data.decode('utf-8'))

        self._set_response()
        self.wfile.write("POST request for {}".format(self.path).encode('utf-8'))

def run(server_class=HTTPServer, handler_class=S, port=80):
    logging.basicConfig(level=logging.INFO)
    server_address = ('', port)
    http_server = server_class(server_address, handler_class)
    logging.info('Starting HTTP Server at port %d...\n', port)
    try:
        http_server.serve_forever()
    except KeyboardInterrupt:
        pass
    http_server.server_close()
    logging.info('Stopping HTTP Server...\n')

if __name__ == '__main__':
    from sys import argv

    if len(argv) == 2:
        run(port=int(argv[1]))
    else:
        run()

このチュートリアルの残りの手順では、サーバーを実行したままにします。
```
sudo python3 server.py
```

Eventarc トリガーを作成する

新しい Pub/Sub トピックを作成し、メッセージが Pub/Sub トピックにパブリッシュされたときに、VM にデプロイされたイベントレシーバーにイベントを転送する Eventarc トリガーを作成します。

トリガーでは、テスト目的で Compute Engine のデフォルトのサービスアカウント（PROJECT_NUMBER-compute@developer.gserviceaccount.com）を ID として使用します。このサービスアカウントは、Compute Engine API を有効にすると自動的に作成されます。

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

注:

iam.automaticIamGrantsForDefaultServiceAccounts 組織のポリシーの制約により、編集者のロールはデフォルトのサービスアカウントに自動的に付与されません。2024 年 5 月 3 日より後に組織を作成した場合、この制約はデフォルトで適用されます。

この制約を適用して、ロールの自動付与を無効にすることを強くおすすめします。ロールの自動付与を無効にする場合は、デフォルトのサービスアカウントに付与するロールを決定し、ご自身でこれらのロールを付与する必要があります。

デフォルトのサービスアカウントにすでに編集者ロールが設定されている場合は、編集者ロールを権限の低いロールに置き換えることをおすすめします。サービスアカウントのロールを安全に変更するには、Policy Simulator を使用して変更の影響を確認してから、適切なロールを付与または取り消す操作を行います。

gcloud eventarc triggers create TRIGGER_NAME \
    --location=$REGION \
    --destination-http-endpoint-uri=http://INSTANCE_NAME.$ZONE.c.PROJECT_ID.internal \
    --network-attachment="projects/PROJECT_ID/regions/$REGION/networkAttachments/ATTACHMENT_NAME" \
    --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
    --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

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

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

トリガーの構成の詳細については、VPC ネットワークの内部 HTTP エンドポイントにイベントを転送するをご覧ください。

Pub/Sub トピックイベントを生成して表示する

Pub/Sub トピックにメッセージを公開することでイベントを生成できます。

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

export MY_TOPIC=$(gcloud eventarc triggers describe TRIGGER_NAME \
    --location=$REGION \
    --format='value(transport.pubsub.topic)')

Pub/Sub トピックにメッセージをパブリッシュしてイベントを生成します。
```
gcloud pubsub topics publish $MY_TOPIC --message "Hello World"
```
Eventarc トリガーは、VPC ネットワークの内部 HTTP エンドポイントにイベントを転送します。ブラウザの SSH ターミナルに、イベントの本文が出力されます。次のようになります。
```
Body:
{
    "message": {
        "data": "SGVsbG8gV29ybGQ=",
        "messageId": "8795720366614192",
        "publishTime": "2023-08-26T13:09:48Z"
    }
}

10.10.10.3 - - [26/Aug/2023 13:09:49] "POST / HTTP/1.1" 200 -
```
SGVsbG8gV29ybGQ= の data 値を Base64 形式からデコードすると「Hello World」が返されます。

これで VPC ネットワークの内部 HTTP エンドポイントにイベントレシーバーサービスが正常にデプロイされ、Eventarc トリガーが作成されて、Pub/Sub からイベントが生成されました。また、トリガーにより、イベントが期待どおりにターゲットエンドポイントにルーティングされたことを確認できました。

クリーンアップ

このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、リソースを含むプロジェクトを削除するか、プロジェクトを維持して個々のリソースを削除します。

プロジェクトを削除する

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

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

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

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

リソースを個別に削除する

Eventarc トリガーを削除します。

gcloud eventarc triggers delete TRIGGER_NAME --location=$REGION

インスタンスを削除します。

gcloud compute instances delete INSTANCE_NAME

ネットワークアタッチメントを削除します。

gcloud compute network-attachments delete ATTACHMENT_NAME --region=$REGION

ファイアウォールルールを削除します。

gcloud compute firewall-rules delete RULE_NAME_ONE
gcloud compute firewall-rules delete RULE_NAME_TWO

サブネットを削除します。

gcloud compute networks subnets delete SUBNET_NAME --region=$REGION

VPC ネットワークを削除します。

gcloud compute networks delete NETWORK_NAME