托管的目标参考

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档
信息

<ph type="x-smartling-placeholder">

环境变量限制

托管目标会限制环境变量的大小和数量 可在 Hosted Targets 运行时环境中设置。

  • 1000:单个环境变量的长度上限。
  • 100:您可以设置的环境变量的数量上限。

如需了解如何设置环境变量,请参阅 清单文件

在应用运行时中设置的环境变量

部署 Hosted Targets 应用时,会设置以下环境变量,并 可在运行时使用:

  • APIGEE_ENVIRONMENT - 部署了托管目标代理的环境。
  • APIGEE_ORGANIZATION - 部署了 Hosted Target 代理的组织。
  • PORT - Hosted Target 应用必须监听的端口。

系统资源分配

每个 Hosted Targets 实例都会接收以下资源:

  • 256 MB 内存
  • 1.2 GHz CPU

扩缩

本部分介绍 Hosted Targets 应用如何根据 Edge 账号类型进行扩缩 。
  • 在 Apigee Edge 的试用版中,每个代理仅限使用一个 Hosted Targets 实例。
  • 付费 Apigee Edge 账号可获享根据请求速率、响应延迟时间和 以及每个代理的其他应用指标
  • 同时部署到付费版和试用版 Apigee Edge 的 Hosted Targets 应用会在非活动期间缩减至零。 在这种情况下,您可能会注意到响应速度在短时间内会变慢。另请参阅 已知问题

清单文件

为了收集用于构建和部署托管应用的运行时信息,Edge 会查找 resources/hosted 目录中名为 app.yaml 的清单文件。 此文件包含构建和部署 Hosted Targets 应用所需的信息。

Manfiest 文件语法

runtime: node
runtimeVersion: version_number
command: command_name
args: argument_array
env:
  - name: variable_name
    value: literal_value
  - name: variable_name
    valueRef:
      name: kvm_name
      key: kvm_value

清单文件元素

app.yaml 清单文件包含以下元素:

  • runtime -(必需)指定要部署的应用类型。 您必须指定 node
  • runtimeVersion -(可选)运行时 默认值:Node.js LTS (v10.x)。参阅适用于 Node 的 Docker 官方代码库 了解其他选项。
  • command:(可选)可让您指定要运行的命令,而 用于启动应用的默认命令。默认:Node.js=npm
  • args -(可选)要传递给 应用(使用标准 YAML 数组语法指定)。通常,这些标记会添加到默认命令中。 默认值为 start。例如,默认情况下,系统会向 Node.js 应用传递命令 npm start
  • env -(可选)环境变量数组(名称/值对) 。这些变量可用于 Hosted Targets 应用。 <ph type="x-smartling-placeholder">
    • name - 变量名称。
    • 值 |valueRef - 您有两种选择。您可以设置一个字面量值 也可以引用存储在键值对映射中的值。键值对映射必须 Edge 环境中已经存在。请参阅使用键值对映射 <ph type="x-smartling-placeholder">
        </ph>
      • 如果您使用 value,则必须 指定变量 name 和字面量 value。例如:
        runtime: node
        env:
         - name: NODE_ENV
           value: production
      • 如果您使用 valueRef, 那么您必须提供之前在 Edge 中创建的键值对映射 (KVM) 的名称。 例如:
        runtime: node
        env:
          - name: DB_ENV
            value: production
          - name: DB_PASSWORD
            valueRef:
              name: hosted-kvm
              key: db-password

    清单文件示例

    本部分包含 Node.js 的示例清单文件 应用。必须提供清单文件才能部署 Hosted Targets 应用,而且清单文件必须位于 位于 apiproxy/resources/hosted 目录中,文件名必须为 app.yaml

    以下是 Node.js 应用的示例 app.yaml(清单)文件。

    指定字面量环境变量的示例:

     runtime: node
     env:
       - name: NODE_ENV
         value: production

    包含启动命令、命令行参数和环境变量的示例。

     runtime: node
     command: ./node_modules/pm2/bin/pm2
     env:
       - name: NODE_ENV
         value: production
     args:
       - app.js


    指定键值对映射 (KVM) 引用的示例:

    如需详细了解 KVM 访问权限,请参阅清单文件

    runtime: node
    env:
      - name: DB_ENV
        value: production
      - name: DB_PASSWORD
        valueRef:
          name: hosted-kvm
          key: db-password

    GitHub 上的示例托管目标应用

    Apigee 在 GitHub 上提供编写了 Hosted Targets 应用的示例代理 。您可以克隆此代码库并按照 README 说明 部署任意代理

    前提条件

    要部署示例,您必须在系统上安装两个工具:

    • apigeetool -- 命令行 部署 Edge 代理的工具。
    • get_token - 用于获取 apigeetool 所需的授权令牌的命令行工具。

    如果您想在本地测试示例,还必须安装 Node.js。

    获取示例代码库

    1. 在浏览器中,转到 https://github.com/apigee/api-platform-samples
    2. 点击克隆或下载,然后使用 您的首选方法。
    3. 使用 cd 命令复制到 <your install dir>/api-platform-samples/doc-samples/hosted-targets
    4. 下载代码库后,您可以转到任何示例目录,然后按照 将示例代理部署到 Edge 的 README 说明。部署命令如下所示。Simply 将指示的参数替换为您 Apigee 账号的参数:
    5. get_token && apigeetool deployproxy \
        -o YOUR_ORGANIZATION \
        -e YOUR_ENVIRONMENT \
        --json \
        --token "$(< ~/.sso-cli/valid_token.dat)"\
        --api NAME_OF_THE_PROXY \
        --directory .

    示例:执行示例应用

    克隆示例代码库

    cd ~/myhome
    git clone https://github.com/apigee/api-platform-samples.git
    cd ~/myhome/api-platform-samples/doc-samples/hosted-targets
    cd node-hosted-hello

    在本地测试应用

    必须安装 Node.js 才能执行此本地测试。

     PORT=8081 node apiproxy/resources/hosted/index.js
     curl http://localhost:8081
    

    输出示例:

    {"date":"2018-03-12T21:45:22.161Z","msg":"Hello, World!"}

    部署代理

     get_token && apigeetool deployproxy \
       -o myorg \
       -e test \
       --json \
       --token "$(< ~/.sso-cli/valid_token.dat)"\
       --api node-hosted-hello \
       --directory .

    测试部署

    部署可能需要几分钟才能完成。如果遇到部署错误,请执行 再次部署命令

    curl http://myorg-test.apigee.net/node-hosted-hello

    输出示例:

    {"date":"2018-03-23T18:59:18.668Z","msg":"Hello, World!"

    已知问题

    • 网络延迟 - 现在 Node.js 应用不再运行 在 MP 的 JVM 中,MP 和部署之间现在存在网络跃点。当然 这需要付出代价,但初步基准数据显示,其价格在合理的范围内
    • API 响应缓慢 - 运行应用的基础架构 可根据需要自动扩缩这意味着您的应用实际上可以 如果是这种情况,则下一次 API 请求花费的时间会比 因为基础架构会启动实例来处理 请求。
    • 部署错误 - 如果您在部署 Hosted Targets 代理,请尝试重新部署该代理。在某些情况下,部署可能会超时 如果您重新部署,问题将自行解决。