Skip to content

[Automated] Draft docs (agentgateway): xbackend: avoid collisions with AGWBackend keys - #1313

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-agentgateway-3891
Open

github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-agentgateway-3891

Conversation

@github-actions

@github-actions github-actions Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

agentgateway/agentgateway#3891 — xbackend: avoid collisions with AGWBackend keys

Docs versions: standalone/main, kubernetes/main

No 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.go
  • crates/agentgateway/src/proxy/httpproxy.rs

What 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.kind when 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.io with kind: XBackend. The standalone Attachment points page now explains when to set policies.target.backend.backend.kind and when to omit it.

Not verified: No cluster or local binary was used; the configuration is unrun.

How agentgateway-3891 was drafted, and what was not verified

Plan, and what changed it

  • Planned: Document the new typed backend key behavior in the Kubernetes and standalone trees named by the work list.
  • Learned: The dossier diff and target pages showed target-merge.md owns Kubernetes policy targets, attachment.md owns standalone policy attachment, and the dedicated XBackend guide is parked as an unbuilt .txt file.
  • Did: Updated those two pages and wrote a release-note entry.

Why a documentation change is necessary

The pull request changes XBackend keys from namespace/name to gateway.networking.x-k8s.io/XBackend/namespace/name and carries kind: XBackend through 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 new policies.target.backend.backend.kind field 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 required group and kind values.
  • content/docs/standalone/main/documentation/configuration/policies/attachment.md: Added guidance for policies.target.backend.backend.kind.

How to verify this change

  1. In a Kubernetes test cluster with XBackend support enabled, apply an XBackend and an {{< reuse "agw-docs/snippets/backend.md" >}} with the same namespace and name.
  2. Apply an {{< reuse "agw-docs/snippets/policy.md" >}} that targets the XBackend with group: gateway.networking.x-k8s.io and kind: XBackend.
  3. Confirm that the XBackend and {{< reuse "agw-docs/snippets/backend.md" >}} are both accepted, and that the policy attaches to the XBackend target rather than the same-named {{< reuse "agw-docs/snippets/backend.md" >}}.

What was not verified

The configuration was not applied to a cluster, so every command in this diff is unrun.
No agentgateway --validate-only run 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

  • Product: agentgateway (upstream) → agentgateway/website
  • Docs version: standalone/main, kubernetes/main
  • Summary (read from the body): Put xbackend in its own key space. keep AGWbackend in the old key for compat/size
  • Not tested: no cluster was available, so every command in this diff is unrun
  • No rule covers 2 touched file(s). The candidate pages below come from the files that DID match a rule, so they may scope this narrower than the change is. Read these before deciding the change is only about the pages listed:
    • controller/pkg/agentgateway/utils/utils.go
    • crates/agentgateway/src/proxy/httpproxy.rs

Release 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

…h AGWBackend keys

Signed-off-by: GitHub Action <action@github.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Deploying agentproxy with  Cloudflare Pages  Cloudflare Pages

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

View logs

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.

1 participant