Bug 1818830

Summary: Document supported must-gather images
Product: OpenShift Container Platform Reporter: Andrea Hoffer <ahoffer>
Component: DocumentationAssignee: Andrea Hoffer <ahoffer>
Status: CLOSED CURRENTRELEASE QA Contact: zhou ying <yinzhou>
Severity: unspecified Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: unspecifiedCC: aos-bugs, dmoessne, dsilvaju, ealcaniz, erich, jokerman, palonsor, rheinzma, yinzhou
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-07-28 19:53:34 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Andrea Hoffer 2020-03-30 13:25:32 UTC 
Document URL: 

https://docs.openshift.com/container-platform/4.3/support/gathering-cluster-data.html

Section Number and Name: 

Gathering data about your cluster

Describe the issue: 

There are now several supported images for must-gather, but we only document how to run the default must-gather image.

Suggestions for improvement: 

* Document the list of supported must-gather images. Be sure to include downstream image for OCP vs. upstream image for OKD.
* Document how to run using multiple images.

Additional information: 

CNV documents using their image here: https://docs.openshift.com/container-platform/4.3/cnv/cnv_logging_events_monitoring/cnv-collecting-cnv-data.html#gathering-data-specific-features_cnv-collecting-cnv-data
Comment 1 Andrea Hoffer 2020-03-30 13:29:30 UTC 
From Eric Rich:

OCS, Service Mesh, kubevirt, knative. Also looking into SRI-OV as well.

* https://github.com/kubevirt/must-gather#usage
* https://maistra.io/docs/troubleshooting/must_gather/
* https://github.com/openshift/ocs-operator/tree/master/must-gather
Comment 2 Andrea Hoffer 2020-03-30 13:56:59 UTC 
Downstream image for service mesh (from Jonh Wendell): --image=registry.redhat.io/openshift-service-mesh/istio-must-gather-rhel7:1.0
Comment 3 Andrea Hoffer 2020-06-01 18:02:56 UTC 
PR to add list of supported must-gather images: https://github.com/openshift/openshift-docs/pull/22456
Comment 4 Andrea Hoffer 2020-06-25 15:12:05 UTC 
@Ying Zhou, can you please review this update? Thanks!

PR: https://github.com/openshift/openshift-docs/pull/22456

Previews:

    (OCP): https://bz-1818830--ocpdocs.netlify.app/openshift-enterprise/latest/support/gathering-cluster-data.html#gathering-data-specific-features_gathering-cluster-data
    (OKD): https://bz-1818830--ocpdocs.netlify.app/openshift-origin/latest/support/gathering-cluster-data.html#gathering-data-specific-features_gathering-cluster-data
Comment 5 zhou ying 2020-06-28 05:31:03 UTC 
For doc : (OKD): https://bz-1818830--ocpdocs.netlify.app/openshift-origin/latest/support/gathering-cluster-data.html#gathering-data-specific-features_gathering-cluster-data , the example command better to use image in the table: Table 1. Available must-gather images
Comment 6 zhou ying 2020-07-01 03:40:16 UTC 
Have reviewed the doc , and add /lgtm tag , will verify this issue.
Comment 7 Andrea Hoffer 2020-07-01 16:04:12 UTC 
PRs have been merged.
Comment 8 Andrea Hoffer 2020-07-28 19:53:34 UTC 
Updates are live: https://docs.openshift.com/container-platform/4.5/support/gathering-cluster-data.html#gathering-data-specific-features_gathering-cluster-data