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

DOC: Storage checkup documentation lacks context when there is a failure

XMLWordPrintable

    • Quality / Stability / Reliability
    • 5
    • False
    • True
    • None
    • None

      Description of problem:

      The storage checkup documentation (https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/virtualization/monitoring#virt-checking-storage-configuration_virt-running-cluster-checkups) lacks a documented flow of what to do if the storage checkup fails.
      
      To improve usability, we suggest including steps to help users collect the necessary information for failure analysis to share them with engineering:
      
      - Document the available skipTearDown modes, and recommend enabling the onfailure mode so resources are retained after a failed checkup for easier debugging. (See https://github.com/kiagnose/kubevirt-storage-checkup/blob/main/README.md#skipteardown-modes).
      
      - Add an optional step after “6. Review the results of the checkup …” that explains what to do if the checkup fails. This should include a link to must-gather documentation so users can collect the relevant resources for debugging and investigate the failed resources.    

      Version-Release number of selected component (if applicable):

       

      How reproducible:

      Always

      Steps to Reproduce:

      1.
      2.
      3.
      

      Actual results:

       

      Expected results:

       

      Additional info:

       

              abrennan@redhat.com Ashleigh Brennan
              rh-ee-alromero Alvaro Romero
              Yan Du Yan Du
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: