配置参考
ADC 使用一个或多个配置文件定义 API7 企业版中的服务、路由、插件和其他配置。配置文件可以采用 YAML 或 JSON 格式,作为唯一的配置依据。
本文档提供配置文件示例,供你创建自己的配置文件时参考。关于通过 ADC 使用配置文件的更多信息,请参阅命令参考。
配置文件示例
以下配置文件定义了两个具有多条路由和标签的服务、两个具有 Key 身份认证凭据的消费者,以及配置 Prometheus 插件的全局规则。
adc.yaml
services:
- name: mockbin-service
labels:
deployment: staging
upstream:
name: Default Upstream
scheme: http
type: roundrobin
hash_on: vars
nodes:
- host: mock.api7.ai
port: 80
weight: 100
priority: 0
timeout:
connect: 60
send: 60
read: 60
retry_timeout: 0
keepalive_pool:
size: 320
idle_timeout: 60
requests: 1000
pass_host: pass
strip_path_prefix: true
routes:
- uris:
- /api
name: api
methods:
- GET
enable_websocket: false
priority: 0
- name: httpbin-service
labels:
deployment: production
upstream:
name: Default Upstream
scheme: http
nodes:
- host: httpbin.org
port: 80
routes:
- uris:
- /ip
name: ip
labels:
app: catalog
methods:
- GET
- uris:
- /anything/*
name: anything
methods:
- GET
consumers:
- username: Jane
labels:
organisation: ACME
credentials:
- name: primary-key
labels:
type: internal
type: key-auth
config:
key: c1_yN0nCWousUfiR4EzfH
metadata:
namespace: api7
id: 9ae2df2b-e578-46d9-8357-cf7c3cd64d51
- username: John
labels:
organisation: API7.ai
credentials:
- name: primary-key
type: key-auth
config:
key: EIul6mAuYkLJ27on1aJD4
metadata:
namespace: api7
id: c5e8c41e-37c5-4329-87a9-ba2e6916cfe3
global_rules:
prometheus:
_meta:
disable: false
prefer_name: false
配置文件中的变量
ADC 支持多种在配置文件中引用变量的语法,各种语法在运行时从不同来源解析变量值。
不同语法支持的 ADC 版本如下。
| 语法 | 解析方 | 最低 ADC 版本 |
|---|---|---|
$env:// | 数据面 | v0.12.1 |
${ENV} | ADC | v0.12.0 |
\${} | 数据面 | v0.19.1 |
数据面环境变量
ADC 支持在适用字段中使用 $env:// 语法引用数据面环境变量,从运行中的数据面(网关)实例环境中动态解析配置值。请参阅自定义环境变量。
ADC 环境变量
ADC 的所有字段都支持使用 ${ENV} 语法引用 ADC 侧的环境变量。这些变量由 ADC 自身解析,通常用于将配置值外置,避免将值直接硬编码到文件中。
内置变量
ADC 支持在适用字段中使用 \${} 语法配置内置变量。
在 YAML 双引号字符串中,将转义序列写为 \\${...},使 ADC 在 YAML 解析后接收到 \${...}。在单引号字符串或未加引号的值中,可以直接写 \${...}。
例如,以下插件使用内置变量,根据 HTTP 请求头 X-User-Info 中的值动态确定限流 Key 和限额。
plugins:
limit-count:
count: "\\${http_x_user_info.low_rate_limit}"
key: "\\${http_x_user_info.rate_limit_key}"
time_window: 60
key_type: var