Files
pulse/docs
rcourtman 0cebf6f51f Require page-owned state on WorkloadsSurface
WorkloadsSurface built its own workloads state when no `state` prop
arrived, and its props type extended every useWorkloadsState option.
Both production mounts, the Proxmox and vSphere overviews, already
build that state themselves (it also drives their one WorkloadsFilter)
and pass it in, so the fallback only ran in tests. The mounts still
passed vms, containers, nodes and useWorkloads, and Proxmox passed its
app-container exclusion, all of which the surface ignored once it had
a state.

The surface now requires `state` and accepts only presentation props:
forcedPlatform, forcedViewMode, the empty-state copy and tableTitle.
The hook's options type is renamed WorkloadsStateOptions so it no
longer shares a name with the surface's props. The pages drop the
ignored props. Tests that leaned on the fallback build state through a
page-owned harness, as the pages do.

The Proxmox page contract test pins the exact props its mount passes.
The overview guardrails check that each surface repeats the platform
and view scope its page gave the state, and that the surface imports
only the state's type, so it cannot call the hook again.

Because the surface no longer imports the hook at runtime, Rollup now
names the chunk the Proxmox and vSphere pages share after its last
module, useWorkloadsState, and the bundle check reported the old
WorkloadsSurface key as missing. The chunk is the same code at the
same size, so the budget key follows it with its baseline and limit
unchanged.
2026-10-10 13:05:50 +01:00
..
…
2026-10-05 21:53:41 +01:00
…
…
2026-10-05 21:53:41 +01:00
2026-10-05 21:53:41 +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.

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.