Skip to content

[Automated] Draft docs (agentgateway): retry: respect explicit attempts: 0 on AgentgatewayPolicy - #1445

Open
github-actions[bot] wants to merge 5 commits into
mainfrom
pr-tracker-draft-agentgateway-4180
Open

github-actions[bot] wants to merge 5 commits into
mainfrom
pr-tracker-draft-agentgateway-4180

Conversation

@github-actions

@github-actions github-actions Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

agentgateway/agentgateway#4180 — retry: respect explicit attempts: 0 on AgentgatewayPolicy

Docs versions: standalone/main, standalone/latest, kubernetes/main, kubernetes/latest (first shipped in v1.7.0)

No code-path rule covers 1 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:

  • crates/agentgateway/src/proxy/httpproxy.rs

What changes for users: Retry policies can use attempts: 0 to disable retries. On AgentgatewayPolicy, explicit zero is now distinct from an omitted value; omitted attempts still default to one retry.

What the docs now say: The standalone Retries pages now say that attempts: 0 disables retries and that omitting the field uses the one-retry default. The Kubernetes Request retries guide now adds the same retry.attempts note to the HTTPRoute, HTTPRoute rule, and Gateway listener field tables for 1.7 and later.

Not verified: No cluster or local agentgateway run; the configuration is unrun, and internal links are unchecked.

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

Plan, and what changed it

  • Planned: Add the attempts: 0 retry-disabling behavior to the retry documentation in both standalone and Kubernetes modes.
  • Learned: The dossier diff and target pages put the behavior on the existing retry pages; the neighbor dossiers did not carry this retry-attempt behavior.
  • Did: Updated the standalone retry examples and the shared Kubernetes retry field tables, and wrote a proposed release note.

Why a documentation change is necessary

The pull request body says that Gateway API v1.7 allows attempts: 0 and requires it to disable retries, while an AgentgatewayPolicy value of zero previously reached the data plane as if the field were unset. The diff makes Retry.attempts optional on the wire, keeps the unset default at one retry, and changes the standalone schema minimum to 0. The target retry pages described positive retry counts but did not tell readers how to disable retries by setting the attempts field to zero.

What changed on disk

  • assets/agw-docs/pages/resiliency/retry/retry.md: Adds gated retry.attempts table text that 0 disables retries for Kubernetes 1.7 and later.
  • content/docs/standalone/latest/documentation/configuration/resiliency/retries.md: Adds comments to both retry examples that 0 disables retries and omitting the field uses the default of one retry.
  • content/docs/standalone/main/documentation/configuration/resiliency/retries.md: Adds the same standalone retry comments for the main tree.

How to verify this change

  1. In a Kubernetes 1.7 or later environment, apply an AgentgatewayPolicy with spec.traffic.retry.attempts: 0 and codes: [503] on a Gateway target.
  2. Port-forward the proxy admin port and query the config dump. The generated policy shows traffic.retry.attempts: 0.
  3. For standalone mode, set routes[].policies.retry.attempts: 0 in a config file and run agentgateway --validate-only -f config.yaml. The configuration validates.

Proposed release note

Wrote proposed-release-note.md because the change alters observable retry behavior.

What was not verified

  • The configuration was not applied to a cluster.
  • The standalone configuration was not run with agentgateway --validate-only.
  • Internal links are unchecked because Hugo was not run.

Validation of the added standalone configuration

0 of 4 added config file(s) passed --validate-only (latest with cr.agentgateway.dev/agentgateway:latest, main with cr.agentgateway.dev/agentgateway:latest-dev).
Validation checks field names and types only. Commands, runtime behavior, and field paths written in prose are unverified.

Rejected:

  • content/docs/standalone/latest/documentation/configuration/resiliency/retries.md:16 — Run 'docker run --help' for more information
  • content/docs/standalone/latest/documentation/configuration/resiliency/retries.md:39 — Run 'docker run --help' for more information
  • content/docs/standalone/main/documentation/configuration/resiliency/retries.md:16 — Run 'docker run --help' for more information
  • content/docs/standalone/main/documentation/configuration/resiliency/retries.md:39 — Run 'docker run --help' for more information
How the pages were chosen (triage report)

Draft a documentation change

agentgateway/agentgateway#4180 — retry: respect explicit attempts: 0 on AgentgatewayPolicy

  • Product: agentgateway (upstream) → agentgateway/website
  • Docs version: standalone/main, standalone/latest, kubernetes/main, kubernetes/latest
  • Summary (read from the body): Gateway API v1.7 allows retry attempts: 0 and requires it to disable retries. HTTPRoute already handled this by omitting the policy, but on AgentgatewayPolicy the zero was indistinguishable from unset on the wire and the data plane defaulted it to 1 retry.
  • Not tested: no cluster was available, so every command in this diff is unrun
  • No rule covers 1 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:
    • crates/agentgateway/src/proxy/httpproxy.rs

Release notes

This pull request also adds its release-note entries:

  • content/docs/standalone/latest/release-notes/release-notes.md: retry: respect explicit attempts: 0 on AgentgatewayPolicy (fix, under Traffic management)
  • content/docs/standalone/main/release-notes/release-notes.md: retry: respect explicit attempts: 0 on AgentgatewayPolicy (fix, under Traffic management)

Release notes kept out of a tree. Check that each change really does not reach the trees named here:

Draft branch: pr-tracker-draft-agentgateway-4180

…ts: 0 on AgentgatewayPolicy

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

cloudflare-workers-and-pages Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Deploying agentproxy with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4815434
Status: ✅  Deploy successful!
Preview URL: https://8e605eb2.agentproxy.pages.dev
Branch Preview URL: https://pr-tracker-draft-agentgatewa-dtzd.agentproxy.pages.dev

View logs

The release-notes entry for this change now lives in the combined
release-notes PR, #1482, so the draft PRs no longer conflict on
the release-notes pages.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
@kristin-kronstain-brown

Copy link
Copy Markdown
Collaborator

Moved this PR's release-notes entry to the combined release-notes PR, #1482, so the draft PRs stop conflicting on the release-notes pages. Review or change the entry there.

…tgateway-4180

Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Kristin Brown <kristin.brown@solo.io>
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.

2 participants