Repository navigation
[Automated] Draft docs (kagent): refactor(api)!: make pre-RC API breaks for future machine principals - #669
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
…ks for future machine principals Signed-off-by: GitHub Action <action@github.com>
Contributor
|
Closing as folded into #652. operational-considerations.md now says that a Session records the Agent's UID, and that a same-name replacement Agent gets a new UID while existing Sessions keep the old UID and revision. Live-tested at v1.0.0-rc1, which also showed that deleting an Agent does not end its Sessions; they keep answering, and the page now says so. |
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#3453 — refactor(api)!: make pre-RC API breaks for future machine principals
Docs versions:
1.x(first shipped in v1.0.0-rc1)No code-path rule covers 19 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/a2a-gateway.mdgo/api/client/a2a.gogo/api/gen/kagent/api/v1/agent_templates.pb.gogo/api/gen/kagent/api/v1/sessions.pb.gogo/api/gen/kagent/runtime/v1/memory.pb.gogo/api/gen/kagent/runtime/v1/memory_grpc.pb.goWhat changes for users: Sessions now record the Agent reference and Kubernetes UID from the revision that created them. Deleting an Agent and creating another one with the same namespace and name does not move existing Sessions to the replacement Agent.
What the docs now say: The operational considerations page now states that running Sessions keep the original Agent identity and revision, and that a new Session is required to pick up replacement Agent configuration.
Not verified: No cluster command was run;
cluster-facts.mdrecords API surface only, the configuration is unrun, and internal links are unchecked.How
kagent-3453was drafted, and what was not verifiedPlan, and what changed it
agents/agent-memory.mdalready documents exactnamespace/namememory keys, and no target page owns client-authored A2A message IDs.operations/operational-considerations.md.Why a documentation change is necessary
The pull request changes
Session.agentfrom a plain resource reference toAgentProvenance{ref, uid}and stores the Agent UID from the pinned revision. The target page already says that a running Session keeps its original revision for life, but it did not say that a same-name replacement Agent is also a different identity. Without that detail, a reader might expect deleting and recreating an Agent to move old conversations onto the new Agent definition.What changed on disk
docs-site/content/kagent/1.x/operations/operational-considerations.md— clarifies that existing Sessions stay tied to the original Agent identity and revision after an Agent is deleted and recreated with the same namespace and name.How to verify this change
ref.name: my-first-agentand a non-emptyuid.Proposed release note
No
proposed-release-note.md:markers.notes_placeableis false for this product run.Pre-RC Session and memory API breaks
Sessions now return
agentasAgentProvenance, withrefanduid, so clients that readSession.agent.namespaceorSession.agent.namemust readSession.agent.refinstead. Memory list, search, and delete calls now match only the exactnamespace/nameAgent key, and A2A messages with IDs that start withscheduled-run/are rejected unless they come from the in-process scheduler.What was not verified
cluster-facts.mdwas used only as API-surface evidence.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.md), but one of them is already grouped with another author's change; merge them if both drafts do land thereDraft a documentation change
kagent-dev/kagent#3453 — refactor(api)!: make pre-RC API breaks for future machine principals
kagent-dev/websitedocs/architecture/a2a-gateway.mdgo/api/client/a2a.gogo/api/gen/kagent/api/v1/agent_templates.pb.gogo/api/gen/kagent/api/v1/sessions.pb.gogo/api/gen/kagent/runtime/v1/memory.pb.gogo/api/gen/kagent/runtime/v1/memory_grpc.pb.goDraft branch:
pr-tracker-draft-kagent-3453