Skip to content

[Automated] Draft docs (kagent): feat(session): add opt-in crash recovery on send - #730

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

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

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#3399 — feat(session): add opt-in crash recovery on send

Docs versions: main

No code-path rule covers 10 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/api/gen/kagent/config/v1/config.pb.go
  • go/core/internal/service/session/interactions.go
  • go/core/internal/service/session/recovery.go
  • go/core/internal/service/session/workflow.go
  • go/core/pkg/app/app.go
  • ...and 4 more

What changes for users: Operators can set config.sessions.automaticRecovery: true so A2A sends attempt crash recovery without a separate RevertSession call. The default stays false; callers still need Session update access, and an in-progress recovery returns KAGENT_SEND_NOT_ACCEPTED with state: RECOVERING.

What the docs now say: The Operational considerations page now documents config.sessions.automaticRecovery, the default explicit-recovery behavior, the UI Recover action, and the RuntimeLost end state for runtimes that cannot be recovered.

How kagent-3399 was drafted

Plan, and what changed it

  • Planned: Update the page that already documents RevertSession and crashed agent recovery.
  • Learned: The target page said neither the CLI nor the UI can revert a Session, but the dossier shows the UI now offers Recover for pending recovery and send-refusal paths.
  • Did: Updated docs-site/content/kagent/main/operations/operational-considerations.md with the new setting and corrected the stale recovery behavior.

Why a documentation change is necessary

The pull request adds config.sessions.automaticRecovery, an opt-in controller setting that lets sends start or continue crashed runtime recovery. The operations page already explains node loss, crashed Actors, and explicit RevertSession, but it said kagent does not recover on its own and that the UI cannot recover a Session. Those claims became incomplete or stale after the change.

How to verify this change

  1. Render controller config with automatic recovery enabled.
    cat > kagent-recovery.yaml <<'EOF'
    config:
      sessions:
        automaticRecovery: true
    EOF
    helm template kagent \
      oci://ghcr.io/kagent-dev/kagent/helm/kagent \
      --namespace kagent \
      --values kagent-recovery.yaml \
      --show-only templates/controller-configmap.yaml \
      | yq -r '.data."controller.yaml"' > controller.yaml
    yq -r '.sessions.automaticRecovery' controller.yaml
    Expected output: true.
  2. Validate the rendered controller config with kagent config validate --component controller --config controller.yaml.
  3. In a test cluster, interrupt an agent runtime during a turn or post-turn suspension, then retry the same A2A send. With config.sessions.automaticRecovery: true, the retry either reaches the recovered runtime or returns KAGENT_SEND_NOT_ACCEPTED with state: RECOVERING and retryAfterMs: 1000.

Proposed release note

No proposed-release-note.md: markers.notes_placeable is false.

Suggested note: kagent can now recover crashed runtimes during A2A sends when config.sessions.automaticRecovery is enabled. The setting defaults to false, and explicit RevertSession recovery remains available.

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#3399 — feat(session): add opt-in crash recovery on send

  • Product: kagent (upstream) → kagent-dev/website
  • Docs version: main
  • Summary (read from the body): Builds on #3395, now merged; rebased onto main.
  • Not tested: no cluster was available, so every command in this diff is unrun
  • No rule covers 10 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/api/gen/kagent/config/v1/config.pb.go
    • go/core/internal/service/session/interactions.go
    • go/core/internal/service/session/recovery.go
    • go/core/internal/service/session/workflow.go
    • go/core/pkg/app/app.go
    • ...and 4 more

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


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.

…very on send

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