openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Code Issues Releases Activity

MIG-1717-Removed conditions specific to OADP for the must-gather tool

Browse Source
This commit is contained in:
Apurva Bhide
2025-04-09 16:01:35 +05:30
committed by openshift-cherrypick-robot
parent c032b77ee5
commit c70ee7003f
1 changed files with 1 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
modules/migration-using-must-gather.adoc
View File

@@ -2,7 +2,6 @@
//
// * migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc
// * migration_toolkit_for_containers/troubleshooting-mtc.adoc
// * backup_and_restore/application_backup_and_restore/troubleshooting.adoc
:_mod-docs-content-type: PROCEDURE
[id="migration-using-must-gather_{context}"]
@@ -12,26 +11,14 @@ You can collect logs, metrics, and information about {local-product} custom reso
The `must-gather` data must be attached to all customer cases.
ifdef::troubleshooting-3-4,troubleshooting-mtc[]
You can collect data for a one-hour or a 24-hour period and view the data with the Prometheus console.
endif::[]
ifdef::oadp-troubleshooting[]
You can run the `must-gather` tool with the following data collection options:
* Full `must-gather` data collection collects Prometheus metrics, pod logs, and Velero CR information for all namespaces where the OADP Operator is installed.
* 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.
* `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.
* Prometheus metrics data dump downloads an archive file containing the metrics data collected by Prometheus.
endif::[]
.Prerequisites
* You must be logged in to the {product-title} cluster as a user with the `cluster-admin` role.
* You must have the OpenShift CLI (`oc`) installed.
ifdef::oadp-troubleshooting[]
* You must use {op-system-base-full} {op-system-version-9} with {oadp-short} 1.4.
endif::[]
.Procedure
@@ -56,6 +43,7 @@ $ oc adm must-gather --image=registry.redhat.io/rhmtc/openshift-migration-must-g
+
This operation can take a long time. This command saves the data as the `must-gather/metrics/prom_data.tar.gz` file.
endif::[]
ifdef::troubleshooting-mtc[]
* To collect data for the past 24 hours, run the following command:
+
@@ -74,39 +62,3 @@ $ oc adm must-gather --image=registry.redhat.io/rhmtc/openshift-migration-must-g
+
This operation can take a long time. This command saves the data as the `must-gather/metrics/prom_data.tar.gz` file.
endif::[]
ifdef::oadp-troubleshooting[]
* Full `must-gather` data collection, including Prometheus metrics:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4}
----
+
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].
* Essential `must-gather` data collection, without Prometheus metrics, for a specific time duration:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} \
-- /usr/bin/gather_<time>_essential <1>
----
<1> Specify the time in hours. Allowed values are `1h`, `6h`, `24h`, `72h`, or `all`, for example, `gather_1h_essential` or `gather_all_essential`.
* `must-gather` data collection with timeout:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} \
-- /usr/bin/gather_with_timeout <timeout> <1>
----
<1> Specify a timeout value in seconds.
* Prometheus metrics data dump:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather_metrics_dump
----
This operation can take a long time. The data is saved as `must-gather/metrics/prom_data.tar.gz`.
endif::[]