Skip to content

Commit ebaed22

Browse files
kayx23kayx23
authored
docs: specify namespace in metadata explicitly (#2549)
1 parent 7f6cff4 commit ebaed22

File tree

8 files changed

+80
-5
lines changed

8 files changed

+80
-5
lines changed

‎docs/en/latest/concepts/gateway-api.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ The following example demonstrates how to configure an HTTPRoute resource to rou
6363
apiVersion: gateway.networking.k8s.io/v1
6464
kind: GatewayClass
6565
metadata:
66+
namespace: ingress-apisix
6667
name: apisix
6768
spec:
6869
controllerName: "apisix.apache.org/apisix-ingress-controller"
@@ -72,8 +73,8 @@ spec:
7273
apiVersion: gateway.networking.k8s.io/v1
7374
kind: Gateway
7475
metadata:
76+
namespace: ingress-apisix
7577
name: apisix
76-
namespace: default
7778
spec:
7879
gatewayClassName: apisix
7980
listeners:
@@ -86,6 +87,7 @@ spec:
8687
apiVersion: gateway.networking.k8s.io/v1
8788
kind: HTTPRoute
8889
metadata:
90+
namespace: ingress-apisix
8991
name: httpbin
9092
spec:
9193
parentRefs:

‎docs/en/latest/configure.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ The `controller_name` field is used to identify the `controllerName` in the Gate
5050
apiVersion: gateway.networking.k8s.io/v1
5151
kind: GatewayClass
5252
metadata:
53+
namespace: ingress-apisix
5354
name: apisix
5455
spec:
5556
controllerName: "apisix.apache.org/apisix-ingress-controller"

‎docs/en/latest/getting-started/configure-routes.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,15 @@ If you are using Gateway API, you should first configure the GatewayClass and Ga
6363
apiVersion: gateway.networking.k8s.io/v1
6464
kind: GatewayClass
6565
metadata:
66+
namespace: ingress-apisix
6667
name: apisix
6768
spec:
6869
controllerName: apisix.apache.org/apisix-ingress-controller
6970
---
7071
apiVersion: gateway.networking.k8s.io/v1
7172
kind: Gateway
7273
metadata:
74+
namespace: ingress-apisix
7375
name: apisix
7476
spec:
7577
gatewayClassName: apisix
@@ -107,6 +109,7 @@ values={[
107109
apiVersion: gateway.networking.k8s.io/v1
108110
kind: HTTPRoute
109111
metadata:
112+
namespace: ingress-apisix
110113
name: getting-started-ip
111114
spec:
112115
parentRefs:
@@ -129,6 +132,7 @@ spec:
129132
apiVersion: networking.k8s.io/v1
130133
kind: Ingress
131134
metadata:
135+
namespace: ingress-apisix
132136
name: getting-started-ip
133137
spec:
134138
ingressClassName: apisix
@@ -152,6 +156,7 @@ spec:
152156
apiVersion: apisix.apache.org/v2
153157
kind: ApisixRoute
154158
metadata:
159+
namespace: ingress-apisix
155160
name: getting-started-ip
156161
spec:
157162
ingressClassName: apisix

‎docs/en/latest/getting-started/key-authentication.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,15 @@ If you are using Gateway API, you should first configure the GatewayClass and Ga
5353
apiVersion: gateway.networking.k8s.io/v1
5454
kind: GatewayClass
5555
metadata:
56+
namespace: ingress-apisix
5657
name: apisix
5758
spec:
5859
controllerName: apisix.apache.org/apisix-ingress-controller
5960
---
6061
apiVersion: gateway.networking.k8s.io/v1
6162
kind: Gateway
6263
metadata:
64+
namespace: ingress-apisix
6365
name: apisix
6466
spec:
6567
gatewayClassName: apisix
@@ -96,6 +98,7 @@ Create a Kubernetes manifest file to configure a consumer:
9698
apiVersion: apisix.apache.org/v1alpha1
9799
kind: Consumer
98100
metadata:
101+
namespace: ingress-apisix
99102
name: tom
100103
spec:
101104
gatewayRef:
@@ -113,6 +116,7 @@ Create a Kubernetes manifest file to configure a route and enable key authentica
113116
apiVersion: v1
114117
kind: Service
115118
metadata:
119+
namespace: ingress-apisix
116120
name: httpbin-external-domain
117121
spec:
118122
type: ExternalName
@@ -121,6 +125,7 @@ spec:
121125
apiVersion: apisix.apache.org/v1alpha1
122126
kind: PluginConfig
123127
metadata:
128+
namespace: ingress-apisix
124129
name: auth-plugin-config
125130
spec:
126131
plugins:
@@ -132,6 +137,7 @@ spec:
132137
apiVersion: gateway.networking.k8s.io/v1
133138
kind: HTTPRoute
134139
metadata:
140+
namespace: ingress-apisix
135141
name: getting-started-ip
136142
spec:
137143
parentRefs:
@@ -168,6 +174,7 @@ Create a Kubernetes manifest file to configure a consumer:
168174
apiVersion: apisix.apache.org/v2
169175
kind: ApisixConsumer
170176
metadata:
177+
namespace: ingress-apisix
171178
name: tom
172179
spec:
173180
ingressClassName: apisix
@@ -183,6 +190,7 @@ Create a Kubernetes manifest file to configure a route and enable key authentica
183190
apiVersion: apisix.apache.org/v2
184191
kind: ApisixUpstream
185192
metadata:
193+
namespace: ingress-apisix
186194
name: httpbin-external-domain
187195
spec:
188196
externalNodes:
@@ -192,6 +200,7 @@ spec:
192200
apiVersion: apisix.apache.org/v2
193201
kind: ApisixRoute
194202
metadata:
203+
namespace: ingress-apisix
195204
name: getting-started-ip
196205
spec:
197206
ingressClassName: apisix

‎docs/en/latest/getting-started/load-balancing.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,15 @@ If you are using Gateway API, you should first configure the GatewayClass and Ga
5353
apiVersion: gateway.networking.k8s.io/v1
5454
kind: GatewayClass
5555
metadata:
56+
namespace: ingress-apisix
5657
name: apisix
5758
spec:
5859
controllerName: apisix.apache.org/apisix-ingress-controller
5960
---
6061
apiVersion: gateway.networking.k8s.io/v1
6162
kind: Gateway
6263
metadata:
64+
namespace: ingress-apisix
6365
name: apisix
6466
spec:
6567
gatewayClassName: apisix
@@ -96,6 +98,7 @@ values={[
9698
apiVersion: v1
9799
kind: Service
98100
metadata:
101+
namespace: ingress-apisix
99102
name: httpbin-external-domain
100103
spec:
101104
type: ExternalName
@@ -104,6 +107,7 @@ spec:
104107
apiVersion: v1
105108
kind: Service
106109
metadata:
110+
namespace: ingress-apisix
107111
name: mockapi7-external-domain
108112
spec:
109113
type: ExternalName
@@ -112,6 +116,7 @@ spec:
112116
apiVersion: apisix.apache.org/v1alpha1
113117
kind: BackendTrafficPolicy
114118
metadata:
119+
namespace: ingress-apisix
115120
name: passhost-node
116121
spec:
117122
targetRefs:
@@ -127,6 +132,7 @@ spec:
127132
apiVersion: gateway.networking.k8s.io/v1
128133
kind: HTTPRoute
129134
metadata:
135+
namespace: ingress-apisix
130136
name: lb-route
131137
spec:
132138
parentRefs:
@@ -153,6 +159,7 @@ spec:
153159
apiVersion: apisix.apache.org/v2
154160
kind: ApisixUpstream
155161
metadata:
162+
namespace: ingress-apisix
156163
name: httpbin-external-domain
157164
spec:
158165
scheme: https
@@ -166,6 +173,7 @@ spec:
166173
apiVersion: apisix.apache.org/v2
167174
kind: ApisixUpstream
168175
metadata:
176+
namespace: ingress-apisix
169177
name: mockapi7-external-domain
170178
spec:
171179
scheme: https
@@ -179,6 +187,7 @@ spec:
179187
apiVersion: apisix.apache.org/v2
180188
kind: ApisixRoute
181189
metadata:
190+
namespace: ingress-apisix
182191
name: lb-route
183192
spec:
184193
ingressClassName: apisix

‎docs/en/latest/getting-started/rate-limiting.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,15 @@ If you are using Gateway API, you should first configure the GatewayClass and Ga
5353
apiVersion: gateway.networking.k8s.io/v1
5454
kind: GatewayClass
5555
metadata:
56+
namespace: ingress-apisix
5657
name: apisix
5758
spec:
5859
controllerName: apisix.apache.org/apisix-ingress-controller
5960
---
6061
apiVersion: gateway.networking.k8s.io/v1
6162
kind: Gateway
6263
metadata:
64+
namespace: ingress-apisix
6365
name: apisix
6466
spec:
6567
gatewayClassName: apisix
@@ -96,6 +98,7 @@ values={[
9698
apiVersion: v1
9799
kind: Service
98100
metadata:
101+
namespace: ingress-apisix
99102
name: httpbin-external-domain
100103
spec:
101104
type: ExternalName
@@ -104,6 +107,7 @@ spec:
104107
apiVersion: apisix.apache.org/v1alpha1
105108
kind: PluginConfig
106109
metadata:
110+
namespace: ingress-apisix
107111
name: limit-count-plugin-config
108112
spec:
109113
plugins:
@@ -116,6 +120,7 @@ spec:
116120
apiVersion: gateway.networking.k8s.io/v1
117121
kind: HTTPRoute
118122
metadata:
123+
namespace: ingress-apisix
119124
name: getting-started-ip
120125
spec:
121126
parentRefs:
@@ -144,6 +149,7 @@ spec:
144149
apiVersion: apisix.apache.org/v2
145150
kind: ApisixUpstream
146151
metadata:
152+
namespace: ingress-apisix
147153
name: httpbin-external-domain
148154
spec:
149155
externalNodes:
@@ -153,6 +159,7 @@ spec:
153159
apiVersion: apisix.apache.org/v2
154160
kind: ApisixRoute
155161
metadata:
162+
namespace: ingress-apisix
156163
name: getting-started-ip
157164
spec:
158165
ingressClassName: apisix

0 commit comments

Comments
 (0)