Uploaded image for project: 'OpenShift Over the Air'
  1. OpenShift Over the Air
  2. OTA-1174

Show links to SOP/documentation for insights with --details


    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • None
    • OTA 249, OTA 250, OTA 251, OTA 252

      OpenShift Update Concepts proposes a --details option that should supply the insights with SOP/documentation links, but does not give an example of how the output would look like:

      =Update Health= 
      3h		Warning		API Availability	High control plane CPU during upgrade
      Resolved	Info		Update Speed		Pod is slow to terminate
      4h		Info		Update Speed		Pod was slow to terminate
      30m		Info		None			Worker node version skew
      1h		Info		None			Update worker node
      Run with --details for additional description and links to online documentation.

      Justin's design ideas contain a remediation struct for this which I like.

      Definition of Done:

      • With --details, every insight will have two more fields - description and remediation URL (runbook, documentation...). Both mandatory.
      • Output will not be a table, but a oc describe -like tree output
      • For CO insights, we stop putting the (potentially long) CO condition message into insight message, but place it in new description  field instead.
      • We can use the links to generic alert runbooks that someone asks us to do in alerts (OCPBUGS-14246)

            afri@afri.cz Petr Muller
            afri@afri.cz Petr Muller
            0 Vote for this issue
            4 Start watching this issue