Files
pulse/docs
rcourtman 72d25e4925 Drop guest row captions that repeat an empty cell (#2912)
The Workloads guest table put a second line under memory and disk cells
that repeated an empty cell and gave no reason: "N/A / Unavailable" and
"- / Unavailable" on every stopped guest, "Unavailable" under every
agentless VM's disk, and "May include cache" under every agentless VM's
memory bar regardless of value.

What changes:

- Memory that cannot be read renders the same dash as an unreadable
disk. Its reason stays in the cell title, the sparkline's hover title
and assistive text. Sparkline accessible values are unchanged.
- Disk shows a visible label only for a retained reading (Last known /
Prior) or a read the user can fix (No permission / Agent error, amber).
Stopped VMs, missing guest agents and lock deferrals show the dash.
- "May include cache" appears only when the guest's own memory is at its
warning or critical threshold (the figure the bar is coloured by, in
host-share mode too), the case from #2762 and #2639. Below that, the
caveat is title and assistive text.
- Unavailable memory explanations name what is known rather than
"Unknown source"; a powered-off guest reads "Unavailable while the guest
is powered off."
- `MetricMiniSparkline` gains an optional `tooltip` so the chart
covering the cell carries that reason without changing its accessible
name.

User guide: `docs/VM_DISK_MONITORING.md` (and its shipped mirror) now
describes the labels the row shows, and
`test_guest_disk_reading_docs.py` pins them. This replaces #2893, whose
docs recipe test still expected the old labels.

Contracts: `frontend-primitives.md` and `performance-and-scalability.md`
describe the new caption rules. Four browser proof scripts and
`86-hybrid-memory-browser.spec.ts` are updated to the new behaviour; the
proof scripts need their container harness and were not run here.

Verification: Workloads suites (106 files, 2160 tests),
`memoryObservation` and `MetricMiniSparkline` tests, lint, Prettier and
type check pass. Browser receipt `6e39cc0902eefe58.json` records a live
pass on a mock stack built from main, in Bars and Trends at 1900x1100
and 375x812: captions only on the cache VM at warning, dashes on stopped
and agentless rows, rows 32px / 44px, no overflow.
2026-10-13 21:29:21 +01:00
..
2026-10-12 16:53:18 +01:00
2026-10-12 14:10:58 +01:00
2026-10-12 14:10:58 +01:00

Pulse documentation

Start here for installation, platform setup, security, operations, and Pulse Intelligence. Commands, configuration keys, image names, API fields, and product identifiers remain untranslated in localized guides.

Need help with a failure? Read the safe reporting guidance before sharing evidence. A second reproduction or diagnostics export is not required; keep the original evidence if another attempt could interrupt workloads or send duplicate notifications. GitHub reports and attachments are public: review them locally and keep credentials and private details out.

Start here

  • Install Pulse — signed Proxmox/Linux installation, Docker, Docker Compose, Kubernetes, and first-run setup.
  • Production deployment and security — least-privilege Proxmox setup, root-agent boundaries, discovery, supply-chain verification, plan limits, scale evidence, and a rollout checklist.
  • Upgrade from Pulse v5 — migration prerequisites, rollback, agent continuity, and post-upgrade checks.
  • Releases and update channels: choosing Stable or Preview, beta and RC expectations, and how releases are tested and promoted.
  • Configure Pulse — authentication, notifications, discovery, retention, and system settings.
  • Deployment models — data locations, lifecycle, and differences between supported deployment paths.
  • Troubleshooting and FAQ — common failures, diagnostics, and operator questions.

Localized getting started guides: Deutsch · Español

Platforms and agents

VMware vSphere support is early access. Current builds expose dedicated vSphere inventory and recovery context, but operators should validate the integration against their own vCenter before production use.

Monitoring and operations

Pulse Intelligence

Patrol watch-only analysis is available on Community with a local model or the operator's own provider. Investigation and governed fixes require the relevant Pulse Pro capabilities.

Security, privacy, and access

Plans and managed access

Pulse Cloud is not generally available. Ordinary self-hosted Pulse remains the primary installation path; MSP and Enterprise access are explicit commercial paths rather than defaults in self-hosted setup.

Development and reference

Detailed design notes and dated migration specifications may remain in this directory for maintainers, but they are not operator setup guides unless they are linked from the sections above.

Previous versions and migrations

Found a bug? Use the issue forms. For setup questions, use GitHub Discussions.