move must gather docs to support

openshift · Sep 8, 2023 · 6b8e44e · 6b8e44e
1 parent ff14a28
commit 6b8e44e
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 44 deletions.
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2640,8 +2640,6 @@ Topics:
     File: cluster-logging-log-store-status
   - Name: Understanding Logging alerts
     File: cluster-logging-alerts
-  - Name: Collecting logging data for Red Hat Support
-    File: cluster-logging-must-gather
   - Name: Troubleshooting for Critical Alerts
     File: cluster-logging-troubleshooting-for-critical-alerts
 - Name: Uninstalling Logging

diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -419,8 +419,6 @@ Topics:
     File: cluster-logging-log-store-status
   - Name: Understanding Logging alerts
     File: cluster-logging-alerts
-  - Name: Collecting logging data for Red Hat Support
-    File: cluster-logging-must-gather
   - Name: Troubleshooting for Critical Alerts
     File: cluster-logging-troubleshooting-for-critical-alerts
 - Name: Uninstalling Logging

diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -536,8 +536,6 @@ Topics:
     File: cluster-logging-log-store-status
   - Name: Understanding Logging alerts
     File: cluster-logging-alerts
-  - Name: Collecting logging data for Red Hat Support
-    File: cluster-logging-must-gather
   - Name: Troubleshooting for Critical Alerts
     File: cluster-logging-troubleshooting-for-critical-alerts
 - Name: Uninstalling Logging

diff --git a/logging/cluster-logging-support.adoc b/logging/cluster-logging-support.adoc
@@ -32,3 +32,27 @@ The {logging-title} is not:
 
 include::modules/cluster-logging-maintenance-support-list.adoc[leveloffset=+1]
 include::modules/unmanaged-operators.adoc[leveloffset=+1]
+
+[id="cluster-logging-support-must-gather"]
+== Collecting logging data for Red Hat Support
+
+When opening a support case, it is helpful to provide debugging information about your cluster to Red Hat Support.
+
+The
+ifdef::openshift-enterprise,openshift-origin[]
+xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[`must-gather` tool]
+endif::[]
+ifdef::openshift-rosa,openshift-dedicated[]
+link:https://docs.openshift.com/container-platform/latest/support/gathering-cluster-data.html#gathering-cluster-data[`must-gather` tool]
+endif::[]
+enables you to collect diagnostic information for project-level resources, cluster-level resources, and each of the {logging} components.
+
+For prompt support, supply diagnostic information for both {product-title} and OpenShift Logging.
+
+[NOTE]
+====
+Do not use the `hack/logging-dump.sh` script. The script is no longer supported and does not collect data.
+====
+
+include::modules/cluster-logging-must-gather-about.adoc[leveloffset=+2]
+include::modules/cluster-logging-must-gather-collecting.adoc[leveloffset=+2]
diff --git a/logging/troubleshooting/cluster-logging-must-gather.adoc b/logging/troubleshooting/cluster-logging-must-gather.adoc
diff --git a/modules/cluster-logging-must-gather-about.adoc b/modules/cluster-logging-must-gather-about.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/troubleshooting/cluster-logging-must-gather.adoc
+// * logging/cluster-logging-support.adoc
 
 :_content-type: CONCEPT
 [id="about-must-gather_{context}"]

diff --git a/modules/cluster-logging-must-gather-collecting.adoc b/modules/cluster-logging-must-gather-collecting.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * logging/troubleshooting/cluster-logging-must-gather.adoc
+// * logging/cluster-logging-support.adoc
 
 :_content-type: PROCEDURE
 [id="cluster-logging-must-gather-collecting_{context}"]

diff --git a/support/index.adoc b/support/index.adoc
@@ -109,6 +109,6 @@ A cluster administrator can monitor and troubleshoot the following {product-titl
 ** xref:../logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-cluster-status[Status of the Logging Operator].
 ** xref:../logging/troubleshooting/cluster-logging-cluster-status.adoc#cluster-logging-cluster-status[Status of the Log store].
 ** xref:../logging/troubleshooting/cluster-logging-alerts.adoc#cluster-logging-alerts[OpenShift Logging alerts].
-** xref:../logging/troubleshooting/cluster-logging-must-gather.adoc#cluster-logging-must-gather[Information about your OpenShift logging environment using `oc adm must-gather` command].
+** xref:../logging/cluster-logging-support.adoc#cluster-logging-support-must-gather_cluster-logging-support[Information about your OpenShift logging environment using `oc adm must-gather` command].
 
 * xref:../support/troubleshooting/diagnosing-oc-issues.adoc#diagnosing-oc-issues[OpenShift CLI (oc) issues]: Investigate OpenShift CLI (oc) issues by increasing the log level.