Tracking: re-baseline the 1.x docs for kagent 1.0.0-alpha5
维护者通常 1 天内回复
@Rachael-Graham 已经在做这个了。
开始于 2026年9月29日。
评估
这个 Issue 还没有评估数据。
描述
kagent 1.0.0-alpha5 is a breaking re-baseline rather than a point release. Four changes each invalidate large parts of the published 1.x doc set, and they land on overlapping pages, so they need sequencing rather than parallel fixes.
Everything below was verified against the v1.0.0-alpha5 tag on a live cluster or read from the tagged source, not from the release notes.
What changed
1. The API group was renamed
kagent.dev becomes api.kagent.dev. The version stays v1alpha3. The old group is gone from the CRD bases and the Helm chart with no compatibility alias, so every YAML example in the doc set is rejected by the API server.
48 occurrences across 30 files.
2. AgentInstance became Session, and Agent is a new kind
kagent#2952 replaces implicit AgentTemplate/Harness label matching with an explicit Agent resource that pairs the two. Each side takes either a reference or an inline spec.
allowedAgentTemplatesis removed fromHarnessSpecentirely. Every example that pairs a template to a harness by label is obsolete. TheHarnessfield table onagents/agent-harness.mddocuments it as required.- The conversation resource is
Session. The rename runs through protobuf services, PostgreSQL tables, Go clients, the CLI and TUI, MCP, and runtime persistence. - Subagent tools changed shape:
tools[].subAgentwith exactly one oftemplateReforagentRef. Theisolationfield is removed. - There is no upgrade migration. The initial core migration defines the new state directly, and development databases must be recreated.
335 mentions across 47 files, plus three CLI reference pages that no longer describe a real command: kagent-create-agent-instance, kagent-get-agent-instance, kagent-delete-agent-instance.
3. Environment variables moved under KAGENT_
kagent#2967 renamed 138 user-configurable settings and generates docs/env.md as their reference. PORT becomes KAGENT_PORT, LOG_LEVEL becomes KAGENT_LOG_LEVEL, POSTGRES_DATABASE_URL becomes KAGENT_POSTGRES_DATABASE_URL. The old names are no longer read.
OTEL_*, provider credentials, and KUBECONFIG are unchanged. Verified: OTEL_EXPORTER_OTLP_* and OTEL_TRACES_EXPORTER still appear unprefixed in docs/env.md.
agents/bring-your-own-agent.md tells readers to set PORT in a Harness spec.env in five places, and both the Go and Python ADK now read KAGENT_PORT.
4. Controller authentication is wired up
kagent#2971 states that the shipped controller "admits unauthenticated requests, so enabling oauth2-proxy does not authenticate controller requests." It restores controller.auth.mode and controller.auth.userIdClaim.
This changes what substrate-runtime/identity.md asserts, which currently describes the permissive posture as simply how the open source build works. A new caveat needs documenting: ProxyAuthenticator decodes claims without verifying signature or expiry, so trusted-proxy mode requires ingress and network isolation.
Also in alpha5
- A2A endpoints moved again.
/agents/{namespace}/{name}replaces the per-instance path added in alpha4, andSession.idis the publiccontextId. - Standalone sandboxes shipped.
SandboxTemplateandSandboxCRDs, standalone runtimes, and akagent sandboxcommand group. The alpha3 note that this was follow-up work no longer applies. - The UI creates, edits and deletes explicit Agents, and app extensions can replace chat part renderers.
- Agent Substrate moved to v0.3.0-alpha1.
Sequencing
Do these in order. The mechanical renames land on pages the model change rewrites, so running them in parallel means editing the same files three times.
- API group rename, all 30 files. Verify on a cluster that nothing else moved with it.
- Agent and Session model. The conceptual rewrite: core concepts, agent harness, delegation, every AgentInstance page, and the three dead CLI pages.
-
KAGENT_environment variables. Fold each page's renames into whichever pass is already touching it, rather than a separate sweep. - Controller authentication, including the unverified-claims isolation requirement.
- Standalone sandboxes. Net-new pages.
- UI coverage for explicit Agents. Needs screenshots.
Existing issues this affects
Adjusted for alpha5 in their own descriptions: #538, #537, #539, #534, #531, #530, #519, #517, #499.
Unaffected, verified: #535 (ui.basePath is still in values.yaml at alpha5) and #521.
Content merged or merging during alpha4 is written against the old model and needs sweeping with everything else:
| Source | Pages |
|---|---|
| #503, via #505 | agents/context-management.md |
| #518, via #545 | agents/structured-output.md |
| #529 | setup/model-providers/about-model-providers.md, amazon-bedrock.md, google-vertexai.md, sap-ai-core.md, anthropic.md, gemini.md, and agents/agent-harness.md |
#529 is a special case worth calling out. It corrects four credential configurations that the published pages describe as supported and that the compiler rejects, and those corrections are not invalidated by alpha5 — re-verified on a cluster on 2026-09-29, all four still reject, and docs/architecture/credential-injection.md at the alpha5 tag now states the rejections are by design. Sweeping those pages for the API group rename must not undo them.
- 主要语言
- TypeScript
- 星标
- 21
- 派生
- 69
- 平均合并
- 23 小时 53 分钟
- 30 天内合并 PR
- 83
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
kagent-dev/website 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
kagent-dev/website#579 ·
维护者通常 1 天内回复
-
Hold until GA: repoint kagent.dev navigation from 0.x to 1.x可能已有人在做 @Rachael-Graham 于 17 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
kagent-dev/website#521 · 已指派 1 人 ·
维护者通常 1 天内回复
-
bug DocOps
难度 4/5 1-2 天 新手友好度 18/100
kagent-dev/website#606 ·
维护者通常 1 天内回复
-
documentation kagent
难度 4/5 3-5 天 新手友好度 60/100
kagent-dev/website#562 ·
维护者通常 1 天内回复
-
help wanted
难度 3/5 1-2 天 新手友好度 72/100
kagent-dev/website#539 ·
维护者通常 1 天内回复
查看 kagent-dev/website 的全部 Issue
相似的 Issue
-
Endpoint links in the tag operations list are below the 24px target size可能已有人在做 @AdzerKI 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
ai-driven-qa bug Minor
难度 2/5 1-3 小时 新手友好度 80/100
linagora/twake-tasks#435 ·
维护者通常 1 天内回复
-
bug domain: database priority: p1 Stellar Wave
难度 2/5 1-3 小时 新手友好度 74/100
StellarState/SS-backend#632 · 1 条评论 ·
维护者通常 1 天内回复
-
A2A audit timestamps end in +00:00Z (invalid ISO 8601)可能已有人在做 @O1sumitkumar 今天认领。 未关闭bug good first issue help wanted python
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
`cf complete zsh >> .zshrc` fails on vanilla zsh可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 2/5 1-3 小时 新手友好度 75/100
cloudflare/cf#340 ·
维护者通常 1 天内回复