Runbooks
Create and manage operational runbooks for incident response, deployment procedures, maintenance tasks, onboarding guides, and troubleshooting across your services.
Runbooks (/runbooks) are operational playbooks tied to specific services in your organization. They document how to respond to incidents, deploy safely, perform maintenance, onboard new team members, and troubleshoot common issues.
Runbooks list page
The main page shows all runbooks grouped by category, with search and filtering controls.
Summary tiles
Five tiles at the top show the total runbook count and per-category breakdowns for the four primary categories: Incident Response, Deployment, Maintenance, and Onboarding.
Search and filter
- Search -- full-text search across runbook titles
- Category filter -- dropdown to show only runbooks in a specific category
Grouped display
Runbooks are grouped by category, with each group showing its icon, label, and item count. Each runbook entry displays:
- Title (links to the detail page)
- Severity badge (P1, P2, or P3) if assigned
- Associated service/repository name
- Last updated date
- Up to three tags
Categories
| Category | Use case |
|---|---|
| Incident Response | Step-by-step procedures for handling service outages |
| Deployment | Pre-deployment checklists, deployment steps, rollback plans |
| Maintenance | Scheduled maintenance procedures and verification steps |
| Onboarding | Service architecture overviews and local setup guides |
| Troubleshooting | Diagnostic commands and fixes for common issues |
Creating a runbook
Click New Runbook to open the creation form at /runbooks/new. The form includes:
- Service (required) -- select the repository this runbook applies to, populated from your service catalog
- Title (required) -- a descriptive name for the runbook
- Category -- select from the five categories above
- Severity -- optional priority level (P1 Critical, P2 High, P3 Medium)
- Tags -- comma-separated labels for organization and filtering
- Content (required) -- the runbook body, written in Markdown
Starting from a template
If the content field is empty, a Start from a template prompt appears with buttons for each category. Clicking a category pre-fills the title and content with a structured template that includes relevant sections, placeholder commands, and best-practice headings.
The incident response template, for example, includes sections for detection, severity assessment, immediate actions, common failure modes with code snippets, escalation paths, and post-incident steps.
Runbook detail page
Each runbook has a detail page at /runbooks/[id] that renders the Markdown content with full formatting support, including code blocks, tables, and checklists.
Deleting a runbook
On the list page, hover over a runbook entry to reveal the delete button. Deletion requires confirmation and cannot be undone.