Merge pull request #80738 from cbippley/OSDOCS-11648

OSDOCS-11648 Table of must-gather flags

Author: ShaunaDiaz

modules/must-gather-flags.adoc

@@ -0,0 +1,67 @@
+// Module included in the following assemblies:
+//
+// * support/gathering-cluster-data.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="must-gather-flags_{context}"]
+= Must-gather flags
+
+The flags listed in the following table are available to use with the `oc adm must-gather` command.
+
+.{product-title} flags for `oc adm must-gather`
+[cols="1,1,3",options="header"]
+|====
+|Flag |Example command |Description
+
+|`--all-images`
+|`oc adm must-gather --all-images=false`
+|Collect `must-gather` data using the default image for all Operators on the cluster that are annotated with `operators.openshift.io/must-gather-image`.
+
+|`--dest-dir`
+|`oc adm must-gather --dest-dir='<directory_name>'`
+|Set a specific directory on the local machine where the gathered data is written.
+
+|`--host-network`
+|`oc adm must-gather --host-network=false`
+|Run `must-gather` pods as `hostNetwork: true`. Relevant if a specific command and image needs to capture host-level data.
+
+|`--image`
+|`oc adm must-gather --image=[<plugin_image>]`
+|Specify a `must-gather` plugin image to run. If not specified, {product-title}'s default `must-gather` image is used.
+
+|`--image-stream`
+|`oc adm must-gather --image-stream=[<image_stream>]`
+|Specify an`<image_stream>` using a namespace or name:tag value containing a `must-gather` plugin image to run.
+
+|`--node-name`
+|`oc adm must-gather --node-name='<node>'`
+|Set a specific node to use. If not specified, by default a random master is used.
+
+|`--node-selector`
+|`oc adm must-gather --node-selector='<node_selector_name>'`
+|Set a specific node selector to use. Only relevant when specifying a command and image which needs to capture data on a set of cluster nodes simultaneously.
+
+|`--run-namespace`
+|`oc adm must-gather --run-namespace='<namespace>'`
+|An existing privileged namespace where `must-gather` pods should run. If not specified, a temporary namespace is generated.
+
+|`--since`
+|`oc adm must-gather --since=<time>`
+|Only return logs newer than the specified duration. Defaults to all logs. Plugins are encouraged but not required to support this. Only one `since-time` or `since` may be used.
+
+|`--since-time`
+|`oc adm must-gather --since-time='<date_and_time>'`
+|Only return logs after a specific date and time, expressed in (link:https://www.rfc-editor.org/rfc/rfc3339[RFC3339]) format. Defaults to all logs. Plugins are encouraged but not required to support this. Only one `since-time` or `since` may be used.
+
+|`--source-dir`
+|`oc adm must-gather --source-dir='/<directory_name>/'`
+|Set the specific directory on the pod where you copy the gathered data from.
+
+|`--timeout`
+|`oc adm must-gather --timeout='<time>'`
+|The length of time to gather data before timing out, expressed as seconds, minutes, or hours, for example, 3s, 5m, or 2h. Time specified must be higher than zero. Defaults to 10 minutes if not specified.
+
+|`--volume-percentage`
+|`oc adm must-gather --volume-percentage=<percent>`
+|Specify maximum percentage of pod's allocated volume that can be used for `must-gather`. If this limit is exceeded, `must-gather` stops gathering, but still copies gathered data. Defaults to 30% if not specified.
+|====

support/gathering-cluster-data.adoc

@@ -31,6 +31,11 @@ ifndef::openshift-origin[]
 include::modules/support-gather-data.adoc[leveloffset=+2]
 endif::openshift-origin[]
 
+ifndef::openshift-origin[]
+// Table of must-gather flags
+include::modules/must-gather-flags.adoc[leveloffset=+2]
+endif::openshift-origin[]
+
 // Gathering data about specific features
 include::modules/gathering-data-specific-features.adoc[leveloffset=+2]