Uploaded image for project: 'OpenShift Virtualization'
  1. OpenShift Virtualization
  2. CNV-75199

Doc: Review and update downstream runbooks for the new VM alerts

XMLWordPrintable

    • Quality / Stability / Reliability
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • Hide

      New alerts added to runbooks repo, wordsmithed, runbooks updated in the documentation, release note

      Show
      New alerts added to runbooks repo, wordsmithed, runbooks updated in the documentation, release note
    • None
    • None

      New VM alerts are added in 4.22

      • Update the runbook links to add the new alerts
      • Add release note
      • As a user, I want to find alert names in the documentation along with links to the source of truth, where I can find a description of the alert, in the openshift/runbooks repo.

      Background

      • KubeVirt runbooks are versionless.
      • KubeVirt runbooks are published in the kubevirt/monitoring GitHub repo.
      • OpenShift Virtualization runbooks are published as upstream Markdown files (openshift/runbooks).
      • In the downstream docs, we include a list of the alerts where each alert links to the alert in https://github.com/openshift/runbooks.

      Goals

      • Add new alerts to the list of alerts in the documentation.
      • Edit alert descriptions in the openshift/runbooks repo to ensure the descriptions are clearly explained.

      Updating the runbooks

      Runbooks contain information to help users diagnose and resolve issues that trigger OpenShift Virtualization alerts in the OpenShift Container Platform web console.

      The purpose of this Jira is to maintain the list of alerts in the documentation by adding new alerts and/or deprecating old alerts.

      Example: ticket for 4.19: https://issues.redhat.com/browse/CNV-52798

              Unassigned Unassigned
              ctomasko Catherine Tomasko
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: