Repository navigation
[Automated] Draft docs (kagent): feat: support gateway token passthrough for embedded controllers - #649
Open
github-actions[bot] wants to merge 1 commit into
Open
[Automated] Draft docs (kagent): feat: support gateway token passthrough for embedded controllers#649github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…ugh for embedded controllers Signed-off-by: GitHub Action <action@github.com>
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.
kagent-dev/kagent#3263 — feat: support gateway token passthrough for embedded controllers
Docs versions:
1.x(first shipped in v1.0.0-alpha17)No code-path rule covers 4 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:
docs/architecture/credential-injection.mdgo/core/internal/controller/reconciler.gogo/core/pkg/app/app.gogo/core/pkg/egresspolicy/egresspolicy.goWhat changes for users: Embedded kagent controllers can register
app.Options.EgressPolicyCompilerssotokenPassthroughclients send thekagent-credential-injectedplaceholder to the runtime while the egress gateway binds the caller token. With any compiler registered, each passthrough target must have a credential header, and compiler or validation failure denies Actor egress until retry.What the docs now say: The Egress control page now explains the gateway-bound caller-token path, including the exact origin/header/prefix target, compiler ordering, failure behavior, and conflicts with Secret credentials or non-passthrough clients. The About model providers page now distinguishes the default runtime-forwarded token path from embedded deployments that bind the token at the gateway.
Not verified: No cluster; the configuration and embedded-controller compiler path are unrun.
How
kagent-3263was drafted, and what was not verifiedPlan, and what changed it
docs-site/content/kagent/1.x/about/substrate-runtime/networking-and-egress.mdalready owns policy generation and credential injection, whileabout-model-providers.mdalready states the defaulttokenPassthroughpath.Why a documentation change is necessary
The pull request adds
app.Options.EgressPolicyCompilersand recordstokenPassthroughclients as gateway targets with an origin, header, and prefix. The existing docs described credential injection andtokenPassthrough, but only the default path where the runtime forwards the caller token. Readers embedding kagent could not tell that compiler-registered deployments bind the token at the gateway, require every target to be bound, and deny Actor egress after compiler validation failure.What changed on disk
docs-site/content/kagent/1.x/about/substrate-runtime/networking-and-egress.md: AddedCaller-token passthrough through the gateway.docs-site/content/kagent/1.x/setup/model-providers/about-model-providers.md: Clarified that the default provider path forwards the caller token from the runtime, while embedded controllers can bind it at the gateway.How to verify this change
app.Options.EgressPolicyCompilers.Proposed release note
No
proposed-release-note.md:markers.notes_placeableis false. Suggested note: kagent now lets embedding controllers register egress policy compilers that bindtokenPassthroughcredentials at the Agent Substrate egress gateway. In embedded deployments, runtimes can send thekagent-credential-injectedplaceholder while the gateway applies the caller token, and kagent denies Actor egress when compiler validation fails.What was not verified
The embedded-controller compiler path was not run.
How the pages were chosen (triage report)
Draft a documentation change
kagent-dev/kagent#3263 — feat: support gateway token passthrough for embedded controllers
kagent-dev/websitedocs/architecture/credential-injection.mdgo/core/internal/controller/reconciler.gogo/core/pkg/app/app.gogo/core/pkg/egresspolicy/egresspolicy.goDraft branch:
pr-tracker-draft-kagent-3263