Extensible Service Proxy 启动选项

Extensible Service Proxy (ESP) 是一种基于 NGINX 的代理，可让 Cloud Endpoints 提供 API 管理功能。您可以通过在启动 ESP Docker 容器时指定相应选项来配置 ESP。ESP 容器启动时，它会运行一个名为 start_esp 的脚本，该脚本会使用您指定的选项写入 NGINX 配置文件并启动 ESP。

您可在 docker run 命令中指定 ESP 启动选项，例如：

sudo docker run \
    --detach \
    DOCKER_ARGUMENTS \
    gcr.io/endpoints-release/endpoints-runtime:1 \
    --service=SERVICE_NAME \
    --rollout_strategy=managed \
    --backend=YOUR_API_CONTAINER_NAME:8080

如要将 ESP 部署到 Kubernetes，您可以在部署清单文件的 args 字段中指定启动选项，例如：

containers:
- 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"
  ]

下表介绍了 ESP 的启动选项。

¹ 这些端口是可选的，且不可重复。如果您未指定任何端口选项，则 ESP 将接受使用端口 8080 进行的 HTTP/1.x 连接。对于 HTTPS 连接，ESP 要求 TLS 密钥位于 /etc/nginx/ssl/nginx.crt 和 /etc/nginx/ssl/nginx.key。

命令行调用示例

以下示例演示了部分命令行参数的用法：

如要启动 ESP 以处理通过 HTTP/1.x 端口 80 和 HTTPS 端口 443 传入的请求，并将请求发送到位于 127.0.0.1:8000 的 API 后端，请运行以下命令：

sudo docker run \
    --detach \
    DOCKER_ARGUMENTS \
    gcr.io/endpoints-release/endpoints-runtime:1
     --service=echo-api.endpoints.example-project-12345.cloud.goog \
        --rollout_strategy=managed \
        --http_port=80 \
        --ssl_port=443 \
        --backend=127.0.0.1:8000

要使用服务账号凭据文件来获取服务配置并连接到 Service Control，从而通过自定义 NGINX 配置启动 ESP，请运行以下命令：

sudo docker run \
    --detach \
    --volume=$HOME/Downloads:/esp \
    DOCKER_ARGUMENTS \
    gcr.io/endpoints-release/endpoints-runtime:1 \
    --service=echo-api.endpoints.example-project-12345.cloud.goog \
    --rollout_strategy=managed \
    --service_account_key=/esp/serviceaccount.json \
    --nginx_config=/esp/nginx.conf
    

请注意，您必须使用 Docker 标志 --volume 或 --mount 将包含服务账号私钥的 JSON 文件和自定义 NGINX 配置文件作为卷装载到 ESP 的 Docker 容器内部。上述示例将本地计算机上的 $HOME/Downloads 目录映射到容器中的 esp 目录。当您保存服务账号的私钥文件时，该文件通常会被下载到 Downloads 目录中。如果需要，您可以将私钥文件复制到其他目录。如需了解详情，请参阅管理 Docker 中的数据。

向 ESP 添加 CORS 支持

如需了解可用的 CORS 支持选项的说明，请参阅支持 CORS。本部分介绍如何使用 ESP 启动标志来支持 CORS。

如需在 ESP 中启用 CORS 支持，请添加 --cors_preset 选项，并将其设置为 basic 或 cors_with_regex。如果您添加 --cors_preset=basic 或 --cors_preset=cors_with_regex，ESP 会执行以下操作：

• 假定所有位置路径都具有相同的 CORS 政策。
• 同时响应简单请求和预检 HTTP OPTIONS 请求。
• 最多可将预检 OPTIONS 请求的结果缓存 20 天（1728000 秒）。

• 将响应标头设置为以下值：

  Access-Control-Allow-Origin: *
  Access-Control-Allow-Methods: GET, POST, PUT, PATCH, DELETE, OPTIONS
  Access-Control-Allow-Headers: DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization
  Access-Control-Expose-Headers: Content-Length,Content-Range

如需替换 Access-Control-Allow-Origin 的默认值，请指定以下其中一个选项：

设置 --cors_preset=basic 或 --cors_preset=cors_with_regex 以启用 CORS 后，您可以通过指定以下一个或多个选项来替换其他响应标头的默认值：

如果 ESP CORS 启动选项不适合您的应用需求，您可以使用应用所需的 CORS 支持来创建自定义 nginx.conf 文件。如需了解详情，请参阅创建自定义 nginx.conf 以支持 CORS。

后续步骤

了解：

• 将 ESP 和 API 后端部署到 Google Cloud
• 在本地或其他平台上运行 ESP
• GitHub 上的 start_esp 脚本