Skip to content

Runbook

In one line

A runbook documents step-by-step procedures for operating and troubleshooting a system — guides on-call responders.

In simple words

A runbook (or playbook) contains step-by-step instructions for routine operations and emergency responses. A good runbook has clear, copy-pasteable commands, expected output, verification steps, and links to dashboards.

Types: operational (deploy, backup), incident (service down), diagnostic (slow query, high CPU). Runbook automation (RBA) turns manual runbooks into executable scripts.

Example

markdown
# Runbook: API Service Down
## Steps
1. Check recent deploys: kubectl rollout history deployment/api
2. Check pod health: kubectl get pods -l app=api
3. Rollback if needed: kubectl rollout undo deployment/api
4. Verify: curl https://api.example.com/health

A runbook guides the on-call responder through diagnosing and fixing the API. Each step has copy-pasteable commands and verification. No guessing under pressure.

Common confusions

  • Confused with: Documentation

    The difference: Documentation describes how a system works. A runbook describes what to DO. Documentation is for understanding; runbooks are for acting.

Related terms

Related Resources

Related Lessons

Decode error messages

Plain-English explanations of common errors — what they mean, why they happen, and how to fix them.

View errors

← Back to glossary