mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-10-24 04:33:17 +00:00
rcourtman
d836208f16
## Problem An agent installed by the cluster deploy flow starts with `--enroll` and a one-time bootstrap token. Only the host module exchanged that token for the runtime token. Everything else `main.go` builds at startup kept the bootstrap token for the whole first process lifetime: - the remote config client (initial fetch and the one-minute refresh) - the updater - the Docker / Podman and Kubernetes modules and their primary report targets The bootstrap token carries only the enrollment scope and the server removes it on exchange, so each of those failed with 401 until the service restarted. On a freshly deployed Proxmox node this showed up as a remote config 401 every minute. Those modules also kept the pre-enrollment agent ID instead of the server-assigned one. ## Fix `main.go` now enrolls once, before it builds any authenticated client: - `hostagent.Enroll` is a standalone entry point over the existing enrollment loop. Payload, headers, retry and backoff, status handling, and `runtime.token` / `agent-id` persistence are unchanged. - It runs after self-test and agent-ID preparation and before the first remote config fetch. Every module is then built from the runtime token and the canonical agent ID. - The ID is persisted to the configured agent-ID file, and the host module's own enrollment is switched off so there is no second exchange. - A persisted runtime token is reused without a request or host discovery. A `403` keeps the configured token as a non-bootstrap credential. A permanent rejection stops startup before any module is built. - Windows is gated off and keeps its previous behaviour. Startup there runs before the service control dispatcher, and an enrollment retry could outlast its 30-second deadline. No Windows installer passes `--enroll`. - Enrollment and reporting now derive hostname, OS and architecture through one `resolveHostIdentity`, so the runtime token is bound to the hostname the agent reports under. ## Tests - `TestRunEnrollsBeforeBuildingAuthenticatedModules`: enrollment happens before any request to Pulse. Remote config, the updater, and the host, Docker and Kubernetes configs and their targets all carry the runtime token and canonical ID, and the agent-ID file is written. With the new step disabled, this test fails. - `TestRunStopsBeforeModulesWhenEnrollmentIsRejected`, `TestRunWithoutEnrollDoesNotExchangeTokens` and `TestRunLeavesEnrollmentToTheHostModuleWhenGatedOff`. - `TestEnroll*` cases for `Enroll`: payload and identity, the monitoring-only command ceiling, reuse of a persisted token (including when host discovery fails), the 403 keep, the 409 rejection, and a missing token. - `TestEnrollPresentsTheIdentityNewReports` checks that enrollment presents the hostname, OS and architecture that `New` reports, with Proxmox detection and the architecture fallback. - `go test ./cmd/pulse-agent ./internal/hostagent ./internal/remoteconfig` passes. `go vet` is clean for linux, windows and freebsd. ## Not in this change - The health listener still starts after enrollment, so `/readyz` is unreachable while enrollment retries on network errors. The installer only warns in that case. With the health listener enabled, its registration check now always sees the runtime token. With it disabled, the process-only check can still race enrollment. - Distinguishing a deploy binding mismatch from a non-bootstrap token, which both return 403. - Two older durability gaps that this change doesn't make worse. If writing a custom `--agent-id-file` fails, the next start has no fallback to the canonical ID saved in the state directory. If persisting `runtime.token` fails, enrollment still succeeds, and the next restart is left with the spent bootstrap token.
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.
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 (request-assisted)
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.