Repository navigation
[Automated] Draft docs (agentgateway): filters: better error handling - #1385
Open
github-actions[bot] wants to merge 4 commits into
Open
github-actions[bot] wants to merge 4 commits into
github-actions[bot] wants to merge 4 commits into
Conversation
Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| Latest commit: |
150edd1
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3b265863.agentproxy.pages.dev |
| Branch Preview URL: | https://pr-tracker-draft-agentgatewa-43lu.agentproxy.pages.dev |
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
- path.full and path.prefix must start with '/'. An empty value fails at load with 'empty string' (PathAndQuery parse in de_redirect_path), verified with --validate-only on b75bb313. - Reword the other sentences to say what agentgateway rejects. - release-notes.md belongs to #1351. Restore it to main. Signed-off-by: Art Berger <art.berger@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#4097 — filters: better error handling
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:
crates/agentgateway/src/http/filters.rscrates/core/src/serdes.rsWhat changes for users: Standalone configuration validation now rejects several invalid filter configurations before startup: invalid header modifier names or values, direct response policies that set both
bodyandbodyExpression, request mirror percentages outside0.0to1.0, and invalid redirect or rewrite paths.What the docs now say: The standalone Header manipulation, Direct Response, Mirroring, Redirects, and Rewrites pages now state the validation rules beside the fields that readers configure.
Not verified: No cluster and no local agentgateway binary were available in this sandbox; the configuration is unrun.
How
agentgateway-4097was drafted, and what was not verifiedPlan, and what changed it
Why a documentation change is necessary
The pull request moves several filter errors from request time to standalone configuration validation. The existing policy pages showed the affected fields without the constraints that now make a configuration fail before startup. Readers who copy those examples and adjust the fields need the rejection conditions on the same pages.
What changed on disk
content/docs/standalone/main/documentation/configuration/traffic-management/manipulation.md— Notes that standalone validation rejects invalid HTTP header names or values in header modifiers.content/docs/standalone/main/documentation/configuration/traffic-management/direct-response.md— Notes thatbodyandbodyExpressionare mutually exclusive.content/docs/standalone/main/documentation/configuration/resiliency/mirroring.md— Documents the validrequestMirror.percentagerange.content/docs/standalone/main/documentation/configuration/traffic-management/redirects.md— Documents redirect path validation and thepath.prefixroute-match requirement.content/docs/standalone/main/documentation/configuration/traffic-management/rewrites.md— Documents rewrite path validation and thepath.prefixroute-match requirement.How to verify this change
requestMirror.percentage: 1.2and runagentgateway -f config.yaml --validate-only. The command should fail withrequestMirror percentage must be between 0.0 and 1.0, got 1.2.bodyandbodyExpression, then runagentgateway -f config.yaml --validate-only. The command should fail withdirectResponse body and bodyExpression may not both be set.path.prefixon a route whose match is notpathPrefix, then runagentgateway -f config.yaml --validate-only. The command should fail withpath prefix rewrite requires every match to be a path prefix match.What was not verified
The configuration was not applied to a cluster, and standalone validation was not run with an agentgateway binary. Every command in this diff is unrun.
How the pages were chosen (triage report)
Draft a documentation change
agentgateway/agentgateway#4097 — filters: better error handling
agentgateway/websitecrates/agentgateway/src/http/filters.rscrates/core/src/serdes.rsA declared version this draft does not reach
This pull request is planned for more than one documentation version,
and nothing in the diff publishes to:
kubernetes/mainA file under
assets/reaches a version tree only where a page in thattree reuses it, so editing a shared asset does not by itself cover every
mode a product ships. Either that version still needs writing, or the
change genuinely does not apply there and the reason belongs in this body.
Release notes
This pull request also adds its release-note entries:
content/docs/standalone/main/release-notes/release-notes.md: filters: better error handling (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, because its note'sversions:line. If the change also reaches that tree, add the note there.Draft branch:
pr-tracker-draft-agentgateway-4097Important
The test suite has not run on this pull request. It was opened by
github-actions[bot], and GitHub does not start workflows for pull requests opened with the repository's own token. Doc tests, link checking and the static checks are held asaction_requireduntil somebody presses Approve and run on the Checks tab. Cloudflare Pages and DCO are GitHub Apps rather than Actions, so those two do run on their own.Please approve the checks before reviewing the content: an absence of failures here means the tests have not run, not that they passed.