Merge pull request #99406 from DCChadwick/osdocws154444

OSDOCS-15444 Adding module on how to exclude pod logs from OC Admin In…

Author: dfitzmau

modules/support-must-gather-targeted-collection-gathering-data.adoc

@@ -0,0 +1,36 @@
+// Module included in the following assemblies:
+//
+// * support/gathering-cluster-data.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="support-must-gather-targeted-collection-gathering-data_{context}"]
+= Gathering data for specific resources
+
+Instead of collecting data for the entire cluster, you can direct the `must-gather` tool to inspect a specific resource. This method is highly effective for isolating issues within a single project, Operator, or application.
+
+The `must-gather` tool uses `oc adm inspect` internally. You can specify what to inspect by passing the `inspect` command and its arguments after the `--` separator.
+
+.Procedure
+
+* To gather data for a specific namespace, such as `my-project`, run the following command:
++
+[source,terminal]
+----
+$ oc adm must-gather --dest-dir=my-project-must-gather -- oc adm inspect ns/my-project
+----
+
+* This command collects all standard resources within the `my-project` namespace, including logs from pods in that namespace, but excludes cluster-scoped resources.
+
+* To gather data related to a specific Cluster Operator, such as `openshift-apiserver`, run the following command:
++
+[source,terminal]
+----
+$ oc adm must-gather --dest-dir=apiserver-must-gather -- oc adm inspect clusteroperator/openshift-apiserver
+----
+
+* To exclude logs entirely and significantly reduce the size of the `must-gather` archive, add a double dash (`--`) after `oc adm must-gather` command and add the `--no-logs` argument:
++
+[source,terminal]
+----
+$ oc adm must-gather -- /usr/bin/gather --no-logs
+----

modules/support-must-gather-targeted-collection.adoc

@@ -0,0 +1,11 @@
+// Module included in the following assemblies:
+//
+// * support/gathering-cluster-data.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="support-must-gather-targeted-collection_{context}"]
+= Reducing the size of must-gather output
+
+The `oc adm must-gather` command collects comprehensive cluster information. However, a full data collection can result in a large file that is difficult to upload and analyze and could result in timeouts. 
+
+To manage the output size and target your data collection for more effective troubleshooting, you can pass specific flags to the underlying `gather` script or scope the collection to particular resources.

support/gathering-cluster-data.adoc

@@ -31,6 +31,16 @@ ifndef::openshift-origin[]
 include::modules/support-gather-data.adoc[leveloffset=+2]
 endif::openshift-origin[]
 
+ifndef::openshift-origin[]
+// Reducing the size of must-gather output
+include::modules/support-must-gather-targeted-collection.adoc[leveloffset=+1]
+endif::openshift-origin[]
+
+ifndef::openshift-origin[]
+// Gathering data for specific resources
+include::modules/support-must-gather-targeted-collection-gathering-data.adoc[leveloffset=+2]
+endif::openshift-origin[]
+
 ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
 [role="_additional-resources"]
 .Additional resources