Control diagnostic data scope

To restrict or expand the diagnostic scope, you can use environmental variables to configure Red Hat OpenStack Services on OpenShift (RHOSO) must-gather collectors.

Procedure
Copy link

To provide environmental variables, run the gathering command manually: 
$ oc adm must-gather --image=quay.io/openstack-k8s-operators/openstack-must-gather -- <VARIABLE>=<VALUE> gather

For example, to pass an empty SOS_SERVICES environmental variable to disable SOS gathering:

$ oc adm must-gather --image=quay.io/openstack-k8s-operators/openstack-must-gather -- SOS_SERVICES= gather

Must-gather environmental variables
Copy link

The default oc adm must-gather command gathers information from your cluster that is most likely needed for debugging issues, such as resource definitions and service logs. Use environmental variables to configure must-gather collectors for higher precision and resource management.

OSP_NS
Namespace where the RHOSO services are running. The default value is openstack.
OSP_OPERATORS_NS
Namespace where the RHOSO operators are running. The default value is openstack-operators.
CONCURRENCY
Must-gather can run many operations, so for efficiency the operations run in parallel with a concurrency of 5 by default.
SOS_SERVICES
Comma-separated list of services to gather the SOS reports from. You can set a value of an empty string to skip sos report gathering for that service.
SOS_ONLY_PLUGINS
List of SOS report plugins to use. You can set a value of an empty string to run all of the reports. The default value is: block,cifs,crio,devicemapper,devices,iscsi,lvm2,memory,multipath,nfs,nis,nvme,podman,process,processor,selinux,scsi,udev.
SOS_EDPM
Comma-separated list of edpm nodes to gather SOS reports from. You can set a value of an empty string to skip sos report gathering, or use the keyword all to gather from all the nodes, such as: edpm-compute-0,edpm-compute-1.
SOS_EDPM_PROFILES
List of sos report profiles to use. You can set a value of an empty string to run all of the reports. The default value is: container,openstack_edpm,system,storage,virt.
SOS_EDPM_PLUGINS
Optional list of sos report plugins to use.
OPENSTACK_DATABASES
Comma-separated list of RHOSO databases that you want to dump. You can set the value to the keyword all to dump all databases. The default value is an empty string and the database dump is skipped.
ADDITIONAL_NAMESPACES
Comma-separated list of additional namespaces where you want to gather the associated resources.
COMPRESSED_PATH
Defines the path to store the compressed form of the gathered data.
DELETE_AFTER_COMPRESSION
The default value is 0. If you set the value to 1, the uncompressed data is deleted after the archive is created.