Runbook template
Status: Template only — not a verified installation procedure.
| Field | Value |
|---|---|
| Service / topic | SERVICE_NAME |
| Last tested | YYYY-MM-DD |
| Supported OS | OS / VERSION |
| Dependency versions | VERSION / REFERENCE |
| Owner | DOCUMENT OWNER |
| Status | tested / partially tested / proposed |
1. Goal and prerequisites
Describe purpose, scope, permissions, supported hardware, network access and required packages.
2. Configuration
Document safe sample variables in .env.example; never include live tokens, private addresses, passwords or customer data.
3. Installation
Include version-pinned, reviewed commands copied from an independently verified setup. Avoid copy-and-run placeholders until commands have been tested.
4. Verification
Record expected process status, health endpoint output, functional smoke tests, logs, and clear pass/fail criteria.
5. Troubleshooting
| Symptom | Diagnostic | Likely cause | Recovery |
|---|---|---|---|
| Example only | SERVICE_STATUS_COMMAND | To be validated | To be validated |
6. Rollback and recovery
State backup requirements, upgrade compatibility, rollback commands, and what is not automatically restored.
7. Security and evidence
Record authentication expectations, log redaction, network exposure review and links to publicly shareable evidence. Set publication status only after technical and confidentiality reviews.