Repository navigation
[Automated] Draft docs (agentgateway): Fail closed when a backend TLS policy can't be built - #1459
Open
github-actions[bot] wants to merge 3 commits into
Open
github-actions[bot] wants to merge 3 commits into
github-actions[bot] wants to merge 3 commits into
Conversation
… policy can't be built Drafts-Commit: 7e70138 Signed-off-by: GitHub Action <action@github.com>
Deploying agentproxy with
|
| Latest commit: |
4730feb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7ba42639.agentproxy.pages.dev |
| Branch Preview URL: | https://pr-tracker-draft-agentgatewa-crzi.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. |
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.
The target's own content scan fails where the base build passed (docs-theme-extras
markdown-leaks/built-html-integrity):agentgateway/agentgateway#4198 — Fail closed when a backend TLS policy can't be built
Docs versions:
standalone/main,kubernetes/mainNo 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: Invalid backend TLS policies now make requests fail with HTTP
503instead of allowing plaintext backend traffic. An invalid update to a previously accepted policy also fails closed, and the proxy records a warning that the backend TLS policy is invalid.What the docs now say: The standalone Backend TLS page and the Kubernetes BackendTLS guide now describe the fail-closed behavior, the warning text, and the cases that can trigger it, such as invalid certificates, hostname or SAN problems, and disallowed key exchange groups.
Not verified: No cluster; the configuration and commands are unrun.
How
agentgateway-4198was drafted, and what was not verifiedPlan, and what changed it
assets/agw-docs/pages/security/backendtls.mdis shared by older Kubernetes version trees, soreferences/version-gates.mdrequired a main-only gate; the section index and schema validation page did not own backend TLS runtime behavior.Why a documentation change is necessary
The pull request changes what a reader sees when a backend TLS policy cannot be built. Requests to the affected backend now fail with HTTP
503, and the proxy does not connect to the backend in plaintext. The Kubernetes backend TLS guide already told readers that invalid backend TLS configuration affects requests, and the standalone Backend TLS page shows where readers configurebackendTLS, but neither page said that invalid backend TLS settings fail closed or that a bad update to a previously working policy also fails closed.What changed on disk
assets/agw-docs/pages/security/backendtls.md— Added a main-only Kubernetes note that invalid backend TLS settings fail closed with HTTP503.content/docs/standalone/main/documentation/configuration/security/backend-tls.md— Added a section that documents invalid backend TLS policy behavior for standalone configuration.How to verify this change
200, then replace the CA bundle in thecaConfigMap with invalid PEM data and reapply the backend TLS policy.503, and the backend should not receive the request.policies.backendTLS.rootpointing to an invalid certificate file, then send a request to that backend. The response should be HTTP503, and the proxy should record a warning that starts withinvalid backend TLS policy, requests to the backend will fail:.What was not verified
How the pages were chosen (triage report)
Draft a documentation change
agentgateway/agentgateway#4198 — Fail closed when a backend TLS policy can't be built
agentgateway/websitecrates/agentgateway/src/proxy/httpproxy.rsRelease notes
This pull request also adds its release-note entries:
content/docs/kubernetes/main/release-notes/release-notes.md: Invalid backend TLS policies fail closed (breaking_change, in a new 1.8 section)content/docs/standalone/main/release-notes/release-notes.md: Invalid backend TLS policies fail closed (breaking_change, in a new 1.8 section)Check these release-note links and names. Each note is on its page, but a link may not reach the drafted content there, or a name may belong to the other mode:
content/docs/kubernetes/main/release-notes/release-notes.md: Fail closed when a backend TLS policy can't be built agentgateway#4198's note links to/documentation/configuration/security/backend-tls/, which has no page incontent/docs/kubernetes/maincontent/docs/standalone/main/release-notes/release-notes.md: Fail closed when a backend TLS policy can't be built agentgateway#4198's note links to/documentation/security/backendtls/, which has no page incontent/docs/standalone/mainDraft branch:
pr-tracker-draft-agentgateway-4198