Repository navigation
[Automated] Draft docs (agentgateway): Allow sending callout requests through CONNECT tunnel - #1288
Closed
github-actions[bot] wants to merge 2 commits into
Closed
github-actions[bot] wants to merge 2 commits into
github-actions[bot] wants to merge 2 commits into
Conversation
… through CONNECT tunnel Signed-off-by: GitHub Action <action@github.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Kristin Brown <kristin.brown@solo.io>
Collaborator
|
Closing as a duplicate of #1286, which documents the same change (agentgateway/agentgateway#3864) and was opened before this draft was turned into a pull request. |
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.
Warning
1 reference(s) this draft adds appear in neither the code change (agentgateway/agentgateway#3864) nor these docs. Readers run what these pages say, so check each one before merging. A host marked no has never appeared in either.
http://user:pass@proxy.example.com:3128agentgateway/agentgateway#3864 — Allow sending callout requests through CONNECT tunnel
Docs versions:
standalone/mainWhat changes for users: Operators can set
config.callouts.tunnel.urland optionalconfig.callouts.tunnel.noProxy, or use standard proxy environment variables, to send gateway-originated callouts through an HTTP proxy. The setting applies to callout APIs such as JWKS, OIDC discovery, external authorization, and cloud credential fetches, but not primary backends, XDS/CA, or GCP auth through config.What the docs now say: The new Callout proxy page explains the difference from the egress proxy, shows the
config.callouts.tunnelfields, states which callouts use the proxy, and calls out the environment-variable fallback.Not verified: The standalone configuration and runtime proxy path were not run.
How
agentgateway-3864was drafted, and what was not verifiedPlan, and what changed it
config.callouts.tunnel.create-in.mdauthorized onlycontent/docs/standalone/main/documentation/configuration, andbody.mdlimited the feature to callout APIs.callout-proxy.mdin that directory and wrote a proposed feature release note.Why a documentation change is necessary
The pull request adds the new
config.calloutsblock and reference rows forconfig.callouts.tunnel.urlandconfig.callouts.tunnel.noProxy, but no prose page mentioned the fields. The body says users can configure CONNECT settings for callouts withconfig.callouts.tunnelor standard environment variables. Without a page, standalone users can find the generated schema row but cannot see which outbound calls use the proxy or which calls are excluded.What changed on disk
content/docs/standalone/main/documentation/configuration/callout-proxy.md- Added a new standalone configuration page for callout proxy settings.How to verify this change
config.callouts.tunnel.urlandconfig.callouts.tunnel.noProxy, then runagentgateway -f config.yaml --validate-only. The command should printConfiguration is valid!.callouts will use proxy, and the proxy should receive the outbound request.config.callouts.tunnel.noProxy, or with a loopback or link-local destination. The proxy should not receive that callout.Proposed release note
Wrote
proposed-release-note.md: this is an unlabelled new user-configurable feature, so the note declareskind: featureand places it under Traffic management and operations.What was not verified
The configuration was not applied or run, and no outbound callout was sent through an HTTP proxy.
How the pages were chosen (triage report)
Draft a new page
agentgateway/agentgateway#3864 — Allow sending callout requests through CONNECT tunnel
agentgateway/website--validate-onlyafter drafting, and commands are unrunCargo.tomlcrates/agentgateway/src/app.rscrates/agentgateway/src/client/aws.rscrates/agentgateway/src/client/azure.rscrates/agentgateway/src/client/mod.rscrates/agentgateway/src/http/auth/aws.rscontent/docs/standalone/main/documentation/configuration(13 sibling page(s))Warnings
Release notes
This pull request also adds its release-note entries:
content/docs/standalone/main/release-notes/release-notes.md: Callout requests can use an HTTP proxy (feature)Draft branch:
pr-tracker-draft-agentgateway-3864Important
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.
Maintainer edits