Repository navigation
[Automated] Draft docs (kagent): feat(auth): add gateway Actor JWT credentials - #668
Closed
github-actions[bot] wants to merge 1 commit into
Closed
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…edentials Signed-off-by: GitHub Action <action@github.com>
Contributor
|
Folded into #672. |
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#3359 — feat(auth): add gateway Actor JWT credentials
Docs versions:
1.x(first shipped in v1.0.0-rc1)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/remotemcpserver/reconciler.gogo/core/internal/service/tool/mcp.gogo/core/internal/translator/egress.goWhat changes for users: Operators can set
spec.actorJwton ModelConfig and RemoteMCPServer, orauthentication.actorJwton an EgressPolicy destination, so a downstream service can authenticate the executing Actor instead of the invocation caller. Audiences are required,expirationSecondsdefaults to900, andkagent-runtimeis reserved for controller calls.What the docs now say: The model provider, MCP tools, EgressPolicy, identity, egress, and harness pages now describe Actor JWT credentials, provider support, required audiences, lifetime bounds, credential-field exclusivity, RemoteMCPServer discovery behavior, and EgressPolicy placeholder-header behavior.
Not verified: No cluster; the configuration is unrun.
How
kagent-3359was drafted, and what was not verifiedPlan, and what changed it
actorJwtalongside the existing model-provider credential and identity guidance.Why a documentation change is necessary
The pull request adds the
actorJwtAPI surface to ModelConfig, RemoteMCPServer, and EgressPolicy authentication. The existing pages documented Secret-backed credentials and caller-token passthrough, but did not explain how to authenticate the executing Actor to a downstream service. The generated API reference will list the fields, but the prose pages own when to use them and the constraints around provider support, audiences, lifetimes, and mutually exclusive credential choices.The neighbor dossier for kagent-dev/kagent#3362 says the target version also resolves Agent metadata from scoped Actor tokens. The excerpt did not include a prose-doc target for that follow-up API, so this draft stays on the credential fields that #3359 adds.
What changed on disk
docs-site/content/kagent/1.x/setup/model-providers/about-model-providers.md: Adds a ModelConfig Actor JWT section, provider support, field constraints, and the credential-header table row.docs-site/content/kagent/1.x/setup/model-providers/azure-openai.md: AddsactorJwtto the Azure OpenAI authentication table.docs-site/content/kagent/1.x/setup/model-providers/azure-ai-foundry.md: AddsactorJwtto the Foundry authentication table.docs-site/content/kagent/1.x/skills-and-mcp/about-tools.md: Adds RemoteMCPServer Actor JWT configuration and discovery behavior.docs-site/content/kagent/1.x/agents/egress-policies.md: Adds an EgressPolicy Actor JWT example and validation conflict note.docs-site/content/kagent/1.x/about/substrate-runtime/identity.md: Adds downstream Actor JWTs to the identity model.docs-site/content/kagent/1.x/about/substrate-runtime/networking-and-egress.md: Updates the credential sources that feed egress policy rules.docs-site/content/kagent/1.x/agents/agent-harness.md: Adds the ModelConfigspec.actorJwtprovider-support restriction.How to verify this change
spec.actorJwt.audiencesand points a supported provider, such asOpenAI, at a test endpoint that trusts the Agent Substrate issuer.spec.actorJwt.audiences;kubectl get remotemcpserver <name> -n <namespace> -o yamlshould reportDiscoveryDisabledwith the messageGlobal tool discovery requires an executing Actor because actorJwt is enabled; agents resolve the tool list at run time.authentication.actorJwt, select it from an Agent, and call the destination from the agent. The downstream service should receive the configured header with a Bearer JWT whose audience matches the configured value.Proposed release note
No
proposed-release-note.md:markers.notes_placeableis false for this item.Suggested note text: Downstream services can authenticate the executing Actor by using
spec.actorJwton ModelConfig or RemoteMCPServer, orauthentication.actorJwton EgressPolicy destinations. Agent Substrate mints and refreshes the token at the egress gateway; audiences are required, and the lifetime defaults to900seconds.What was not verified
cluster-facts.mdwas present for this item; field spelling was checked against the dossier diff and generated CRD schema hunks.How the pages were chosen (triage report)
Feature clusters
Kept apart on purpose. Merging wrongly produces a guide that documents two things and explains neither, so these are reported for a person to merge rather than grouped automatically:
docs-site/content/kagent/1.x/observability/launch-ui.mdas a candidate, but for one of them it is one page among more than 3, so they are kept apart; merge them if both drafts do land thereDraft a documentation change
kagent-dev/kagent#3359 — feat(auth): add gateway Actor JWT credentials
kagent-dev/websiteactorJwtto ModelConfig and RemoteMCPServer, and to EgressPolicy's existingauthenticationobject.docs/architecture/credential-injection.mdgo/core/internal/controller/remotemcpserver/reconciler.gogo/core/internal/service/tool/mcp.gogo/core/internal/translator/egress.goDraft branch:
pr-tracker-draft-kagent-3359