透過 ESP 開始使用 Kubernetes 適用的 Endpoints

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

設定 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 輸入檔案使用不同的目錄，請變更 --proto_path 以讓編譯器能夠搜尋您儲存 bookstore.proto 的目錄。

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 名稱為 endpoints.examples.bookstore.Bookstore，就像 api_config.yaml 檔案中的名稱一樣。

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

詳情請參閱「設定 Endpoints」一文。

部署 Endpoints 設定

如要部署 Endpoints 設定，請使用 gcloud endpoints services deploy 指令。這個指令使用了服務基礎架構，也就是 Google 的基礎服務平台。Endpoints 和其他服務都是使用這個基礎架構來建立和管理 API 及服務。

1. 確認您所在的目錄有 api_descriptor.pb 和 api_config.yaml 檔案。
2. 確認 gcloud 指令列工具目前使用的預設專案，就是您要部署 Endpoints 設定的 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 中的修訂編號將會增加。

檢查必要服務

在大多數情況下，gcloud endpoints services deploy 指令會啟用這些必要服務。不過在以下情況中，即便您成功執行 gcloud 指令，還是無法啟用必要服務：

• 您使用 Terraform 之類的第三方應用程式，而其中未包含這些服務。

• 您已將 Endpoints 設定部署至現有Google Cloud 專案，但在專案中已明確停用這些服務。

使用下列指令，確認已啟用必要服務：

gcloud services list

如果必要的服務並未列出，請執行下列指令加以啟用：

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

並啟用 Endpoints 服務：

gcloud services enable ENDPOINTS_SERVICE_NAME

如要判斷 ENDPOINTS_SERVICE_NAME，您可以採取下列任一做法：

• 部署 Endpoints 設定後，請前往 Cloud 控制台的「Endpoints」頁面。系統會在「Service name」欄下方顯示可能的 ENDPOINTS_SERVICE_NAME 清單。

• 針對 OpenAPI，ENDPOINTS_SERVICE_NAME 是您在 OpenAPI 規格 host 欄位中指定的值。針對 gRPC，ENDPOINTS_SERVICE_NAME 是您在 gRPC Endpoints 設定的 name 欄位中指定的值。

如要進一步瞭解 gcloud 指令，請參閱 gcloud 服務。

如果您收到錯誤訊息，請參閱排解 Endpoints 設定部署問題一文。

詳情請參閱「部署 Endpoints 設定」一文。

為服務建立憑證

為了妥善管理您的 API，ESP 和 ESPv2 都需要使用服務基礎架構中的服務。ESP 和 ESPv2 必須使用存取憑證才能呼叫這些服務。當您將 ESP 或 ESPv2 部署至 GKE 或 Compute Engine 等 Google Cloud 環境時，ESP 和 ESPv2 會透過 Google Cloud 中繼資料服務為您取得存取憑證。

如果您要將 ESP 或 ESPv2 部署至非Google Cloud 環境 (例如本機電腦、內部部署的 Kubernetes 叢集，或是其他雲端服務平台)，則必須提供含有私密金鑰的服務帳戶 JSON 檔案。ESP 和 ESPv2 會使用服務帳戶產生存取權杖，以呼叫管理 API 所需的服務。

您可以使用 Google Cloud 控制台或 Google Cloud CLI 建立服務帳戶和私密金鑰檔案：

新增必要的 IAM 角色：

本節說明 ESP 和 ESPv2 使用的 IAM 資源，以及附加服務帳戶存取這些資源所需的 IAM 角色。

端點服務設定

ESP 和 ESPv2 會呼叫 Service Control，後者會使用 Endpoints 服務設定。端點服務設定是 IAM 資源，ESP 和 ESPv2 需要Service Controller 角色才能存取。

IAM 角色是在端點服務設定中，而非在專案中。一個專案可以有多個端點服務設定。

使用下列 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 是已附加的服務帳戶。詳情請參閱「 什麼是角色和權限？」。

如要進一步瞭解指令，請參閱 gcloud iam service-accounts。

部署 API 後端

到目前為止，您已將服務設定部署至 Service Management，但尚未部署為 API 後端提供服務的程式碼。本節會逐步引導您針對 API 範例和 ESP，將預先建置的容器部署至 Kubernetes。

為 ESP 提供服務憑證

在容器內部執行的 ESP 必須能存取儲存在本機 service-account-creds.json 檔案中的憑證。如果要讓 ESP 能存取憑證，您可以建立 Kubernetes 密鑰，並將 Kubernetes 密鑰掛接成 Kubernetes 磁碟區。

如何建立 Kubernetes 密鑰並掛接磁碟區：

1. 如果您使用 Google Cloud 主控台建立服務帳戶，請將 JSON 檔案重新命名為 service-account-creds.json。將檔案移至 api_descriptor.pb 和 api_config.yaml 所在的相同目錄中。

2. 使用服務帳戶憑證建立 Kubernetes 密鑰：

    kubectl create secret generic service-account-creds
         --from-file=service-account-creds.json

   成功後，您會看見此訊息：secret "service-account-creds" created。

您用來將 API 和 ESP 部署至 Kubernetes 的部署資訊清單檔案，已包含密鑰磁碟區，如下列檔案的兩個區段所示：

volumes:
  - name: service-account-creds
    secret:
      secretName: service-account-creds

volumeMounts:
  - mountPath: /etc/nginx/creds
    name: service-account-creds
    readOnly: true

設定服務名稱並啟動服務

ESP 必須知道您的服務名稱，才能使用 gcloud endpoints services deploy指令找出先前部署的設定。

如何設定服務名稱及啟動服務：

1. 將部署資訊清單檔案 k8s-grpc-bookstore.yaml 的複本儲存至 service-account-creds.json 所在的相同目錄中。

2. 開啟 k8s-grpc-bookstore.yaml，並將 SERVICE_NAME 替換為 Endpoints 服務名稱。這是您在 api_config.yaml 檔案的 name 欄位中設定的名稱相同。

   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",
         "--service_account_key=/etc/nginx/creds/service-account-creds.json"
       ]

   --rollout_strategy=managed 選項可將 ESP 設為使用最新部署的服務設定。指定此選項時，在您部署新服務設定後 5 分鐘內，ESP 會偵測到變更並自動開始使用新設定。建議您指定此選項而非讓 ESP 使用特定的設定 ID。 如要進一步瞭解 ESP 引數，請參閱 ESP 啟動選項一文。

3. 啟動服務以在 Kubernetes 上部署服務：

   kubectl create -f k8s-grpc-bookstore.yaml

   如果您看到類似以下內容的錯誤訊息：

   The connection to the server localhost:8080 was refused - did you specify the right host or port?

   這表示您未正確設定 kubectl，詳情請參閱「設定 kubectl」。

取得服務的外部 IP 位址

您需要取得服務的外部 IP 位址，才能向範例 API 傳送要求。當您在容器中啟動服務後，系統可能需要幾分鐘的時間才能備妥外部 IP 位址。

1. 查看外部 IP 位址：

   kubectl get service

2. 記下 EXTERNAL-IP 的值，然後將它儲存在 SERVER_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
   

   • 在「Endpoints」>「Services」(服務) 頁面中查看 API 的活動圖表。
     

     前往 Endpoints 服務頁面

     要求可能需要一些時間才能反映在圖表中。

   • 在「Logs Explorer」(記錄檔探索工具) 頁面中查看您的 API 要求記錄。
     

     前往「Logs Explorer」頁面

如果您未取得成功的回應，請參閱排解回應錯誤一文。

您已在 Endpoints 中部署並測試了 API！