Skip to main content

Runbook Template

info

Copy this template when creating a new runbook. Delete this info box in your copy.

[Runbook Title]

Overview​

Brief description of what this runbook accomplishes and when to use it.

Prerequisites​

  • Required access/permissions: e.g., Azure DevOps, AWS Console, 1Password vault
  • Required tools: e.g., Azure CLI, pnpm, Python
  • Required knowledge: e.g., familiarity with deployment pipelines

When to Use​

Describe the scenarios or triggers that would require following this runbook.

  • Scenario 1: e.g., Scheduled production release
  • Scenario 2: e.g., Hotfix deployment

Procedure​

Step 1: [Step Title]​

Purpose: Why this step is necessary

# Example command
command --with-flags

Expected Output:

Expected output or success message

Verification: How to confirm this step succeeded

Step 2: [Step Title]​

Purpose: Why this step is necessary

  1. Navigate to [Location/URL]
  2. Click on [Button/Menu]
  3. Enter the following values:
    • Field 1: value
    • Field 2: value

Verification: How to confirm this step succeeded

Step 3: [Step Title]​

Continue with additional steps...

Post-Procedure Verification​

  • Verification check 1: e.g., Application loads without errors
  • Verification check 2: e.g., Health check endpoint returns 200
  • Verification check 3: e.g., Analytics events are being received

Rollback Procedure​

If something goes wrong, follow these steps to revert:

  1. Step to undo the changes
  2. Step to restore previous state
  3. Step to verify rollback succeeded

Troubleshooting​

ProblemPossible CauseSolution
Error message or symptomWhy this might happenHow to fix it
Error message or symptomWhy this might happenHow to fix it

Escalation​

If you cannot resolve an issue:

  1. Slack Channel: #channel-name
  2. On-Call Contact: team or person
  3. Escalation Path: who to contact if on-call cannot resolve
  • [Link to related doc 1]
  • [Link to related doc 2]