Repository navigation
[Automated] Draft docs (agentgateway): xbackend: avoid collisions with AGWBackend keys - #1313
Open
github-actions[bot] wants to merge 1 commit into
Open
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…h AGWBackend keys Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| Latest commit: |
6f95ed3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://07b75c21.agentproxy.pages.dev |
| Branch Preview URL: | https://pr-tracker-draft-agentgatewa-mnvl.agentproxy.pages.dev |
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.
agentgateway/agentgateway#3891 — xbackend: avoid collisions with AGWBackend keys
Docs versions:
standalone/main,kubernetes/mainNo code-path rule covers 2 touched file(s). The planner could route these only by identifier search, so the candidate pages may miss what they changed, including in the other mode:
controller/pkg/agentgateway/utils/utils.gocrates/agentgateway/src/proxy/httpproxy.rsWhat changes for users: XBackend resources now use a typed backend key, so an XBackend and an agentgateway backend resource with the same namespace and name resolve as separate backends. Standalone global backend-policy targets can use
policies.target.backend.backend.kindwhen a typed backend target needs that distinction.What the docs now say: The Kubernetes Targeting and merging page now lists XBackend as a valid backend-policy target and says to set
group: gateway.networking.x-k8s.iowithkind: XBackend. The standalone Attachment points page now explains when to setpolicies.target.backend.backend.kindand when to omit it.Not verified: No cluster or local binary was used; the configuration is unrun.
How
agentgateway-3891was drafted, and what was not verifiedPlan, and what changed it
target-merge.mdowns Kubernetes policy targets,attachment.mdowns standalone policy attachment, and the dedicated XBackend guide is parked as an unbuilt.txtfile.Why a documentation change is necessary
The pull request changes XBackend keys from
namespace/nametogateway.networking.x-k8s.io/XBackend/namespace/nameand carrieskind: XBackendthrough policy targets. The Kubernetes policy page did not list XBackend as a valid backend-policy target, and the standalone policy page did not explain the newpolicies.target.backend.backend.kindfield that the generated configuration reference now exposes. Without those updates, a reader cannot tell how to target the XBackend when another backend type has the same namespace and name.What changed on disk
content/docs/kubernetes/main/documentation/about/policies/target-merge.md: Added XBackend to backend-policy targets and documented the requiredgroupandkindvalues.content/docs/standalone/main/documentation/configuration/policies/attachment.md: Added guidance forpolicies.target.backend.backend.kind.How to verify this change
group: gateway.networking.x-k8s.ioandkind: XBackend.What was not verified
The configuration was not applied to a cluster, so every command in this diff is unrun.
No
agentgateway --validate-onlyrun was performed for the standalone field.How the pages were chosen (triage report)
New configuration: no page mentions it yet
agentgateway/agentgateway#3891 — xbackend: avoid collisions with AGWBackend keys
agentgateway/websitecontroller/pkg/agentgateway/utils/utils.gocrates/agentgateway/src/proxy/httpproxy.rsRelease notes
This pull request also adds its release-note entries:
content/docs/kubernetes/main/release-notes/release-notes.md: xbackend: avoid collisions with AGWBackend keys (fix, under Traffic management)content/docs/standalone/main/release-notes/release-notes.md: xbackend: avoid collisions with AGWBackend keys (fix, under Traffic management)Draft branch:
pr-tracker-draft-agentgateway-3891