Operational Runbook Block
Create operational runbooks with step-by-step procedures, commands, prerequisites, and rollback instructions.
Overview
The Operational Runbook block documents step-by-step operational procedures for routine tasks, deployments, and incident response. Each step includes actions, notes, and optional commands. The block also captures prerequisites, rollback procedures, and escalation paths. Use this block to standardise operational procedures.
Database Failover Runbook
An operational runbook for database failover procedures.
Block Properties
| Property | Required | Description |
|---|---|---|
| title | Yes | Runbook title |
| trigger | No | When this runbook should be used |
| prerequisites | No | Array of prerequisites before starting |
| steps | No | Array of steps with order, action, notes, and optional command |
| rollback | No | Rollback procedure if things go wrong |
| escalation | No | When and how to escalate |
| owner | No | Team responsible for this runbook |