Operational Runbook

Use this template when documenting a repeatable operational procedure. Completed runbooks belong in process/ or technology/ depending on scope.

When to Use

Defining a deployment, migration, or maintenance procedure.
Documenting incident response steps.
Creating on-call reference material for operational tasks.

Target Section

process/ (development workflows) or technology/ (infrastructure procedures).

Template

---
title: "Runbook: Operation Title"
tags: [runbook, operations]
domain: process
maturity: published
author: DevOps Engineer
---

# Runbook: [Operation Title]

**Author**: DevOps Engineer
**Date**: YYYY-MM-DD
**Last Verified**: YYYY-MM-DD
**Environments**: dev | stage | prod

## Purpose

Brief description of when and why this runbook is used.

## Prerequisites

- **Access required**: [e.g., AWS console, kubectl, bastion host, 1Password vault]
- **Tools required**: [e.g., AWS CLI, Helm, Flyway CLI, psql]
- **Permissions required**: [e.g., IAM role, Kubernetes RBAC]

## Procedure

### Step 1: [Action]

```bash
[command or instruction]
```

**Expected output**: [describe what success looks like]

### Step 2: [Action]

```bash
[command or instruction]
```

**Expected output**: [describe what success looks like]

### Step 3: [Action]

```bash
[command or instruction]
```

**Expected output**: [describe what success looks like]

## Verification

How to confirm the operation completed successfully:

- [ ] [Verification check 1]
- [ ] [Verification check 2]
- [ ] [Verification check 3]

## Rollback

If the operation fails or produces unexpected results:

### Step 1: [Rollback Action]

```bash
[command or instruction]
```

### Step 2: [Rollback Action]

```bash
[command or instruction]
```

## Troubleshooting

| Symptom | Likely Cause | Resolution |
|---|---|---|
| [Error message or behavior] | [Root cause] | [Fix] |
| [Error message or behavior] | [Root cause] | [Fix] |

## Related Runbooks

- [Link to related runbooks]

## Change History

| Date | Author | Change |
|---|---|---|
| YYYY-MM-DD | [name] | Initial version |