SIS / runbook

Service-Runbook.md

Capture how to start, stop, inspect and recover a service.

DownloadView source file Read related standard See example

Useful when

A service is difficult to operate.

Choose your situation

What you should change

Replace commands, logs, dependencies and recovery steps.

Use only the parts that help. These are starting points, not rigid requirements.

View resource

# 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: