Meta – Template Runbook
Dmitrii Iurco edited this page 2026-06-11 15:39:28 -04:00

Status: Active | Owner: @roof | Updated: 2026-06-11

Meta – Template Runbook

This is a copy-only skeleton. To use it: copy the full content into a new page, rename the page with the appropriate prefix and title, fill in each section, and delete this notice.

New Admin pages that describe a procedure must follow this shape.


> **Status:** Draft | **Owner:** @username | **Applies to:** vX.Y+ | **Updated:** YYYY-MM-DD

# Admin – <Verb> <Object>

One sentence: what this runbook achieves and why someone would run it.

---

## Purpose

What outcome does this procedure produce? When should an admin run it?

---

## Prerequisites

- List everything that must be true before you start.
- Include: access requirements, services that must be running, backups that should exist.
- Example: "Cell is running (`make status` shows all containers healthy)."
- Example: "You have a recent backup — see [[Admin – Back Up and Restore]]."

---

## Steps

1. First step. One action only. State the exact command or UI action.

   ```bash
   # Run on: <where — e.g. "the cell server host, from /opt/pic", "the cell server as root">
   # Requires: <any precondition>
   <command>

You should now see: .

  1. Second step.

    ⚠️ Warning: <State exactly what is destroyed or irreversible, if applicable.>

  2. Continue numbering steps to completion.


Verification

How do you confirm the procedure worked?

  • List expected outputs, log lines, or UI states.
  • Include at least one command the admin can run to verify.
# Run on: <where>
<verification command>

Expected output: <what success looks like>.


Rollback

If the procedure fails or produces the wrong result, how do you undo it?