Skip to content

[Automated] Draft docs (kagent): session/lifecycle: support force deletion without suspension - #729

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-kagent-3530
Open

github-actions[bot] wants to merge 1 commit into
mainfrom
pr-tracker-draft-kagent-3530

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

The target's own content scan fails where the base build passed (docs-theme-extras markdown-leaks / built-html-integrity):

  • markdown-leaks.spec.ts > markdown-leaks: rendered HTML scan > no leaked markdown across built HTML pages

kagent-dev/kagent#3530 — session/lifecycle: support force deletion without suspension

Docs versions: main

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:

  • go/api/gen/kagent/api/v1/sessions.pb.go
  • go/core/internal/controller/scheduledrun/controller.go
  • go/core/internal/grpcserver/session.go
  • go/core/internal/service/session/service.go
  • go/core/internal/service/session/workflow.go
  • go/core/test/e2e/README.md
  • ...and 2 more

What changes for users: Session deletion now rejects ordinary delete requests while a turn is submitted or running, unless the caller sets force. Forced deletion stops active turns, records active tasks as canceled, and deletes the Actor directly without requiring suspension or a final snapshot first.

What the docs now say: The Operational considerations page now distinguishes idle expiry from client-requested deletion, shows kagent agent session delete <session-id> --force, and explains that API callers keep DeleteSessionRequest.sessionId while setting force to true.

How kagent-3530 was drafted

Plan, and what changed it

  • Planned: Add the forced Session deletion behavior to the Session lifetime material in operations/operational-considerations.md.
  • Learned: the code diff shows force bypasses active turns but not checkpoint creation or lifecycle guards, and the target page's active-work sentence applied only to idle expiry.
  • Did: Narrowed the idle-expiry claim and added the client/API forced deletion behavior, retry boundary, direct DeleteActor behavior, and task outcomes.

Why a documentation change is necessary

The release note says that Session deletion supports force deletion during active turns and no longer requires actor suspension. The Operational considerations page already documents Session expiry and deletion outcomes, but it said active work is never deleted without limiting that claim to idle expiry. A reader deleting a Session from the CLI or API needs to know when ordinary deletion fails, when to use force, and which guards still block deletion.

How to verify this change

  1. In a kagent main test installation, start a Session and keep a turn active. Run kagent agent session delete <session-id>.
  2. The delete command returns an error that says to stop active turns or use --force, and kagent agent session get <session-id> -o json still shows the Session in READY.
  3. Run kagent agent session delete <session-id> --force. A later kagent agent session get <session-id> returns not found, and the task history records the active task as canceled with Session deleted while the turn was active.

Proposed release note

No proposed-release-note.md: markers.notes_placeable is false. Suggested text: Session deletion supports force deletion during active turns and no longer requires actor suspension.

Files in this pull request

  • docs-site/content/kagent/main/operations/operational-considerations.md
How the pages were chosen (triage report)

Draft a documentation change

kagent-dev/kagent#3530 — session/lifecycle: support force deletion without suspension

  • Product: kagent (upstream) → kagent-dev/website
  • Docs version: main
  • Release note: Session deletion supports force deletion during active turns and no longer requires actor suspension.
  • Not tested: no cluster was available, so every command in this diff is unrun
  • No rule covers 8 touched file(s). The candidate pages below come from the files that DID match a rule, so they may scope this narrower than the change is. Read these before deciding the change is only about the pages listed:
    • go/api/gen/kagent/api/v1/sessions.pb.go
    • go/core/internal/controller/scheduledrun/controller.go
    • go/core/internal/grpcserver/session.go
    • go/core/internal/service/session/service.go
    • go/core/internal/service/session/workflow.go
    • go/core/test/e2e/README.md
    • ...and 2 more

Draft branch: pr-tracker-draft-kagent-3530


Important

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 as action_required until 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.

…etion without suspension

Signed-off-by: GitHub Action <action@github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant