This is an automated email from the ASF dual-hosted git repository. kayx23 pushed a commit to branch agent/fix-config-default-docs in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
commit 4a9e822472eb605a920351305f7f1554d597b227 Author: kayx23 <[email protected]> AuthorDate: Mon Aug 10 14:53:57 2026 +0800 docs: correct configuration defaults --- config/samples/config.yaml | 10 +++++----- docs/en/latest/configure.md | 4 ++-- docs/en/latest/reference/configuration-file.md | 10 +++++----- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/config/samples/config.yaml b/config/samples/config.yaml index 157fb681..b0fae7d5 100644 --- a/config/samples/config.yaml +++ b/config/samples/config.yaml @@ -4,8 +4,8 @@ log_level: "info" # The log level of the APISIX In controller_name: apisix.apache.org/apisix-ingress-controller # The controller name of the APISIX Ingress Controller, # which is used to identify the controller in the GatewayClass. # The default value is "apisix.apache.org/apisix-ingress-controller". -leader_election_id: "apisix-ingress-controller-leader" # The leader election ID for the APISIX Ingress Controller. - # The default value is "apisix-ingress-controller-leader". +leader_election_id: "apisix-ingress-gateway-leader" # The leader election ID for the APISIX Ingress Controller. + # The default value is "apisix-ingress-gateway-leader". leader_election: lease_duration: 30s # lease_duration is the duration that non-leader candidates will wait # after observing a leadership renewal until attempting to acquire leadership of a @@ -19,7 +19,7 @@ leader_election: metrics_addr: ":8080" # The address the metrics endpoint binds to. # The default value is ":8080". enable_server: false # The debug API is behind this server which is disabled by default for security reasons. -server_addr: "127.0.0.1:9092" # Available endpoints: /debug can be used to debug in-memory state of translated adc configs to be synced with data plane. +server_addr: "127.0.0.1:9092" # Recommended local binding for the debug API. The binary default is ":9092". enable_http2: false # Whether to enable HTTP/2 for the server. # The default value is false. @@ -47,8 +47,8 @@ provider: # Value can be "apisix" or "apisix-standalone". sync_period: 1h # The period between two consecutive syncs. - # The default value is 1 hour, which means the controller will not sync. - # If you want to enable the sync, set it to a positive value. + # The default value is 1 hour. + # The value must be greater than 0 for APISIX providers. init_sync_delay: 20m # The initial delay before the first sync, only used when the controller is started. # The default value is 20 minutes. diff --git a/docs/en/latest/configure.md b/docs/en/latest/configure.md index eefc0251..46320e94 100644 --- a/docs/en/latest/configure.md +++ b/docs/en/latest/configure.md @@ -38,8 +38,8 @@ controller_name: apisix.apache.org/apisix-ingress-controller # The controller n # which is used to identify the controller in the GatewayClass. # The default value is "apisix.apache.org/apisix-ingress-controller". -leader_election_id: "apisix-ingress-controller-leader" # The leader election ID for the APISIX Ingress Controller. - # The default value is "apisix-ingress-controller-leader". +leader_election_id: "apisix-ingress-gateway-leader" # The leader election ID for the APISIX Ingress Controller. + # The default value is "apisix-ingress-gateway-leader". ``` ### Controller Name diff --git a/docs/en/latest/reference/configuration-file.md b/docs/en/latest/reference/configuration-file.md index 7bbd2803..8c3691a5 100644 --- a/docs/en/latest/reference/configuration-file.md +++ b/docs/en/latest/reference/configuration-file.md @@ -27,7 +27,7 @@ The APISIX Ingress Controller uses a configuration file `config.yaml` to define Configurations are defined in a Kubernetes ConfigMap and mounted into the controller pod as a file at runtime. To apply changes, you can update the ConfigMap and restart the controller Deployment to reload the configurations. -Below are all available configuration options, including their default values and usage: +The example below shows binary defaults. Helm charts can render different values into the ConfigMap, so inspect the chart values and the generated ConfigMap when troubleshooting an installation. ```yaml log_level: "info" # The log level of the APISIX Ingress Controller. @@ -36,8 +36,8 @@ log_level: "info" # The log level of the APISIX In controller_name: apisix.apache.org/apisix-ingress-controller # The controller name of the APISIX Ingress Controller, # which is used to identify the controller in the GatewayClass. # The default value is "apisix.apache.org/apisix-ingress-controller". -leader_election_id: "apisix-ingress-controller-leader" # The leader election ID for the APISIX Ingress Controller. - # The default value is "apisix-ingress-controller-leader". +leader_election_id: "apisix-ingress-gateway-leader" # The leader election ID for the APISIX Ingress Controller. + # The default value is "apisix-ingress-gateway-leader". leader_election: lease_duration: 30s # lease_duration is the duration that non-leader candidates will wait # after observing a leadership renewal until attempting to acquire leadership of a @@ -76,8 +76,8 @@ provider: # Value can be "apisix" or "apisix-standalone". sync_period: 1h # The period between two consecutive syncs. - # The default value is 1 hour, which means the controller will not sync. - # If you want to enable the sync, set it to a positive value. + # The default value is 1 hour. + # The value must be greater than 0 for APISIX providers. init_sync_delay: 20m # The initial delay before the first sync, only used when the controller is started. # The default value is 20 minutes. ```
