跳到主要内容
版本:3.2.16.6

环境变量

API7 企业版支持使用 消费者凭证、SSL 证书 以及部分插件。系统保留了一些特殊用途的环境变量,同时也支持创建自定义名称的环境变量并进行引用。

保留环境变量​

API7 企业版目前保留以下环境变量:

变量名描述
APISIX_DEPLOYMENT_ETCD_HOSTetcd 主机地址。
APISIX_WORKER_PROCESSES工作进程数量。

使用这些配置时,需在启动 APISIX 前为环境变量赋值。

自定义环境变量​

您可以在配置文件和部分插件中使用自定义环境变量。

注意

环境变量直接配置在各数据平面(网关实例)上,重启后立即生效。由于这种配置方式,您无法从控制平面查看实际值。此外,网关组内不同网关实例间的环境变量配置不一致可能导致不可预测的行为和 API 故障。

消费者凭证​

以下消费者凭证中的敏感字段可通过 NGINX env 指令 存储于环境变量:

  • 密钥认证凭证中的 key
  • 基础认证凭证中的 password
  • JWT 认证凭证中的 secret 和 public key
  • HMAC 认证凭证中的 secret key

以下示例展示如何配置密钥认证凭证从环境变量获取用户认证密钥。

设置环境变量​

部署网关实例时设置环境变量。参照 添加网关实例,然后将环境变量添加到生成的脚本中。

Docker 示例,在 docker run 命令中添加自定义环境变量:

docker run -d -e API7_CONTROL_PLANE_ENDPOINTS='["https://your-host-or-ip:443"]' \
-e API7_GATEWAY_GROUP_SHORT_ID=default \
-e ALICE_AUTH_KEY=alice-key \
-e API7_CONTROL_PLANE_CERT="-----BEGIN CERTIFICATE-----
YOUR_GATEWAY_MTLS_CERTIFICATE_BODY
-----END CERTIFICATE-----" \
-e API7_CONTROL_PLANE_KEY="-----BEGIN PRIVATE KEY-----
YOUR_GATEWAY_MTLS_PRIVATE_KEY_BODY
-----END PRIVATE KEY-----" \
-e API7_CONTROL_PLANE_CA="-----BEGIN CERTIFICATE-----
YOUR_CONTROL_PLANE_CA_CERTIFICATE_BODY
-----END CERTIFICATE-----" \
-p 9080:9080 \
-p 9443:9443 \
api7/api7-ee-3-gateway:dev
备注

部署后,网关实例的环境变量需重启实例才能修改。

配置使用环境变量的消费者凭证​

  1. 从侧边栏选择您网关组的 消费者。

  2. 点击 + 新增消费者。

  3. 在对话框中:

    • 在 名称 字段输入 Alice
    • 点击 新增
  4. 在 认证凭据 标签页下,点击 + 新增 Key Authentication 凭据

  5. 在对话框中:

    • 在 名称 字段输入 primary-key
    • 在 密钥 字段选择 手动输入,然后输入 $env://ALICE_AUTH_KEY
    • 点击 新增
  6. 验证:参照 为 API 启用密钥认证 的说明,在服务级别启用 Key Auth Plugin。然后按照 验证密钥认证 的步骤操作。

SSL 证书​

SSL 证书中的敏感字段 private key 和 certificate 可通过 NGINX env 指令 存储于环境变量。

以下示例展示如何配置 SSL 证书从环境变量获取敏感数据。

设置环境变量​

部署网关实例时设置环境变量。参照 添加网关实例,然后将环境变量添加到生成的脚本中。

Docker 示例,在 docker run 命令中添加自定义环境变量:

docker run -d -e API7_CONTROL_PLANE_ENDPOINTS='["https://your-host-or-ip:443"]' \
-e API7_GATEWAY_GROUP_SHORT_ID=default \
-e SSL_CERTIFICATE="-----BEGIN CERTIFICATE-----
YOUR_TLS_SERVER_CERTIFICATE_BODY
-----END CERTIFICATE-----" \
-e SSL_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----
YOUR_TLS_SERVER_PRIVATE_KEY_BODY
-----END PRIVATE KEY-----" \
-e API7_CONTROL_PLANE_CERT="-----BEGIN CERTIFICATE-----
YOUR_GATEWAY_MTLS_CERTIFICATE_BODY
-----END CERTIFICATE-----" \
-e API7_CONTROL_PLANE_KEY="-----BEGIN PRIVATE KEY-----
YOUR_GATEWAY_MTLS_PRIVATE_KEY_BODY
-----END PRIVATE KEY-----" \
-e API7_CONTROL_PLANE_CA="-----BEGIN CERTIFICATE-----
YOUR_CONTROL_PLANE_CA_CERTIFICATE_BODY
-----END CERTIFICATE-----" \
-p 9080:9080 \
-p 9443:9443 \
api7/api7-ee-3-gateway:dev
备注

部署后,网关实例的环境变量需重启实例才能修改。

配置使用环境变量的 SSL 证书​

  1. 从侧边栏选择您网关组的 证书。
  2. 点击 + 新增 SSL 证书。
  3. 在对话框中:
    • 在证书 字段输入 $env://SSL_CERTIFICATE
    • 在私钥 字段输入 $env://SSL_PRIVATE_KEY
    • 点击添加