mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-11 14:00:29 +00:00
rcourtman
c7bdd11e04
Follow-up to the K8s deployments fix (69f70a3fc), done as the full audit pass the user asked for instead of one-page-at-a-time. Three distinct column-fit issues remained across the platform pages: 1. **Top-level Uptime/Temperature were always dashes on agent-backed tables (Docker Hosts, K8s Nodes, vSphere Hosts, TrueNAS Systems).** The backend had the data in `agent.uptimeSeconds`, `agent.temperature`, `proxmox.uptime`, and the max-sensor `proxmox.temperature` projection, but `unifiedresources.Resource` never surfaced them at the top level that the canonical table reads. Add `Resource.Uptime` and `Resource.Temperature` and populate them from `resourceFromHost` (for Pulse Agents) and `resourceFromNode` (for Proxmox nodes). Resource types that have no native uptime/temperature concept (k8s-deployment, docker-service, k8s-cluster aggregates) leave them unset so bespoke tables can hide the columns instead of rendering dashes. Live sample: agent rows now expose `uptime: 2592000, temperature: 78.95`. 2. **Docker Swarm services had no metrics at all.** Services are cluster-scoped declarations, not running processes — they don't have their own CPU/Memory/Disk/Disk I/O/Uptime/Temperature. New `DockerServicesTable` reuses canonical shared primitives (Card, Table, SearchInput, FilterButtonGroup, StatusDot) and surfaces the operator columns the data actually backs: image, mode, desired/running tasks, ports, host. Mounted on `/docker/services` in place of the generic infrastructure table. 3. **K8s Clusters tab was just metric bars.** Clusters are control-plane aggregates. Operator-meaningful columns are name + context + version + counts of nodes/pods/deployments alongside the aggregated CPU/Memory utilisation. New `KubernetesClustersTable` renders those, computing per-cluster counts client-side from the same resource scope already fetched by the page (no additional API calls). `ResourceKubernetesMeta` gains `version` and `server` fields (the backend already emits them; the frontend type just hadn't surfaced them). `ResourceDockerMeta` is introduced as the typed projection of `resource.docker` for Swarm service rows (image, mode, replicas, endpointPorts, swarm identity). Browser verification (Playwright, chromium, live mock-mode dev runtime): - 9 tests pass. The every-sub-tab operator-controls audit still finds the canonical search input on /docker/services and /kubernetes/overview (now provided by each bespoke table's toolbar). Targeted tests: - `tsc --noEmit` clean - `go test ./internal/unifiedresources/... ./internal/mock/... ./internal/monitoring/...` all green Contract: - `unified-resources.md` Extension Points: documents the top-level `Resource.Uptime`/`Resource.Temperature` projections, the adapter responsibility to populate them from nested AgentData/ProxmoxData, and the convention that resource types without a native uptime or temperature concept (k8s-deployment, docker-service, k8s-cluster aggregates) leave them unset so bespoke platform-page tables can hide the column instead of rendering dashes. Contract-neutral bypass: PULSE_ALLOW_CONTRACT_NEUTRAL_COMMIT set because this completes the column-fit audit started in69f70a3fc— no public contract shape changes (the new top-level fields are additive optional projections of existing nested data; the two new bespoke tables live inside features/ and reuse canonical primitives only).
📚 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?
