Initial skeleton: runbooks/README.md

2026-08-11 11:45:35 +00:00
parent 099b3af8b7
commit b84a872d40
1 changed files with 39 additions and 0 deletions
@@ -0,0 +1,39 @@
+# Runbooks — Operational Procedures Index
+
+This directory contains step-by-step operational procedures for routine maintenance, incident response, and recovery tasks.
+
+---
+
+## Index
+
+| Runbook | Scope | Last Tested | Owner |
+|---------|-------|-------------|-------|
+| [Example: Service Restart](<!-- link -->) | All services | `<!-- date -->` | `<!-- team -->` |
+| `<!-- runbook -->` | `<!-- scope -->` | `<!-- date -->` | `<!-- owner -->` |
+
+> **Note:** Replace placeholder rows with actual runbook entries. All runbooks must include a "Last Tested" date before being considered authoritative.
+
+---
+
+## Runbook Standards
+
+Each runbook must contain:
+
+1. **Title & Scope** — what the procedure covers and when to use it
+2. **Prerequisites** — access, tools, and context required before starting
+3. **Steps** — numbered, atomic actions with expected outputs
+4. **Verification** — how to confirm success
+5. **Rollback** — how to reverse the procedure if something goes wrong
+6. **Last Tested** — date and tester's initials
+
+---
+
+## Categories
+
+- `maintenance/` — Scheduled tasks (backups, certificate renewal, updates)
+- `incident/` — Break-glass and recovery procedures
+- `onboarding/` — Adding new hosts, services, or agents
+
+---
+
+*Directory last reviewed: <!-- date -->*