Merge pull request #63952 from abrennan89/support-logging

abrennan89 · web-flow · commit 8235e4ff8b44 · 2023-08-31T12:07:36.000-05:00
OBSDOCS-152: Restructure support section to remove duplication and improve findability
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2524,6 +2524,8 @@ Distros: openshift-enterprise,openshift-origin
 Topics:
 - Name: Release notes
   File: cluster-logging-release-notes
+- Name: Support
+  File: cluster-logging-support
 - Name: Logging 5.7
   Dir: v5_7
   Distros: openshift-enterprise,openshift-origin
diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -359,6 +359,8 @@ Distros: openshift-dedicated
 Topics:
 - Name: Release notes
   File: cluster-logging-release-notes
+- Name: Support
+  File: cluster-logging-support
 - Name: About Logging
   File: cluster-logging
 - Name: Installing Logging
diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -476,6 +476,8 @@ Distros: openshift-rosa
 Topics:
 - Name: Release notes
   File: cluster-logging-release-notes
+- Name: Support
+  File: cluster-logging-support
 - Name: About Logging
   File: cluster-logging
 - Name: Installing Logging
diff --git a/logging/cluster-logging-support.adoc b/logging/cluster-logging-support.adoc
@@ -0,0 +1,31 @@
+:_content-type: ASSEMBLY
+[id="cluster-logging-support"]
+include::_attributes/common-attributes.adoc[]
+= Support
+:context: cluster-logging-support
+
+toc::[]
+
+////
+Getting support - possibly add general OCP docs?
+ifdef::openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-origin[]
+
+include::modules/support.adoc[leveloffset=+1]
+include::modules/support-knowledgebase-about.adoc[leveloffset=+1]
+include::modules/support-knowledgebase-search.adoc[leveloffset=+1]
+include::modules/support-submitting-a-case.adoc[leveloffset=+1]
+
+endif::openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-origin[]
+////
+include::snippets/logging-supported-config-snip.adoc[]
+include::snippets/logging-compatibility-snip.adoc[]
+
+The {logging-title} is an opinionated collector and normalizer of application, infrastructure, and audit logs. It is intended to be used for forwarding logs to various supported systems.
+
+The {logging-title} is not:
+
+* A high scale log collection system
+* Security Information and Event Monitoring (SIEM) compliant
+* Historical or long term log retention or storage
+* A guaranteed log sink
+* Secure storage - audit logs are not stored by default
diff --git a/logging/cluster-logging.adoc b/logging/cluster-logging.adoc
@@ -22,13 +22,6 @@ Because the internal {product-title} Elasticsearch log store does not provide se
 ====
 endif::[]
 
-include::modules/logging-support-considerations.adoc[leveloffset=+1]
-
-// 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.
-
 ifdef::openshift-rosa,openshift-dedicated[]
 include::modules/cluster-logging-cloudwatch.adoc[leveloffset=+1]
 .Next steps
diff --git a/logging/v5_5/logging-5-5-architecture.adoc b/logging/v5_5/logging-5-5-architecture.adoc
@@ -8,5 +8,3 @@ toc::[]
 
 :context: logging-5-5-architecture
 include::modules/logging-architecture-overview.adoc[leveloffset=+1,lines=9..31]
-
-include::modules/logging-support-considerations.adoc[leveloffset=+1]
diff --git a/logging/v5_6/logging-5-6-architecture.adoc b/logging/v5_6/logging-5-6-architecture.adoc
@@ -8,5 +8,3 @@ toc::[]
 
 
 include::modules/logging-architecture-overview.adoc[leveloffset=+1,lines=9..31]
-
-include::modules/logging-support-considerations.adoc[leveloffset=+1]
diff --git a/logging/v5_7/logging-5-7-architecture.adoc b/logging/v5_7/logging-5-7-architecture.adoc
@@ -7,8 +7,7 @@ include::_attributes/common-attributes.adoc[]
 toc::[]
 
 :context: logging-5-7-architecture-overview
-include::modules/logging-architecture-overview.adoc[lines=9..31]
 
-include::modules/logging-support-considerations.adoc[leveloffset=+1]
+include::modules/logging-architecture-overview.adoc[lines=9..31]
 
 include::snippets/logging-5.7-outputs-snip.adoc[]
diff --git a/modules/logging-support-considerations.adoc b/modules/logging-support-considerations.adoc
diff --git a/snippets/logging-compatibility-snip.adoc b/snippets/logging-compatibility-snip.adoc
@@ -1,9 +1,17 @@
 // Text snippet included in the following assemblies:
 //
+// logging/.meta-logging-quickref.adoc
+// logging/cluster-logging-release-notes.adoc
+// logging/v5_5/logging-5-5-release-notes.adoc
+// logging/v5_6/logging-5-6-release-notes.adoc
+// logging/v5_7/logging-5-7-release-notes.adoc
+// logging/cluster-logging-support.adoc
 //
 // Text snippet included in the following modules:
 //
-//
+// logging-deploy-RHOL-console.adoc
+// logging-getting-started.adoc
+
 :_content-type: SNIPPET
 
 [NOTE]
diff --git a/snippets/logging-supported-config-snip.adoc b/snippets/logging-supported-config-snip.adoc
@@ -1,14 +1,21 @@
 // Text snippet included in the following assemblies:
 //
+// logging/v5_5/logging-5-5-configuration.adoc
+// logging/v5_6/logging-5-6-configuration.adoc
+// logging/v5_7/logging-5-7-configuration.adoc
+// logging/.meta-logging-quickref.adoc
+// logging/cluster-logging-support.adoc
 //
 // Text snippet included in the following modules:
 //
-//
+
 :_content-type: SNIPPET
 
-The supported way of configuring the logging subsystem for Red Hat OpenShift is by configuring it using the options described in this documentation. Do not use other configurations, as they are unsupported. Configuration paradigms might change across OpenShift Container Platform releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in this documentation, your changes will disappear because the Operators reconcile any differences. The Operators reverse everything to the defined state by default and by design.
+Only the configuration options described in this documentation are supported for the {logging}.
+
+Do not use any other configuration options, as they are unsupported. Configuration paradigms might change across {product-title} releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in this documentation, your changes will be overwritten, because Operators are designed to reconcile any differences.
 
 [NOTE]
 ====
-If you must perform configurations not described in the OpenShift Container Platform 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 OpenShift Logging environment is not supported and does not receive updates until you return OpenShift Logging to `Managed`.
 ====

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,3 @@ toc::[]`
`8`	`8`
`9`	`9`
`10`	`10`	`include::modules/logging-architecture-overview.adoc[leveloffset=+1,lines=9..31]`
`11`		`-`
`12`		`-include::modules/logging-support-considerations.adoc[leveloffset=+1]`