Collect diagnostics with must-gather

On OpenShift Container Platform clusters, you can collect a diagnostic snapshot of the Che Operator, DevWorkspace-based Cloud Development Environments, and related cluster state by using the Che community-supported must-gather image with oc adm must-gather. Share this dump with others so they can help troubleshoot the issue.

Prerequisites

  • You are running Che on an OpenShift Container Platform cluster.

  • The oc OpenShift CLI is installed and configured for the target cluster. See Getting started with the OpenShift CLI.

  • You have cluster-admin permissions on the cluster.

  • Che is installed on the cluster.

Procedure

  1. Collect Che and DevWorkspace diagnostics:

    $ oc adm must-gather --image=quay.io/che-incubator/must-gather:latest

    The command creates a local directory named must-gather.local.<id> that contains the diagnostic dump.

    This must-gather image focuses on Che, DevWorkspace, and related components. To collect full cluster data, run oc adm must-gather without specifying a custom image.

  2. Optional: Write the output to a specific directory:

    $ oc adm must-gather --image=quay.io/che-incubator/must-gather:latest \
  --dest-dir=<directory_name>
Verification

  • A local must-gather.local.<id> directory (or the directory you passed to --dest-dir) exists and contains the diagnostic dump.