使用入门：Kubernetes 上使用 ESPv2 的 Cloud Endpoints

下载示例代码

根据需要下载示例代码。在本教程中，您将部署预构建的容器映像，因此您不必使用示例代码构建容器。但是，您不妨下载示例代码，它是以多种语言提供的，可以帮助您了解示例 API 的工作原理。

要下载示例代码，请执行以下操作：

获取 Kubernetes 配置文件

1. 将包含本教程中使用的 yaml 文件的 GitHub 代码库克隆到您的本地机器：

    git clone https://github.com/googlecloudplatform/endpoints-samples

   或者，下载该示例的 zip 文件并将其解压缩。

2. 转到包含此配置文件的目录：

    cd endpoints-samples/kubernetes

配置 Endpoints

示例代码包括 OpenAPI 配置文件 openapi.yaml，该文件基于 OpenAPI 规范 v2.0。 要配置 Endpoints，请执行以下操作：

1. 在示例代码目录中，打开 openapi.yaml 配置文件。
   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"

   请注意以下事项：

   • 配置示例显示了 host 字段附近的几行内容，您需要修改这些内容。如需将 openapi.yaml 文件部署到 Endpoints，您需要完整的 OpenAPI 文档。
   • 示例 openapi.yaml 文件包含用于配置身份验证的部分（本教程不需要）。您无需使用 YOUR-SERVICE-ACCOUNT-EMAIL 和 YOUR-CLIENT-ID 配置这些行。
   • OpenAPI 是一种与语言无关的规范。为方便起见，每种语言的 GitHub 存储库中的 getting-started 示例均包含相同的 openapi.yaml 文件。

2. 将 host 字段中的文本替换为 Endpoints 服务名称，该名称应采用以下格式：

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

   将 YOUR_PROJECT_ID 替换为您的 Google Cloud 项目 ID。例如：

   host: "echo-api.endpoints.example-project-12345.cloud.goog"

请注意，echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog 是 Endpoints 服务名称。该名称不是您用于向 API 发送请求的完全限定域名 (FQDN)。

如需了解 OpenAPI 文档中 Endpoints 所需的字段，请参阅配置 Endpoints。

在完成以下所有配置步骤，并且可以使用 IP 地址向示例 API 成功发送请求后，请参阅为 Endpoints 配置 DNS，了解如何将 echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog 配置为 FQDN。

部署 Endpoints 配置

如需部署 Endpoints 配置，请使用 gcloud endpoints services deploy 命令。此命令使用 Service Management 创建一项托管式服务。

如需部署 Endpoints 配置，请执行以下操作：

1. 确保您位于 endpoints-samples/kubernetes 目录中。
2. 上传配置并创建托管式服务：

   gcloud endpoints services deploy openapi.yaml
   

然后，gcloud 命令会调用 Service Management API，以便使用您在 openapi.yaml 文件的 host 字段中指定的名称创建托管式服务。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 配置部署问题。

检查所需服务

在大多数情况下，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，ESP 和 ESPv2 都需要使用 Service Infrastructure 中的服务。为了调用这些服务，ESP 和 ESPv2 必须使用访问令牌。当您将 ESP 或 ESPv2 部署到 Google Cloud 环境（例如 GKE、Compute Engine 或 App Engine 柔性环境）时，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。端点服务配置是 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是关联的服务账号。如需了解详情，请参阅 什么是角色和权限？

如需详细了解这些命令，请参阅 gcloud iam service-accounts。

部署 API 后端

到目前为止，您已将 OpenAPI 文档部署到 Service Management，但尚未部署为 API 后端提供服务的代码。本部分逐步介绍如何将示例 API 和 ESPv2 的预构建容器部署到 Kubernetes。

检查所需权限

向与集群关联的服务账号授予所需的权限：

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
    --member "serviceAccount:SERVICE_ACCOUNT" \
    --role roles/servicemanagement.serviceController

如需了解详情，请参阅什么是角色和权限？

为 ESPv2 提供服务凭据

ESPv2 在容器内部运行，并且需要访问存储在本地 service-account-creds.json 文件中的凭据。要让 ESPv2 能够访问这些凭据，请创建 Kubernetes 密钥，并将此密钥作为 Kubernetes 卷装载。

要创建 Kubernetes 密钥并装载卷，请执行以下操作：

1. 务必将 JSON 文件重命名为 service-account-creds.json，并将其复制到 endpoints-samples/kubernetes（如果此文件之前是下载到其他目录）。这样，该名称就与 echo.yaml 部署清单文件中指定的选项匹配。
2. 确保您位于 endpoints-samples/kubernetes 目录中。

3. 使用以下命令通过服务账号凭据创建 Kubernetes Secret：

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

   成功后，系统会显示以下消息：

   secret "service-account-creds" created

用于将 API 和 ESPv2 部署到 Kubernetes 的部署清单文件已包含 Secret 卷，如该文件的以下两个部分所示：

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

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

配置服务名称并启动服务

ESPv2 需要知道您的服务名称，才能找到您之前使用 gcloud endpoints services deploy 命令部署的配置。

要配置服务名称并启动服务，请执行以下操作：

1. 打开部署清单文件 echo.yaml，并将 ESPv2 启动选项中的 SERVICE_NAME 替换为您的服务的名称。该名称与您在 OpenAPI 文档的 host 字段中配置的名称相同。例如：

   "--service=echo-api.endpoints.example-project-12345.cloud.goog"

   containers:
   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:2
     args: [
       "--listener_port=8080",
       "--backend=127.0.0.1:8081",
       "--service=SERVICE_NAME",
       "--rollout_strategy=managed",
       "--non_gcp",
       "--service_account_key=/etc/esp/creds/service-account-creds.json"
     ]
     ports:
       - containerPort: 8080
     volumeMounts:
       - mountPath: /etc/esp/creds
         name: service-account-creds
         readOnly: true
   - name: echo
     image: gcr.io/endpoints-release/echo:latest
     ports:
       - containerPort: 8081
   

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

2. 使用以下命令启动服务，以在 Kubernetes 上部署 Endpoints 服务：

   kubectl create -f echo.yaml

   如果您看到类似以下内容的错误消息：

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

   这表示未正确配置 kubectl。如需了解详情，请参阅配置 kubectl。 如需了解详情，请参阅在 Kubernetes 上部署 Endpoints。

获取服务的外部 IP 地址

如果您使用的是 Minikube，请跳到使用 IP 地址发送请求。 在容器中启动服务后，外部 IP 地址可能需要过几分钟才可以使用。

要查看服务的外部 IP 地址，请执行以下操作：

1. 运行以下命令：

   kubectl get service

2. 请记下 EXTERNAL-IP 的值。在向示例 API 发送请求时，您需要使用该 IP 地址。

使用 IP 地址发送请求

在容器集群中运行示例 API 之后，您可以向 API 发送请求。

创建 API 密钥并设置环境变量

示例代码需要 API 密钥。为简化请求，请为 API 密钥设置环境变量。

1. 在您用于 API 的同一 Google Cloud 项目中，在 API 凭据页面上创建 API 密钥。如果要在其他 Google Cloud 项目中创建 API 密钥，请参阅在 Google Cloud 项目中启用 API。

   转到“凭据”页面

2. 点击创建凭据，然后选择 API 密钥。
3. 将密钥复制到剪贴板。
4. 点击关闭。
5. 在本地计算机上，粘贴 API 密钥以将其分配给环境变量：
   • 在 Linux 或 macOS 中：export ENDPOINTS_KEY=AIza...
   • 在 Windows PowerShell 中：$Env:ENDPOINTS_KEY="AIza..."

将请求发送到 minikube

以下命令使用您先前设置的 ENDPOINTS_KEY 环境变量。

NODE_PORT=`kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}'`
MINIKUBE_IP=`minikube ip`
curl --request POST \
    --header "content-type:application/json" \
    --data '{"message":"hello world"}' \
    ${MINIKUBE_IP}:${NODE_PORT}/echo?key=${ENDPOINTS_KEY}

$Env:NODE_PORT=$(kubectl get service esp-echo --output='jsonpath={.spec.ports[0].nodePort}')
$Env:MINIKUBE_IP=$(minikube ip)
(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://$Env:MINIKUBE_IP:$Env:NODE_PORT/echo?key=$Env:ENDPOINTS_KEY").Content

将请求发送到其他 Kubernetes 集群

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

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

API 会回显您发送的消息，并以如下内容作为响应：

{
  "message": "hello world"
}

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

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

跟踪 API 活动

要跟踪 API 活动，请执行以下操作：

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

   转到“Endpoints 服务”页面

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

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

   转到“日志浏览器”页面

为 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，请执行以下操作：

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.yaml 文件进行了以下配置：

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"

使用上述 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 发送请求

• 在 Linux 或 Mac OS 中：

  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

为 API 创建开发者门户

您可以使用 Cloud Endpoints 门户来创建开发者门户，一个供您与示例 API 进行交互的网站。如需了解详情，请参阅 Cloud Endpoints 门户概览。