Skip to content

feat(operator): Static name annotation#5655

Open
lmilan wants to merge 2 commits into
mainfrom
feat/operator-static-name
Open

feat(operator): Static name annotation#5655
lmilan wants to merge 2 commits into
mainfrom
feat/operator-static-name

Conversation

@lmilan

@lmilan lmilan commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes #5334

Preview Links

Checklist

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

@lmilan lmilan self-assigned this Jun 22, 2026
@lmilan lmilan requested a review from a team as a code owner June 22, 2026 08:11
Copilot AI review requested due to automatic review settings June 22, 2026 08:11
@netlify

netlify Bot commented Jun 22, 2026

Copy link
Copy Markdown

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 6fed8e7
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6a38ee1a6c684200082e6452
😎 Deploy Preview https://deploy-preview-5655--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates Kong Operator how-to documentation to describe and cross-link the “static naming” annotation for Konnect control planes, including an immutability warning and related-resource navigation.

Changes:

  • Adds related_resources links to connect static naming docs with adjacent Operator how-tos.
  • Adds an immutability warning stating that KonnectGatewayControlPlane names can’t be changed after creation.
  • Adds “static naming” informational callouts to relevant Operator how-tos.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
app/_how-tos/operator/operator-konnect-static-naming.md Adds related resources and an immutability warning, but the naming behavior description needs correction.
app/_how-tos/operator/operator-konnect-auth-cross-namespace-reference.md Adds a related-resource link and an informational callout about static naming (wording needs correction).
app/_how-tos/operator/operator-get-started-gateway-api-2-create-gateway.md Adds a related-resource link and an informational callout about static naming (wording needs correction).
Comments suppressed due to low confidence (1)

app/_how-tos/operator/operator-konnect-static-naming.md:48

  • The static naming description here doesn’t match kong-operator behavior: with the static naming annotation enabled, generated objects use the Gateway name (not a namespace-prefixed name), so the current “namespace and name” explanation (and example default-hybrid) is misleading.
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 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:

* If the Gateway is in the same namespace as {{site.operator_product_name}}, the name will be the same as the Gateway name.
* If the Gateway is in a different namespace, the name will be the Gateway name prefixed with the namespace.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document static naming annotation

2 participants