Repository navigation
[Automated] Draft docs (agentgateway): retry: respect explicit attempts: 0 on AgentgatewayPolicy - #1445
Open
github-actions[bot] wants to merge 5 commits into
Open
[Automated] Draft docs (agentgateway): retry: respect explicit attempts: 0 on AgentgatewayPolicy#1445github-actions[bot] wants to merge 5 commits into
github-actions[bot] wants to merge 5 commits into
Conversation
…ts: 0 on AgentgatewayPolicy Drafts-Commit: f3c174a Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| 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 |
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>
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>
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#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.rsWhat changes for users: Retry policies can use
attempts: 0to 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: 0disables retries and that omitting the field uses the one-retry default. The Kubernetes Request retries guide now adds the sameretry.attemptsnote 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-4180was drafted, and what was not verifiedPlan, and what changed it
attempts: 0retry-disabling behavior to the retry documentation in both standalone and Kubernetes modes.Why a documentation change is necessary
The pull request body says that Gateway API v1.7 allows
attempts: 0and requires it to disable retries, while an AgentgatewayPolicy value of zero previously reached the data plane as if the field were unset. The diff makesRetry.attemptsoptional on the wire, keeps the unset default at one retry, and changes the standalone schema minimum to0. 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 gatedretry.attemptstable text that0disables retries for Kubernetes 1.7 and later.content/docs/standalone/latest/documentation/configuration/resiliency/retries.md: Adds comments to both retry examples that0disables 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
spec.traffic.retry.attempts: 0andcodes: [503]on a Gateway target.traffic.retry.attempts: 0.routes[].policies.retry.attempts: 0in a config file and runagentgateway --validate-only -f config.yaml. The configuration validates.Proposed release note
Wrote
proposed-release-note.mdbecause the change alters observable retry behavior.What was not verified
agentgateway --validate-only.Validation of the added standalone configuration
0 of 4 added config file(s) passed
--validate-only(latestwithcr.agentgateway.dev/agentgateway:latest,mainwithcr.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 informationcontent/docs/standalone/latest/documentation/configuration/resiliency/retries.md:39— Run 'docker run --help' for more informationcontent/docs/standalone/main/documentation/configuration/resiliency/retries.md:16— Run 'docker run --help' for more informationcontent/docs/standalone/main/documentation/configuration/resiliency/retries.md:39— Run 'docker run --help' for more informationHow the pages were chosen (triage report)
Draft a documentation change
agentgateway/agentgateway#4180 — retry: respect explicit attempts: 0 on AgentgatewayPolicy
agentgateway/websitecrates/agentgateway/src/proxy/httpproxy.rsRelease 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:
kubernetes/main,kubernetes/latest, because the draft edited no page there. If the change also reaches that tree, add the note there.Draft branch:
pr-tracker-draft-agentgateway-4180