openshift-must-gather is a tool for collecting cluster data.
clusteroperator data, and associated namespace data, into a specified
The directory structure, as well as specific details behind this tool can be found in this enhancement.
Data collection scripts are kept in
./collection-scripts. The content of that folder is placed in
/usr/bin in the image.
The data collection scripts should only include collection logic for components that are included as part of the OpenShift
CVO payload. Outside components are encouraged to produce a similar "must-gather" image, but this is not the spot to be
How to run
You can run
must-gather on a cluster with
oc adm must-gather.
-h flag to see available options.
Obfuscate confidential information
There is a dedicated to obfuscate and omit confidential information. Head over to openshift/must-gather-clean for more information.