mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-05-22 03:02:35 +00:00
b0c4faa4a0
Audit pass against the live mock backend (PULSE_MOCK_MODE=true) revealed
three platform sub-tabs that could never populate from canonical
resources today, even with a mature fixture environment:
- Docker > Swarm services: no `docker-service` resource is emitted by
the unified resource adapter at the /api/resources boundary.
- Kubernetes > Services: no `k8s-service` resource type is defined in
internal/unifiedresources; only k8s-cluster, k8s-node, pod, and
k8s-deployment are projected.
- TrueNAS > Hosts: TrueNAS connections produce storage, datasets,
physical disks, and app-containers but no top-level `agent` row
tagged with the `truenas` platform.
Per the platform-pages goal ("if a platform lacks enough canonical data
model support to make a useful page even after fixture work, do not
invent speculative UI — report the data-model gap and skip or gate
that surface deliberately"), the three sub-tabs are removed from the
page navigation and the resource queries are tightened to drop the
unused types. TrueNAS now defaults to /truenas/storage as the first
canonical operator entry point.
Kubernetes Nodes now also includes agent rows whose `sources` array
reports `kubernetes`, because the backend registry merges Pulse-Agent-
linked Kubernetes nodes onto the linked agent row. The merged agents
are the canonical projection of K8s nodes when an agent is installed
on them; treating them as Nodes makes the tab populate against mock
mode and live agent fleets alike.
Browser verification (Playwright, chromium, against live mock-mode
Pulse dev runtime):
- 8 tests, all pass. Every declared platform sub-tab now asserts at
least one canonical row populates under mock mode:
- docker: /docker/overview (2 hosts), /docker/containers
- kubernetes: /kubernetes/overview (1 cluster),
/kubernetes/nodes (3 merged agents), /kubernetes/pods (10),
/kubernetes/deployments (4)
- truenas: /truenas/storage (9), /truenas/apps (5)
- vmware: /vmware/overview (4 ESXi hosts), /vmware/vms (8),
/vmware/storage (datastores)
Targeted tests:
- dockerPageModel, kubernetesPageModel, truenasPageModel suites
updated and passing.
- resourceLinks.test.ts asserts the new TrueNAS default sub-tab.
Contracts updated:
- unified-resources.md Extension Points: platform default sub-tab must
land on a canonical surface that actually populates.
- storage-recovery.md Shared Boundaries: same; calls out TrueNAS
defaulting to /truenas/storage today.
Remaining canonical data-model gaps (intentionally not surfaced as
empty platform sub-tabs in the UI):
- internal/unifiedresources does not emit `docker-service` resources
even though mock.generateDockerServicesAndTasks() generates them in
the StateSnapshot; revisit when adding a docker-service projection.
- internal/unifiedresources does not define ResourceTypeK8sService;
revisit when k8s-service rows are added to the canonical model.
- internal/unifiedresources does not project a top-level TrueNAS
system as an `agent` row; revisit when the TrueNAS adapter promotes
the connection target into a canonical infrastructure row.
|
||
|---|---|---|
| .. | ||
| api | ||
| architecture | ||
| images | ||
| monitoring | ||
| operations | ||
| release-control | ||
| releases | ||
| security | ||
| AGENT_SECURITY.md | ||
| AGENT_SUBSTRATE.md | ||
| AI.md | ||
| AI_AUTONOMY.md | ||
| API.md | ||
| AUDIT_LOGGING.md | ||
| AUTO_UPDATE.md | ||
| CANONICAL_ALERT_ENGINE_MIGRATION_2026-03-10.md | ||
| CENTRALIZED_MANAGEMENT.md | ||
| CLOUD.md | ||
| CONFIGURATION.md | ||
| DEPLOYMENT_MODELS.md | ||
| DOCKER.md | ||
| FAQ.md | ||
| INSTALL.md | ||
| KUBERNETES.md | ||
| MAIL_GATEWAY.md | ||
| METRICS_HISTORY.md | ||
| MIGRATION.md | ||
| MIGRATION_UNIFIED_NAV.md | ||
| MULTI_TENANT.md | ||
| OIDC.md | ||
| PBS.md | ||
| PRIVACY.md | ||
| PROXY_AUTH.md | ||
| PULSE_PRO.md | ||
| RBAC.md | ||
| README.md | ||
| RECOVERY.md | ||
| RELAY.md | ||
| RELEASE_NOTES.md | ||
| REPO_BOUNDARY.md | ||
| REVERSE_PROXY.md | ||
| SCREENSHOTS.md | ||
| SECURITY.md | ||
| STORAGE_ARCHITECTURE.md | ||
| TEMPERATURE_MONITORING.md | ||
| TROUBLESHOOTING.md | ||
| TRUENAS.md | ||
| UNIFIED_AGENT.md | ||
| UNIFIED_RESOURCES.md | ||
| UPGRADE_v5.md | ||
| UPGRADE_v6.md | ||
| VM_DISK_MONITORING.md | ||
| WEBHOOKS.md | ||
| ZFS_MONITORING.md | ||
📚 Pulse Documentation
Welcome to the Pulse documentation portal. Here you'll find everything you need to install, configure, and master Pulse.
v6 Execution Canonical Source
For Pulse v6 build/release execution work, do not start from this broad docs index. Use:
docs/release-control/v6/internal/SOURCE_OF_TRUTH.mdfor stable human governance and locked decisionsdocs/release-control/v6/internal/status.jsonfor live lane state, lane-to-subsystem ownership, structured evidence references, typed lane/subsystem decision records, and canonical ordered listsdocs/release-control/v6/status.schema.jsonfor the machine-readable status contractdocs/release-control/v6/internal/subsystems/registry.jsonanddocs/release-control/v6/internal/subsystems/registry.schema.jsonfor subsystem ownership, explicit shared-ownership exceptions, and proof-routing rulespython3 scripts/release_control/status_audit.py --checkif you need a machine-derived evidence health auditpython3 scripts/release_control/registry_audit.py --checkif you need a machine-derived subsystem registry auditpython3 scripts/release_control/contract_audit.py --checkif you need a machine-derived subsystem contract audit, including explicit cross-subsystem dependency checks and exact registry-derived shared-boundary wording Local pre-commit runs the v6 machine audits against staged control-file content so partial staging cannot hide governance drift. Local pre-commit also blocks partial staging for hook-sensitive governance files underdocs/release-control/v6/,scripts/release_control/,internal/repoctl/,.husky/pre-commit, and.github/workflows/canonical-governance.yml, because those checks still execute or structurally read the working-tree versions locally.python3 scripts/release_control/subsystem_lookup.py <path> [<path> ...] --pretty --leanif you need subsystem ownership, proof routing, exact contract-focus lines, and compact lane context for a change
For governed runtime changes, a staged subsystem contract only counts if its
diff updates a substantive contract section such as Purpose, Canonical Files,
Shared Boundaries, Extension Points, Forbidden Paths,
Completion Obligations, or Current State, rather than metadata alone.
All other documents are supporting references unless explicitly required for evidence.
🚀 Getting Started
- Installation Guide Step-by-step guides for Docker, Kubernetes, and bare metal.
- Configuration
Learn how to configure authentication, notifications (Email, Discord, etc.), and system settings. - Deployment Models
Where config lives, how updates work, and what differs per deployment. - Migration Guide
Moving to a new server? Here's how to export and import your data safely. - Upgrade to v6
Practical upgrade guidance and post-upgrade checks for Pulse v6. - FAQ Common questions and quick answers.
🛠️ Deployment & Operations
- Docker Guide – Advanced Docker & Compose configurations.
- Kubernetes – Helm charts, ingress, and HA setups.
- Reverse Proxy – Nginx, Caddy, Traefik, and Cloudflare Tunnel recipes.
- Troubleshooting – Deep dive into common issues and logs.
🔐 Security
- Security Policy – The core security model (Encryption, Auth, API Scopes).
- Privacy – What leaves your network (and what doesn’t).
- OIDC / SSO – OIDC Single Sign-On configuration (Authentik, Keycloak, Azure AD, etc.).
- Proxy Auth – Authentik/Authelia/Cloudflare proxy authentication configuration.
- Agent Security – Agent privilege model, Proxmox API-only choices, and self-update verification.
📖 Advanced Topics (Relay / Pro / legacy Pro+ / Cloud)
- AI Autonomy & Safety – Configure patrol autonomy levels, assistant control levels, investigation tuning, and safety guardrails.
- Role-Based Access Control (RBAC) – Define custom roles, assign permissions, and integrate with OIDC group mapping.
- Audit Logging – Tamper-evident event logging for compliance, with query, export, and signature verification.
✨ New in 6.0
- Unified Resource Model – How all platforms merge into one model with task-based navigation.
- Unified Navigation Migration – Upgrading from platform-specific tabs to v6 navigation.
- TrueNAS Integration – First-class TrueNAS SCALE/CORE monitoring (pools, datasets, disks, snapshots, replication).
- Relay / Pulse Mobile Handoff – End-to-end encrypted relay for supported Pulse Mobile clients (Relay and above).
- Recovery Central – Unified backup, snapshot, and replication view across all providers.
- Pulse Cloud (Hosted) – Fully managed hosting with automatic updates and backups.
- Pulse AI – Chat assistant, patrol findings, alert analysis, intelligence, and forecasts.
- Metrics History – Persistent metrics storage with configurable retention.
- Mail Gateway – Proxmox Mail Gateway (PMG) monitoring.
- Auto Updates – One-click updates for supported deployments.
- Multi-Tenant Organizations – Isolate infrastructure by organization (Enterprise, opt-in).
- Entitlements Overhaul – Capability-key-based feature gating across Community/Relay/Pro/Cloud, with legacy Pro+ continuity still supported.
💳 Plans (Community / Relay / Pro / Cloud)
Pulse is available in three self-hosted tiers plus hosted Cloud:
-
Community: Free self-hosted monitoring with core monitoring included and 7-day history.
-
Relay: Adds secure remote access to the Pulse web UI, Pulse Mobile pairing for handoff, push notifications, and 14-day history.
-
Pro: Adds alert-triggered root-cause analysis, safe remediation workflows, operations tooling, governance features, and 90-day history.
-
Cloud: Hosted Pulse with Pro-level capabilities; hosted pricing is unchanged by the self-hosted model lock.
-
Plans and entitlements (includes the Community/Relay/Pro/Cloud matrix)
-
Multi-Tenant Organizations (Enterprise) — Isolate infrastructure by organization for MSPs and multi-datacenter deployments.
📡 Monitoring & Agents
- Unified Agent – Single binary for host, Docker, and Kubernetes monitoring.
- Centralized Agent Management (Pro/Cloud) – Agent profiles and remote config.
- Proxmox Backup Server – PBS integration, direct API vs PVE passthrough, token setup.
- TrueNAS – TrueNAS SCALE/CORE integration.
- ZFS Monitoring – Proxmox-native ZFS pool monitoring.
- Storage Architecture – Proposed canonical storage, disk, S.M.A.R.T., and topology model for making storage genuinely operator-useful.
- VM Disk Monitoring – Enabling QEMU Guest Agent for disk stats.
- Temperature Monitoring – Agent-based temperature monitoring (
pulse-agent --enable-proxmox). Sensor proxy has been removed. - Webhooks – Custom notification payloads.
💻 Development
- API Reference – Complete REST API documentation.
- Architecture – System design and component interaction.
- Contributing – How to contribute to Pulse.
📁 Previous Versions
- Upgrade to v5 – Upgrade guidance for v4 → v5 migrations.
- v6 Release Promotion Policy – Canonical stable-vs-prerelease promotion rules and rollback expectations.
- v6 Prerelease Runbook – Internal release operations used during the v6 prerelease period.
Found a bug or have a suggestion?
