This is an automated email from the ASF dual-hosted git repository.
traky pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new ebaed224 docs: specify namespace in metadata explicitly (#2549)
ebaed224 is described below
commit ebaed2241210bbfdc88bdb878e8239167de98c71
Author: Traky Deng <trakyd...@gmail.com>
AuthorDate: Wed Sep 10 14:29:59 2025 +0800
docs: specify namespace in metadata explicitly (#2549)
---
docs/en/latest/concepts/gateway-api.md | 4 +-
docs/en/latest/configure.md | 1 +
docs/en/latest/getting-started/configure-routes.md | 5 +++
.../latest/getting-started/key-authentication.md | 9 +++++
docs/en/latest/getting-started/load-balancing.md | 9 +++++
docs/en/latest/getting-started/rate-limiting.md | 7 ++++
docs/en/latest/reference/example.md | 47 ++++++++++++++++++++--
docs/en/latest/upgrade-guide.md | 3 +-
8 files changed, 80 insertions(+), 5 deletions(-)
diff --git a/docs/en/latest/concepts/gateway-api.md
b/docs/en/latest/concepts/gateway-api.md
index 44f5376f..7954537a 100644
--- a/docs/en/latest/concepts/gateway-api.md
+++ b/docs/en/latest/concepts/gateway-api.md
@@ -63,6 +63,7 @@ The following example demonstrates how to configure an
HTTPRoute resource to rou
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controllerName: "apisix.apache.org/apisix-ingress-controller"
@@ -72,8 +73,8 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
+ namespace: ingress-apisix
name: apisix
- namespace: default
spec:
gatewayClassName: apisix
listeners:
@@ -86,6 +87,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
parentRefs:
diff --git a/docs/en/latest/configure.md b/docs/en/latest/configure.md
index c4a104e9..eefc0251 100644
--- a/docs/en/latest/configure.md
+++ b/docs/en/latest/configure.md
@@ -50,6 +50,7 @@ The `controller_name` field is used to identify the
`controllerName` in the Gate
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controllerName: "apisix.apache.org/apisix-ingress-controller"
diff --git a/docs/en/latest/getting-started/configure-routes.md
b/docs/en/latest/getting-started/configure-routes.md
index e248e981..c90be316 100644
--- a/docs/en/latest/getting-started/configure-routes.md
+++ b/docs/en/latest/getting-started/configure-routes.md
@@ -63,6 +63,7 @@ If you are using Gateway API, you should first configure the
GatewayClass and Ga
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controllerName: apisix.apache.org/apisix-ingress-controller
@@ -70,6 +71,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
gatewayClassName: apisix
@@ -107,6 +109,7 @@ values={[
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: getting-started-ip
spec:
parentRefs:
@@ -129,6 +132,7 @@ spec:
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
+ namespace: ingress-apisix
name: getting-started-ip
spec:
ingressClassName: apisix
@@ -152,6 +156,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: getting-started-ip
spec:
ingressClassName: apisix
diff --git a/docs/en/latest/getting-started/key-authentication.md
b/docs/en/latest/getting-started/key-authentication.md
index 0c7e38e8..54f8c54e 100644
--- a/docs/en/latest/getting-started/key-authentication.md
+++ b/docs/en/latest/getting-started/key-authentication.md
@@ -53,6 +53,7 @@ If you are using Gateway API, you should first configure the
GatewayClass and Ga
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controllerName: apisix.apache.org/apisix-ingress-controller
@@ -60,6 +61,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
gatewayClassName: apisix
@@ -96,6 +98,7 @@ Create a Kubernetes manifest file to configure a consumer:
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
+ namespace: ingress-apisix
name: tom
spec:
gatewayRef:
@@ -113,6 +116,7 @@ Create a Kubernetes manifest file to configure a route and
enable key authentica
apiVersion: v1
kind: Service
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
type: ExternalName
@@ -121,6 +125,7 @@ spec:
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
+ namespace: ingress-apisix
name: auth-plugin-config
spec:
plugins:
@@ -132,6 +137,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: getting-started-ip
spec:
parentRefs:
@@ -168,6 +174,7 @@ Create a Kubernetes manifest file to configure a consumer:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
+ namespace: ingress-apisix
name: tom
spec:
ingressClassName: apisix
@@ -183,6 +190,7 @@ Create a Kubernetes manifest file to configure a route and
enable key authentica
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
externalNodes:
@@ -192,6 +200,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: getting-started-ip
spec:
ingressClassName: apisix
diff --git a/docs/en/latest/getting-started/load-balancing.md
b/docs/en/latest/getting-started/load-balancing.md
index 8eb6b81c..5a430411 100644
--- a/docs/en/latest/getting-started/load-balancing.md
+++ b/docs/en/latest/getting-started/load-balancing.md
@@ -53,6 +53,7 @@ If you are using Gateway API, you should first configure the
GatewayClass and Ga
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controllerName: apisix.apache.org/apisix-ingress-controller
@@ -60,6 +61,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
gatewayClassName: apisix
@@ -96,6 +98,7 @@ values={[
apiVersion: v1
kind: Service
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
type: ExternalName
@@ -104,6 +107,7 @@ spec:
apiVersion: v1
kind: Service
metadata:
+ namespace: ingress-apisix
name: mockapi7-external-domain
spec:
type: ExternalName
@@ -112,6 +116,7 @@ spec:
apiVersion: apisix.apache.org/v1alpha1
kind: BackendTrafficPolicy
metadata:
+ namespace: ingress-apisix
name: passhost-node
spec:
targetRefs:
@@ -127,6 +132,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: lb-route
spec:
parentRefs:
@@ -153,6 +159,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
scheme: https
@@ -166,6 +173,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
+ namespace: ingress-apisix
name: mockapi7-external-domain
spec:
scheme: https
@@ -179,6 +187,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: lb-route
spec:
ingressClassName: apisix
diff --git a/docs/en/latest/getting-started/rate-limiting.md
b/docs/en/latest/getting-started/rate-limiting.md
index 82a5f272..ca852b23 100644
--- a/docs/en/latest/getting-started/rate-limiting.md
+++ b/docs/en/latest/getting-started/rate-limiting.md
@@ -53,6 +53,7 @@ If you are using Gateway API, you should first configure the
GatewayClass and Ga
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controllerName: apisix.apache.org/apisix-ingress-controller
@@ -60,6 +61,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
gatewayClassName: apisix
@@ -96,6 +98,7 @@ values={[
apiVersion: v1
kind: Service
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
type: ExternalName
@@ -104,6 +107,7 @@ spec:
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
+ namespace: ingress-apisix
name: limit-count-plugin-config
spec:
plugins:
@@ -116,6 +120,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: getting-started-ip
spec:
parentRefs:
@@ -144,6 +149,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
externalNodes:
@@ -153,6 +159,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: getting-started-ip
spec:
ingressClassName: apisix
diff --git a/docs/en/latest/reference/example.md
b/docs/en/latest/reference/example.md
index 0d326f6c..746a5d7d 100644
--- a/docs/en/latest/reference/example.md
+++ b/docs/en/latest/reference/example.md
@@ -19,8 +19,9 @@ To update the Control Plane endpoint and admin key for
connectivity between APIS
apiVersion: apisix.apache.org/v1alpha1
kind: GatewayProxy
metadata:
+ namespace: ingress-apisix
name: apisix-config
- namespace: apisix-ingress
+ namespace: ingress-apisix
spec:
provider:
type: ControlPlane
@@ -52,6 +53,7 @@ values={[
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controllerName: "apisix.apache.org/apisix-ingress-controller"
@@ -59,6 +61,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
gatewayClassName: apisix
@@ -81,6 +84,7 @@ spec:
apiVersion: networking.k8s.io/v1
kind: IngressClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controller: apisix.apache.org/apisix-ingress-controller
@@ -88,7 +92,7 @@ spec:
apiGroup: apisix.apache.org
kind: GatewayProxy
name: apisix-config
- namespace: apisix-ingress
+ namespace: ingress-apisix
scope: Namespace
```
@@ -100,6 +104,7 @@ spec:
apiVersion: networking.k8s.io/v1
kind: IngressClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controller: apisix.apache.org/apisix-ingress-controller
@@ -107,7 +112,7 @@ spec:
apiGroup: apisix.apache.org
kind: GatewayProxy
name: apisix-config
- namespace: apisix-ingress
+ namespace: ingress-apisix
scope: Namespace
```
@@ -134,6 +139,7 @@ values={[
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
parentRefs:
@@ -156,6 +162,7 @@ spec:
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
ingressClassName: apisix
@@ -179,6 +186,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
ingressClassName: apisix
@@ -215,6 +223,7 @@ values={[
apiVersion: v1
kind: Service
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
type: ExternalName
@@ -223,6 +232,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: get-ip
spec:
parentRefs:
@@ -245,6 +255,7 @@ spec:
apiVersion: v1
kind: Service
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
type: ExternalName
@@ -253,6 +264,7 @@ spec:
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
+ namespace: ingress-apisix
name: get-ip
spec:
rules:
@@ -275,6 +287,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
+ namespace: ingress-apisix
name: httpbin-external-domain
spec:
externalNodes:
@@ -284,6 +297,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: get-ip
spec:
ingressClassName: apisix
@@ -318,6 +332,7 @@ values={[
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
parentRefs:
@@ -344,6 +359,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
ingressClassName: apisix
@@ -385,6 +401,7 @@ values={[
apiVersion: apisix.apache.org/v1alpha1
kind: BackendTrafficPolicy
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
targetRefs:
@@ -411,6 +428,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
ingressClassName: apisix
@@ -448,6 +466,7 @@ To create a consumer and configure the authentication
credentials directly on th
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
+ namespace: ingress-apisix
name: alice
spec:
gatewayRef:
@@ -465,6 +484,7 @@ You can also use the secret CRD, where the credential
should be base64 encoded:
apiVersion: v1
kind: Secret
metadata:
+ namespace: ingress-apisix
name: key-auth-primary
data:
key: YWxpY2UtcHJpbWFyeS1rZXk=
@@ -472,6 +492,7 @@ data:
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
+ namespace: ingress-apisix
name: alice
spec:
gatewayRef:
@@ -493,6 +514,7 @@ To create a consumer and configure the authentication
credentials directly on th
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
+ namespace: ingress-apisix
name: alice
spec:
ingressClassName: apisix
@@ -508,6 +530,7 @@ You can also use the secret CRD, where the credential
should be base64 encoded:
apiVersion: v1
kind: Secret
metadata:
+ namespace: ingress-apisix
name: key-auth-primary
data:
key: YWxpY2UtcHJpbWFyeS1rZXk=
@@ -515,6 +538,7 @@ data:
apiVersion: apisix.apache.org/v2
kind: ApisixConsumer
metadata:
+ namespace: ingress-apisix
name: alice
spec:
ingressClassName: apisix
@@ -546,6 +570,7 @@ values={[
apiVersion: apisix.apache.org/v1alpha1
kind: Consumer
metadata:
+ namespace: ingress-apisix
name: alice
spec:
gatewayRef:
@@ -597,6 +622,7 @@ values={[
apiVersion: apisix.apache.org/v1alpha1
kind: HTTPRoutePolicy
metadata:
+ namespace: ingress-apisix
name: http-route-policy
spec:
targetRefs:
@@ -621,6 +647,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
ingressClassName: apisix
@@ -667,6 +694,7 @@ values={[
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
+ namespace: ingress-apisix
name: auth-plugin-config
spec:
plugins:
@@ -678,6 +706,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: get-ip
spec:
parentRefs:
@@ -708,6 +737,7 @@ To enable `basic-auth`, `key-auth`, `wolf-rbac`,
`jwt-auth`, `ldap-auth`, or `hm
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: get-ip
spec:
ingressClassName: apisix
@@ -730,6 +760,7 @@ To enable other plugins:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: get-ip
spec:
ingressClassName: apisix
@@ -772,6 +803,7 @@ values={[
apiVersion: apisix.apache.org/v1alpha1
kind: GatewayProxy
metadata:
+ namespace: ingress-apisix
name: apisix-config
spec:
plugins:
@@ -792,6 +824,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixGlobalRule
metadata:
+ namespace: ingress-apisix
name: apisix-global-rule-logging
spec:
ingressClassName: apisix
@@ -828,6 +861,7 @@ values={[
apiVersion: apisix.apache.org/v1alpha1
kind: GatewayProxy
metadata:
+ namespace: ingress-apisix
name: apisix-config
spec:
pluginMetadata:
@@ -882,6 +916,7 @@ values={[
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
+ namespace: ingress-apisix
name: example-plugin-config
spec:
plugins:
@@ -895,6 +930,7 @@ spec:
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
parentRefs:
@@ -923,6 +959,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixPluginConfig
metadata:
+ namespace: ingress-apisix
name: example-plugin-config
spec:
ingressClassName: apisix
@@ -937,6 +974,7 @@ spec:
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
+ namespace: ingress-apisix
name: httpbin
spec:
ingressClassName: apisix
@@ -976,6 +1014,7 @@ To configure the `statusAddress`:
apiVersion: apisix.apache.org/v1alpha1
kind: GatewayProxy
metadata:
+ namespace: ingress-apisix
name: apisix-config
spec:
statusAddress:
@@ -994,6 +1033,7 @@ To configure the `statusAddress`:
apiVersion: apisix.apache.org/v1alpha1
kind: GatewayProxy
metadata:
+ namespace: ingress-apisix
name: apisix-config
spec:
statusAddress:
@@ -1006,6 +1046,7 @@ To configure the `publishService`:
apiVersion: apisix.apache.org/v1alpha1
kind: GatewayProxy
metadata:
+ namespace: ingress-apisix
name: apisix-config
spec:
publishService: apisix-ee-3-gateway-gateway
diff --git a/docs/en/latest/upgrade-guide.md b/docs/en/latest/upgrade-guide.md
index e892e789..eac2ebf6 100644
--- a/docs/en/latest/upgrade-guide.md
+++ b/docs/en/latest/upgrade-guide.md
@@ -108,6 +108,7 @@ From version 2.0.0, the data plane must be connected via
the `GatewayProxy` CRD:
apiVersion: networking.k8s.io/v1
kind: IngressClass
metadata:
+ namespace: ingress-apisix
name: apisix
spec:
controller: "apisix.apache.org/apisix-ingress-controller"
@@ -121,8 +122,8 @@ spec:
apiVersion: apisix.apache.org/v1alpha1
kind: GatewayProxy
metadata:
+ namespace: ingress-apisix
name: apisix-proxy-config
- namespace: default
spec:
provider:
type: ControlPlane
