OADP must-gather for 1.4.5 #95588
OADP must-gather for 1.4.5 #95588
Conversation
Signed-off-by: Shruti Deshpande <shdeshpa@redhat.com>
openshift-ci
bot
added
the
size/L
|
🤖 Tue Jul 15 07:06:30 - Prow CI generated the docs preview: |
Signed-off-by: Shruti Deshpande <shdeshpa@redhat.com>
|
/label OADP |
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
|
/remove-label peer-review-needed /label peer-review-in-progress |
openshift-ci
bot
added
peer-review-in-progress
| // * backup_and_restore/application_backup_and_restore/using-the-must-gather-tool.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="oadp-running-must-gather_{context}"] |
There was a problem hiding this comment.
From OpenShift docs guidelines:
The anchor ID with _{context} must be lowercase and match the module’s file name.
Similarly in modularization guidelines:
At the top of every module, provide an anchor in the format [id="filename_{context}"] where filename is the exact name of the file, without the file extension (.adoc) and a module prefix
So I would recommend either renaming the file or changing the ID, so that the ID and file name matches
| For more information about the supported flags, use the help flag with the `must-gather` tool as shown in the following example: | ||
|
|
||
| [source,terminal,subs="attributes+"] | ||
| ---- | ||
| $ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather -h | ||
| ---- |
There was a problem hiding this comment.
I do not usually see commands in the introduction of a procedure.
Could it be possibly moved to the procedure? and if not, maybe putting this into a note would work better here?
...p_and_restore/application_backup_and_restore/troubleshooting/using-the-must-gather-tool.adoc
Show resolved
Hide resolved
| ---- | ||
| $ oc adm must-gather --image={must-gather-v1-4} -- /usr/bin/gather --request-timeout 15s --skip-tls #<1> | ||
| ---- | ||
| <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. |
There was a problem hiding this comment.
By default, the
--skip-tlsflag value isfalse. Set the value totrueto allow insecure TLS connections.
The --skip-tls option is already used in the previous example command, so it would be better to explain this behavior sooner. It could be moved to the decription of "Insecure TLS connections" in the introduction.
openshift-ci
bot
added
peer-review-done
Co-authored-by: Eliska Romanova <eromanov@redhat.com>
|
@shdeshpa07: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Jira
OADP must-gather for OCP 4.18 4.17 4.16
Version
Preview
QE Review