Bug 2010347 - OpenShift Alerting Rules Style-Guide Compliance
Summary: OpenShift Alerting Rules Style-Guide Compliance
Status: CLOSED DUPLICATE of bug 1992553
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Image Registry
Version: 4.10
Hardware: Unspecified
OS: Unspecified
Target Milestone: ---
: ---
Assignee: Oleg Bulatov
QA Contact: XiuJuan Wang
Depends On:
TreeView+ depends on / blocked
Reported: 2021-10-04 13:47 UTC by Brad Ison
Modified: 2021-10-04 13:51 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Last Closed: 2021-10-04 13:51:17 UTC
Target Upstream Version:

Attachments (Terms of Use)

Description Brad Ison 2021-10-04 13:47:20 UTC

The OpenShift Monitoring Team has published a set guidelines for
writing alerting rules in OpenShift, including a basic style guide.
You can find these here:


A subset of these are now being enforced in OpenShift End-to-End
tests [1], with temporary exceptions for existing non-compliant rules.

This component was found to have the following issues:

* Alerts without summary and/or description annotations:

  - ImageRegistryStorageReconfigured

Alerts MUST include summary and description annotations.

Think of summary as the first line of a commit message, or an email
subject line. It should be brief but informative. The description is
the longer, more detailed explanation of the alert.

The enhancement document linked above has examples of alerts with
these annotations.

Thank you!

Repo: openshift/cluster-image-registry-operator

[1]: https://github.com/openshift/origin/commit/097e7a6

Comment 1 Oleg Bulatov 2021-10-04 13:51:17 UTC

*** This bug has been marked as a duplicate of bug 1992553 ***

Note You need to log in before you can comment on or make changes to this bug.