Operations pillar · v0.16.0
runbook Runbook
Operational runbook.
$id · https://corpospec.com/schemas/v0.16.0/runbook.schema.json
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| entity | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| id | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| last_drilled | IsoDate | yes | ISO 8601 date (YYYY-MM-DD). |
| name | string | yes | |
| next_drill_due | IsoDate | yes | ISO 8601 date (YYYY-MM-DD). |
| owner | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| recent_executions | RunbookExecution[] | yes | Recent executions for MTTR analysis. |
| status | RunbookStatus | yes | Lifecycle. |
| steps | RunbookStep[] | yes | |
| system | PathRef | yes | PathRef to the system / service this runbook applies to. |
| trigger | RunbookTrigger | yes | Trigger type. |
| trigger_summary | string | yes | Symptom / alert that this runbook resolves. |
| version | Semver | yes | Semantic version string (MAJOR.MINOR.PATCH). |
| dashboard_ref | PathRef? | — | PathRef to monitoring / dashboard. |
| parent_sop | PathRef? | — | PathRef to any related SOP. |
Definitions
Shared types referenced within this schema.
IsoDate
ISO 8601 date (YYYY-MM-DD).
type: string
PathRef
Path-based cross-reference relative to .corpospec/ root.
Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$
RunbookExecution
Last execution of the runbook.
type: object
RunbookStatus
Lifecycle.
RunbookStep
One runbook step.
type: object
RunbookTrigger
Trigger type.
Semver
Semantic version string (MAJOR.MINOR.PATCH).
pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$
StepKind
Step kind.
Reference in your YAML
# yaml-language-server: $schema=https://corpospec.com/schemas/v0.16.0/runbook.schema.json