Repository navigation
[Automated] Draft docs (kagent): feat(sandbox): adopt env guest service redesign (+1 related) - #670
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
…ce redesign (+1 related) Signed-off-by: GitHub Action <action@github.com>
Contributor
|
Covered by #652 (v1.0.0-rc1 docs update). |
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#3148 + kagent-dev/kagent#3261](kagent-dev/kagent#3148 and kagent-dev/kagent#3261) — Sandbox guest redesign and scoped Substrate reads
Docs versions:
1.x(first shipped in v1.0.0-rc1)No code-path rule covers 8 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:
.agents/skills/kagent/references/sandboxes.mddocs/architecture/sandboxes.mdgo/api/client/sandbox.gogo/core/internal/grpcserver/policy.gogo/core/internal/grpcserver/sandbox_guest.gogo/core/internal/service/sandbox/guest.goWhat changes for users: The UI's Substrate page is scoped to the controller's watched namespaces. Empty namespace and atespace filters mean all watched namespaces and atespaces on namespace-scoped installs, and filters outside that set return
PermissionDenied; cluster-wide installs still read every namespace and atespace. The sandbox guest-service redesign also changes process fields and RPC names, but the dossier did not give an authorized reader page for that API surface.What the docs now say: The Launch the UI page now explains how namespace-scoped installs affect the Substrate page and clarifies that the Scope tile's
allvalue means all watched namespaces and atespaces in that mode. The sandbox API change is recorded as a placement gap, not drafted into the unrelated MCP, skills, plugins, or UI pages.Not verified: The configuration was not applied to a cluster, and internal links are unchecked.
How
kagent-3148was drafted, and what was not verifiedPlan, and what changed it
launch-ui.mdowns the Substrate UI behavior from fix(substrate): scope Substrate reads and page tokens to the watched namespaces kagent#3261, but the feat(sandbox): adopt env guest service redesign kagent#3148 candidate pages cover UI access, MCP tool binding, skills, and plugins rather than sandbox process APIs.launch-ui.mdfor scoped Substrate reads, and downgraded the sandbox process API portion to an issue because no authorized page fits it.Why a documentation change is necessary
kagent-dev/kagent#3261 changes what a namespace-scoped controller returns to the Substrate page. The existing Launch the UI page says that the page reads WorkerPools, ActorTemplates, Actors, and Workers, and that the Scope tile reads
alluntil a filter is set. Without this update, a reader of a namespace-scoped install might interpretallas every tenant rather than every watched namespace and atespace.kagent-dev/kagent#3148 changes sandbox process and file API behavior: process responses use
stateinstead ofstatus,exit_codeis present only afterPROCESS_STATE_EXITED,kill_sandbox_processacknowledges SIGKILL delivery instead of returning a final exit code, and existing sandboxes must be deleted across the guest wire-format change. The candidate pages do not document sandbox process APIs.your-first-mcp-tool.mdis about binding Kubernetes MCP tools to an AgentTemplate,about-tools.mdis about AgentTemplate tool bindings,plugins.mdandskills.mddocument packaging, and the section index cannot hold configuration or API details.What changed on disk
docs-site/content/kagent/1.x/observability/launch-ui.md- explains namespace-scoped Substrate reads and updates the Scope tile description.How to verify this change
PermissionDeniederror.Proposed release note
No
proposed-release-note.md: this product has no release-note placement target for this run.Suggested note for kagent-dev/kagent#3148:
The sandbox guest protocol now uses
statefor process lifecycle reporting, includesexit_codeonly afterPROCESS_STATE_EXITED, and replacesKillProcessandStreamProcessOutputswithSignalProcessandStreamProcessOutput. Delete existing sandboxes before upgrading because old guest wire-protocol messages are incompatible.Suggested note for kagent-dev/kagent#3261:
Namespace-scoped kagent installs now scope Substrate summary, actor, worker, and page-token reads to their watched namespaces and atespaces. Requests outside that scope return
PermissionDeniedorInvalidArgument; cluster-wide installs continue to read all namespaces and atespaces.What was not verified
cluster-facts.mdrecords the installed API surface only; no configuration was applied.How the pages were chosen (triage report)
Feature clusters
These pull requests document one feature between them:
docs-site/content/kagent/1.x/observability/launch-ui.md, the only page a code-path rule names for one of them, so separate pull requests would conflictKept 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#3261 — fix(substrate): scope Substrate reads and page tokens to the watched namespaces
kagent-dev/websitego/api/gen/kagent/api/v1/system.pb.gogo/core/internal/service/system/service.gogo/core/internal/service/system/substrate.goproto/kagent/api/v1/system.protoNew configuration: no page mentions it yet
kagent-dev/kagent#3148 — feat(sandbox): adopt env guest service redesign
kagent-dev/websiteagent-substrate/envto0d359eaand updates the sandbox gRPC API, Go client, CLI, MCP tools, and generated schema to match the redesigned guest services..agents/skills/kagent/references/sandboxes.mddocs/architecture/sandboxes.mdgo/api/client/sandbox.gogo/core/internal/grpcserver/policy.gogo/core/internal/grpcserver/sandbox_guest.gogo/core/internal/service/sandbox/guest.goWarnings
Draft branch:
pr-tracker-draft-kagent-3148-plus1Important
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. This repository's checks are held asaction_requireduntil somebody presses Approve and run on the Checks tab. Checks that come from GitHub Apps rather than Actions, such as DCO, 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.