Skip to content

Commit d91a3ba

Browse files
authored
doc: recommended to use apisix-standalone mode for installation. (#2470)
1 parent 0a4e05c commit d91a3ba

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

docs/en/latest/getting-started.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ Before installing APISIX Ingress Controller, ensure you have:
4343
1. A working Kubernetes cluster (version 1.26+)
4444
2. [Helm](https://helm.sh/) (version 3.8+) installed
4545

46-
### Install APISIX and APISIX Ingress Controller
46+
### Install APISIX and APISIX Ingress Controller (Standalone API-driven mode)
4747

48-
Install the Gateway API CRDs, APISIX, and APISIX Ingress Controller using the following commands:
48+
Install the Gateway API CRDs, [APISIX Standalone API-driven mode](https://apisix.apache.org/docs/apisix/deployment-modes/#api-driven-experimental), and APISIX Ingress Controller using the following commands:
4949

5050
```bash
5151
helm repo add apisix https://charts.apiseven.com
@@ -55,7 +55,11 @@ helm repo update
5555
helm install apisix \
5656
--namespace ingress-apisix \
5757
--create-namespace \
58+
--set apisix.deployment.role=traditional \
59+
--set apisix.deployment.role_traditional.config_provider=yaml \
60+
--set etcd.enabled=false \
5861
--set ingress-controller.enabled=true \
62+
--set ingress-controller.config.provider.type=apisix-standalone \
5963
--set ingress-controller.apisix.adminService.namespace=ingress-apisix \
6064
--set ingress-controller.gatewayProxy.createDefault=true \
6165
apisix/apisix
@@ -66,7 +70,7 @@ helm install apisix \
6670
Install the httpbin example application to test the configuration:
6771

6872
```bash
69-
https://raw.githubusercontent.com/apache/apisix-ingress-controller/refs/heads/v2.0.0/examples/httpbin/deployment.yaml
73+
kubectl apply -f https://raw.githubusercontent.com/apache/apisix-ingress-controller/refs/heads/v2.0.0/examples/httpbin/deployment.yaml
7074
```
7175

7276
### Configure a Route

docs/en/latest/upgrade-guide.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ etcdserver:
6666
6767
In 2.0.0, all data plane configurations must originate from the Ingress Controller. Configurations via Admin API or any external methods are no longer supported and will be ignored or may cause errors.
6868
69+
#### APISIX With Etcd (Admin API) synchronization performance
70+
71+
In APISIX Ingress Controller 2.0.0, ADC performs scheduled resource synchronization by comparing resources against the admin API response.
72+
73+
Because the Admin API fills in default values, the submitted content may differ from the returned result. This breaks the diff, triggering full updates to data plane resources, causing cache invalidation and significant performance impact.
74+
6975
### Ingress Configuration Changes
7076
7177
#### Configuration Path Changes

0 commit comments

Comments
 (0)