Skip to content

Commit 86df29d

Browse files
Apply suggestions from code review
Co-authored-by: Eliska Romanova <eromanov@redhat.com>
1 parent daacdb9 commit 86df29d

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,6 @@ include::modules/using-must-gather.adoc[leveloffset=+1]
1616
[role="_additional-resources"]
1717
.Additional resources
1818
* xref:../../../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering cluster data]
19+
20+
//unset attributes
21+
:!must-gather-v1-4:

modules/using-must-gather.adoc

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * backup_and_restore/application_backup_and_restore/using-the-must-gather-tool.adoc
3+
// * backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="oadp-running-must-gather_{context}"]
@@ -10,7 +10,7 @@ You can run the `must-gather` tool with the following options. To use an option,
1010

1111
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.
1212
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, use the `must-gather` tool with insecure TLS connections.
13+
Insecure TLS connections:: If a custom CA certificate is used, run the `must-gather` tool with insecure TLS connections.
1414

1515
The `must-gather` tool generates a Markdown output file with the collected information. The Markdown file is located in a cluster directory.
1616

@@ -24,40 +24,44 @@ $ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather -h
2424
.Prerequisites
2525

2626
* 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`).
27+
* You have installed the {oc-first}.
2828
* You must use {op-system-base-full} {op-system-version-9} with {oadp-short} 1.4.
29+
2930
.Procedure
3031

3132
. Navigate to the directory where you want to store the `must-gather` data.
3233
. Run the `oc adm must-gather` command for one of the following data collection options:
3334

34-
* To use the default configuration of the `must-gather` tool, run the following command:
35+
** To use the default configuration of the `must-gather` tool, run the following command:
3536
+
3637
[source,terminal,subs="attributes+"]
3738
----
3839
$ oc adm must-gather --image={must-gather-v1-4}
3940
----
40-
+
41-
* To use the timeout flag with the `must-gather` tool, run the following command:
41+
42+
** To use the timeout flag with the `must-gather` tool, run the following command:
4243
+
4344
[source,terminal,subs="attributes+"]
4445
----
45-
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 1m # <1>
46+
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 1m <1>
4647
----
4748
<1> In this example, the timeout is 1 minute.
48-
* To use the insecure TLS connection flag with the `must-gather` tool, run the following command:
49+
50+
** To use the insecure TLS connection flag with the `must-gather` tool, run the following command:
4951
+
5052
[source,terminal,subs="attributes+"]
5153
----
5254
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --skip-tls
5355
----
54-
* To use a combination of the insecure TLS connection, and the timeout flags with the `must-gather` tool, run the following command:
56+
57+
** To use a combination of the insecure TLS connection, and the timeout flags with the `must-gather` tool, run the following command:
5558
+
5659
[source,terminal,subs="attributes+"]
5760
----
58-
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 15s --skip-tls #<1>
61+
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 15s --skip-tls <1>
5962
----
6063
<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+
6165
.Verification
6266

6367
. 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`

0 commit comments

Comments
 (0)