透過 ESP 開始使用 GKE 專用的 Cloud Endpoints

OpenAPI  |  gRPC

本教學課程說明如何設定範例 API 和可擴充服務 Proxy (ESP)，並部署至 Google Kubernetes Engine (GKE) 叢集。

本文採用 OpenAPI 規格說明範例 API。此外，本教學課程也會說明如何建立 API 金鑰，以及如何用於向 API 傳送要求。

本教學課程使用範例程式碼與 ESP 預先建構的容器映像檔，這些映像檔儲存在 Artifact Registry 中。

如需 Cloud Endpoints 的總覽資訊，請參閱關於 Endpoints 和 Endpoints 架構。

目標

在逐步進行本教學課程時，請使用以下高階工作清單。您必須完成第 1 部分內的所有工作，才能成功傳送要求至 API。

第 1 部分

1. 設定 Google Cloud 專案。請參閱「事前準備」。
2. 在 GKE 上建立容器叢集，請參閱建立容器叢集一節。
3. 安裝及設定用於教學課程的軟體，請參閱安裝並設定所需的軟體一節。
4. 下載範例程式碼，請參閱取得範例程式碼。
5. 建立用來設定 Cloud Endpoints 的 openapi.yaml 檔案，請參閱設定 Endpoints 一節。
6. 部署 Endpoints 設定以建立 Endpoints 服務。請參閱部署 Endpoints 設定一節。
7. 將 API 和 ESP 部署至叢集，請參閱部署 API 後端一節。
8. 取得叢集的 IP 位址，請參閱取得叢集的外部 IP 位址一節。
9. 使用 IP 位址傳送要求至 API。請參閱使用 IP 位址傳送要求一節。
10. 追蹤 API 活動。請參閱追蹤 API 活動一節。

第 2 部分

1. 為範例 API 設定 DNS 記錄，請參閱為 Endpoints 設定 DNS 一節。
2. 使用完整的網域名稱將要求傳送至 API，請參閱使用 FQDN 傳送要求一節。

清除

完成本課程時，請參閱「清除所用資源」，以免系統向您的 Google Cloud 帳戶收取相關費用。

費用

在本文件中，您會使用下列 Google Cloud的計費元件：

• GKE
• Endpoints

您可以使用 Pricing Calculator，根據預測用量估算費用。

初次使用 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.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify 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.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

1. 記下 Google Cloud 專案 ID，後續步驟將會用到。

建立容器叢集

您必須在 GKE 中建立容器叢集，才能執行範例 API 後端程式碼。

如何為範例 API 建立容器叢集：

1. 前往 Google Cloud 控制台的 GKE 叢集頁面。
   

   前往 Kubernetes 的「clusters」(叢集) 頁面

2. 按一下 [Create cluster] (建立叢集)。

3. 接受預設值並按一下 [Create] (建立)。這個步驟可能需要幾分鐘才能完成。

4. 記下叢集名稱與區域，以便用來向容器叢集驗證 kubectl。

安裝並設定所需的軟體

在本教學課程中，您將安裝 gcloud CLI，以便使用 Google Cloud CLI 管理專案。您會使用 kubectl 對 GKE 叢集執行指令。另外，您也必須備妥測試 API 的方法。

在後續程序中，如果您已安裝所需的軟體，請繼續進行下一步驟。

安裝並設定所需的軟體：

1. 您需要一個可以將要求傳送至範例 API 的應用程式。

   • Linux 和 macOS 使用者：本教學課程提供了使用 curl 的範例，這項工具通常已預先安裝於您的作業系統。如果您尚未安裝 curl，可以前往 curl 的版本與下載頁面下載這項工具。
   • Windows 使用者：本教學課程提供了使用 Invoke-WebRequest 的範例，PowerShell 3.0 以上版本均支援這項工具。
2. 安裝並初始化 gcloud CLI。
3. 更新 gcloud CLI 並安裝 Endpoints 元件：

   gcloud components update

4. 確認 Google Cloud CLI (gcloud) 已取得授權，可存取您在 Google Cloud上的資料與服務：

   gcloud auth login

   在開啟的新瀏覽器分頁中選取一個帳戶。
5. 將預設專案設為您的專案 ID：

   gcloud config set project YOUR_PROJECT_ID

   將 YOUR_PROJECT_ID 替換為專案 ID。如果您有其他 Google Cloud 專案，並想使用 gcloud 加以管理，請參閱「管理 gcloud CLI 設定」。

6. 安裝 kubectl。

   gcloud components install kubectl

7. 取得新的使用者憑證，以便用於應用程式預設憑證。您必須取得使用者憑證，才能為 kubectl 提供授權。

   gcloud auth application-default login

   在開啟的新瀏覽器分頁中選取一個帳戶。

下載範例程式碼

為了協助您快速開始和執行作業，本課程提供多種語言版本的範例程式碼。

如要將範例程式碼下載至本機電腦，請按照下列指示操作：

Java

如何複製或下載範例 API：

1. 將範例應用程式存放區複製到您的本機電腦：

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

   或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

2. 前往包含範例程式碼的目錄：

   cd java-docs-samples/endpoints/getting-started

Python

如何複製或下載範例 API：

1. 將範例應用程式存放區複製到您的本機電腦：

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

   或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

2. 前往包含範例程式碼的目錄：

   cd python-docs-samples/endpoints/getting-started

Go

如何複製或下載範例 API：

1. 確定您已設定 GOPATH 環境變數。
2. 將範例應用程式存放區複製到您的本機電腦：

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. 前往包含範例程式碼的目錄：

   cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

PHP

如何複製或下載範例 API：

1. 將範例應用程式存放區複製到您的本機電腦：

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

   或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

2. 前往包含範例程式碼的目錄：

   cd php-docs-samples/endpoints/getting-started

Ruby

如何複製或下載範例 API：

1. 將範例應用程式存放區複製到您的本機電腦：

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

   或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

2. 前往包含範例程式碼的目錄：

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

如何複製或下載範例 API：

1. 將範例應用程式存放區複製到您的本機電腦：

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

   或者，您也可以選擇下載範例 ZIP 檔案，然後再解壓縮。

2. 前往包含範例程式碼的目錄：

   cd nodejs-docs-samples/endpoints/getting-started

設定 Endpoints

您必須提供符合 OpenAPI 2.0 或 OpenAPI 3.x 的 OpenAPI 文件，此文件須說明您應用程式的介面以及所有驗證需求。詳情請參閱「支援的 OpenAPI 版本」。

此外，您也必須加入內含各應用程式網址的 Google 專用欄位，這樣 ESPv2 才能獲得叫用應用程式所需的資訊。如果您還不熟悉 OpenAPI，請參閱 OpenAPI 總覽瞭解詳情。

OpenAPI 2.0

如要使用 OpenAPI 2.0 規格設定 Endpoints，可以使用下載範例程式碼的 endpoints/getting-started 目錄中提供的 openapi.yaml 檔案。

OpenAPI 2.0 規格的內容應與下列內容類似：

swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"

host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

consumes:
  - "application/json"
produces:
  - "application/json"

schemes:
# Uncomment the next line if you configure SSL for this API.
# - "https"
  - "http"

paths:
  /echo:
    post:
      description: "Echo back a given message."
      operationId: "echo"
      produces:
        - "application/json"
      responses:
        200:
          description: "Echo"
          schema:
            $ref: "#/definitions/echoMessage"
      parameters:
        -
          description: "Message to echo"
          in: body
          name: message
          required: true
          schema:
            $ref: "#/definitions/echoMessage"
      security:
        - api_key: []
  /auth/info/googlejwt:
    get:
      description: "Returns the requests' authentication information."
      operationId: "auth_info_google_jwt"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authenication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_jwt: []
  /auth/info/googleidtoken:
    get:
      description: "Returns the requests' authentication information."
      operationId: "authInfoGoogleIdToken"
      produces:
        - "application/json"
      responses:
        200:
          description: "Authentication info."
          schema:
            $ref: "#/definitions/authInfoResponse"
      security:
        - api_key: []
          google_id_token: []

definitions:
  echoMessage:
    type: "object"
    properties:
      message:
        type: "string"
  authInfoResponse:
    properties:
      id:
        type: "string"
      email:
        type: "string"

securityDefinitions:
  # This section configures basic authentication with an API key.
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"

  # This section configures authentication using Google API Service Accounts
  # to sign a json web token. This is mostly used for server-to-server
  # communication.
  google_jwt:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    # This must match the 'iss' field in the JWT.
    x-google-issuer: "jwt-client.endpoints.sample.google.com"
    # Update this with your service account's email address.
    x-google-jwks_uri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
    # This must match the "aud" field in the JWT. You can add multiple
    # audiences to accept JWTs from multiple clients.
    x-google-audiences: "echo.endpoints.sample.google.com"
  # This section configures authentication using Google OAuth2 ID Tokens.
  # ID Tokens can be obtained using OAuth2 clients, and can be used to access
  # your API on behalf of a particular user.

  google_id_token:
    authorizationUrl: ""
    flow: "implicit"
    type: "oauth2"
    x-google-issuer: "https://accounts.google.com"
    x-google-jwks_uri: "https://www.googleapis.com/oauth2/v3/certs"
    # Your OAuth2 client's Client ID must be added here. You can add
    # multiple client IDs to accept tokens from multiple clients.
    x-google-audiences: "YOUR_CLIENT_ID"

OpenAPI 3.x

如要使用 OpenAPI 3.x 規格設定 Endpoints，可以取代下載範例程式碼的 endpoints/getting-started 目錄中 openapi.yaml 檔案的內容：

1. 在文字編輯器中開啟 openapi.yaml，並將內容替換為下列程式碼：

   openapi: 3.0.4
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   servers:
     - url: "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
       x-google-endpoint: {}
   
   paths:
     "/echo":
       post:
         description: "Echo back a given message."
         operationId: "echo"
         requestBody:
           description: "Message to echo"
           required: true
           content:
             "application/json":
               schema:
                 $ref: "#/components/schemas/echoMessage"
         responses:
           '200':
             description: "Echo"
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/echoMessage"
         security:
           - api_key: []
   
     "/auth/info/googlejwt":
       get:
         description: "Returns the requests' authentication information."
         operationId: "auth_info_google_jwt"
         responses:
           '200':
             description: "Authentication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - api_key: []
             google_jwt: []
   
     "/auth/info/googleidtoken":
       get:
         description: "Returns the requests' authentication information."
         operationId: "authInfoGoogleIdToken"
         responses:
           '200':
             description: "Authentication info."
             content:
               "application/json":
                 schema:
                   $ref: "#/components/schemas/authInfoResponse"
         security:
           - api_key: []
             google_id_token: []
   
   components:
     schemas:
       echoMessage:
         type: "object"
         properties:
           message:
             type: "string"
       authInfoResponse:
         properties:
           id:
             type: "string"
           email:
             type: "string"
   
     securitySchemes:
       api_key:
         type: "apiKey"
         name: "key"
         in: "query"
   
       google_jwt:
         type: "oauth2"
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "jwt-client.endpoints.sample.google.com"
           jwksUri: "https://www.googleapis.com/service_accounts/v1/jwk/YOUR_SERVICE_ACCOUNT_EMAIL"
           audiences: "echo.endpoints.sample.google.com"
   
       google_id_token:
         type: "oauth2"
         flows:
           implicit:
             authorizationUrl: ""
             scopes: {}
         x-google-auth:
           issuer: "https://accounts.google.com"
           jwksUri: "https://www.googleapis.com/oauth2/v3/certs"
           audiences:
             - "YOUR_CLIENT_ID"

2. 儲存 openapi.yaml 的新內容。

本教學課程會使用 OpenAPI 規格的 Google 專屬擴充功能，讓您設定服務名稱。指定服務名稱的方法取決於您使用的 OpenAPI 規格版本。

OpenAPI 2.0

使用 host 欄位指定服務名稱：

host: echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog

如要設定 Endpoints：

1. 開啟 openapi.yaml 檔案。
2. 在 host 欄位中，將 YOUR_PROJECT_ID 替換為您的 Google Cloud 專案 ID。
3. 儲存 openapi.yaml 檔案。

OpenAPI 3.x

在 servers 物件中使用 url 欄位指定服務名稱：

servers:
- url: https://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog
  x-google-endpoint: {}

如要設定 Endpoints：

1. 開啟 openapi.yaml 檔案。
2. 如果 openapi.yaml 檔案有 host 欄位，請移除該欄位。
3. 新增 servers 物件，如下所示。
4. 在 url 欄位中，將 YOUR_PROJECT_ID 替換為您的 Google Cloud 專案 ID。
5. 儲存 openapi.yaml 檔案。

完成下列的所有設定步驟之後，您就能使用 IP 位址成功將要求傳送至範例 API。請參閱「為 Endpoints 設定 DNS」一節，瞭解如何將 echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog 設為完整的網域名稱 (FQDN)。

部署 Endpoints 設定

如要部署 Endpoints 設定，請使用 gcloud endpoints services deploy 指令。這個指令會使用 Service Management 建立代管服務。

如何部署 Endpoints 設定：

1. 確認您位於 openapi.yaml 設定檔所在的目錄。
2. 上傳設定並建立代管服務：

   gcloud endpoints services deploy openapi.yaml
   

接著，gcloud 指令會呼叫 Service Management API，並使用您在 openapi.yaml 檔案 host 或 servers.url 欄位中指定的名稱建立代管服務。Service Management 會依據 openapi.yaml 檔案中的設定建立服務。變更 openapi.yaml 時，您必須重新部署檔案才能更新 Endpoints 服務。

Service Management 在建立和設定服務時，會輸出資訊至終端機。您可以放心忽略 openapi.yaml 檔案中路徑不需要 API 金鑰的警告。完成服務設定程序之後，Service Management 會顯示含有服務設定 ID 與服務名稱的訊息，類似於以下內容：

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

在上方的範例中，2017-02-13r0 是服務設定 ID，echo-api.endpoints.example-project-12345.cloud.goog 則為 Endpoints 服務。服務設定 ID 是由一個日期戳記和一個修訂版本編號所組成。如果您在同一天再次部署 openapi.yaml 檔案，服務設定 ID 中的修訂版本編號就會遞增。您可以在 Google Cloud 主控台的「Endpoints」 >「Services」(服務) 頁面中查看 Endpoints 服務設定。

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

檢查必要服務

Endpoints 和 ESP 至少需要啟用下列 Google 服務：

名稱	標題
servicemanagement.googleapis.com	Service Management API
servicecontrol.googleapis.com	Service Control API

在大多數情況下，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」頁面。「服務名稱」欄下方會顯示可能的 ENDPOINTS_SERVICE_NAME 清單。

• 如果是 OpenAPI，ENDPOINTS_SERVICE_NAME 是您在 OpenAPI 規格的 host 欄位中指定的內容。如果是 gRPC，ENDPOINTS_SERVICE_NAME 是您在 gRPC Endpoints 設定的 name 欄位中指定的內容。

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

部署 API 後端

您目前已將 OpenAPI 文件部署至 Service Management，但尚未部署為 API 後端提供服務的程式碼。本節會逐步引導您針對 API 範例和 ESP，將預先建構的容器部署至叢集。

檢查必要權限

ESP 和 ESPv2 會呼叫 Google 服務，這些服務使用 IAM 驗證呼叫身分是否具備足夠的權限，可存取使用的 IAM 資源。呼叫身分是部署 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 角色位於端點服務設定中，而非專案。 一個專案可能有多個端點服務設定。

使用下列 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 服務，將追蹤記錄匯出至專案。這個專案稱為追蹤專案。在 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 部署至叢集。

如何將容器部署至叢集：

1. 取得叢集憑證，並提供給 kubectl：

   gcloud container clusters get-credentials NAME 
   
       --zone ZONE

   將 NAME 替換為叢集名稱，並以叢集區域取代 ZONE。
2. 將 Kubernetes 服務部署至 GKE 叢集。Kubernetes 服務會導入 API。請編輯 Kubernetes 設定檔 /endpoints/getting-started/deployment.yaml，並將 ESP 啟動選項中的 SERVICE_NAME 替換為您的服務名稱。
   Java

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
     ]

   Python

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
     ]

   Go

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   PHP

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   Ruby

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   NodeJS

   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port", "8081",
       "--backend", "127.0.0.1:8080",
       "--service", "SERVICE_NAME",
       "--rollout_strategy", "managed",
     ]

   例如：

     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=echo-api.endpoints.example-project-12345.cloud.goog ",
       "--rollout_strategy=managed",
     ]

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

   建議您將上述容器規格中的 imagePullPolicy 設為 Always。這樣一來，新建立的 Pod 就能一律提取最新版本的 ESP。如需更多詳細資料，請參閱 設定最佳做法。 發布新版 ESP 時，您可以對所有 Pod 執行滾動式重新啟動，確保使用最新版本。

3. 使用 kubectl apply 指令啟動 Kubernetes 服務：

   kubectl apply -f deployment.yaml

注意： 如果 GKE 叢集是私人的，您需要使用 Compute Engine 中繼資料伺服器做為 DNS 解析器，解析 Google 服務主機名稱。新增這個 ESP 旗標： --dns=169.254.169.254

如果您收到錯誤訊息，請參閱在 GKE 中疑難排解 Endpoints 一文。

詳情請參閱部署 API 後端。

取得叢集的外部 IP 位址

如要將要求傳送至 API，您必須取得服務的外部 IP。在容器中啟動服務之後，系統可能需要幾分鐘的時間才能備妥外部 IP 位址。

1. 查看外部 IP 位址：

   kubectl get service
   

2. 記下 EXTERNAL-IP 的值。將要求傳送至範例 API 時，您必須使用這組 IP 位址。

使用 IP 位址傳送要求

服務已在容器叢集中運作，您也取得了外部 IP 位址，因此可以將要求傳送至 API。

建立 API 金鑰並設定環境變數

範例程式碼需要 API 金鑰。為了簡化要求，請設定 API 金鑰的環境變數。

1. 在您用於 API 的 Google Cloud 專案中，在 API 憑證頁面上建立 API 金鑰。如要在其他 Google Cloud 專案中建立 API 金鑰，請參閱「在 Google Cloud 專案中啟用 API」。

   前往憑證頁面

2. 按一下 [Create credentials] (建立憑證)，然後選取 [API key] (API 金鑰)。
3. 將金鑰複製到剪貼簿。
4. 按一下 [Close] (關閉)。
5. 在本機電腦中貼上 API 金鑰，以便指派給環境變數：
   • 在 Linux 或 macOS 中：export ENDPOINTS_KEY=AIza...
   • 在 Windows PowerShell 中：$Env:ENDPOINTS_KEY="AIza..."

傳送要求

Linux 或 mac OS

使用 curl，透過先前設定的 ENDPOINTS_KEY 環境變數傳送 HTTP 要求。將 IP_ADDRESS 替換為您的執行個體外部 IP 位址。

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

在上方的 curl 中：

• --data 選項會指定要發布至 API 的資料。
• --header 選項會指定資料採用 JSON 格式。

PowerShell

使用 Invoke-WebRequest，透過先前設定的 ENDPOINTS_KEY 環境變數傳送 HTTP 要求。將 IP_ADDRESS 替換為您的執行個體外部 IP 位址。

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content

在上述範例中，前兩行的結尾為倒引號。當您將範例貼到 PowerShell 中時，請確保倒引號後面沒有空格。 如要瞭解範例要求中使用的選項，請參閱 Microsoft 說明文件中的 Invoke-WebRequest。

第三方應用程式

您可以使用諸如 Chrome 瀏覽器擴充功能 Postman 等第三方應用程式，傳送要求：

• 選取 POST 做為 HTTP 動詞。
• 選取 content-type 鍵和 application/json 值做為標頭。
• 輸入以下內文：
  {"message":"hello world"}
• 在網址中使用實際的 API 金鑰，而非環境變數。例如：
  http://192.0.2.0:80/echo?key=AIza...

API 會回應您傳送的訊息，並傳回以下內容：

{
  "message": "hello world"
}

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

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

注意事項：如想告訴我們您對這個教學課程的想法，歡迎在本頁面底端提供意見回饋。您的意見回饋可協助我們改善教學課程。
如果您在過程中看見錯誤訊息，不妨加入 google-cloud-endpoints Google 群組，告知我們何處發生問題。這個網上論壇可接收來自其他 Endpoints 使用者的回應，以及負責管理論壇 Google 工程師的回覆。

追蹤 API 活動

如何追蹤 API 活動：

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

   前往 Endpoints 服務頁面

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

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

   前往「Logs Explorer」(記錄檔探索工具) 頁面

為 Endpoints 設定 DNS

API 的 Endpoints 服務名稱位於 .endpoints.YOUR_PROJECT_ID.cloud.goog 網域，因此您只需要略為調整 openapi.yaml 檔案的設定，即可將該網域當做完整的網域名稱 (FQDN)。這樣一來，您就能使用 echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog (而非 IP 位址) 將要求傳送至範例 API。

如何設定 Endpoints DNS：

OpenAPI 2.0

1. 開啟 OpenAPI 設定檔 openapi.yaml，並在檔案最上層新增 x-google-endpoints 屬性 (請勿使用縮排或巢狀結構)，如以下程式碼片段所示：

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   x-google-endpoints:
   - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
     target: "IP_ADDRESS"

2. 在 name 屬性中，將 YOUR_PROJECT_ID 替換為您的專案 ID。
3. 在 target 屬性中，將 IP_ADDRESS 替換為您向範例 API 傳送要求時使用的 IP 位址。
4. 將更新的 OpenAPI 設定檔部署至 Service Management：

   gcloud endpoints services deploy openapi.yaml
   

OpenAPI 3.x

1. 開啟 OpenAPI 設定檔 openapi.yaml，並在檔案最上層新增 servers.url 屬性 (請勿使用縮排或巢狀結構)，如以下程式碼片段所示：

   servers:
     - url: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
       x-google-endpoint:
         target: "IP_ADDRESS"

2. 在 name 屬性中，將 YOUR_PROJECT_ID 替換為您的專案 ID。
3. 在 target 屬性中，將 IP_ADDRESS 替換為您向範例 API 傳送要求時使用的 IP 位址。
4. 將更新的 OpenAPI 設定檔部署至 Service Management：

   gcloud endpoints services deploy openapi.yaml
   

舉例來說，假設 openapi.yaml 檔案的設定如下：

OpenAPI 2.0

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

OpenAPI 3.x

servers:
  - url: "echo-api.endpoints.example-project-12345.cloud.goog"
    x-google-endpoint:
      target: "192.0.2.1"

您使用前述的 gcloud 指令部署 openapi.yaml 檔案時，Service Management 會建立 DNS A 記錄 echo-api.endpoints.my-project-id.cloud.goog，這個記錄會解析為目標 IP 位址 192.0.2.1。新的 DNS 設定可能需要幾分鐘才會生效。

設定安全資料傳輸層 (SSL)

如要進一步瞭解如何設定 DNS 和安全資料傳輸層 (SSL)，請參閱啟用 Endpoints 的安全資料傳輸層 (SSL) 一文。

使用 FQDN 傳送要求

為範例 API 設定 DNS 記錄之後，請使用 FQDN (將 YOUR_PROJECT_ID 替換為您的專案 ID) 與先前設定的 ENDPOINTS_KEY 環境變數向 API 傳送要求：

• 在 Linux 或 macOS 中：

  curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"

• 在 Windows PowerShell 中：

  (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

清除所用資源

為避免因為本教學課程所用資源，導致系統向 Google Cloud 收取費用，請刪除含有相關資源的專案，或者保留專案但刪除個別資源。

如要瞭解如何停用本教學課程使用的服務，請參閱刪除 API 和 API 執行個體一文。

後續步驟

• 瞭解如何建構 Docker 映像檔。
• 瞭解如何在 Kubernetes 上部署 Endpoints。
• 與其他開發人員共用您的 API。
• 進一步瞭解驗證。
• 瞭解社群支援選項。
• 排解 GKE 部署問題。