agentleFS
kryptophonikkryptophonik/SRE-Skills/.claude/skills/sre-runbook-templates/SKILL.md

sre-runbook-templates

Skill4 starsChanged 25 days agoMITView on GitHub

Use when creating or reviewing a runbook: full template with owner, scope, diagnosis, decision points, gated actions with rollback, verification, escalation and last-reviewed date.

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Wait for explicit human approval before any prod-changing command, MCP write tool, or external post.

    line 12
  2. Distinctive:

    Keep diagnosis steps read-only.

    line 23

≈ “Common” is an estimate: at least 1 in 5 of the 372,429 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Runbook Templates

Safety gates (REQUIRED)

  1. Read-only diagnosis first.
  2. Propose each change with risk (low/med/high) and reversibility.
  3. Wait for explicit human approval before any prod-changing command, MCP write tool, or external post.
  4. Act only as approved, verify, and stop and escalate if anything gets worse.

Full rules: sre-safety-gates. Read-only MCP setup: sre-safety-gates/references/mcp.md.

Complete runbook template for alerts and incidents.

How to use

  1. Copy the template below.
  2. Fill every field. Mark unknowns [TBD]; never guess.
  3. Keep diagnosis steps read-only.
  4. Give every action a risk, reversibility, and rollback. Each action requires approval per sre-safety-gates, using the risk catalog in sre-remediation-actions.
  5. Set Last reviewed whenever you change the runbook.

Template

# Runbook: [Alert or scenario name]

| Field | Value |
|---|---|
| Owner | [Team / service owner, contact] |
| Alert link | [URL to alert definition and dashboard] |
| Severity | [SEV-1..SEV-4 and paging policy] |
| Last reviewed | [YYYY-MM-DD by @reviewer] |

## Scope
- **Applies when:** [Symptoms/alert conditions this runbook covers]
- **Does not apply when:** [Situations where this runbook is wrong or dangerous; what to use instead]

## Impact
[User-facing impact and SLO affected]

## Diagnosis (read-only)
1. Check dashboard: [link]
2. Check dependencies: [DB, cache, upstream]
3. Check recent deploys/config changes: [command or link]
4. Capture evidence: logs, rollout history, heap dump if relevant

## Decision points
- If errors correlate with a deploy in the last 2h -> Action A (rollback)
- If dependency X is unhealthy -> escalate to owning team
- If none match -> escalate; do not improvise prod changes

## Actions (each requires approval per sre-safety-gates, using the risk catalog in sre-remediation-actions)

### Action A: [e.g., roll back deployment]
- **Command:** `[exact command]`
- **Risk:** [low | med | high]
- **Reversible:** [yes | no]
- **Rollback:** [how to undo]

## Verification
- [ ] SLO burn stopped
- [ ] Latency/5xx back to baseline
- [ ] Synthetic checks passing
- [ ] Stable for 15 min

## Escalation
1. Primary on-call: [rotation link]
2. Secondary: [rotation link]
3. Service owner: [contact]
- Escalate if: no improvement in [N] min, action fails, or impact grows

## References
[Architecture docs, past postmortems]

Output

  • A filled-in runbook in markdown using the template above; unknown fields marked [TBD]

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.