courtmanr@gmail.com
21a489cbec
Refactor integration docs (K8s, Proxy, Webhooks) to be concise
2025-11-25 00:19:34 +00:00
rcourtman
188944019a
docs: Add webhook private IP allowlist configuration guide
...
Document the new webhook security feature that allows homelab users to configure
trusted private IP ranges for webhook targets.
Includes:
- Overview of default security behavior
- Step-by-step configuration instructions
- Security considerations and best practices
- Example CIDR configurations
- Troubleshooting guidance for common error messages
Related to #673
2025-11-09 08:36:15 +00:00
rcourtman
2f43d67af9
docs: simplify Mermaid diagrams for better readability
...
The previous diagrams were too complex and overwhelming. Simplified
all diagrams to show core concepts clearly:
- Adaptive polling: reduced to basic scheduler→queue→workers flow
- Temperature proxy: simplified to 3-box trust boundary view
- Sensor proxy sequence: simplified to essential request flow
- Webhook pipeline: reduced to template→send→retry flow
- Script library: simplified to code→test→bundle→dist flow
Fixed parsing error in temperature proxy diagram (parentheses in
edge label causing render failure).
Diagrams should clarify architecture, not recreate implementation.
2025-10-21 10:50:40 +00:00
rcourtman
85ffe10aed
docs: add Mermaid diagrams to improve visual documentation
...
Enhance documentation with six Mermaid diagrams to better explain
complex system implementations:
- Adaptive polling lifecycle flowchart showing enqueue→execute→feedback
cycle with scheduler, priority queue, and worker interactions
- Circuit breaker state machine diagram illustrating Closed↔Open↔Half-open
transitions with triggers and recovery paths
- Temperature proxy architecture diagram highlighting trust boundaries,
security controls, and data flow between host/container/cluster
- Sensor proxy request flow sequence diagram showing auth, rate limiting,
validation, and SSH execution pipeline
- Alert webhook pipeline flowchart detailing template resolution, URL
rendering, HTTP dispatch, and retry logic
- Script library workflow diagram illustrating dev→test→bundle→distribute
lifecycle emphasizing modular design
These visualizations make it easier for operators and contributors to
understand Pulse's sophisticated architectural patterns.
2025-10-21 10:40:33 +00:00
rcourtman
c91b7874ac
docs: comprehensive v4.24.0 documentation audit and updates
...
Complete documentation overhaul for Pulse v4.24.0 release covering all new
features and operational procedures.
Documentation Updates (19 files):
P0 Release-Critical:
- Operations: Rewrote ADAPTIVE_POLLING_ROLLOUT.md as GA operations runbook
- Operations: Updated ADAPTIVE_POLLING_MANAGEMENT_ENDPOINTS.md with DEFERRED status
- Operations: Enhanced audit-log-rotation.md with scheduler health checks
- Security: Updated proxy hardening docs with rate limit defaults
- Docker: Added runtime logging and rollback procedures
P1 Deployment & Integration:
- KUBERNETES.md: Runtime logging config, adaptive polling, post-upgrade verification
- PORT_CONFIGURATION.md: Service naming, change tracking via update history
- REVERSE_PROXY.md: Rate limit headers, error pass-through, v4.24.0 verification
- PROXY_AUTH.md, OIDC.md, WEBHOOKS.md: Runtime logging integration
- TROUBLESHOOTING.md, VM_DISK_MONITORING.md, zfs-monitoring.md: Updated workflows
Features Documented:
- X-RateLimit-* headers for all API responses
- Updates rollback workflow (UI & CLI)
- Scheduler health API with rich metadata
- Runtime logging configuration (no restart required)
- Adaptive polling (GA, enabled by default)
- Enhanced audit logging
- Circuit breakers and dead-letter queue
Supporting Changes:
- Discovery service enhancements
- Config handlers updates
- Sensor proxy installer improvements
Total Changes: 1,626 insertions(+), 622 deletions(-)
Files Modified: 24 (19 docs, 5 code)
All documentation is production-ready for v4.24.0 release.
2025-10-20 17:20:13 +00:00
rcourtman
91fecacfef
feat: add docker agent command handling
2025-10-15 19:27:19 +00:00
rcourtman
f46ff1792b
Fix settings security tab navigation
2025-10-11 23:29:47 +00:00