Merge pull request #64444 from abrennan89/logging-support-2

abrennan89 · web-flow · commit 057d03abb8e9 · 2023-09-12T14:40:32.000-05:00
OBSDOCS-152: Additional logging Support section clean up
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2608,8 +2608,6 @@ Topics:
     File: cluster-logging-moving-nodes
   - Name: Configuring systemd-journald for Logging
     File: cluster-logging-systemd
-  - Name: Maintenance and support
-    File: cluster-logging-maintenance-support
 - Name: Logging using LokiStack
   File: cluster-logging-loki
 - Name: Viewing logs for a specific resource
@@ -2642,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
@@ -390,8 +390,6 @@ Topics:
     File: cluster-logging-moving-nodes
   #- Name: Configuring systemd-journald and Fluentd
   #  File: cluster-logging-systemd
-  - Name: Maintenance and support
-    File: cluster-logging-maintenance-support
 - Name: Logging using LokiStack
   File: cluster-logging-loki
 - Name: Viewing logs for a specific resource
@@ -421,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
@@ -509,8 +509,6 @@ Topics:
     File: cluster-logging-moving-nodes
   #- Name: Configuring systemd-journald and Fluentd
   #  File: cluster-logging-systemd
-  - Name: Maintenance and support
-    File: cluster-logging-maintenance-support
 - Name: Logging using LokiStack
   File: cluster-logging-loki
 - Name: Viewing logs for a specific resource
@@ -538,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
@@ -29,3 +29,30 @@ The {logging-title} is not:
 * Historical or long term log retention or storage
 * A guaranteed log sink
 * Secure storage - audit logs are not stored by default
+
+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{nbsp}Hat Support.
+
+You can use 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::[]
+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 the {logging-title}.
+
+[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/config/cluster-logging-collector.adoc b/logging/config/cluster-logging-collector.adoc
@@ -11,14 +11,6 @@ toc::[]
 
 You can configure the CPU and memory limits for the log collector and xref:../../logging/config/cluster-logging-moving-nodes.adoc#cluster-logging-moving[move the log collector pods to specific nodes]. All supported modifications to the log collector can be performed though the `spec.collection.log.fluentd` stanza in the `ClusterLogging` custom resource (CR).
 
-
-// The following include statements pull in the module files that comprise
-// the assembly. Include any combination of concept, procedure, or reference
-// modules required to cover the user story. You can also include other
-// assemblies.
-
-include::modules/cluster-logging-maintenance-support-about.adoc[leveloffset=+1]
-
 include::modules/cluster-logging-collector-pod-location.adoc[leveloffset=+1]
 
 include::modules/cluster-logging-collector-limits.adoc[leveloffset=+1]
diff --git a/logging/config/cluster-logging-maintenance-support.adoc b/logging/config/cluster-logging-maintenance-support.adoc
diff --git a/logging/troubleshooting/cluster-logging-must-gather.adoc b/logging/troubleshooting/cluster-logging-must-gather.adoc
diff --git a/migrating_from_ocp_3_to_4/planning-migration-3-4.adoc b/migrating_from_ocp_3_to_4/planning-migration-3-4.adoc
@@ -190,7 +190,7 @@ For more information, see xref:../logging/cluster-logging.adoc#cluster-logging-a
 
 Some logging configurations that were available in {product-title} 3.11 are no longer supported in {product-title} {product-version}.
 
-For more information on the explicitly unsupported logging cases, see xref:../logging/config/cluster-logging-maintenance-support.adoc#cluster-logging-maintenance-and-support[Maintenance and support].
+For more information on the explicitly unsupported logging cases, see the xref:../logging/cluster-logging-support.adoc#cluster-logging-support[logging support documentation].
 
 [id="migration-preparing-security"]
 === Security considerations
diff --git a/modules/cluster-logging-maintenance-support-about.adoc b/modules/cluster-logging-maintenance-support-about.adoc
diff --git a/modules/cluster-logging-maintenance-support-list.adoc b/modules/cluster-logging-maintenance-support-list.adoc
@@ -1,23 +1,21 @@
 // Module included in the following assemblies:
 //
-// * logging/config/cluster-logging-maintenance-support.adoc
+// * logging/cluster-logging-support.adoc
 
 [id="cluster-logging-maintenance-support-list_{context}"]
 = Unsupported configurations
 
-You must set the Red Hat OpenShift Logging Operator to the unmanaged state to modify the following components:
+You must set the Red{nbsp}Hat OpenShift Logging Operator to the `Unmanaged` state to modify the following components:
 
-* The `Elasticsearch` CR
+* The `Elasticsearch` custom resource (CR)
 
 * The Kibana deployment
 
 * The `fluent.conf` file
 
 * The Fluentd daemon set
 
-You must set the OpenShift Elasticsearch Operator to the unmanaged state to modify the following component:
-
-*  the Elasticsearch deployment files.
+You must set the OpenShift Elasticsearch Operator to the `Unmanaged` state to modify the Elasticsearch deployment files.
 
 Explicitly unsupported cases include:
 
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/modules/unmanaged-operators.adoc b/modules/unmanaged-operators.adoc
@@ -2,6 +2,7 @@
 //
 // * architecture/architecture-installation.adoc
 // * updating/updating-cluster-within-minor.adoc
+// * logging/cluster-logging-support.adoc
 
 [id="unmanaged-operators_{context}"]
 = Support policy for unmanaged Operators
diff --git a/snippets/logging-supported-config-snip.adoc b/snippets/logging-supported-config-snip.adoc
@@ -17,5 +17,5 @@ Do not use any other configuration options, as they are unsupported. Configurati
 
 [NOTE]
 ====
-If you must perform configurations not described in the {product-title} documentation, you must set your Red Hat OpenShift Logging Operator to `Unmanaged`. An unmanaged OpenShift Logging environment is not supported and does not receive updates until you return OpenShift Logging to `Managed`.
+If you must perform configurations not described in the {product-title} documentation, you must set your Red Hat OpenShift Logging Operator to `Unmanaged`. An unmanaged {logging-title} is not supported and does not receive updates until you return its status to `Managed`.
 ====
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.
