ESP を使用した GKE 用 Endpoints のスタートガイド

---

OpenAPI   |  gRPC

ここでは、Google Kubernetes Engine（GKE）上の Extensible Service Proxy（ESP）を使用して単純な gRPC サービスの例をデプロイする方法について説明します。このチュートリアルでは、bookstore-grpc サンプルの Python 版を使用しています。他の言語の gRPC サンプルについては、次のステップ セクションをご覧ください。

このチュートリアルでは、事前にビルドしたサンプルコードと ESP のコンテナ イメージを使用します（これらは、Container Registry に保存されています）。コンテナをまだよく理解していない場合は、次の情報をご覧ください。

• コンテナ化されたウェブ アプリケーションのデプロイ
• Kubernetes コンテナのイメージ

Cloud Endpoints の概要については、Endpoints についてと Endpoints アーキテクチャをご覧ください。

目標

タスクの概要を示す次のリストを参照しながら、チュートリアルを実施してください。API にリクエストを送信するには、すべてのタスクを行う必要があります。

1. Google Cloud プロジェクトをセットアップして、必要なソフトウェアをダウンロードします。始める前にをご覧ください。
2. bookstore-grpc サンプルからファイルをコピーして構成します。Endpoints を構成するをご覧ください。
3. Endpoints 構成をデプロイして Endpoints サービスを作成します。Endpoints 構成をデプロイするをご覧ください。
4. API を提供するバックエンドを作成し、API をデプロイします。API バックエンドをデプロイするをご覧ください。
5. サービスの外部 IP アドレスを取得します。サービスの外部 IP アドレスを取得するをご覧ください。
6. API にリクエストを送信します。API にリクエストを送信するをご覧ください。
7. Google Cloud アカウントへの課金が発生しないようにします。クリーンアップをご覧ください。

料金

このドキュメントでは、Google Cloud の次の課金対象のコンポーネントを使用します。

• GKE
• Endpoints

料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。 新しい Google Cloud ユーザーは無料トライアルをご利用いただける場合があります。

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

始める前に

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. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

   プロジェクト セレクタに移動

3. Google Cloud プロジェクトで課金が有効になっていることを確認します。

4. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

   注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

   プロジェクト セレクタに移動

5. Google Cloud プロジェクトで課金が有効になっていることを確認します。

6. 後で必要になるので、Google Cloud プロジェクト ID はメモしておいてください。
7. Google Cloud CLI をインストールして初期化します。
8. gcloud CLI を更新し、Endpoints コンポーネントをインストールします。

   gcloud components update

9. Google Cloud CLI（gcloud）が、Google Cloud にある対象のデータとサービスへのアクセスが許可されていることを確認します。

   gcloud auth login

   新しいブラウザタブが開き、アカウントの選択を要求するプロンプトが表示されます。
10. デフォルト プロジェクトを実際のプロジェクト ID に設定します。

    gcloud config set project YOUR_PROJECT_ID

    YOUR_PROJECT_ID を実際のプロジェクト ID に置き換えます。

    他にも Google Cloud プロジェクトがあり、gcloud を使用してそのプロジェクトを管理する場合は、gcloud CLI 構成の管理をご覧ください。

11. kubectl のインストール:

    gcloud components install kubectl

12. アプリケーションのデフォルト認証情報用に使用する新しいユーザー認証情報を取得します。ユーザー認証情報は kubectl を承認するために必要です。

    gcloud auth application-default login

    表示された新しいブラウザタブで、アカウントを選択します。
13. gRPC Python クイックスタートの手順に従い、gRPC と gRPC ツールをインストールします。

Endpoints の設定

bookstore-grpc サンプルには、ローカルにコピーして構成する必要のあるファイルが含まれています。

1. サービスの .proto ファイルから、自己完結型 protobuf 記述子ファイルを作成します。
   1. サンプル リポジトリから、bookstore.proto のコピーを保存します。このファイルは Bookstore サービスの API を定義します。
   2. 次のコマンドでディレクトリを作成します。mkdir generated_pb2
   3. protoc プロトコル バッファ コンパイラを使用して、記述子ファイル api_descriptor.pb を作成します。bookstore.proto を保存したディレクトリで次のコマンドを実行します。

      python -m grpc_tools.protoc \
          --include_imports \
          --include_source_info \
          --proto_path=. \
          --descriptor_set_out=api_descriptor.pb \
          --python_out=generated_pb2 \
          --grpc_python_out=generated_pb2 \
          bookstore.proto
      

      上記のコマンドでは、--proto_path が現在の作業ディレクトリに設定されています。gRPC ビルド環境で、.proto 入力ファイルに別のディレクトリを使用する場合は、bookstore.proto を保存したディレクトリをコンパイラが検索するように --proto_path を変更します。

2. gRPC API 構成 YAML ファイルを作成します。
   1. api_config.yaml ファイルのコピーを保存します。このファイルは、Bookstore サービスの gRPC API 構成を定義します。
   2. api_config.yaml ファイルの MY_PROJECT_ID は、実際の Google Cloud プロジェクト ID で置き換えます。例:

      #
      # Name of the service configuration.
      #
      name: bookstore.endpoints.example-project-12345.cloud.goog
      

      このファイルの apis.name フィールド値は、.proto ファイルの完全修飾 API 名と完全に一致させる必要があります。一致しなければ、デプロイは機能しません。Bookstore サービスは、パッケージ endpoints.examples.bookstore 内の bookstore.proto で定義されています。この完全修飾 API 名は、api_config.yaml ファイルと同じように endpoints.examples.bookstore.Bookstore になります。

      apis:
        - name: endpoints.examples.bookstore.Bookstore
      

詳細については、Endpoints を構成するをご覧ください。

Endpoints 構成をデプロイする

Endpoints の構成をデプロイするには、gcloud endpoints services deploy コマンドを使用します。このコマンドを実行すると、Service Management を使用してマネージド サービスが作成されます。

1. api_descriptor.pb ファイルと api_config.yaml ファイルがあるディレクトリにいることを確認します。
2. gcloud コマンドライン ツールが現在使用しているデフォルト プロジェクトが、エンドポイント構成をデプロイする Google Cloud プロジェクトであることを確認します。それには、次のコマンドを使用して返されるプロジェクト ID を確認してください。これは、間違ったプロジェクト内にサービスが作成されないようにするためです。

   gcloud config list project
   

   デフォルト プロジェクトを変更する必要がある場合は、次のコマンドを実行します。

   gcloud config set project YOUR_PROJECT_ID
   

3. Google Cloud CLI を使用して、proto descriptor ファイルと構成ファイルをデプロイします。

   gcloud endpoints services deploy api_descriptor.pb api_config.yaml
   

   サービスが作成され構成されるに従い、ターミナルには Service Management からの情報が出力されます。デプロイが完了すると、次のようなメッセージが表示されます。

   Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]

   CONFIG_ID は、デプロイによって作成される一意の Endpoints サービス構成 ID です。例:

   Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
   

   上記の例では、2017-02-13r0 はサービス構成 ID で、bookstore.endpoints.example-project.cloud.goog はサービス名です。サービス構成 ID は、日付スタンプとそれに続くリビジョン番号で構成されます。Endpoints の構成を同じ日に再デプロイすると、サービス構成 ID のリビジョン番号が増分されます。

必要なサービスの確認

Endpoints と ESP を使用するには、少なくとも次の Google サービスの有効化が必要です。

名前	タイトル
servicemanagement.googleapis.com	Service Management API
servicecontrol.googleapis.com	Service Control API
endpoints.googleapis.com	Google Cloud Endpoints

ほとんどの場合、gcloud endpoints services deploy コマンドによってこれらの必須サービスが有効化されます。ただし、以下の状況では、gcloud コマンドは正常に完了しますが、必須サービスが有効になりません。

• Terraform などのサードパーティのアプリケーションを使用していて、上記のサービスを含めていない場合。

• 上記のサービスが明示的に無効にされている既存の Google Cloud プロジェクトに Endpoints 構成をデプロイした場合。

必要なサービスが有効になっていることを確認するには、次のコマンドを実行します。

gcloud services list

必要なサービスが表示されない場合は、次のコマンドを使用してサービスを有効にします。

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Endpoints サービスも有効にします。

gcloud services enable ENDPOINTS_SERVICE_NAME

ENDPOINTS_SERVICE_NAME を確認するには、次のいずれかを行います。

• Endpoints 構成をデプロイ後、Cloud Console の [Endpoints] ページに移動します。[サービス名] 列に、考えられる ENDPOINTS_SERVICE_NAME のリストが表示されます。

• OpenAPI の場合、ENDPOINTS_SERVICE_NAME は OpenAPI 仕様の host フィールドで指定したものです。gRPC の場合、ENDPOINTS_SERVICE_NAME は gRPC Endpoints 構成の name フィールドで指定したものです。

gcloud コマンドの詳細については、gcloud サービスをご覧ください。

エラー メッセージが表示された場合は、Endpoints 構成のデプロイのトラブルシューティングをご覧ください。

詳しくは、Endpoints 構成をデプロイするをご覧ください。

API バックエンドをデプロイする

ここまでの手順でサービス構成を Service Management にデプロイしましたが、API バックエンドを処理するコードはまだデプロイしていません。ここでは、API バックエンドをホストする GKE クラスタを作成して API をデプロイする手順を説明します。

コンテナ クラスタの作成

サンプルにコンテナ クラスタを作成するには:

1. Google Cloud Console で、Kubernetes クラスタページに移動します。
   

   [Kubernetes クラスタ] ページに移動

2. [クラスタを作成] をクリックします。
3. デフォルトの設定を使用し、[作成] をクリックします。このチュートリアルの後半で必要になるので、クラスタ名とゾーンをメモしておきます。

コンテナ クラスタに対する kubectl の認証

kubectl を使用してクラスタ リソースを作成し、管理するには、クラスタの認証情報を取得して kubectl で使用可能にする必要があります。この操作を行うには、次のコマンドを実行します。NAME は新しいクラスタ名、ZONE はクラスタゾーンで置き換えます。

gcloud container clusters get-credentials NAME --zone ZONE

必要な権限を確認する

ESP と ESPv2 は、IAM を使用して、呼び出し元の ID が、使用されている IAM リソースにアクセスするための十分な権限を持っているかどうかを確認する Google サービスを呼び出します。呼び出し元の ID は、ESP と ESPv2 をデプロイする、接続されたサービス アカウントでます。

接続されたサービス アカウントは、GKE Pod にデプロイされると、ノードのサービス アカウントです。通常、それは、Compute Engine のデフォルト サービス アカウントです。この権限の推奨事項に従って、適切なノードのサービス アカウントを選択してください。

Workload Identity を使用する場合、ノードのサービス アカウントとは別のサービス アカウントを使用して Google サービスと通信できます。Pod 用の Kubernetes サービス アカウントを作成して ESP と ESPv2 を実行し、Google サービス アカウントを作成して Kubernetes サービス アカウントを Google サービス アカウントに関連付けることができます。

この手順に沿って、Kubernetes サービス アカウントを Google サービス アカウントに関連付けます。 この Google サービス アカウントは、接続されているサービス アカウントです。

接続されたサービス アカウントがプロジェクトの Compute Engine のデフォルト サービス アカウントで、エンドポイント サービス構成が同じプロジェクトにデプロイされている場合、サービス アカウントには、IAM リソースにアクセスするための十分な権限があるため、続く IAM ロールの設定手順はスキップできます。これに該当しない場合は、次の IAM ロールを、接続されたサービス アカウントに追加する必要があります。

必要な IAM ロールを追加する

このセクションでは、ESP と ESPv2 で使用される IAM リソースと、これらのリソースにアクセスするために接続されたサービス アカウントに必要な IAM ロールについて説明します。

エンドポイント サービスの構成

ESP と ESPv2 は、エンドポイント サービス構成を使用する Service Control を呼び出します。エンドポイント サービスの構成は IAM リソースであり、ESP と ESPv2 にはサービス コントローラ ロールが必要です。

IAM ロールは、プロジェクトではなく、エンドポイント サービスの構成に対するものです。1 つのプロジェクトには、複数のエンドポイント サービス構成が存在する場合があります。

次の gcloud コマンドを使用して、エンドポイント サービス構成の接続されたサービス アカウントにロールを追加します。

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/servicemanagement.serviceController

ここで、
* SERVICE_NAME は、エンドポイント サービス名です。
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com は、接続されたサービス アカウントです。

Cloud Trace

ESP と ESPv2 は Cloud Trace サービスを呼び出して、Trace をプロジェクトにエクスポートします。このプロジェクトはトレース プロジェクトと呼ばれます。ESP では、トレース プロジェクトと、エンドポイント サービス構成を有するプロジェクトは同じです。ESPv2 では、トレース プロジェクトはフラグ --tracing_project_id で指定できます。デフォルトはデプロイ プロジェクトです。

ESP と ESPv2 では、Cloud Trace を有効にするために、Cloud Trace エージェント ロールが必要です。

次の gcloud コマンドを使用して、接続されたサービス アカウントにロールを追加します。

gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/cloudtrace.agent

ここで、
* TRACING_PROJECT_ID は、トレース プロジェクト ID です。
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com は、接続されたサービス アカウントです。詳細については、ロールと権限についてをご覧ください。

クラスタにサンプル API と ESP をデプロイする

gRPC サンプル サービスをクラスタにデプロイし、クライアントで使用可能にするには:

1. grpc-bookstore.yaml デプロイメント マニフェスト ファイルのコピーを保存し、編集用に開きます。
2. SERVICE_NAME を Endpoints サービスの名前で置き換えます。 これは、api_config.yaml ファイルの name フィールドで構成した名前と同じです。

   spec:
     containers:
     - name: esp
       image: gcr.io/endpoints-release/endpoints-runtime:1
       args: [
         "--http2_port=9000",
         "--service=SERVICE_NAME",
         "--rollout_strategy=managed",
         "--backend=grpc://127.0.0.1:8000"
       ]
       ports:
         - containerPort: 9000
     - name: bookstore
       image: gcr.io/endpointsv2/python-grpc-bookstore-server:1
       ports:
         - containerPort: 8000

   --rollout_strategy=managed オプションを指定すると、デプロイ済みの最新のサービス構成を使用するように ESP が構成されます。このオプションを指定すると、新しいサービス構成をデプロイしてから 5 分以内に ESP が変更を検出し、自動的に使用します。ESP が特定の構成 ID でなく、このオプションを使用するようにしてください。ESP 引数の詳細については、ESP 起動オプションをご覧ください。

   次に例を示します。

       spec:
         containers:
         - name: esp
           image: gcr.io/endpoints-release/endpoints-runtime:1
           args: [
             "--http2_port=9000",
             "--service=bookstore.endpoints.example-project-12345.cloud.goog",
             "--rollout_strategy=managed",
             "--backend=grpc://127.0.0.1:8000"
           ]
   

   上記のコンテナ仕様の imagePullPolicy を Always に設定することをおすすめします。この設定により、新しく作成された Pod は常に ESP の最新バージョンを pull することが許可されます。詳細については、構成のベスト プラクティスをご覧ください。ESP の新しいバージョンがリリースされたら、すべての Pod をローリング再起動して、最新バージョンを使用できるようにします。

3. サービスを起動します。

   kubectl create -f grpc-bookstore.yaml
   

注: GKE クラスタが非公開の場合は、DNS リゾルバとして Compute Engine メタデータ サーバーを使用して、Google サービスホスト名を解決する必要があります。次の ESP フラグを追加します。 --dns=169.254.169.254

エラー メッセージが表示された場合は、GKE での Endpoints のトラブルシューティングをご覧ください。

サービスの外部 IP アドレスを取得する

サンプル API にリクエストを送信するには、サービスの外部 IP アドレスが必要です。コンテナでサービスを開始してから外部 IP アドレスを確認できるまで数分かかる場合があります。

1. 外部 IP アドレスを表示します。

   kubectl get service

2. EXTERNAL-IP の値をメモしておき、SERVER_IP 環境変数に保存します。この外部 IP アドレスは、リクエストをサンプル API に送信するために使用されます。

   export SERVER_IP=YOUR_EXTERNAL_IP
   

API にリクエストを送信する

サンプル API にリクエストを送信するには、Python で作成された gRPC クライアントを使用できます。

1. gRPC クライアント コードがホストされる git リポジトリのクローンを作成します。

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
      

2. 作業ディレクトリに移動します。

   cd python-docs-samples/endpoints/bookstore-grpc/
     

3. 依存関係をインストールします。

   pip install virtualenv
   virtualenv env
   source env/bin/activate
   python -m pip install -r requirements.txt
   

4. サンプル API にリクエストを送信します。

   python bookstore_client.py --host SERVER_IP --port 80
   

   • [エンドポイント] > [サービス] ページで API のアクティビティ グラフを確認します。
     

     [Endpoints] の [サービス] ページに移動

     グラフにリクエストが反映されるまでしばらくかかります。

   • [ログ エクスプローラ] ページで、API のリクエストログを確認します。
     

     [ログ エクスプローラ] ページに移動

正常なレスポンスが返されない場合は、レスポンス エラーのトラブルシューティングをご覧ください。

これで Endpoints の API のデプロイとテストが完了しました。

注: このチュートリアルについてのご感想やご要望がありましたら、このページの下部からフィードバックをお送りください。いただいたフィードバックは、チュートリアルの品質向上に利用させていただきます。
エラーが発生した場合は、google-cloud-endpoints Google グループに参加して、どのような問題が生じたかをお知らせください。このグループに参加すると、他の Endpoints ユーザーや、このグループをモニタリングしている Google エンジニアから回答を受け取ることができます。

クリーンアップ

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

1. API を削除します。

   gcloud endpoints services delete SERVICE_NAME
   

   SERVICE_NAME は、API の名前に置き換えます。

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

   gcloud container clusters delete NAME --zone ZONE
   

次のステップ

• Cloud Endpoints に独自の gRPC API を構成する方法を学習する。
• GitHub の Bookstore サンプルで詳細を確認する。クライアントとサーバーのどちらも Python と Java で利用できます。
• GitHub には、次の言語の getting-started-grpc のサンプルがあります。
  • Java
  • Python
  • Ruby
  • Go
  • Node.js