OBSDOCS-152: Additional logging Support section clean up

openshift · Sep 6, 2023 · 3589fed · 3589fed
1 parent fb0fcf8
commit 3589fed
Show file tree

Hide file tree

Showing 10 changed files with 9 additions and 48 deletions.
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

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

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

diff --git a/logging/cluster-logging-support.adoc b/logging/cluster-logging-support.adoc
@@ -29,3 +29,6 @@ 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]
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/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 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/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`.
 ====