使用入门：GKE 上使用 ESPv2 的 Endpoints

配置 Endpoints

bookstore-grpc 示例包含您在本地复制并进行配置所需的文件。

1. 通过服务 .proto 文件创建一个独立的 protobuf 描述符文件：
   1. 保存示例代码库中 bookstore.proto 的副本。此文件用于定义 Bookstore 服务的 API。
   2. 创建以下目录：mkdir generated_pb2
   3. 使用 protoc Protocol Buffers 编译器创建描述符文件 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 命令。此命令使用 Service Management 创建一项托管式服务。

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 页面。服务名称列下显示了可能的 ENDPOINTS_SERVICE_NAME 列表。

• 对于 OpenAPI，ENDPOINTS_SERVICE_NAME 是您在 OpenAPI 规范的 host 字段中指定的值。对于 gRPC，ENDPOINTS_SERVICE_NAME 是您在 gRPC Endpoints 配置的 name 字段中指定的值。

如需详细了解 gcloud 命令，请参阅 gcloud 服务。

如果您收到错误消息，请参阅排查 Endpoints 配置部署问题。

如需了解更多信息，请参阅部署 Endpoints 配置。

部署 API 后端

目前，您已将服务配置部署到 Service Management，但尚未部署将提供 API 后端的代码。本部分介绍了如何创建 GKE 集群以托管 API 后端，以及如何部署 API。

创建容器集群

集群需要 IP 别名才能使用容器原生负载平衡。为示例创建具有 IP 别名的容器集群：

gcloud container clusters create espv2-demo-cluster \
    --enable-ip-alias \
    --create-subnetwork="" \
    --network=default \
    --zone=us-central1-a

上面的命令会在可用区 us-central1-a 中创建一个具有自动预配子网的集群 espv2-demo-cluster。

将 kubectl 向容器集群进行身份验证

要使用 kubectl 创建和管理集群资源，您需要获取集群凭据并将其提供给 kubectl。为此，请运行以下命令：将 NAME 替换为新的集群名称，将 ZONE 替换为其集群区域。

gcloud container clusters get-credentials NAME --zone ZONE

检查所需权限

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 需要 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 Agent 角色才能启用 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是关联的服务账号。如需了解详情，请参阅 什么是角色和权限？

配置 SSL 密钥和证书

容器原生负载平衡使用必须经过 TLS 加密的 HTTP2 LB。这需要将 TLS 证书部署到 GKE Ingress 和 ESPv2。您可以自带证书或使用自签名证书。

1. 使用 openssl 创建自签名证书和密钥。在系统要求您提供“公用名 (CN)”时，请务必输入相同的 FQDN bookstore.endpoints.MY_PROJECT_ID.cloud.goog。客户端使用该名称来验证服务器证书。

   openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
   -keyout ./server.key -out ./server.crt

2. 使用您的 SSL 密钥和证书创建 Kubernetes Secret。请注意，证书会复制到两个位置，即 server.crt 和 tls.crt，因为密钥同时提供给 GKE Ingress 和 ESPv2。GKE Ingress 会查找证书路径 tls.crt，ESPv2 会查找证书路径 server.crt。

   kubectl create secret generic esp-ssl \
   --from-file=server.crt=./server.crt --from-file=server.key=./server.key \
   --from-file=tls.crt=./server.crt --from-file=tls.key=./server.key

将示例 API 和 ESPv2 部署到集群

如需将示例 gRPC 服务部署到集群，以便客户端能够使用该服务，请执行以下操作：

1. git clone此代码库，并打开以修改 grpc-bookstore.yaml 部署清单文件。
2. 将 SERVICE_NAME 替换为 Ingress 和 ESPv2 容器的 Endpoints 服务的名称。此名称与您在 api_config.yaml 文件的 name 字段中配置的名称相同。
   # Copyright 2016 Google Inc.
   #
   # Licensed under the Apache License, Version 2.0 (the "License");
   # you may not use this file except in compliance with the License.
   # You may obtain a copy of the License at
   #
   #     http://www.apache.org/licenses/LICENSE-2.0
   #
   # Unless required by applicable law or agreed to in writing, software
   # distributed under the License is distributed on an "AS IS" BASIS,
   # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   # See the License for the specific language governing permissions and
   # limitations under the License
   
   # Use this file to deploy the container for the grpc-bookstore sample
   # and the container for the Extensible Service Proxy (ESP) to
   # Google Kubernetes Engine (GKE).
   
   apiVersion: networking.k8s.io/v1beta1
   kind: Ingress
   metadata:
     name: esp-grpc-bookstore
     annotations:
       kubernetes.io/ingress.class: "gce"
       kubernetes.io/ingress.allow-http: "false"
   spec:
     tls:
     - hosts:
       - SERVICE_NAME
       secretName: esp-ssl
     backend:
       serviceName: esp-grpc-bookstore
       servicePort: 443
   ---
   apiVersion: cloud.google.com/v1
   kind: BackendConfig
   metadata:
     name: esp-grpc-bookstore
   spec:
     healthCheck:
       type: HTTP2
       requestPath: /healthz
       port: 9000
   ---
   apiVersion: v1
   kind: Service
   metadata:
     name: esp-grpc-bookstore
     annotations:
       service.alpha.kubernetes.io/app-protocols: '{"esp-grpc-bookstore":"HTTP2"}'
       cloud.google.com/neg: '{"ingress": true, "exposed_ports": {"443":{}}}'
       cloud.google.com/backend-config: '{"default": "esp-grpc-bookstore"}'
   spec:
     ports:
     # Port that accepts gRPC and JSON/HTTP2 requests over TLS.
     - port: 443
       targetPort: 9000
       protocol: TCP
       name: esp-grpc-bookstore
     selector:
       app: esp-grpc-bookstore
     type: ClusterIP
   ---
   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: esp-grpc-bookstore
   spec:
     replicas: 1
     selector:
       matchLabels:
         app: esp-grpc-bookstore
     template:
       metadata:
         labels:
           app: esp-grpc-bookstore
       spec:
         volumes:
         - name: esp-ssl
           secret:
             secretName: esp-ssl
         containers:
         - name: esp
           image: gcr.io/endpoints-release/endpoints-runtime:2
           args: [
             "--listener_port=9000",
             "--service=SERVICE_NAME",
             "--rollout_strategy=managed",
             "--backend=grpc://127.0.0.1:8000",
             "--healthz=/healthz",
             "--ssl_server_cert_path=/etc/esp/ssl",
           ]
           ports:
             - containerPort: 9000
           volumeMounts:
           - mountPath: /etc/esp/ssl
             name:  esp-ssl
             readOnly: true
         - name: bookstore
           image: gcr.io/endpointsv2/python-grpc-bookstore-server:1
           ports:
             - containerPort: 8000
   

   --rollout_strategy=managed 选项可将 ESPv2 配置为使用最新部署的服务配置。如果指定此选项，则 ESPv2 会在您部署新服务配置后的一分钟内检测到更改并自动开始使用该服务配置。建议您指定此选项，而不是提供特定配置 ID 供 ESPv2 使用。如需详细了解 ESPv2 参数，请参阅 ESPv2 启动选项。

   例如：

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

3. 启动服务：

   kubectl create -f grpc-bookstore.yaml
   

如果收到错误消息，请参阅对 GKE 中的 Endpoints 进行问题排查。

获取服务的外部 IP 地址

如需向示例 API 发送请求，您需要具备服务的外部 IP 地址。在容器中启动服务后，外部 IP 地址可能需要过几分钟才可以使用。

1. 查看外部 IP 地址：

   kubectl get ingress

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. 为自签名证书创建根 CA

   openssl x509 -in server.crt -out client.pem -outform PEM
     

5. 向示例 API 发送一个请求：

   python bookstore_client.py --host SERVER_IP --port 443 \
   --servername bookstore.endpoints.MY_PROJECT_ID.cloud.goog --use_tls true --ca_path=client.pem
   

   • 在 Endpoints > 服务页面中查看 API 的活动图表。
     

     转到“Endpoints 服务”页面

     请求可能需要一些时间才能体现在图表中。

   • 在“日志浏览器”页面中查看 API 的请求日志。
     

     转到“日志浏览器”页面

如果未成功收到响应，请参阅排查响应错误。

您刚刚在 Endpoints 中部署并测试了一个 API！