mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-10-23 20:25:56 +00:00
rcourtman
97a30b0600
Execution posture is now profile-owned through the core-only, never-serialized tools.ExecutionProfile. Both Patrol profiles are non-interactive, deny infrastructure mutations, and clear any inherited autonomous mode. Detection restricts pulse-state mutations to an explicit allowlist of the finding lifecycle tools - a blanket pulse-state allowance would also permit alert dismissal and knowledge writes - while investigation denies all pulse-state mutations, keeping it structurally read-only. InvocationPolicy gains the allowlist and Allows() is now tool-name-aware. Chat turns build ONE effective request executor (control level, autonomy, profile, resolved context) BEFORE provider projection and clone that executor per provider attempt, reversing the previous project-from-base-then-clone order so the offered schema and the runtime boundary always agree. Scheduled Patrol (ExecutePatrolStream) now runs under the detection profile instead of autonomous mode - closing its direct view of Docker/Kubernetes mutation subactions - and ListAvailableTools projects through the identical path. toolsForExecutionMode's mode booleans are replaced by the profile on the executor itself. Non-interactive profiles independently hide pulse_question from the manifest AND runtime-block it before the interactive-call-set special case: a fabricated question call returns a non-interactive error without emitting a waiting event, and sibling tool calls from the same provider turn keep processing. Approval waits never block for non-interactive profiles (they queue), and the tool-only-turn wrap-up guardrail is interactive-profile-owned instead of keyed on autonomy. The system prompt describes detection and investigation modes directly rather than claiming controlled or autonomous execution; the investigation prompt directs the model toward typed action proposals. Proofs: detection allowlist enforcement (alerts resolve and knowledge remember blocked, finding tools allowed, projection agrees), investigation structural read-only (patrol mutation tools dropped from the manifest and blocked at runtime), profile clone isolation, profile prompt modes, and question-tool hiding across profiles.
📚 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
- 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.
📁 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?
