ESPv2 を使用して Knative serving 用の Cloud Endpoints OpenAPI を設定する
このページでは、Knative serving 用に Cloud Endpoints を設定する方法について説明します。Endpoints は Extensible Service Proxy V2（ESPv2）を API ゲートウェイとして使用します。Knative serving 向けに API 管理機能を提供するには、GKE クラスタで実行中の Knative serving にビルド済みの ESPv2 コンテナをデプロイします。
この設定では、ESPv2 がサービスに対するすべてのリクエストを傍受し、必要なチェック（認証など）を行ってから、該当するサービスを呼び出します。サービスが応答すると、ESPv2 はテレメトリーを収集して報告します。
Endpoints の概要については、Endpoints についてと Endpoints アーキテクチャをご覧ください。
タスクリスト
次のタスクリストを参照しながら、チュートリアルを実施してください。このチュートリアルを完了するには、すべてのタスクを行う必要があります。
Google Cloud プロジェクトを作成する。独自の Knative serving をデプロイしていない場合は、サンプルのサービスをデプロイします。始める前にをご覧ください。
Knative serving を有効にして GKE クラスタを作成します。
Knative serving サービスのサンプルをデプロイする。
Endpoints API を記述する OpenAPI ドキュメントを作成し、Knative serving サービスへのルートを構成する。Endpoints を構成するをご覧ください。
OpenAPI ドキュメントをデプロイして、マネージド サービスを作成します。Endpoints 構成をデプロイするをご覧ください。
Endpoints サービス構成で新しい ESPv2 Docker イメージをビルドします。新しい ESPv2 イメージをビルドするをご覧ください。
新しい ESPv2 Knative serving イメージをデプロイします。ESPv2 Cloud Run イメージをデプロイするをご覧ください。
ESPv2 Knative serving サービスへのドメイン マッピングを作成します。
API にリクエストを送信して構成をテストする。
サービスに対するアクティビティを追跡します。API の活動を追跡するをご覧ください。
クリーンアップします。
費用
このドキュメントでは、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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
- 後で必要になるため、プロジェクト ID をメモしておきます。このページでは以降、このプロジェクト ID を ESP_PROJECT_ID とします。
- Google Cloud SDK をダウンロードしてインストールします。
- デプロイしたサンプル サービスにリクエストを送信する場合は、cURL をインストールします。
gcloud コマンドラインを設定する
Anthos の Knative serving 用に gcloud CLI を設定するには:
データとサービスへのアクセスを Google Cloud SDK に対して承認していることを確認します。
ログインします。
gcloud auth login
表示された新しいブラウザタブで、ESPv2 を Knative serving にデプロイするために作成した Google Cloud プロジェクトの編集者またはオーナーのロールが割り当てられているアカウントを選択します。
インストールした
gcloudコンポーネントをアップデートします。gcloud components update
プラットフォームを
gkeに設定し、gcloudのデフォルト プロジェクト設定を先ほど作成したものに設定します。gcloud config set run/platform gke
gcloud config set project ESP_PROJECT_IDESP_PROJECT_ID は、作成したプロジェクトのプロジェクト ID に置き換えます。
新しいクラスタに必要なゾーンを設定します。GKE がサポートされていれば、どのゾーンでも使用できます。次に例を示します。
gcloud config set compute/zone ZONE
ZONE は、実際のゾーンに置き換えます。たとえば、
us-central1-aを使用します。GKE でサポートされている任意のゾーンを使用できます。プロジェクトで次の API を有効にします。これは、クラスタの作成や、コンテナのビルドと Artifact Registry へのパブリッシュで必要になります。
gcloud services enable container.googleapis.com artifactregistry.googleapis.com cloudbuild.googleapis.com
Knative serving を有効にした GKE クラスタを作成する
クラスタを作成して、Google Cloud 上の Knative serving 用に有効にするには:
次のコマンドで新しいクラスタを作成します。
gcloud container clusters create CLUSTER_NAME \ --addons=HttpLoadBalancing,CloudRun \ --machine-type=n1-standard-4 \ --num-nodes=3 \ --enable-stackdriver-kubernetes
CLUSTER_NAME は、クラスタに付ける名前で置き換えます。
これらの手順では、クラスタの自動スケーリングを有効にしてクラスタのサイズを変更することはできませんが、Google Cloud の Knative serving ではクラスタ内のインスタンスが自動的にスケーリングされます。
クラスタの作成が完了するまで待機します。作成プロセス中に、次のようなメッセージが表示されます。
Creating cluster CLUSTER_NAME...done. Created [https://container.googleapis.com/v1/projects/ESP_PROJECT_ID/zones/ZONE/clusters/CLUSTER_NAME].
また、出力には、出力の
NODE_VERSION列のクラスタのバージョンも示されます。たとえば、1.15.11-gke.1や1.14.10-gke.27です。このドキュメントの後半で使用するので、クラスタのバージョンをメモしておいてください。gcloud CLI を使用するときに指定しなくても済むように、新しいクラスタとクラスタのロケーションを
gcloudのデフォルトに設定します。gcloud config set run/cluster CLUSTER_NAME
gcloud config set run/cluster_location ZONE次のコマンドを使用して、新しいクラスタの詳細を表示します。
gcloud container clusters describe CLUSTER_NAME
次のコマンドを使用して、クラスタの認証情報を取得します。
gcloud container clusters get-credentials CLUSTER_NAME
サンプル Knative serving コンテナをデプロイする
作成したクラスタに「hello」Knative serving サンプル コンテナをデプロイするには:
[サービスの作成] をクリックします。
開発プラットフォームとして [Knative serving] を選択します。
[使用可能なクラスタ] プルダウン メニューで、先ほど作成したクラスタを選択します。
サービス名として hello を使用します。他の名前を使用することもできますが、その場合は以降もその名前を使用してください。以降の説明では、hello を使用するものとします。
[接続] で [内部] を選択して、サービスが外部からアクセスできないようにします。
[次へ] をクリックして、サービス作成フォームの 2 ページ目に進みます。
[コンテナ イメージの URL] として
gcr.io/cloudrun/helloを指定します。[作成] をクリックしてイメージを Knative serving にデプロイし、デプロイの完了を待ちます。
完了したら、[リビジョン] 画面が表示されます。デプロイされたサービスの URL は次のとおりです。
http://hello.default.svc.cluster.local内部サービスを作成すると、GKE は DNS 名を作成します。これは外部リクエストではなく、クラスタ内から発生したリクエストに対してのみ解決できます。クラスタ外からこのリンクにアクセスすることはできません。詳細については、Cloud Run サービスをご覧ください。
cURL を使用してサービスが正しく動作していることを確認するには、デスクトップからクラスタへのトンネルを設定します。これらの手順を表示するには、[リビジョン] 画面で URL の右側にある
アイコンをクリックします。
パネルが開き、内部サービスへのアクセスに使用する 2 つのコマンドが表示されます。最初のコマンドは 2 番目のコマンドで使用されるポート転送を設定するため、これらのコマンドは 2 つの個別のターミナル ウィンドウで実行する必要があります。
cURL コマンドを実行すると、サービスからの出力が次の形式で表示されます。
<!doctype html> <html lang=en> <head> <meta charset=utf-8> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Congratulations | Cloud Run</title> ...
Endpoints を構成する
OpenAPI 仕様 v2.0 に基づいて、バックエンド サービスの surface と認証要件を記述する OpenAPI ドキュメントを用意する必要があります。また、ESPv2 がサービスを呼び出すために必要な情報を取得できるよう、このドキュメントには各サービスの URL を設定した Google 固有のフィールドも追加する必要があります。OpenAPI を初めて使用する場合は、OpenAPI の概要で詳細をご覧ください。
OpenAPI 仕様のホスト フィールドの設定について
OpenAPI 仕様の host フィールドで、Knative serving サービスへのアクセスに使用する Endpoints サービス名を指定します。Endpoints サービス名は、ドメイン名の形式です。
API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog
Endpoints サービス名はドメイン名に対応しているため、名前は次のルールに従う必要があります。
- 使用できるのは小文字、数字、ピリオド、ダッシュのみです。
- ダッシュで始めることはできません。
- アンダースコアを含めることはできません。
次に例を示します。
hello-api.endpoints.ESP_PROJECT_ID.cloud.goog
OpenAPI 仕様の作成
openapi-run-anthos.yamlという名前のテキスト ファイルを作成しますKnative serving バックエンド サービスは、
openapi-run-anthos.yamlファイルの先頭にあるx-google-backend定義で定義されます。次に例を示します。swagger: '2.0' info: title: Cloud Endpoints + Cloud Run description: Sample API on Cloud Endpoints with a Cloud Run backend version: 1.0.0 host: API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog x-google-endpoints: - name: API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog target: "INGRESS-IP" schemes: - https produces: - application/json x-google-backend: address: http://hello.default.svc.cluster.local disable_auth: true paths: /hello: get: summary: Greet a user operationId: hello responses: '200': description: A successful response schema: type: string
yaml 形式ではインデントが重要です。たとえば、
hostフィールドはinfoと同じレベルにする必要があります。hostフィールドに、Knative serving サービスへのアクセスに使用する Endpoints API のドメイン名を次の形式で指定します。API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog
次に例を示します。
hello-api.endpoints.ESP_PROJECT_ID.cloud.goog
x-google-endpoints拡張機能は、cloud.googドメインにある Endpoints サービスの DNS エントリを次の形式で登録します。x-google-endpoints: - name: "API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog" target: "IP_ADDRESS"
IP_ADDRESS は、クラスタの
istio-ingressサービスの IP です。この IP アドレスを確認するには、次のようにします。Google Cloud コンソールで [Google Kubernetes Engine] ページに移動します。
左側のナビゲーション パネルで、[Services と Ingress] をクリックして、サービスのリストを表示します。
クラスタ バージョンが
1.15.3-gke.19以降、1.14.3-gke.12以降、1.13.10-gke.8以降のいずれかに相当する場合は、下方向にスクロールしてistio-ingressサービスを表示します。それ以外のクラスタ バージョンの場合は、istio-ingressgatewayサービスまで下にスクロールします。ロードバランサの横に表示されている外部 IP アドレスをコピーします。このとき、ポート設定（表示されている場合）は省きます。たとえば、IP が
XX.XXX.XX.XXX:15020の場合、:15020は省略します。表示されている他の IP アドレスは無視してください。
x-google-backendセクションのaddressフィールドで、"hello" サービスを行うバックエンド Knative serving の内部 DNS 名を指定し、このサービスに対する認証を無効にします。これは、ESPv2 から Knative serving サービスへの呼び出しがクラスタ内から内部呼び出しとして行われるために必要です。したがって、認証は必要ありません。openapi-run-anthos.yamlファイルのtitleプロパティの値をメモします。title: Cloud Endpoints + Cloud Run
titleプロパティの値は、構成をデプロイした後の Endpoints サービスの名前になります。OpenAPI ドキュメントを保存します。
Endpoints に必要な OpenAPI ドキュメントのフィールドについては、Endpoints を構成するをご覧ください。
Endpoints 構成をデプロイする
Endpoints 構成をデプロイするには、gcloud endpoints services deploy コマンドを使用します。このコマンドを実行すると、Service Management を使用してマネージド サービスが作成されます。
Endpoints 構成をデプロイするには:
OpenAPI ドキュメントが格納されているディレクトリに移動します。
構成をアップロードしてマネージド サービスを作成します。
gcloud endpoints services deploy openapi-run-anthos.yaml \ --project ESP_PROJECT_ID
これにより、
openapi-run-anthos.yamlファイルのhostフィールドに指定した名前で、新しい Endpoints サービスが作成されます。Endpoints サービスは OpenAPI ドキュメントに従って構成されています。Service Management でサービスの作成と構成が行われるとき、情報がターミナルに出力されます。デプロイが完了すると、次のようなメッセージが表示されます。
Service Configuration [CONFIG_ID] uploaded for service [API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog]
CONFIG_ID は、デプロイによって作成される一意の Endpoints サービス構成 ID です。次に例を示します。
Service Configuration [2019-02-01r0] uploaded for service [hello-api.endpoints.ESP_PROJECT_ID.cloud.goog]
サービス構成 ID は、日付スタンプとそれに続くリビジョン番号で構成されます。同じ日に
openapi-run-anthos.yamlを再度デプロイすると、サービス構成 ID のリビジョン番号が増分されます。Google Cloud コンソールで [Endpoints] > [サービス] ページを開くと、サービス構成とデプロイの履歴を確認できます。エラー メッセージが表示された場合は、Endpoints 構成のデプロイのトラブルシューティングをご覧ください。
必要なサービスの確認
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.comgcloud services enable servicecontrol.googleapis.comgcloud services enable endpoints.googleapis.com
Endpoints サービスも有効にします。
gcloud services enable ENDPOINTS_SERVICE_NAME
ENDPOINTS_SERVICE_NAME を確認するには、次のいずれかを行います。
Endpoints 構成をデプロイ後、Cloud コンソールの [Endpoints] ページに移動します。[サービス名] 列に、考えられる ENDPOINTS_SERVICE_NAME のリストが表示されます。
OpenAPI の場合、ENDPOINTS_SERVICE_NAME は OpenAPI 仕様の
hostフィールドで指定したものです。gRPC の場合、ENDPOINTS_SERVICE_NAME は gRPC Endpoints 構成のnameフィールドで指定したものです。
gcloud コマンドの詳細については、gcloud サービスをご覧ください。
新しい ESPv2 Knative serving イメージをビルドする
新しい ESPv2 Docker イメージに Endpoints サービス構成をビルドします。このイメージを作成したら、それをクラスタにデプロイできます。
新しい ESPv2 Docker イメージにサービス構成をビルドするには:
gcloud CLI がインストールされているローカルマシンにこのスクリプトをダウンロードし、次のように実行します。
chmod +x gcloud_build_image
./gcloud_build_image -s API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog \ -c CONFIG_ID -p ESP_PROJECT_IDこのスクリプトは、
gcloudコマンドを使用してサービス構成をダウンロードして、新しい ESPv2 イメージにサービス構成をビルドし、新しいイメージを次のプロジェクト コンテナ レジストリにアップロードします。このスクリプトは、出力イメージ名に ESP_VERSION で示される ESPv2 の最新リリースを自動的に使用します。出力イメージは次の場所にアップロードされます。gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog-CONFIG_ID
ESPv2 Knative serving イメージをデプロイする
ESPv2 Knative serving サービスのイメージをクラスタにデプロイします。
新しいイメージで ESPv2 Knative serving サービスをデプロイします。
gcloud run deploy ESP_V2_SERVICE_NAME \ --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog-CONFIG_ID" \ --platform gke \ --project=ESP_PROJECT_ID
ESP_PROJECT_ID には、ESPv2 サービスに使用する名前を指定します。この例では、ESP_V2_SERVICE_NAME を
espv2に設定します。CORS を有効にするなどの追加の ESPv2 起動オプションを使用するように Endpoints を構成する場合は、引数を
ESPv2_ARGS環境変数に渡すことができます。gcloud run deploy ESP_V2_SERVICE_NAME \ --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog-CONFIG_ID" \ --set-env-vars=ESPv2_ARGS=--cors_preset=basic \ --platform gke \ --project ESP_PROJECT_ID
使用可能なオプションのリスト、複数のオプションの指定方法についての情報など、ESPv2_ARGS 環境変数の詳細と設定例については、Extensible Service Proxy V2 のフラグをご覧ください。
ESPv2 サービスは外部サービスとしてデプロイされるため、次の形式の cURL コマンドを使用してアクセスできます。
curl -H "Host: espv2.default.example.com" http://IP_ADDRESS
ここで、IP_ADDRESS は、クラスタの istio-ingress サービスの IP アドレスです。
この cURL コマンドを表示するには、デプロイされた ESPv2 Knative serving サービスの [リビジョン] 画面で、ESPv2 URL の右側にある画像アイコンをクリックします。
ESPv2 サービスを介して Endpoints サービスに対して API 呼び出しを行えるようになりました。たとえば、/hello のパスを使用して Endpoints サービスにリクエストを送信するには、次の形式を使用します。
curl -H "Host: espv2.default.example.com" http://IP_ADDRESS/hello
ただし、Endpoints サービスへのすべてのリクエストで host ヘッダーを指定するのはユーザー フレンドリーではありません。次のセクションでは、ドメインマップを設定して、ESPv2 を介して Endpoints サービスを簡単に呼び出せるようにします。
ESPv2 Knative serving サービスにドメイン マッピングを作成する
リクエスト時に host ヘッダーを省略できるようにするには、ESPv2 サービスのドメイン マッピングを追加します。
[カスタムドメインの管理] を選択します。
[マッピングを追加] を選択します。
プルダウンから、[サービス ドメイン マッピングを追加] を選択します。
[マッピングを追加] のポップアップの [マッピング先のサービスを選択] フィールドで、ESPv2 サービスを選択します。
[ドメイン名を入力] フィールドに、Endpoints を介して Knative serving サービスにアクセスするために使用するドメイン名を指定します。例:
API_NAME.endpoints.ESP_PROJECT_ID.cloud.goog
ここで、API_NAME は Endpoints API の名前です。この例では、「hello-api」を使用できます。
hello-api.endpoints.ESP_PROJECT_ID.cloud.goog
[続行] をクリックします。マッピングの概要が表示されます。
[完了] を選択してマッピングを保存します。
API にリクエストを送信する
cURL を使用して HTTP リクエストを API に送信します。
curl -X GET "http://hello-api.endpoints.ESP_PROJECT_ID.cloud.goog/hello"
正常なレスポンスが返されなかった場合は、レスポンス エラーのトラブルシューティングをご覧ください。
HTTPS を使用するように Endpoints API を構成する
Google Cloud 上の Knative serving では、自動 TLS サポートはデフォルトで無効になっています。そのため、この例では ESPv2 を介して Endpoints API にアクセスする際に、HTTP を使用して呼び出しを行います。
HTTPS を使用してリクエストをサポートするように ESPv2 を構成できます。内部バックエンド サービスである「hello」ではなく、外部サービスである ESPv2 で HTTPS サポートを構成します。
ESPv2 で HTTPS をサポートするには、次の手順を行う必要があります。
ドメインを所有している。ドメインをお持ちでない場合は、Cloud Domains または別のドメイン ベンダーからドメインを取得します。
ESPv2 サービスのドメイン マッピングを作成し、ドメイン マッピング ページの手順に沿って DNS レコードを更新する。
Cloud Domains からドメインを取得した場合は、Cloud DNS または任意の DNS サーバーを使用する。Cloud Domains のドメインを使用するのが最も簡単な方法です。
Endpoints OpenAPI 仕様で、以下を行います。
hostフィールドを*.cloud.googではなくドメインを参照するように設定します。x-google-endpointsタグとその 2 つの子プロパティを削除します。
詳細な手順とチュートリアルについては、HTTPS 証明書と自動 TLS 証明書を有効にするをご覧ください。
API の活動を追跡する
Google Cloud コンソールで [Endpoints] > [サービス] ページに移動して、API のアクティビティ グラフを表示します。
グラフにリクエストが反映されるまでしばらくかかります。
[ログ エクスプローラ] ページで、API のリクエストログを確認します。Endpoints のリクエストログを表示
API のデベロッパー ポータルを作成する
Cloud Endpoints Portal を使用してデベロッパー ポータルを作成できます。デベロッパー ポータルとは、サンプル API の操作に使用できるウェブサイトです。詳細については、Cloud Endpoints Portal の概要をご覧ください。
クリーンアップ
このページで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、次の手順を行います。
このチュートリアルで使用したサービスを停止する場合は、API と API インスタンスを削除するをご覧ください。