Ops: Runbooks

Public

Runbooks are step-by-step guides for routine operations. Keep them accurate and test them quarterly.

Structure

  • Purpose and scope.
  • Pre-checks and prerequisites.
  • Executable steps with validation checkpoints.
  • Rollback steps and contacts.

Where to Find

All runbooks live alongside the service repositories with links from the internal portal. Use the latest main branch unless instructed otherwise.

Template

  1. Context and owner
  2. Inputs and risks
  3. Procedure
  4. Verification and rollback
Tip

Prefer scripts and toggles over manual steps. If a step is error-prone, automate it.

Related docs