Using must-gather

The must-gather tool for Forklift collects logs, metrics, and information about Forklift custom resources.

Prerequisites

• You must be logged in to the KubeVirt cluster as a user with the cluster-admin role.

• You must have the OKD CLI (oc) installed.

Procedure

1. Navigate to the directory where you want to store the must-gather data.

2. Run the oc adm must-gather command with the --image argument:

   $ oc adm must-gather --image=quay.io/konveyor/forklift-must-gather:latest

   The data is saved in a local must-gather directory.

3. To view Prometheus metrics data:

   1. Run the oc adm must-gather command with the gather_metrics_dump script:

      $ oc adm must-gather --image quay.io/konveyor/forklift-must-gather:latest -- /usr/bin/gather_metrics_dump

      Note	This process might take a long time. The tool processes the most recent prom_data.tar.gz file in the /must-gather/metrics directory.

   2. Create a local Prometheus instance to display the data:

      $ make prometheus-run

   3. After you have viewed the data, delete the Prometheus instance and data:

      $ make prometheus-cleanup