mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-10-23 20:25:56 +00:00
rcourtman
6d8dc0aa73
Several v6 subsystem contracts described platform pages embedding
canonical surfaces through controls that no longer exist: a `tableOnly`
/ `embedded tableOnly` mode, a `showFilterToolbar` prop, a
`RecoverySurface`, `forcedPlatformFilter`, an embedded `StorageSurface`
at `/truenas/storage`, and a TrueNAS Protection tab built on a Recovery
surface. The aggregate Recovery surface was deleted on 2026-05-26
(66fb198cc6), and neither `WorkloadsSurface` nor `Storage` has an embed
mode.
What the code does, and what the contracts now say:
- **Workloads embeds** (`performance-and-scalability.md`): only the
Proxmox and vSphere Overview tabs embed `WorkloadsSurface`. Each page
builds its own `useWorkloadsState` with `forcedPlatform` and
`suppressPlatformFilter: true`, renders the one `WorkloadsFilter`
toolbar, and passes that state to the surface with
`suppressFilterToolbar`.
- **Platform-page rule** (`frontend-primitives.md`, with `cloud-paid.md`
now deferring to it instead of keeping a second copy): three tabs embed
a canonical surface (Proxmox and vSphere Overview, and Proxmox Storage
with `forcedSourceFilter`), and those tabs keep their rows on the
embeds. Every other tab renders a platform-owned table on the shared
platform-page primitives. The old "chrome-only, no per-family tables"
wording has not matched the code since the platform-first migration. The
bans on estate summary panels and forked table primitives stay.
- **Storage and recovery** (`storage-recovery.md`,
`unified-resources.md`): `/truenas/storage` renders
`TrueNASStorageTopologyTable`. Proxmox Backups reads `/api/backups/pve`,
`/api/backups/pbs` and the protection postures itself. TrueNAS
Protection feeds `TrueNASProtectionTable` from `useRecoveryPoints` with
the `truenas` platform forced.
Contract-only PRs never get their required checks, so a new case in
`platformOverviewLayout.guardrails.test.ts` pins these claims by parsing
the page surfaces with the TypeScript compiler API. It checks which
embeds each page has and which tab gates them, the platform lock on the
Workloads state and toolbar, `suppressFilterToolbar`, the source lock on
the Storage embed with no `forcedView`, the absence of an embed-mode
prop on either surface, and the wiring from the recovery hook to the
TrueNAS protection table. Twelve negative controls (removing the lock,
un-gating or moving a tab, re-adding the platform chip,
`suppressFilterToolbar={false}`, adding `forcedView` or a `tableOnly`
prop, embedding a `RecoverySurface`, emptying the protection points, and
others) each fail the case at the intended assertion. Two
behaviour-preserving edits still pass: a paren inside a comment and a
`>` inside a quoted attribute. The full guardrail file passes 19/19, and
the project typecheck and eslint are clean.
Out of scope here: the `storage-recovery.md` sections already rewritten
by #2718, and the wider prose about the deleted aggregate Recovery
page's internals (`components/Recovery/`, `useRecoverySurfaceState` as a
state owner, the `buildRecoveryRouteSearch` serializer paragraph). A
separate PR covers those, and the two merge cleanly in either order.
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
- Proxmox Backup Server
- Proxmox Mail Gateway
- Docker and Podman
- Kubernetes and Helm
- TrueNAS SCALE and CORE
- Unified Agent
- Agent security
- VM disk monitoring
- ZFS monitoring
- Temperature monitoring
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
- Metrics history
- Recovery data
- Webhooks
- Automatic updates
- Centralized agent management (Pro)
- Operational trust model
- Current product screenshots
Pulse Intelligence
- Assistant, Patrol, and external-agent overview
- Patrol modes and safety
- Assistant safety model
- External agent HTTP and MCP substrate
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
- Production deployment and security
- Security review scope
- Authentication and credential storage review packet
- Security guide
- Privacy and telemetry disclosure
- OIDC and SSO
- Proxy authentication
- Role-based access control (Pro)
- Audit logging (Pro)
- Reverse proxy configuration
- Code-signing policy
Plans and managed access
- Community, Relay, and Pro capabilities
- Relay and Pulse Mobile handoff
- Multi-tenant organizations (Enterprise/custom)
- Provider-hosted MSP operations (request-assisted)
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
- Upgrade from v4 to v5
- Retired unified-navigation migration — historical context only; current Pulse uses platform-shaped navigation.
- Move a Pulse installation
Found a bug? Use the issue forms. For setup questions, use GitHub Discussions.