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

OpenAPI | gRPC

このチュートリアルでは、サンプル API と Extensible Service Proxy（ESP）を構成して、Google Cloud 上ではない Kubernetes クラスタにデプロイする方法を説明します。Google Kubernetes Engine（GKE）を使用する場合は、GKE での Endpoints のスタートガイドを使用します。

サンプルコードの REST API は、OpenAPI 仕様を使用して作成されています。このチュートリアルでは、API にリクエストを送信するための API キーを作成する方法も説明します。

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

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

目標

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

パート 1

Google Cloud プロジェクトを設定します。始める前にをご覧ください。
チュートリアルで使用するソフトウェアをインストールして構成します。必須ソフトウェアをインストールして構成するをご覧ください。
必要に応じて、サンプルコードをダウンロードします。サンプルコードを取得するをご覧ください。
Kubernetes 構成ファイルをダウンロードします。Kubernetes 構成ファイルを取得するをご覧ください。
Endpoints の構成に使用する openapi.yaml ファイルを構成します。Endpoints を構成するをご覧ください。
Endpoints 構成をデプロイして Cloud Endpoints サービスを作成します。Endpoints 構成をデプロイするをご覧ください。
Endpoints サービスの認証情報を作成します。サービスの認証情報を作成するをご覧ください。
API と ESP をクラスタにデプロイします。API バックエンドをデプロイするをご覧ください。
サービスの外部 IP アドレスを取得します。外部 IP アドレスを取得するをご覧ください。
IP アドレスを使用して API にリクエストを送信します。IP アドレスを使用してリクエストを送信するをご覧ください。
API の活動を追跡します。API のアクティビティを追跡するをご覧ください。

パート 2

サンプル API の DNS レコードを構成します。Endpoints の DNS を構成するをご覧ください。
ドメイン名を使用して API にリクエストを送信します。FQDN を使用してリクエストを送信するをご覧ください。

クリーンアップ

終了したら、クリーンアップを確認して、Google Cloud アカウントに料金が発生しないようにしてください。

費用

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

Endpoints

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

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

始める前に

このチュートリアルは、すでに Minikube または Kubernetes クラスタが設定済みであることを前提としています。詳細については、Kubernetes のドキュメントをご覧ください。

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.

Go to project selector

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.

Go to project selector

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

後で必要になるので、Google Cloud プロジェクト ID はメモしておいてください。

必須ソフトウェアをインストールして構成する

このチュートリアルでは、Google Cloud CLI をインストールし、gcloud CLI を使用してプロジェクトを管理します。Kubernetes クラスタに対してコマンドを実行するときは、kubectl コマンドラインインターフェースを使用します。また、API をテストする手段も必要です。

必須ソフトウェアがすでにインストールされている場合は、次の手順をスキップして先に進んでください。

必須ソフトウェアをインストールして構成するには:

サンプル API にリクエストを送信するためのアプリケーションが必要です。
- Linux ユーザーと MacOS ユーザーの場合: このチュートリアルでは、curl の使用例を示します。これは通常、オペレーティングシステムにプリインストールされています。 curl を所有していない場合は、curl のリリースとダウンロードのページからダウンロードできます。
- Windows ユーザーの場合: このチュートリアルでは、Invoke-WebRequest の使用例を示しています。これは PowerShell 3.0 以降でサポートされています。
gcloud CLI をインストールして初期化します。
gcloud CLI を更新し、Endpoints コンポーネントをインストールします。
```
gcloud components update
```
Google Cloud CLI（gcloud）が、Google Cloud にある対象のデータとサービスへのアクセスが許可されていることを確認します。
```
gcloud auth login
```
表示される新しいタブで、アカウントを選択します。
デフォルトプロジェクトを実際のプロジェクト ID に設定します。
```
gcloud config set project YOUR_PROJECT_ID
```
YOUR_PROJECT_ID を実際のプロジェクト ID に置き換えます。他にも Google Cloud プロジェクトがあり、gcloud を使用してそのプロジェクトを管理する場合は、gcloud CLI 構成の管理をご覧ください。
kubectl をインストールします。
```
gcloud components install kubectl
```
アプリケーションのデフォルト認証情報用に使用する新しいユーザー認証情報を取得します。ユーザー認証情報により kubectl が承認されます。
```
gcloud auth application-default login
```
表示される新しいタブでアカウントを選択します。

次のコマンドを実行して、Kubernetes クライアントが正しく構成されていることを確認します。

kubectl version

出力は次のようになります。

   Client Version: version.Info{Major:"1", Minor:"8", GitVersion:"v1.8.4",
     GitCommit:"9befc2b8928a9426501d3bf62f72849d5cbcd5a3", GitTreeState:"clean",
     BuildDate:"2017-11-20T05:28:34Z", GoVersion:"go1.8.3", Compiler:"gc",
     Platform:"linux/amd64"}
   Server Version: version.Info{Major:"1", Minor:"7+",
     GitVersion:"v1.7.8-gke.0",
     GitCommit:"a7061d4b09b53ab4099e3b5ca3e80fb172e1b018", GitTreeState:"clean",
     BuildDate:"2017-10-10T18:48:45Z", GoVersion:"go1.8.3", Compiler:"gc",
     Platform:"linux/amd64"}

サンプルコードをダウンロードする

必要に応じて、サンプルコードをダウンロードします。このチュートリアルでは、事前にビルドされているコンテナイメージをデプロイします。このため、サンプルコードからコンテナをビルドする必要はありません。ただし、複数言語で提供されているサンプルコードをダウンロードすると、サンプル API の仕組みを理解できます。

サンプルコードをダウンロードするには:

Java