Skip to content

[guide] docs: troubleshooting.md — card-first diagnosis for agents that won't run (#5594 blockers line, never-scheduled chip, start & resume) - #5640

Merged
kubestellar-prow[bot] merged 1 commit into
v4from
guide/docs-agent-card-blockers
Sep 2, 2026
Merged

[guide] docs: troubleshooting.md — card-first diagnosis for agents that won't run (#5594 blockers line, never-scheduled chip, start & resume)#5640
kubestellar-prow[bot] merged 1 commit into
v4from
guide/docs-agent-card-blockers

Conversation

@kubestellar-hive

Copy link
Copy Markdown
Contributor

Documentation Fix

Documents the v4.1.0 agent-card run-blocker diagnostics (#5594) in src/docs/troubleshooting.md § "Agents are stuck, paused, or need CLI login", which previously routed operators straight to tmux and described recovery as a two-step resume-then-restart — exactly the serial treasure hunt the card work eliminated.

Files/cluster claimed: src/docs/troubleshooting.md only. Disjoint from every open hold-gated PR (#5628 claims CHANGELOG.md + security-model.md; #5635 docs/rfc-4002; #5559 UPGRADE.md; the rest are code/test PRs).

What the new "Start on the agent card, not in tmux" subsection covers:

  • the blockers line (session · scheduling · next kick): up/down/disabled session states, scheduling that joins every live reason ("paused + off in surge mode"), and next kick as an ETA or never;
  • the ⏱ never scheduled — set cadences chip for the zero-cadence case, and that it shares its predicate with the fleet-level never-kicked banner;
  • resume-leads and the combined ▶ start & resume button, including endpoint order (POST /api/resume/{agent} before POST /api/restart/{agent} so the fresh session is never born paused) and that it is client-side chaining of existing endpoints — no new API;
  • the tmux path is kept under a new "Inspecting the session" subheading as the deeper-inspection escalation, and the paused-recovery step now points at the combined button.

Verified against the implementation at src/pkg/dashboard/static/index.html (agentBlockerLineHtml, agentToggleTitle, pausedAgentActionHtml, neverScheduledChipHtml, startResumeAgent).

Fixes #5639

— hive: agent=guide backend=copilot model=claude-sonnet-4-6

…eatures)

troubleshooting.md § 'Agents are stuck, paused, or need CLI login' routed
operators straight to tmux and described recovery as resume-then-maybe-
restart — exactly the serial treasure hunt the v4.1.0 agent-card work
(#5594) eliminated. Document the card first:

- the blockers line (session · scheduling · next kick), including the
  disabled/down session states, joined scheduling reasons, and the
  ETA-or-never next-kick segment;
- the '⏱ never scheduled — set cadences' chip and its shared predicate
  with the fleet banner;
- resume-leads and the combined '▶ start & resume' button, including the
  endpoint order (resume before restart) and that it is client-side
  chaining of the two existing endpoints;
- keep tmux as the deeper-inspection escalation under a new subheading,
  and point the paused-recovery step at the combined button.

Fixes #5639

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: sec-check <sec-check@hive.kubestellar.io>

@clubanderson clubanderson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified every claim against the v4 dashboard code (src/pkg/dashboard/static/index.html) post-#5594/#5599/#5610:

  • Blockers line: three segments (session / scheduling / next kick) rendered on both the agent card and the ops-center detail panel (agentBlockerLineHtml, .oc-detail-blockers) — matches.
  • Session values up/down/disabled with the described restart-and-enable guidance — matches the tooltips verbatim.
  • Scheduling: every live reason joined (paused + off in <mode> mode via agentSchedulingBlockers), on demand for on-demand agents — matches.
  • Next kick: ETA form (in 12m; due now comes from formatETA in src/pkg/dashboard/next_kick_eta.go), never while any scheduling blocker exists — matches.
  • Never-scheduled chip: exact text, opens the Cadences tab; the shared-predicate claim holds — the card's noCadence flag and the fleet-level hint are both driven by governor.NoCadenceAgents (src/pkg/config/expected_active.go is explicitly shared by both, #5577), so they cannot name different agents.
  • Start & resume: startResumeAgent chains POST /api/resume first, then POST /api/restart, for exactly the stated reason (fresh session never born paused); no new API surface; pausedAgentActionHtml is the single render site, so a paused agent never shows a bare Start — all matches.
  • Consistent with the just-merged src/docs/fleet-health.md (same never-kicked hint text and predicate); no contradictions found.

Verdict: OK to merge — accurate against the code.

@clubanderson clubanderson added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. and removed hold labels Sep 2, 2026
@kubestellar-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubestellar-prow
kubestellar-prow Bot merged commit f10bf64 into v4 Sep 2, 2026
56 checks passed
@kubestellar-prow
kubestellar-prow Bot deleted the guide/docs-agent-card-blockers branch September 2, 2026 13:17
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Thank you for your contribution! Your PR has been merged.

Check out what's new:

Stay connected: Slack #kubestellar-dev | Multi-Cluster Survey

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. copilot dco-signoff: yes Indicates the PR's author has signed the DCO. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

1 participant