runbook-generator

Topics in the source

• Runbook Generator
• Overview
• Core Capabilities
• When to Use
• Quick Start
• Recommended Workflow
• Reference Docs
• Common Pitfalls

Tier: POWERFUL Category: Engineering Domain: DevOps / Site Reliability Engineering -- Generate operational runbooks quickly from a service name, then customize for deployment, incident response, maintenance, and rollback workflows. Runbook skeleton generation from a CLI Standard sections for start/stop/health/rollback Structured escalation and incident handling placeholders Reference templates for deployment and incident playbooks -- A service has no runbook and needs a baseline immediately Existing runbooks are inconsistent across teams On-call onboarding requires standardized operations docs You need repeatable runbook scaffolding for new services -- -- 1. Generate the initial skeleton with scripts/runbookgenerator.py. 2. Fill in service-specific commands and URLs. 3. Add verification checks and rollback triggers. 4. Dry-run in staging. 5. Store runbook in version control near service code. -- references/runbook-templates.md -- Missing rollback triggers or rollback commands Steps without expected output checks Stale ownership/escalation contacts Runbooks never tested outside of incidents 1. Keep every command copy-pasteable. 2. Include health checks after every critical step. 3.

This is an excerpt. Refer to the complete source and its current requirements.