1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 06:46:26 +01:00
Files
openshift-docs/modules/gathering-data-specific-features.adoc
2020-11-17 21:06:46 +00:00

137 lines
4.1 KiB
Plaintext

// Module included in the following assemblies:
//
// * virt/logging_events_monitoring/virt-collecting-virt-data.adoc
// * support/gathering-cluster-data.adoc
//This file contains UI elements and/or package names that need to be updated.
// Dependency: modules/virt-document-attributes.adoc
ifeval::["{context}" == "gathering-cluster-data"]
:from-main-support-section:
:VirtProductName: OpenShift Virtualization
endif::[]
[id="gathering-data-specific-features_{context}"]
= Gathering data about specific features
You can gather debugging information about specific features by using the `oc adm must-gather` CLI command with the `--image` or `--image-stream` argument. The `must-gather` tool supports multiple images, so you can gather data about more than one feature by running a single command.
ifdef::from-main-support-section[]
ifndef::openshift-origin[]
.Supported must-gather images
[cols="2,2",options="header",subs="attributes+"]
|===
|Image |Purpose
|`registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{HCOVersion}`
|Data collection for {VirtProductName}.
|`registry.redhat.io/openshift-serverless-1/svls-must-gather-rhel8`
|Data collection for OpenShift Serverless.
|`registry.redhat.io/openshift-service-mesh/istio-must-gather-rhel7`
|Data collection for Red Hat OpenShift Service Mesh.
|`registry.redhat.io/rhcam-1-2/openshift-migration-must-gather-rhel8`
|Data collection for migration-related information.
|`registry.redhat.io/ocs4/ocs-must-gather-rhel8`
|Data collection for Red Hat OpenShift Container Storage.
|===
endif::openshift-origin[]
ifdef::openshift-origin[]
.Available must-gather images
[cols="2,2",options="header"]
|===
|Image |Purpose
|`quay.io/kubevirt/must-gather`
|Data collection for KubeVirt.
|`quay.io/openshift-knative/must-gather`
|Data collection for Knative.
|`docker.io/maistra/istio-must-gather`
|Data collection for service mesh.
|`quay.io/konveyor/must-gather`
|Data collection for migration-related information.
|`quay.io/ocs-dev/ocs-must-gather`
|Data collection for OpenShift Container Storage.
|===
endif::openshift-origin[]
endif::from-main-support-section[]
[NOTE]
====
To collect the default `must-gather` data in addition to specific feature data, add the `--image-stream=openshift/must-gather` argument.
====
.Prerequisites
* Access to the cluster as a user with the `cluster-admin` role.
* The {product-title} CLI (`oc`) installed.
.Procedure
. Navigate to the directory where you want to store the `must-gather` data.
ifndef::openshift-origin[]
. Run the `oc adm must-gather` command with one or more `--image` or `--image-stream` arguments. For example, the following command gathers both the default cluster data and information specific to {VirtProductName}:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather \
--image-stream=openshift/must-gather \ <1>
--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{HCOVersion} <2>
----
<1> The default {product-title} `must-gather` image
<2> The must-gather image for {VirtProductName}
endif::openshift-origin[]
ifdef::openshift-origin[]
. Run the `oc adm must-gather` command with one or more `--image` or `--image-stream` arguments. For example, the following command gathers both the default cluster data and information specific to KubeVirt:
+
[source,terminal]
----
$ oc adm must-gather \
--image-stream=openshift/must-gather \ <1>
--image=quay.io/kubevirt/must-gather <2>
----
<1> The default {product-title} `must-gather` image
<2> The must-gather image for KubeVirt
endif::openshift-origin[]
. Create a compressed file from the `must-gather` directory that was just created in your working directory. For example, on a computer that uses a Linux
operating system, run the following command:
+
[source,terminal]
----
$ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/ <1>
----
<1> Make sure to replace `must-gather-local.5421342344627712289/` with the
actual directory name.
. Attach the compressed file to your support case on the link:https://access.redhat.com[Red Hat Customer Portal].
ifeval::["{context}" == "gathering-cluster-data"]
:!from-main-support-section:
:!VirtProductName:
endif::[]