Blame
|
1 | # Template — Service Runbook |
||||||
| 2 | ||||||||
| 3 | ## Purpose |
|||||||
| 4 | ||||||||
| 5 | What this runbook restores or changes, and when to use it. |
|||||||
| 6 | ||||||||
| 7 | ## Preconditions |
|||||||
| 8 | ||||||||
| 9 | Required access, backups, maintenance state and checks before starting. Reference secret locations without copying secrets. |
|||||||
| 10 | ||||||||
| 11 | ## Procedure |
|||||||
| 12 | ||||||||
| 13 | Numbered, executable steps. Put commands in code blocks and state expected output/checkpoints. |
|||||||
| 14 | ||||||||
| 15 | ## Verification |
|||||||
| 16 | ||||||||
| 17 | How to prove the service is healthy from the user's perspective. |
|||||||
| 18 | ||||||||
| 19 | ## Rollback |
|||||||
| 20 | ||||||||
| 21 | Exact safe rollback boundary and data/config implications. |
|||||||
| 22 | ||||||||
| 23 | ## Escalation |
|||||||
| 24 | ||||||||
| 25 | Which product/service owner or specialist is required when the procedure does not recover the system. |
|||||||
| 26 | ||||||||
| 27 | ## Last validation |
|||||||
| 28 | ||||||||
| 29 | Date and version/environment on which this runbook was actually exercised. |
|||||||