Skip to content

Commit 50dda24

Browse files
authored
docs: update reference configuration examples (#2606)
1 parent 06e00cd commit 50dda24

File tree

1 file changed

+63
-14
lines changed

1 file changed

+63
-14
lines changed

docs/en/latest/reference/example.md

Lines changed: 63 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ spec:
9494
name: apisix-config # 5
9595
```
9696
97-
❶ The controllerName field in GatewayClass needs to be customized if you are running multiple distinct instances of the APISIX Ingress Controller in the same cluster (not a single instance with multiple replicas). Each ingress controller instance must use a unique controllerName in its [configuration file](configuration-file.md), and the corresponding GatewayClass should reference that value.
97+
❶ The controller name should be customized if you are running multiple distinct instances of the APISIX Ingress Controller in the same cluster (not a single instance with multiple replicas). Each ingress controller instance must use a unique controllerName in its [configuration file](configuration-file.md), and the corresponding GatewayClass should reference that value.
9898
9999
❷ The `port` in the Gateway listener is required but ignored. This is due to limitations in the data plane: it cannot dynamically open new ports. Since the Ingress Controller does not manage the data plane deployment, it cannot automatically update the configuration or restart the data plane to apply port changes.
100100

@@ -115,15 +115,27 @@ metadata:
115115
namespace: ingress-apisix
116116
name: apisix
117117
spec:
118-
controller: apisix.apache.org/apisix-ingress-controller
118+
controller: apisix.apache.org/apisix-ingress-controller # 1
119119
parameters:
120-
apiGroup: apisix.apache.org
121-
kind: GatewayProxy
122-
name: apisix-config
123-
namespace: ingress-apisix
124-
scope: Namespace
120+
apiGroup: apisix.apache.org # 2
121+
kind: GatewayProxy # 3
122+
name: apisix-config # 4
123+
namespace: ingress-apisix # 5
124+
scope: Namespace # 6
125125
```
126126

127+
❶ The controller name should be customized if you are running multiple distinct instances of the APISIX Ingress Controller in the same cluster (not a single instance with multiple replicas). Each ingress controller instance must use a unique controllerName in its [configuration file](configuration-file.md), and the corresponding IngressClass should reference that value.
128+
129+
❷ API group of the referenced resource.
130+
131+
❸ Kind of the referenced resource.
132+
133+
❹ Name of the referenced resource. Should match the `metadata.name` of the GatewayProxy resource.
134+
135+
❺ Namespace where the referenced resource is defined.
136+
137+
❻ Scope of the referenced resource.
138+
127139
</TabItem>
128140

129141
<TabItem value="apisix-crd">
@@ -135,15 +147,27 @@ metadata:
135147
namespace: ingress-apisix
136148
name: apisix
137149
spec:
138-
controller: apisix.apache.org/apisix-ingress-controller
150+
controller: apisix.apache.org/apisix-ingress-controller # 1
139151
parameters:
140-
apiGroup: apisix.apache.org
141-
kind: GatewayProxy
142-
name: apisix-config
143-
namespace: ingress-apisix
144-
scope: Namespace
152+
apiGroup: apisix.apache.org # 2
153+
kind: GatewayProxy # 3
154+
name: apisix-config # 4
155+
namespace: ingress-apisix # 5
156+
scope: Namespace # 6
145157
```
146158

159+
❶ The controller name should be customized if you are running multiple distinct instances of the APISIX Ingress Controller in the same cluster (not a single instance with multiple replicas). Each ingress controller instance must use a unique controllerName in its [configuration file](configuration-file.md), and the corresponding IngressClass should reference that value.
160+
161+
❷ API group of the referenced resource.
162+
163+
❸ Kind of the referenced resource.
164+
165+
❹ Name of the referenced resource. Should match the `metadata.name` of the GatewayProxy resource.
166+
167+
❺ Namespace where the referenced resource is defined.
168+
169+
❻ Scope of the referenced resource.
170+
147171
</TabItem>
148172

149173
</Tabs>
@@ -836,6 +860,11 @@ metadata:
836860
namespace: ingress-apisix
837861
name: apisix-config
838862
spec:
863+
provider:
864+
type: ControlPlane
865+
controlPlane:
866+
# add your control plane connection configuration here
867+
# ....
839868
plugins:
840869
- name: clickhouse-logger
841870
config:
@@ -894,6 +923,11 @@ metadata:
894923
namespace: ingress-apisix
895924
name: apisix-config
896925
spec:
926+
provider:
927+
type: ControlPlane
928+
controlPlane:
929+
# add your control plane connection configuration here
930+
# ....
897931
pluginMetadata:
898932
opentelemetry: {
899933
"trace_id_source": "x-request-id",
@@ -1047,6 +1081,11 @@ metadata:
10471081
namespace: ingress-apisix
10481082
name: apisix-config
10491083
spec:
1084+
provider:
1085+
type: ControlPlane
1086+
controlPlane:
1087+
# add your control plane connection configuration here
1088+
# ....
10501089
statusAddress:
10511090
- 10.24.87.13
10521091
```
@@ -1066,6 +1105,11 @@ metadata:
10661105
namespace: ingress-apisix
10671106
name: apisix-config
10681107
spec:
1108+
provider:
1109+
type: ControlPlane
1110+
controlPlane:
1111+
# add your control plane connection configuration here
1112+
# ....
10691113
statusAddress:
10701114
- 10.24.87.13
10711115
```
@@ -1079,7 +1123,12 @@ metadata:
10791123
namespace: ingress-apisix
10801124
name: apisix-config
10811125
spec:
1082-
publishService: apisix-ee-3-gateway-gateway
1126+
provider:
1127+
type: ControlPlane
1128+
controlPlane:
1129+
# add your control plane connection configuration here
1130+
# ....
1131+
publishService: apisix-gateway
10831132
```
10841133

10851134
When using `publishService`, make sure your gateway Service is of `LoadBalancer` type the address can be populated. The controller will use the endpoint of this Service to update the status information of the Ingress resource. The format can be either `namespace/svc-name` or simply `svc-name` if the default namespace is correctly set.

0 commit comments

Comments
 (0)