Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions boilerplate/openshift/doc/sre-operator-observability-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# SRE Operator Observability Compliance Card

## Operator name

### Intended Purpose

What purpose does the operator serve?

### Blast Radius (customer-facing or internal)

Provide details about the blast radius of the operator as it pertains to SREs, and then provide details that pertain to the customer view.

### Key Metrics and Alerts

Document metrics and alerts that are key for SRE remediation of operational disruptions of the operator.

### Responsible Parties

List the individuals who will be paged in the event of an incident.

### Post-promotion Health Signals

List the health signals that, upon inspection, verfiy that the operator is functioning properly post-promotion.