Skip to content

Commit 60bb1f4

Browse files
authored
Merge pull request #91906 from apurvabhide17/MIG-1717-simplify-must-gather-file
MIG-1717-Removed conditions specific to OADP for the must-gather tool
2 parents 8704b47 + 5611283 commit 60bb1f4

File tree

1 file changed

+1
-49
lines changed

1 file changed

+1
-49
lines changed

modules/migration-using-must-gather.adoc

+1-49
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
//
33
// * migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc
44
// * migration_toolkit_for_containers/troubleshooting-mtc.adoc
5-
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
65

76
:_mod-docs-content-type: PROCEDURE
87
[id="migration-using-must-gather_{context}"]
@@ -12,26 +11,14 @@ You can collect logs, metrics, and information about {local-product} custom reso
1211

1312
The `must-gather` data must be attached to all customer cases.
1413

15-
ifdef::troubleshooting-3-4,troubleshooting-mtc[]
1614
You can collect data for a one-hour or a 24-hour period and view the data with the Prometheus console.
17-
endif::[]
18-
ifdef::oadp-troubleshooting[]
19-
You can run the `must-gather` tool with the following data collection options:
2015

21-
* Full `must-gather` data collection collects Prometheus metrics, pod logs, and Velero CR information for all namespaces where the OADP Operator is installed.
22-
* Essential `must-gather` data collection collects pod logs and Velero CR information for a specific duration of time, for example, one hour or 24 hours. Prometheus metrics and duplicate logs are not included.
23-
* `must-gather` data collection with timeout. Data collection can take a long time if there are many failed `Backup` CRs. You can improve performance by setting a timeout value.
24-
* Prometheus metrics data dump downloads an archive file containing the metrics data collected by Prometheus.
25-
endif::[]
2616

2717
.Prerequisites
2818

2919
* You must be logged in to the {product-title} cluster as a user with the `cluster-admin` role.
3020
* You must have the OpenShift CLI (`oc`) installed.
3121
32-
ifdef::oadp-troubleshooting[]
33-
* You must use {op-system-base-full} {op-system-version-9} with {oadp-short} 1.4.
34-
endif::[]
3522
3623
.Procedure
3724

@@ -56,6 +43,7 @@ $ oc adm must-gather --image=registry.redhat.io/rhmtc/openshift-migration-must-g
5643
+
5744
This operation can take a long time. This command saves the data as the `must-gather/metrics/prom_data.tar.gz` file.
5845
endif::[]
46+
5947
ifdef::troubleshooting-mtc[]
6048
* To collect data for the past 24 hours, run the following command:
6149
+
@@ -74,39 +62,3 @@ $ oc adm must-gather --image=registry.redhat.io/rhmtc/openshift-migration-must-g
7462
+
7563
This operation can take a long time. This command saves the data as the `must-gather/metrics/prom_data.tar.gz` file.
7664
endif::[]
77-
ifdef::oadp-troubleshooting[]
78-
* Full `must-gather` data collection, including Prometheus metrics:
79-
+
80-
[source,terminal,subs="attributes+"]
81-
----
82-
$ oc adm must-gather --image={must-gather-v1-4}
83-
----
84-
+
85-
The data is saved as `must-gather/must-gather.tar.gz`. You can upload this file to a support case on the link:https://access.redhat.com/[Red Hat Customer Portal].
86-
87-
* Essential `must-gather` data collection, without Prometheus metrics, for a specific time duration:
88-
+
89-
[source,terminal,subs="attributes+"]
90-
----
91-
$ oc adm must-gather --image={must-gather-v1-4} \
92-
-- /usr/bin/gather_<time>_essential <1>
93-
----
94-
<1> Specify the time in hours. Allowed values are `1h`, `6h`, `24h`, `72h`, or `all`, for example, `gather_1h_essential` or `gather_all_essential`.
95-
96-
* `must-gather` data collection with timeout:
97-
+
98-
[source,terminal,subs="attributes+"]
99-
----
100-
$ oc adm must-gather --image={must-gather-v1-4} \
101-
-- /usr/bin/gather_with_timeout <timeout> <1>
102-
----
103-
<1> Specify a timeout value in seconds.
104-
105-
* Prometheus metrics data dump:
106-
+
107-
[source,terminal,subs="attributes+"]
108-
----
109-
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather_metrics_dump
110-
----
111-
This operation can take a long time. The data is saved as `must-gather/metrics/prom_data.tar.gz`.
112-
endif::[]

0 commit comments

Comments
 (0)