rcourtman
|
a4cd3a275e
|
docs(sensor-proxy): comprehensive config management documentation
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 3dc073a28, 804a638ea, 131666bc1
|
2025-11-19 10:01:33 +00:00 |
|
rcourtman
|
1ed69d35b6
|
docs: highlight runbooks in index and script verification checklist
|
2025-11-14 10:39:10 +00:00 |
|
rcourtman
|
4693900f8b
|
docs: document sensor proxy log forwarding
|
2025-11-14 01:12:25 +00:00 |
|
rcourtman
|
7a9c420912
|
docs: clarify auto-update flow and surface proxy guide
|
2025-11-14 01:06:11 +00:00 |
|
rcourtman
|
a163988bf5
|
docs: add auto-update runbook
|
2025-11-14 01:05:06 +00:00 |
|
rcourtman
|
9864258207
|
docs: add operations runbooks and audit fixes
|
2025-11-14 01:01:21 +00:00 |
|
rcourtman
|
f2b888386c
|
Remove installer v2 rollout doc
|
2025-11-13 22:36:01 +00:00 |
|
rcourtman
|
6d591920d9
|
Remove CONTRIBUTING-SCRIPTS doc
|
2025-11-13 22:34:21 +00:00 |
|
rcourtman
|
6eb1a10d9b
|
Refactor: Code cleanup and localStorage consolidation
This commit includes comprehensive codebase cleanup and refactoring:
## Code Cleanup
- Remove dead TypeScript code (types/monitoring.ts - 194 lines duplicate)
- Remove unused Go functions (GetClusterNodes, MigratePassword, GetClusterHealthInfo)
- Clean up commented-out code blocks across multiple files
- Remove unused TypeScript exports (helpTextClass, private tag color helpers)
- Delete obsolete test files and components
## localStorage Consolidation
- Centralize all storage keys into STORAGE_KEYS constant
- Update 5 files to use centralized keys:
* utils/apiClient.ts (AUTH, LEGACY_TOKEN)
* components/Dashboard/Dashboard.tsx (GUEST_METADATA)
* components/Docker/DockerHosts.tsx (DOCKER_METADATA)
* App.tsx (PLATFORMS_SEEN)
* stores/updates.ts (UPDATES)
- Benefits: Single source of truth, prevents typos, better maintainability
## Previous Work Committed
- Docker monitoring improvements and disk metrics
- Security enhancements and setup fixes
- API refactoring and cleanup
- Documentation updates
- Build system improvements
## Testing
- All frontend tests pass (29 tests)
- All Go tests pass (15 packages)
- Production build successful
- Zero breaking changes
Total: 186 files changed, 5825 insertions(+), 11602 deletions(-)
|
2025-11-04 21:50:46 +00:00 |
|