diff --git a/boilerplate/openshift/doc/sre-operator-observability-template.md b/boilerplate/openshift/doc/sre-operator-observability-template.md new file mode 100644 index 00000000..da938eed --- /dev/null +++ b/boilerplate/openshift/doc/sre-operator-observability-template.md @@ -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.