mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-10-31 07:56:08 +00:00
rcourtman
e966726dfa
Follow-up to #2960, stacked on #3327 (which records a failed optional PMG read as a poll error with category `partial` instead of backing off the connection). ## Problem A PMG that answers its version read but fails one optional endpoint (the queue read in #2960) still showed on **Settings → Infrastructure** as **Unreachable**, with a red generic "Server error" banner. It also raised a **critical** connection-degraded alert. `deriveConnectionState` mapped any outstanding poll error to `unreachable`, or to `unauthorized` when the message looked like an auth failure. ## Change - **API:** a poll error with category `partial` now derives a new connection state, `degraded`. This check runs before the auth-text match, so a 403 from one optional endpoint no longer marks the credential unauthorized. A partial connection whose last success is past the stale cutoff is still `stale`. `degraded` rolls up as fleet adapter health `degraded`, keeps credentials `verified`, and does not block rollout or workload inventory. It ranks between `pending` and `stale` in the severity orders. - **Alerts:** `degraded` is a firing state of the existing `connection-degraded` alert at **warning**, never critical. It still needs three observations, keeps an open outage open (a missing reading is not recovery), and steps an open critical outage down to warning once the connection answers again. - **Connections page:** an amber **Degraded** badge, and an amber banner that names the failed reading. Example: "Queue status could not be read: Server error. …". - `monitoring.PollErrorCategoryPartial` exports the category so the ledger reads a single value. ## Verification - Ran a fake PMG over HTTPS that answers version and every read except qshape (HTTP 500), with before and after binaries. - Before: Unreachable badge, red banner, **critical** alert. - After: Degraded badge, amber banner naming the queue read, one **warning** `connection-degraded` alert. Checked at 1280px and 375px. - Go: `internal/alerts` connection tests, `internal/monitoring` partial/PMG tests, `internal/api` connection and contract tests. - Frontend: tsc, plus the Settings, utils and api vitest suites (9,017 tests).
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.
Need help with a failure? Read the safe reporting guidance before sharing evidence. A second reproduction or diagnostics export is not required; keep the original evidence if another attempt could interrupt workloads or send duplicate notifications. GitHub reports and attachments are public: review them locally and keep credentials and private details out.
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 (self-serve evaluation and purchase)
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.