Operations Directory - Agent Guide¶
Purpose¶
This directory contains operational runbooks for managing the Home Security Intelligence system in production environments. Runbooks provide step-by-step procedures for incident response, maintenance tasks, and operational health monitoring.
Directory Contents¶
docs/operations/
AGENTS.md # This file - directory guide
profiling-runbook.md # Pyroscope profiling operations procedures
Runbook Overview¶
| Runbook | Purpose | Audience |
|---|---|---|
| Profiling Runbook | Pyroscope incident response and maintenance | Operators, SREs |
Runbook Structure¶
Each runbook follows a consistent structure:
- Quick Reference - Common commands and access URLs
- Incident Response Procedures - Step-by-step resolution guides
- Maintenance Procedures - Routine operational tasks
- Health Monitoring - Scripts and checks for proactive monitoring
- Performance Baselines - Expected metrics and alert thresholds
- Related Documentation - Links to guides and reference materials
Key Patterns¶
- Incident IDs - Each incident procedure has a unique ID (e.g.,
INC-PROF-001) - Maintenance IDs - Each maintenance procedure has a unique ID (e.g.,
MAINT-PROF-001) - Copy-paste commands - All commands are ready to execute
- Rollback procedures - Each change includes rollback steps
- Impact statements - Each procedure documents the impact
Related Documentation¶
| Resource | Location |
|---|---|
| Operator documentation hub | ../operator/README.md |
| Monitoring guide | ../operator/monitoring.md |
| Troubleshooting guides | ../reference/troubleshooting/ |
| User guides | ../guides/ |
Future Runbooks¶
As the system matures, additional runbooks will be added:
database-runbook.md- PostgreSQL operationsredis-runbook.md- Redis operationsai-services-runbook.md- AI service managementmonitoring-runbook.md- Prometheus/Grafana operationsbackup-runbook.md- Backup and recovery procedures