You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/latest/reference/example.md
+63-14Lines changed: 63 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,7 +94,7 @@ spec:
94
94
name: apisix-config # 5
95
95
```
96
96
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.
98
98
99
99
❷ 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.
❶ 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.
❶ 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
+
147
171
</TabItem>
148
172
149
173
</Tabs>
@@ -836,6 +860,11 @@ metadata:
836
860
namespace: ingress-apisix
837
861
name: apisix-config
838
862
spec:
863
+
provider:
864
+
type: ControlPlane
865
+
controlPlane:
866
+
# add your control plane connection configuration here
867
+
# ....
839
868
plugins:
840
869
- name: clickhouse-logger
841
870
config:
@@ -894,6 +923,11 @@ metadata:
894
923
namespace: ingress-apisix
895
924
name: apisix-config
896
925
spec:
926
+
provider:
927
+
type: ControlPlane
928
+
controlPlane:
929
+
# add your control plane connection configuration here
930
+
# ....
897
931
pluginMetadata:
898
932
opentelemetry: {
899
933
"trace_id_source": "x-request-id",
@@ -1047,6 +1081,11 @@ metadata:
1047
1081
namespace: ingress-apisix
1048
1082
name: apisix-config
1049
1083
spec:
1084
+
provider:
1085
+
type: ControlPlane
1086
+
controlPlane:
1087
+
# add your control plane connection configuration here
1088
+
# ....
1050
1089
statusAddress:
1051
1090
- 10.24.87.13
1052
1091
```
@@ -1066,6 +1105,11 @@ metadata:
1066
1105
namespace: ingress-apisix
1067
1106
name: apisix-config
1068
1107
spec:
1108
+
provider:
1109
+
type: ControlPlane
1110
+
controlPlane:
1111
+
# add your control plane connection configuration here
1112
+
# ....
1069
1113
statusAddress:
1070
1114
- 10.24.87.13
1071
1115
```
@@ -1079,7 +1123,12 @@ metadata:
1079
1123
namespace: ingress-apisix
1080
1124
name: apisix-config
1081
1125
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
1083
1132
```
1084
1133
1085
1134
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