mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-10 02:25:56 +00:00
rcourtman
a5e3469da8
This addresses the need for users who deploy Pulse via infrastructure-as-code tools (Ansible, Terraform, Salt, Puppet) to have scriptable, well-documented installation procedures. Changes: **Comprehensive Automation Section:** - Documented all installer script flags and options - Required: --ctid (LXC) or --standalone (Docker) - Optional: --quiet, --pulse-server, --version, --local-binary, --skip-restart - Documented idempotency, exit codes, and non-interactive behavior **Real-World Examples:** - Ansible playbook for LXC deployments - Ansible playbook for Docker deployments (includes docker-compose.yml management) - Terraform null_resource example with remote-exec - Manual step-by-step configuration (no script) **Configuration Documentation:** - Complete YAML config file format with all options - Environment variable overrides (PULSE_SENSOR_PROXY_ALLOWED_SUBNETS, etc.) - Example systemd service overrides - Rate limiting, metrics, ACL, and subnet configuration **Quick Reference:** - Added link at top of doc for automation users to jump directly to automation section - Clear examples of re-running after changes (adding nodes, upgrading versions) **Key Features for Automation:** - --quiet flag for non-interactive execution - Idempotent design (safe to re-run) - Verifiable exit codes - Environment variable configuration - Local binary support (no internet required) This makes it straightforward for infrastructure teams to integrate Pulse temperature monitoring into their existing automation workflows without relying on interactive scripts or manual steps.
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.
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.
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.
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.
- CONTRIBUTING-SCRIPTS.md – Expectations for installer contributors.
- script-library-guide.md – Working with shared Bash modules.
- installer-v2-rollout.md – Process for shipping major installer updates.
- 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.