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

[CNV must-gather] one click solution for getting all the debug logs

XMLWordPrintable

    • cnv-one-click-mustgather
    • Hide

      We can get all must-gathers with a single oc command if they will opt in to be included in this mechanism.

      Show
      We can get all must-gathers with a single oc command if they will opt in to be included in this mechanism.
    • Green
    • To Do
    • CNV-11934 - Improved troubleshooting
    • 0% To Do, 0% In Progress, 100% Done
    • dev-ready, doc-ready, po-ready, qe-ready, ux-ready
    • Hide

      almost done...

      Show
      almost done...

      Goal

      We want to add a new CLI option named `--all-images` to the `oc adm must-gather` command.
      The oc client will scan all the CSVs on the cluster looking for `operators.openshift.io/must-gather-image=pullUrlOfTheImage` annotation building a list of must-gather images to be used to collect logs for all the products installed on the cluster and then the client will execute all of them aggregating the collection results.
      Operator authors that want to opt-in to this mechanism should explicitly annotate their CSV with ``operators.openshift.io/must-gather-image` annotation.

      User Stories

      • As a Cluster Admin, I want to execute a `oc adm must-gather` only once collecting all the logs for all the products deployed on my cluster without the need to  explicitly specify a long (and error prone) list of images
      • As a Red Hat support engineer, I want to be able to suggest to customers a single and simple command to collect must-gather logs for different products in a single pass reducing the request ping-pong came and so the case resolving time.

      Non-Requirements

      • List of things not included in this epic, to alleviate any doubt raised during the grooming process.

      Notes

      • Any additional details or decisions made/needed

          1.
          upstream roadmap issue Sub-task Closed Normal Unassigned
          2.
          upstream documentation Sub-task Closed Normal Unassigned
          3.
          upgrade consideration Sub-task Closed Normal Unassigned
          4.
          CEE/PX summary presentation Sub-task Closed Normal Unassigned
          5.
          test plans in polarion Sub-task Closed Normal Unassigned
          6.
          automated tests Sub-task Closed Normal Unassigned
          7.
          downstream documentation merged Sub-task Closed Normal Unassigned

              stirabos Simone Tiraboschi
              unassigned_jira Unassigned
              Debarati Basu-Nag Debarati Basu-Nag
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

                Created:
                Updated:
                Resolved: