From b84a872d4054ff7d212667c035ab4044d15e0ad9 Mon Sep 17 00:00:00 2001 From: DaystromMoira Date: Tue, 11 Aug 2026 11:45:35 +0000 Subject: [PATCH] Initial skeleton: runbooks/README.md --- runbooks/README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 runbooks/README.md diff --git a/runbooks/README.md b/runbooks/README.md new file mode 100644 index 0000000..63e7491 --- /dev/null +++ b/runbooks/README.md @@ -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]() | All services | `` | `` | +| `` | `` | `` | `` | + +> **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: *