mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-10 02:25:56 +00:00
rcourtman
54a312bebd
Six of the eight Pro-exclusive features had no telemetry field at all, so there was no way to answer whether RBAC, audit logging, scheduled reporting, agent profiles, alert-triggered AI, or Kubernetes AI were being used by the installs paying for them. Schema v6 adds nine content-free adoption signals: alert_ai_enabled AIConfig.IsAlertTriggeredAnalysisEnabled() rbac_custom_roles non-built-in roles, per org rbac_user_assignments user-to-role assignments, per org audit_logging_persistent a persistent audit store is active, not console audit_events_30d audit events retained inside the window report_schedules configured scheduled reports report_schedules_enabled scheduled reports switched on report_schedules_run_30d schedules whose last run falls inside the window agent_profiles configured agent profiles Counts only. Role names, permissions, usernames, schedule names, delivery recipients, report scope, profile names, and every audit event field stay on the install. kubernetes_ai needs no field of its own: it is derivable at read time from alert_ai_enabled combined with the existing kubernetes_clusters count, and a dedicated field would be redundant. Config-sourced signals are read through applyLicensedFeatureConfigSnapshot; RBAC and audit live behind the router and are read through Router.ApplyLicensedFeatureTelemetrySnapshot. The RBAC read goes through a new TenantRBACProvider.PeekManager so a background telemetry read can never provision an RBAC store for an org that has never used RBAC. Also removes pulse_intelligence_patrol_autofixes_30d and the AutoFixCount field behind it. patrol_run.go hardcoded AutoFixCount to 0 and no increment site existed anywhere in the tree, so the counter was zero in all 233,364 retained production pings. That was a wiring bug, not evidence that nobody uses Patrol fixes; governed fixes are delivered through the approved-action pipeline, which is already instrumented. The field was plumbed through run records, history persistence, the Assistant handoff, and telemetry while being structurally incapable of holding a non-zero value. Verified end to end against a running install rather than only in unit tests, which is precisely the check the autofix counter never had: seeding three report schedules (two enabled, one last run inside the window) and two agent profiles produced report_schedules 3, report_schedules_enabled 2, report_schedules_run_30d 1, agent_profiles 2 in the Settings telemetry preview, and signing in moved audit_events_30d to 1. The private receiver landed first in pulse-pro 78ff7dd so the new fields are accepted on arrival.
📚 Pulse Documentation
Welcome to the Pulse documentation portal. Here you'll find everything you need to install, configure, and master Pulse.
🚀 Getting Started
- Localized getting started: Deutsch • Español. These first-wave pages cover the public install path and preserve commands, config keys, image names, activation keys, and product identifiers exactly.
- 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 Modes & Safety – Configure Patrol mode, 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 Intelligence – Pulse Assistant, Patrol findings, alert analysis, governed actions, 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).
- Pulse for MSPs – Provider operations guide: per-client isolation, split ingress, alert routing, branded reports.
- 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 hands-on Patrol modes, issue investigation, governed fixes, verified outcomes, 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.
- AI-Assisted Development – How AI tools are used to build and maintain Pulse, and where their output is labelled.
📁 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?
