Skip to main content

Service Runbook Template

# Service Runbook

## Service

- Name:
- Service ID:
- Owner:
- Readiness:

## Purpose

What does this service provide?

## Start

\`\`\`text
command goes here
\`\`\`

## Stop

\`\`\`text
command goes here
\`\`\`

## Restart

\`\`\`text
command goes here
\`\`\`

## Status

\`\`\`text
command goes here
\`\`\`

## Health Check

\`\`\`text
command or endpoint goes here
\`\`\`

## Ports

| Name | Port | Protocol | Bind | Required |
| --- | ---: | --- | --- | --- |

## Paths

- State:
- Cache:
- Logs:
- Temporary:

## Dependencies

- Service dependencies:
- File dependencies:
- Network dependencies:

## Recovery

What should an operator do after failure?

## Agent Rules

- What may agents inspect?
- What may agents restart?
- What requires operator approval?

## Known Failure Modes

- Failure:
- Symptom:
- Next safe action: