Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ include::_attributes/common-attributes.adoc[]


[role="_abstract"]
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.
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.

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.
The `must-gather` tool is a container and does not run all the time. The tool runs for a few minutes only after you start the tool by running the `must-gather` command.

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

Expand Down
14 changes: 8 additions & 6 deletions modules/using-must-gather.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
= Using the must-gather tool

[role="_abstract"]
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.
Run the `must-gather` tool with the default configuration, timeout, and insecure TLS options. To use an option, add a flag corresponding to that option in the `must-gather` command.

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.
Timeout:: Data collection can take a long time if there are many failed `Backup` CRs. You can improve performance by setting a timeout value.
Expand Down Expand Up @@ -44,11 +44,12 @@ $ oc adm must-gather --image={must-gather-v1-4}
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 1m <1>
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 1m
----
<1> In this example, the timeout is 1 minute.
+
In this example, the timeout is 1 minute.

** To use the insecure TLS connection flag with the `must-gather` tool, run the following command:
* To use the insecure TLS connection flag with the `must-gather` tool, run the following command:
+
[source,terminal,subs="attributes+"]
----
Expand All @@ -59,9 +60,10 @@ $ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --skip-tls
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 15s --skip-tls <1>
$ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 15s --skip-tls
----
<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.
+
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.

.Verification

Expand Down