Skip to content

Commit ba35beb

Browse files
shdeshpa07shdeshpa07
committed
OADP must-gather for 1.4.5
Signed-off-by: Shruti Deshpande <shdeshpa@redhat.com>
1 parent aa7ffc9 commit ba35beb

File tree

3 files changed

+77
-60
lines changed

3 files changed

+77
-60
lines changed

‎backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc

Lines changed: 5 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -2,75 +2,20 @@
22
[id="using-the-must-gather-tool"]
33
= Using the must-gather tool
44
include::_attributes/common-attributes.adoc[]
5-
include::_attributes/attributes-openshift-dedicated.adoc[]
65
:context: using-the-must-gather-tool
7-
:namespace: openshift-adp
8-
:local-product: OADP
9-
:must-gather-v1-3: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.3
106
:must-gather-v1-4: registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.4
117

128
toc::[]
139

14-
You can collect logs, metrics, and information about {local-product} custom resources by using the `must-gather` tool. The `must-gather` data must be attached to all customer cases.
10+
You can collect logs and information about {oadp-short} custom resources by using the `must-gather` tool. The `must-gather` data must be attached to all customer cases.
1511

16-
You can run the `must-gather` tool with the following data collection options:
17-
18-
* Full `must-gather` data collection collects Prometheus metrics, pod logs, and Velero CR information for all namespaces where the OADP Operator is installed.
19-
* 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.
20-
* `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.
21-
* Prometheus metrics data dump downloads an archive file containing the metrics data collected by Prometheus.
22-
23-
24-
.Prerequisites
25-
26-
* You have logged in to the {product-title} cluster as a user with the `cluster-admin` role.
27-
* You have installed the OpenShift CLI (`oc`).
28-
* You must use {op-system-base-full} {op-system-version-9} with {oadp-short} 1.4.
29-
30-
.Procedure
31-
32-
. Navigate to the directory where you want to store the `must-gather` data.
33-
. Run the `oc adm must-gather` command for one of the following data collection options:
34-
35-
* For full `must-gather` data collection, including Prometheus metrics, run the following command:
36-
+
37-
[source,terminal,subs="attributes+"]
38-
----
39-
$ oc adm must-gather --image={must-gather-v1-4}
40-
----
41-
+
42-
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{nbsp}Hat Customer Portal].
43-
+
44-
For essential `must-gather` data collection, without Prometheus metrics, for a specific time duration, run the following command:
45-
+
46-
[source,terminal,subs="attributes+"]
47-
----
48-
$ oc adm must-gather --image={must-gather-v1-4} \
49-
-- /usr/bin/gather_<time>_essential <1>
50-
----
51-
<1> Specify the time in hours. Allowed values are `1h`, `6h`, `24h`, `72h`, or `all`, for example, `gather_1h_essential` or `gather_all_essential`.
52-
53-
* For `must-gather` data collection with timeout, run the following command:
54-
+
55-
[source,terminal,subs="attributes+"]
56-
----
57-
$ oc adm must-gather --image={must-gather-v1-4} \
58-
-- /usr/bin/gather_with_timeout <timeout> <1>
59-
----
60-
<1> Specify a timeout value in seconds.
61-
62-
* For a Prometheus metrics data dump, run the following command:
63-
+
64-
[source,terminal,subs="attributes+"]
65-
----
66-
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather_metrics_dump
67-
----
68-
This operation can take a long time. The data is saved as `must-gather/metrics/prom_data.tar.gz`.
12+
The `must-gather` tool is a container and does not run all the time. The tool runs for a few minutes only after you invoke the tool by running the `must-gather` command.
6913

14+
include::modules/using-must-gather.adoc[leveloffset=+1]
7015

7116
[role="_additional-resources"]
7217
.Additional resources
7318
* xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering cluster data]
7419
75-
include::modules/support-insecure-tls-connections.adoc[leveloffset=+1]
76-
include::modules/migration-combining-must-gather.adoc[leveloffset=+1]
20+
//unset attributes
21+
:!must-gather-v1-4:

‎images/oadp-must-gather-markdown-output.png

65.2 KB
Loading

‎modules/using-must-gather.adoc

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="oadp-running-must-gather_{context}"]
7+
= Using the must-gather tool
8+
9+
You can run the `must-gather` tool with the following options. To use an option, add a flag corresponding to that option in the `must-gather` command.
10+
11+
Default configuration:: This configuration collects pod logs, {oadp-short}, and `Velero` custom resource (CR) information for all namespaces where the {oadp-short} Operator is installed.
12+
Timeout:: Data collection can take a long time if there are many failed `Backup` CRs. You can improve performance by setting a timeout value.
13+
Insecure TLS connections:: If a custom CA certificate is used, run the `must-gather` tool with insecure TLS connections.
14+
15+
The `must-gather` tool generates a Markdown output file with the collected information. The Markdown file is located in a cluster directory.
16+
17+
For more information about the supported flags, use the help flag with the `must-gather` tool as shown in the following example:
18+
19+
[source,terminal,subs="attributes+"]
20+
----
21+
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather -h
22+
----
23+
24+
.Prerequisites
25+
26+
* You have logged in to the {product-title} cluster as a user with the `cluster-admin` role.
27+
* You have installed the {oc-first}.
28+
* You must use {op-system-base-full} {op-system-version-9} with {oadp-short} 1.4.
29+
30+
.Procedure
31+
32+
. Navigate to the directory where you want to store the `must-gather` data.
33+
. Run the `oc adm must-gather` command for one of the following data collection options:
34+
35+
** To use the default configuration of the `must-gather` tool, run the following command:
36+
+
37+
[source,terminal,subs="attributes+"]
38+
----
39+
$ oc adm must-gather --image={must-gather-v1-4}
40+
----
41+
42+
** To use the timeout flag with the `must-gather` tool, run the following command:
43+
+
44+
[source,terminal,subs="attributes+"]
45+
----
46+
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 1m <1>
47+
----
48+
<1> In this example, the timeout is 1 minute.
49+
50+
** To use the insecure TLS connection flag with the `must-gather` tool, run the following command:
51+
+
52+
[source,terminal,subs="attributes+"]
53+
----
54+
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --skip-tls
55+
----
56+
57+
** To use a combination of the insecure TLS connection, and the timeout flags with the `must-gather` tool, run the following command:
58+
+
59+
[source,terminal,subs="attributes+"]
60+
----
61+
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 15s --skip-tls <1>
62+
----
63+
<1> In this example, the timeout is 15 seconds. By default, the `--skip-tls` flag value is `false`. Set the value to `true` to allow insecure TLS connections.
64+
65+
.Verification
66+
67+
. Verify that the Markdown output file is generated at the following location: `must-gather.local.89...054550/registry.redhat.io/oadp/oadp-mustgather-rhel9:v1.5-sha256-0...84/clusters/a4...86/oadp-must-gather-summary.md`
68+
69+
. Review the `must-gather` data in the Markdown file by opening the file in a Markdown previewer. For an example output, refer to the following image. You can upload this output file to a support case on the link:https://access.redhat.com/[Red{nbsp}Hat Customer Portal].
70+
+
71+
.Example markdown output
72+
image::oadp-must-gather-markdown-output.png[must-gather markdown output]

0 commit comments

Comments
 (0)