Runbook template
A runbook is read under pressure. Put the symptom first, keep steps numbered and copy-pasteable. Delete every template comment before committing.
markdown
---
title: {{title}}
description: {{description}}
type: runbook
since: {{since}}
---
<!-- template: a runbook is read under pressure. Put the symptom first, keep steps numbered and copy-pasteable. Delete every template comment before committing. -->
## When to use this
The alert, symptom or situation that sends someone here.
## Impact
What users or systems are affected, and how badly.
## Check first
```bash
<command that shows the current state>
```
## Procedure
1. <Step one>
2. <Step two>
3. <Step three>
## Verify recovery
How to confirm the problem is fixed.
## Roll back
How to undo the procedure if it makes things worse.
## Escalate
Who to contact, and when.
## Related
- [<Related runbook>](./related.md)Something wrong or missing on this page?Report a docs issue