From 4eba9983eead28af321096301012c93838552b85 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Mon, 22 Jun 2026 10:08:34 +0200 Subject: [PATCH 1/2] add notes --- ...perator-get-started-gateway-api-2-create-gateway.md | 10 +++++++++- .../operator-konnect-auth-cross-namespace-reference.md | 7 ++++++- .../operator/operator-konnect-static-naming.md | 9 +++++++++ 3 files changed, 24 insertions(+), 2 deletions(-) diff --git a/app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md b/app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md index 2f20a1a5f53..1aa93c36a97 100644 --- a/app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md +++ b/app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md @@ -42,6 +42,10 @@ prereqs: konnect: auth: true +related_resources: + - text: Enable static naming for Konnect control planes + url: /operator/konnect/how-to/static-naming/ + --- ## Create a `GatewayConfiguration` resource @@ -176,7 +180,11 @@ spec: ``` {% konnect %} -content: {{site.operator_product_name}} will automatically create the `DataPlane` and `KonnectGatewayControlPlane` resources. +content: | + {{site.operator_product_name}} will automatically create the `DataPlane` and `KonnectGatewayControlPlane` resources. + + {:.info} + > By default, the generated `KonnectGatewayControlPlane` receives a dynamic name. Add the `gateway-operator.konghq.com/static-naming: "true"` annotation to your `Gateway` to use a predictable name based on the Gateway's namespace and name. Names cannot be changed after creation. {% endkonnect %} {% on_prem %} diff --git a/app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md b/app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md index b32f31aaf17..9d6dcde0002 100644 --- a/app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md +++ b/app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md @@ -22,6 +22,8 @@ tldr: related_resources: - text: Reference Secrets across multiple namespaces url: /operator/konnect/how-to/secret-cross-namespace-reference/ + - text: Enable static naming for Konnect control planes + url: /operator/konnect/how-to/static-naming/ min_version: operator: '2.1' @@ -141,4 +143,7 @@ To validate, check that the `KonnectGatewayControlPlane` resource was automatica ```sh kubectl get konnectgatewaycontrolplane -n kong -``` \ No newline at end of file +``` + +{:.info} +> By default, the generated `KonnectGatewayControlPlane` receives a dynamic name. Add the `gateway-operator.konghq.com/static-naming: "true"` annotation to your `Gateway` to use a predictable name based on the Gateway's namespace and name. Names cannot be changed after creation. \ No newline at end of file diff --git a/app/_how-tos/operator/operator-konnect-static-naming.md b/app/_how-tos/operator/operator-konnect-static-naming.md index 6398102fe63..eef615adbfa 100644 --- a/app/_how-tos/operator/operator-konnect-static-naming.md +++ b/app/_how-tos/operator/operator-konnect-static-naming.md @@ -20,6 +20,12 @@ tldr: a: | Add the `gateway-operator.konghq.com/static-naming: "true"` annotation to your `Gateway` resource. +related_resources: + - text: Provision a Gateway + url: /operator/get-started/gateway-api/deploy-gateway/ + - text: Reference Konnect authentication across multiple namespaces + url: /operator/konnect/how-to/auth-cross-namespace-reference/ + min_version: operator: '2.1' @@ -33,6 +39,9 @@ By default, {{ site.operator_product_name }} generates unique, dynamic names for The `gateway-operator.konghq.com/static-naming: "true"` annotation instructs {{site.operator_product_name}} to use a static, predictable name for the generated control plane based on the Gateway's namespace and name (for example, `default-hybrid`). This enables you to configure references before the control plane is created. +{:.warning} +> Once a `KonnectGatewayControlPlane` name is created, it cannot be modified. Plan your naming carefully before enabling this annotation. + When static naming is enabled, {{site.operator_product_name}} derives the name for the `KonnectGatewayControlPlane` using the following logic: * If the Gateway is in the same namespace as {{site.operator_product_name}}, the name will be the same as the Gateway name. From 6fed8e7ce6a72973be06084365603ac68df25251 Mon Sep 17 00:00:00 2001 From: Lucie Milan Date: Mon, 22 Jun 2026 10:10:10 +0200 Subject: [PATCH 2/2] edit --- .../operator-get-started-gateway-api-2-create-gateway.md | 2 +- .../operator/operator-konnect-auth-cross-namespace-reference.md | 2 +- app/_how-tos/operator/operator-konnect-static-naming.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md b/app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md index 1aa93c36a97..4b0d8f8d88a 100644 --- a/app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md +++ b/app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md @@ -184,7 +184,7 @@ content: | {{site.operator_product_name}} will automatically create the `DataPlane` and `KonnectGatewayControlPlane` resources. {:.info} - > By default, the generated `KonnectGatewayControlPlane` receives a dynamic name. Add the `gateway-operator.konghq.com/static-naming: "true"` annotation to your `Gateway` to use a predictable name based on the Gateway's namespace and name. Names cannot be changed after creation. + > By default, the generated `KonnectGatewayControlPlane` receives a dynamic name. Add the `gateway-operator.konghq.com/static-naming: "true"` annotation to your `Gateway` to use a predictable name based on the Gateway's namespace and name. Names can't be changed after creation. {% endkonnect %} {% on_prem %} diff --git a/app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md b/app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md index 9d6dcde0002..88b6cb76fb6 100644 --- a/app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md +++ b/app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md @@ -146,4 +146,4 @@ kubectl get konnectgatewaycontrolplane -n kong ``` {:.info} -> By default, the generated `KonnectGatewayControlPlane` receives a dynamic name. Add the `gateway-operator.konghq.com/static-naming: "true"` annotation to your `Gateway` to use a predictable name based on the Gateway's namespace and name. Names cannot be changed after creation. \ No newline at end of file +> By default, the generated `KonnectGatewayControlPlane` receives a dynamic name. Add the `gateway-operator.konghq.com/static-naming: "true"` annotation to your `Gateway` to use a predictable name based on the Gateway's namespace and name. Names can't be changed after creation. \ No newline at end of file diff --git a/app/_how-tos/operator/operator-konnect-static-naming.md b/app/_how-tos/operator/operator-konnect-static-naming.md index eef615adbfa..de7f50d4f9e 100644 --- a/app/_how-tos/operator/operator-konnect-static-naming.md +++ b/app/_how-tos/operator/operator-konnect-static-naming.md @@ -40,7 +40,7 @@ By default, {{ site.operator_product_name }} generates unique, dynamic names for The `gateway-operator.konghq.com/static-naming: "true"` annotation instructs {{site.operator_product_name}} to use a static, predictable name for the generated control plane based on the Gateway's namespace and name (for example, `default-hybrid`). This enables you to configure references before the control plane is created. {:.warning} -> Once a `KonnectGatewayControlPlane` name is created, it cannot be modified. Plan your naming carefully before enabling this annotation. +> Once a `KonnectGatewayControlPlane` name is created, it can't be modified. Plan your naming carefully before enabling this annotation. When static naming is enabled, {{site.operator_product_name}} derives the name for the `KonnectGatewayControlPlane` using the following logic: