Skip to content

Commit 8f7774b

Browse files
committed
BZ-1818830: Add list of supported must-gather images
1 parent 6a71337 commit 8f7774b

File tree

2 files changed

+98
-2
lines changed

2 files changed

+98
-2
lines changed

modules/gathering-data-specific-features.adoc

Lines changed: 95 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
// Module included in the following assemblies:
22
//
33
// * virt/logging_events_monitoring/virt-collecting-virt-data.adoc
4+
// * support/gathering-cluster-data.adoc
45

56
//This file contains UI elements and/or package names that need to be updated.
67

78
// Dependency: modules/virt-document-attributes.adoc
89

10+
ifeval::["{context}" == "gathering-cluster-data"]
11+
:from-main-support-section:
12+
:VirtProductName: container-native virtualization
13+
endif::[]
14+
915
[id="gathering-data-specific-features_{context}"]
1016
= Gathering data about specific features
1117

@@ -14,6 +20,68 @@ You can gather debugging information about specific features by using the
1420
The `must-gather` tool supports multiple images, so you can gather data about
1521
more than one feature by running a single command.
1622

23+
ifdef::from-main-support-section[]
24+
25+
ifndef::openshift-origin[]
26+
27+
.Supported must-gather images
28+
[cols="2,2",options="header"]
29+
|===
30+
|Image |Purpose
31+
32+
|`registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8`
33+
|Data collection for {VirtProductName}.
34+
35+
|`registry.redhat.io/openshift-serverless-1/svls-must-gather-rhel8`
36+
|Data collection for OpenShift Serverless.
37+
38+
|`registry.redhat.io/openshift-service-mesh/istio-must-gather-rhel7`
39+
|Data collection for Red Hat OpenShift Service Mesh.
40+
41+
|`registry.redhat.io/rhcam-1-2/openshift-migration-must-gather-rhel8`
42+
|Data collection for migration-related information.
43+
44+
|`registry.redhat.io/ocs4/ocs-must-gather-rhel8`
45+
|Data collection for Red Hat OpenShift Container Storage.
46+
47+
|===
48+
49+
endif::openshift-origin[]
50+
51+
ifdef::openshift-origin[]
52+
53+
.Available must-gather images
54+
[cols="2,2",options="header"]
55+
|===
56+
|Image |Purpose
57+
58+
|`quay.io/kubevirt/must-gather`
59+
|Data collection for KubeVirt.
60+
61+
|`quay.io/openshift-knative/must-gather`
62+
|Data collection for Knative.
63+
64+
|`docker.io/maistra/istio-must-gather`
65+
|Data collection for service mesh.
66+
67+
|`quay.io/konveyor/must-gather`
68+
|Data collection for migration-related information.
69+
70+
|`quay.io/ocs-dev/ocs-must-gather`
71+
|Data collection for OpenShift Container Storage.
72+
73+
|===
74+
75+
endif::openshift-origin[]
76+
77+
78+
endif::from-main-support-section[]
79+
80+
[NOTE]
81+
====
82+
To collect the default must-gather data in addition to specific feature data, add the `--image-stream=openshift/must-gather` argument.
83+
====
84+
1785
.Prerequisites
1886

1987
* Access to the cluster as a user with the `cluster-admin` role.
@@ -23,6 +91,8 @@ more than one feature by running a single command.
2391

2492
. Navigate to the directory where you want to store the `must-gather` data.
2593

94+
ifndef::openshift-origin[]
95+
2696
. Run the `oc adm must-gather` command with one or more `--image` or `--image-stream`
2797
arguments. For example, the following command gathers both the default cluster
2898
data and information specific to {VirtProductName}:
@@ -32,8 +102,26 @@ $ oc adm must-gather \
32102
--image-stream=openshift/must-gather \ <1>
33103
--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8 <2>
34104
----
35-
<1> Default {product-title} must-gather image
36-
<2> {VirtProductName} must-gather image
105+
<1> The default {product-title} must-gather image
106+
<2> The must-gather image for {VirtProductName}
107+
108+
endif::openshift-origin[]
109+
110+
ifdef::openshift-origin[]
111+
112+
. Run the `oc adm must-gather` command with one or more `--image` or `--image-stream`
113+
arguments. For example, the following command gathers both the default cluster
114+
data and information specific to KubeVirt:
115+
+
116+
----
117+
$ oc adm must-gather \
118+
--image-stream=openshift/must-gather \ <1>
119+
--image=quay.io/kubevirt/must-gather <2>
120+
----
121+
<1> The default {product-title} must-gather image
122+
<2> The must-gather image for KubeVirt
123+
124+
endif::openshift-origin[]
37125

38126
. Create a compressed file from the `must-gather` directory that was just created
39127
in your working directory. For example, on a computer that uses a Linux
@@ -47,3 +135,8 @@ actual directory name.
47135

48136
. Attach the compressed file to your support case on the
49137
link:https://access.redhat.com[Red Hat Customer Portal].
138+
139+
ifeval::["{context}" == "gathering-cluster-data"]
140+
:!from-main-support-section:
141+
:!VirtProductName:
142+
endif::[]

support/gathering-cluster-data.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,8 @@ include::modules/about-must-gather.adoc[leveloffset=+1]
1919
// Gathering data about your cluster for Red Hat Support
2020
include::modules/support-gather-data.adoc[leveloffset=+1]
2121

22+
// Gathering data about specific features
23+
include::modules/gathering-data-specific-features.adoc[leveloffset=+1]
24+
2225
// Obtain your cluster identifier
2326
include::modules/support-get-cluster-id.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)