跳到主要内容
版本:3.2.14.6

APISIX Declarative CLI (ADC)

APISIX Declarative CLI (ADC) 是一个命令行工具,用于声明式地管理 APISIX 和 API7 企业版。它提供了简单明了的方式来定义网关的期望状态,让开发人员和管理员专注于结果而非步骤。

声明式配置作为单一事实来源,开发人员可以通过他们现有的版本控制系统进行管理。

ADC 具有以下通用语法:

adc [command] [options]

以及全局选项:

  • -V, --version to check the version
  • -h, --help to print the help menu of the command

配置 ADC​

在使用 ADC 管理网关之前,需要先进行配置。你可以使用环境变量或命令行参数来配置 ADC。

使用环境变量​

ADC 将所有配置选项暴露为环境变量。例如,你可以分别使用 ADC_BACKEND 和 ADC_SERVER 环境变量来配置后端类型和地址。

export ADC_BACKEND=api7ee
export ADC_SERVER=https://localhost:7443

更好的方式是在 .env 文件中配置这些选项:

.env
ADC_BACKEND=api7ee
ADC_SERVER=https://localhost:7443

使用命令行参数​

你也可以使用命令行参数来配置 ADC 或覆盖环境变量中的配置。例如,为 ping 命令配置/覆盖后端类型和地址:

adc ping --backend api7ee --server "https://localhost:7443"

运行 adc help [command] 以查看命令的可用配置选项。

命令​

adc ping​

Ping 已配置的后端以验证连接性。

选项默认值说明有效值环境变量
--verbose <integer>1覆盖日志详细程度。0 表示无日志,1 表示基本日志,2 表示调试日志。0, 1 or 2
--backend <backend>apisix要连接的后端类型。apisix or api7eeADC_BACKEND
--server <string>http://localhost:9180后端服务器地址。ADC_SERVER
--token <string>用于访问后端的 API Token。ADC_TOKEN
--gateway-group <string>default要操作的网关组。ADC_GATEWAY_GROUP
--label-selector <selectors>用于筛选资源的标签。
--include-resource-type <string>按资源类型筛选,仅保留指定类型的资源。
--exclude-resource-type <string>按资源类型筛选,排除指定类型的资源。
--timeout <duration>10s客户端连接后端 Admin API 的请求超时时长,例如 30s、10m 或 1h10m。
--ca-cert-file <string>用于验证后端 Admin API 的 CA 证书路径。ADC_CA_CERT_FILE
--tls-client-cert-file <string>用于验证后端 Admin API 的双向 TLS 客户端证书路径。ADC_TLS_CLIENT_CERT_FILE
--tls-client-key-file <string>用于验证后端 Admin API 的双向 TLS 客户端密钥路径。ADC_TLS_CLIENT_KEY_FILE
--tls-skip-verifyfalse连接后端 Admin API 时是否验证 TLS 证书。ADC_TLS_SKIP_VERIFY

使用示例​

adc ping --backend api7ee --server https://localhost:7443

adc lint​

在本地验证提供的配置文件。

选项默认值说明有效值环境变量
-f, --file <file-path>要检查的文件。

使用示例​

adc lint -f service-a.yaml -f service-b.yaml

adc sync​

将本地配置同步到连接的后端。

选项默认值说明有效值环境变量
--verbose <integer>1覆盖日志详细程度。0 表示无日志,1 表示基本日志,2 表示调试日志。0, 1 or 2
--backend <backend>apisix要连接的后端类型。apisix or api7eeADC_BACKEND
--server <string>http://localhost:9180后端服务器地址。ADC_SERVER
--token <string>用于访问后端的 API Token。ADC_TOKEN
--gateway-group <string>default要操作的网关组。ADC_GATEWAY_GROUP
--label-selector <selectors>用于筛选资源的标签。
-f, --file <file-path>要同步的配置文件。
--include-resource-type <string>按资源类型筛选,仅保留指定类型的资源。
--exclude-resource-type <string>按资源类型筛选,排除指定类型的资源。
--timeout <duration>10s客户端连接后端 Admin API 的请求超时时长,例如 30s、10m 或 1h10m。
--ca-cert-file <string>用于验证后端 Admin API 的 CA 证书路径。ADC_CA_CERT_FILE
--tls-client-cert-file <string>用于验证后端 Admin API 的双向 TLS 客户端证书路径。ADC_TLS_CLIENT_CERT_FILE
--tls-client-key-file <string>用于验证后端 Admin API 的双向 TLS 客户端密钥路径。ADC_TLS_CLIENT_KEY_FILE
--tls-skip-verifyfalse连接后端 Admin API 时是否验证 TLS 证书。ADC_TLS_SKIP_VERIFY

使用示例​

adc sync -f service-a.yaml -f service-b.yaml --backend api7ee --server https://localhost:7443

adc dump​

将后端配置保存到本地文件。

选项默认值说明有效值环境变量
--verbose <integer>1覆盖日志详细程度。0 表示无日志,1 表示基本日志,2 表示调试日志。0, 1 or 2
--backend <backend>apisix要连接的后端类型。apisix or api7eeADC_BACKEND
--server <string>http://localhost:9180后端服务器地址。ADC_SERVER
--token <string>用于访问后端的 API Token。ADC_TOKEN
--gateway-group <string>default要操作的网关组。ADC_GATEWAY_GROUP
--label-selector <selectors>用于筛选资源的标签。
-o, --output <file-path>保存后端数据的文件路径。
--include-resource-type <string>按资源类型筛选,仅保留指定类型的资源。
--exclude-resource-type <string>按资源类型筛选,排除指定类型的资源。
--timeout <duration>10s客户端连接后端 Admin API 的请求超时时长,例如 30s、10m 或 1h10m。
--ca-cert-file <string>用于验证后端 Admin API 的 CA 证书路径。ADC_CA_CERT_FILE
--tls-client-cert-file <string>用于验证后端 Admin API 的双向 TLS 客户端证书路径。ADC_TLS_CLIENT_CERT_FILE
--tls-client-key-file <string>用于验证后端 Admin API 的双向 TLS 客户端密钥路径。ADC_TLS_CLIENT_KEY_FILE
--tls-skip-verifyfalse连接后端 Admin API 时是否验证 TLS 证书。ADC_TLS_SKIP_VERIFY

使用示例​

adc dump -o apisix-dump.yaml --backend api7ee --server https://localhost:7443

adc diff​

显示本地文件和后端配置之间的差异。

选项默认值说明有效值环境变量
--verbose <integer>1覆盖日志详细程度。0 表示无日志,1 表示基本日志,2 表示调试日志。0, 1 or 2
--backend <backend>apisix要连接的后端类型。apisix or api7eeADC_BACKEND
--server <string>http://localhost:9180后端服务器地址。ADC_SERVER
--token <string>用于访问后端的 API Token。ADC_TOKEN
--gateway-group <string>default要操作的网关组。ADC_GATEWAY_GROUP
--label-selector <selectors>用于筛选资源的标签。
-f, --file <file-path>要比较的配置文件。
--include-resource-type <string>按资源类型筛选,仅保留指定类型的资源。
--exclude-resource-type <string>按资源类型筛选,排除指定类型的资源。
--timeout <duration>10s客户端连接后端 Admin API 的请求超时时长,例如 30s、10m 或 1h10m。
--ca-cert-file <string>用于验证后端 Admin API 的 CA 证书路径。ADC_CA_CERT_FILE
--tls-client-cert-file <string>用于验证后端 Admin API 的双向 TLS 客户端证书路径。ADC_TLS_CLIENT_CERT_FILE
--tls-client-key-file <string>用于验证后端 Admin API 的双向 TLS 客户端密钥路径。ADC_TLS_CLIENT_KEY_FILE
--tls-skip-verifyfalse连接后端 Admin API 时是否验证 TLS 证书。ADC_TLS_SKIP_VERIFY

使用示例​

adc diff -f service-a.yaml -f service-b.yaml --backend api7ee --server https://localhost:7443

adc convert​

将 API 规范转换为 ADC 配置。

选项默认值说明有效值环境变量
openapi将 OpenAPI 规范转换为 ADC 配置。

使用示例​

adc convert openapi -f open-api-spec.yaml -o adc.yaml

更多信息请参阅 OpenAPI 转换参考。

adc help​

打印通用帮助菜单或指定命令的帮助菜单。

使用示例​

adc help [command]