Chapter 2. Gathering data about your cluster
When opening a support case, it is often helpful to provide debugging information about your cluster to Red Hat Support.
It is recommended to provide:
2.1. Gathering data about your cluster for Red Hat Support
The oc adm must-gather CLI command collects the information from your cluster that is most likely needed for debugging issues, such as:
- Resource definitions
- Audit logs
- Service logs
Prerequisites
-
Access to the cluster as a user with the
cluster-adminrole.
Procedure
Run the
oc adm must-gathercommand:$ oc adm must-gather
This creates a Pod on the cluster to perform the data collection on. All of the collected resources and data from your cluster are saved in the current directory in a new directory that starts with
must-gather.local.Create a compressed file from the
must-gatherdirectory. For example, on a computer that uses a Linux operating system, run the following command:$ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/
- Attach the compressed file to your support case on the Red Hat Customer Portal.
2.2. Obtaining your cluster ID
When providing information to Red Hat Support, it is helpful to provide the unique identifier for your cluster. You can obtain your cluster ID by using the OpenShift CLI (oc) or by using the OpenShift Container Platform web console.
Prerequisites
-
Access to the cluster as a user with the
cluster-adminrole. -
The OpenShift Container Platform CLI (
oc) installed.
Procedure
To obtain your cluster ID using the OpenShift CLI (
oc), run the following command:$ oc get clusterversion -o jsonpath='{.items[].spec.clusterID}{"\n"}'To obtain your cluster ID using the OpenShift Container Platform web console:
-
Navigate to Administration
Cluster Settings. - The value is available in the Cluster ID field of the Overview tab.
-
Navigate to Administration
