feat(operator): Static name annotation#5655
Open
lmilan wants to merge 2 commits into
Open
Conversation
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
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_resourceslinks to connect static naming docs with adjacent Operator how-tos. - Adds an immutability warning stating that
KonnectGatewayControlPlanenames 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #5334
Preview Links
Checklist
descriptionentry in frontmatter.