From 0a632a52f15b54f8db95217f18b55a207844beb5 Mon Sep 17 00:00:00 2001 From: Shruti Deshpande Date: Wed, 4 Mar 2026 18:50:24 +0530 Subject: [PATCH] cqa fixes for must gather Signed-off-by: Shruti Deshpande --- .../using-the-must-gather-tool.adoc | 4 ++-- modules/using-must-gather.adoc | 14 ++++++++------ 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc b/backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc index b0507dc633f5..68b9ff3432c3 100644 --- a/backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc +++ b/backup_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc @@ -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] diff --git a/modules/using-must-gather.adoc b/modules/using-must-gather.adoc index 129f940676d3..916d7e3577ee 100644 --- a/modules/using-must-gather.adoc +++ b/modules/using-must-gather.adoc @@ -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. @@ -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+"] ---- @@ -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