配置文件
API7 Ingress Controller 使用配置文件 config.yaml 定义日志级别、领导者选举行为、指标端点和同步间隔等核心设置。
这些配置定义在 Kubernetes ConfigMap 中,并在运行时作为文件挂载到控制器 Pod。建议通过 Helm 管理这些配置,以便更新和版本控制。如果直接修改 ConfigMap,必须重启控制器 Deployment 才能应用更改。
以下列出所有可用的配置项及其默认值和用途:
config.yaml
log_level: "info" # APISIX Ingress Controller 的日志级别。
# 默认值为 "info"。
controller_name: apisix.apache.org/apisix-ingress-controller # APISIX Ingress Controller 的控制器名称,
# 用于在 GatewayClass 中标识控制器。
# 默认值为 "apisix.apache.org/apisix-ingress-controller"。
leader_election_id: "apisix-ingress-controller-leader" # APISIX Ingress Controller 的领导者选举 ID。
# 默认值为 "apisix-ingress-controller-leader"。
leader_election:
lease_duration: 30s # 非领导者候选节点观察到领导权续约后,
# 在尝试取得领导权之前等待的时长。
renew_deadline: 20s # 当前控制器放弃之前,
# 重试续约领导权的时长(秒)。
retry_period: 2s # 当前控制器每次操作尝试之间
# 等待的时长(秒)。
disable: false # 是否禁用领导者选举。
metrics_addr: ":8080" # 指标端点绑定的地址。
# 默认值为 ":8080"。
enable_server: false # 调试 API 由此服务器提供;出于安全考虑,默认禁用。
server_addr: "127.0.0.1:9092" # 可用端点:/debug 可用于调试内存中已转换、待同步到数据面的 ADC 配置状态。
enable_http2: false # 是否为服务器启用 HTTP/2。
# 默认值为 false。
probe_addr: ":8081" # 探针端点绑定的地址。
# 默认值为 ":8081"。
secure_metrics: false # 安全指标配置。
# 默认值为 ""(空)。
exec_adc_timeout: 15s # ADC 执行的超时时间。
# 默认值为 15 秒。
disable_gateway_api: false # 是否禁用 Gateway API 支持。
# 默认值为 false。
provider:
type: "api7ee" # 服务提供方类型。
sync_period: 1h # 两次连续同步之间的间隔。
# 默认值为 1 小时。
# 如需禁用同步,请设为 0。
init_sync_delay: 20m # 首次同步前的初始延迟,仅在控制器启动时使用。
# 默认值为 20 分钟。
webhook:
enable: false # 是否启用 webhook 服务器。
# 默认值为 false。
tls_cert_file: "tls.crt" # tls_cert_dir 中包含 webhook 服务器 TLS 证书的文件名。
# 默认值为 "tls.crt"。
tls_key_file: "tls.key" # tls_cert_dir 中包含 webhook 服务器 TLS 私钥的文件名。
# 默认值为 "tls.key"。
tls_cert_dir: "/certs" # 包含 webhook 服务器 TLS 证书文件的目录。
# 默认值为 "/certs"。
port: 9443 # webhook 服务器监听的端口。
# 默认值为 9443。