mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-05-12 14:07:28 +00:00
a4cd3a275e
Adds complete documentation for the new sensor-proxy config management CLI implemented in Phase 2. Addresses user-facing aspects of the corruption fix. **New Documentation:** - docs/operations/sensor-proxy-config-management.md (469 lines) - Complete operations runbook for config management - Full CLI reference with examples - Migration guide from inline config - Architecture explanation - Common operational tasks - Troubleshooting guide - Best practices and automation **Updated Documentation:** - cmd/pulse-sensor-proxy/README.md - Configuration Management CLI section - Allowed Nodes File format - Enhanced troubleshooting - Config corruption recovery - docs/TEMPERATURE_MONITORING.md - Config validation failure troubleshooting - Configuration Management quick reference - Cross-links to detailed docs - docs/TROUBLESHOOTING.md - Sensor proxy config validation errors - Comprehensive diagnosis steps - Automatic and manual recovery - README.md & docs/README.md - Added new runbook to operations index - Positioned for discoverability **Coverage:** - Both CLI commands fully documented - Phase 1 & Phase 2 architecture explained - Migration path from pre-v4.31.1 - Config corruption recovery procedures - Safe config editing practices - Automation examples - Troubleshooting all failure modes **Documentation Quality:** - Cross-linked from 5 different documents - Clear examples for common use cases - Target audience: system administrators - Follows project documentation style - Production-ready This completes the sensor-proxy config corruption fix by providing users with comprehensive guidance for the new config management system. Related to Phase 2 commits |
||
|---|---|---|
| .. | ||
| api | ||
| development | ||
| images | ||
| monitoring | ||
| operations | ||
| security | ||
| API.md | ||
| CONFIGURATION.md | ||
| DOCKER.md | ||
| DOCKER_HUB_README.md | ||
| DOCKER_MONITORING.md | ||
| FAQ.md | ||
| HOST_AGENT.md | ||
| INSTALL.md | ||
| KUBERNETES.md | ||
| MIGRATION.md | ||
| OIDC.md | ||
| PORT_CONFIGURATION.md | ||
| PROXY_AUTH.md | ||
| PULSE_SENSOR_PROXY_HARDENING.md | ||
| README.md | ||
| RELEASE_NOTES.md | ||
| REVERSE_PROXY.md | ||
| SCREENSHOTS.md | ||
| script-library-guide.md | ||
| SECURITY.md | ||
| SECURITY_AUDIT_2025-11-07.md | ||
| SECURITY_CHANGELOG.md | ||
| temperature-proxy-control-plane.md | ||
| TEMPERATURE_MONITORING.md | ||
| TEMPERATURE_MONITORING_SECURITY.md | ||
| TROUBLESHOOTING.md | ||
| VM_DISK_MONITORING.md | ||
| WEBHOOKS.md | ||
| zfs-monitoring.md | ||
Pulse Documentation Index
Use this index to navigate the documentation bundled with the repository. Each section groups related guides so you can jump straight to the material you need.
Getting Started
- INSTALL.md – Installation guide covering script, Docker, and Helm paths.
- FAQ.md – Common questions and troubleshooting quick answers.
- MIGRATION.md – Export/import process for moving between hosts.
- DEV-QUICK-START.md – Hot reload workflow for local development.
- Post-install checklist
- operations/audit-log-rotation.md – Schedule regular sensor proxy log rotations after your first installation.
- operations/sensor-proxy-log-forwarding.md – Forward audit/proxy logs to your SIEM as soon as compliance retention is required.
- operations/auto-update.md – Enable and verify the
pulse-updatetimer before handing the system to on-call. - operations/ADAPTIVE_POLLING_ROLLOUT.md – Plan the rollout when turning on adaptive polling beyond lab environments.
Deployment Guides
- DOCKER.md – Container deployment walkthroughs and compose samples.
- KUBERNETES.md – Helm chart usage, ingress, persistence.
- REVERSE_PROXY.md – nginx, Caddy, Apache, Traefik, HAProxy recipes.
- DOCKER_MONITORING.md – Docker/Podman agent installation.
- HOST_AGENT.md – Host agent installers for Linux, macOS, Windows.
- PORT_CONFIGURATION.md – Changing default ports and listeners.
Operations & Monitoring
- CONFIGURATION.md – Detailed breakdown of config files and env vars.
- TEMPERATURE_MONITORING.md – Sensor proxy setup and hardening.
- VM_DISK_MONITORING.md – Enabling guest-agent disk telemetry.
- monitoring/ – Adaptive polling and Prometheus metric references.
- WEBHOOKS.md – Notification providers and payload templates.
- TROUBLESHOOTING.md – Deep dive into common operational issues.
- ../cmd/pulse-sensor-proxy/README.md – Host-side sensor proxy installation and operations guide.
Security
- SECURITY.md – Canonical security policy (root-level document).
- docs/security/ – Sensor proxy network and hardening guidance.
- PROXY_AUTH.md – Authenticating via Authentik, Authelia, etc.
- TEMPERATURE_MONITORING_SECURITY.md – Legacy SSH considerations.
Operations Runbooks
- operations/sensor-proxy-config-management.md – Safe configuration updates using the built-in CLI, migration from inline config, and troubleshooting corruption issues.
- operations/audit-log-rotation.md – Monthly/incident log rotation procedure that preserves the hash chain and validates scheduler health afterward.
- operations/ADAPTIVE_POLLING_ROLLOUT.md – Rollout/rollback plan for enabling adaptive polling in staging or production.
- operations/auto-update.md – Lifecycle of the
pulse-updatetimer/service: enablement, manual trigger, rollback, and observability. - operations/sensor-proxy-log-forwarding.md – Configure rsyslog + RELP/TLS to ship sensor proxy audit/proxy logs to centralized logging.
Reference
- API.md – REST API overview with examples.
- api/SCHEDULER_HEALTH.md – Adaptive scheduler API schema.
- RELEASE_NOTES.md – Latest feature highlights and changes.
- SCREENSHOTS.md – UI tour with annotated screenshots.
- DOCKER_HUB_README.md – Summarised feature list for registries.
Development & Contribution
- CONTRIBUTING.md – Repository-wide contribution guide.
- script-library-guide.md – Working with shared Bash modules.
- development/MOCK_MODE.md – Using mock data while developing.
- MIGRATION_SCAFFOLDING.md – Tracking temporary migration code.
Have an idea for a new guide? Update this index when you add documentation so discoverability stays high.