runbook

A written, step-by-step procedure for a routine operation or for responding to a known kind of incident.

In more detail

A good runbook lets someone who has never done the task before do it safely, and says who to call when it does not work. It records procedures and ownership, never the secrets themselves.

Examples

A Vault runbook records where each vault password comes from, who may use it and how to rotate it.
In AWS: A written, step-by-step guide for handling a specific alert or task, including safe first actions and when to escalate.
A runbook lets anyone on call repeat a task safely without rediscovering it. Commands in a runbook usually assume a particular distribution and release, so confirm the host matches before following it. Symbolic, targeted commands are easier to review in a runbook than commands that overwrite everything with a guessed value.
A runbook lists likely causes of a checkout error alert and the queries that tell them apart.
A SOC runbook tells tier one exactly what to check, what evidence to record, what they may do on their own authority and when to escalate.

Related terms

Taught in

References

Certification courses