OBSDOCS-152: Additional logging docs cleanup

openshift · Oct 6, 2023 · 32dd925 · 32dd925
1 parent a725b8e
commit 32dd925
Show file tree

Hide file tree

Showing 17 changed files with 30 additions and 598 deletions.
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2503,8 +2503,6 @@ Topics:
     File: logging-5-5-administration
 #  - Name: Configuring Logging
 #    File: logging-5-5-configuration
-# - Name: Logging Reference
-#    File: logging-5-5-reference
 - Name: About Logging
   File: cluster-logging
 - Name: Installing Logging

diff --git a/logging/v5_5/logging-5-5-configuration.adoc b/logging/v5_5/logging-5-5-configuration.adoc
@@ -1,13 +1,9 @@
 :_content-type: ASSEMBLY
-[id="logging-configuration-5-5"]
+[id="logging-5-5-configuration"]
 = Configuring your logging deployment
 include::_attributes/common-attributes.adoc[]
-:context: logging-5.5-configuration
+:context: logging-5-5-configuration
 
 toc::[]
 
-include::snippets/logging-crs-by-operator-snip.adoc[]
-
-include::snippets/logging-supported-config-snip.adoc[]
-
 include::modules/logging-multiline-except.adoc[leveloffset=+1]
diff --git a/logging/v5_5/logging-5-5-reference.adoc b/logging/v5_5/logging-5-5-reference.adoc
diff --git a/logging/v5_6/logging-5-6-configuration.adoc b/logging/v5_6/logging-5-6-configuration.adoc
@@ -6,10 +6,4 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-include::snippets/logging-crs-by-operator-snip.adoc[]
-
-include::snippets/logging-supported-config-snip.adoc[]
-
-include::modules/logging-loki-retention.adoc[leveloffset=+1]
-
 include::modules/logging-multiline-except.adoc[leveloffset=+1]
diff --git a/logging/v5_7/logging-5-7-configuration.adoc b/logging/v5_7/logging-5-7-configuration.adoc
@@ -6,12 +6,6 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-include::snippets/logging-crs-by-operator-snip.adoc[]
-
-include::snippets/logging-supported-config-snip.adoc[]
-
-include::modules/logging-loki-retention.adoc[leveloffset=+1]
-
 include::modules/logging-multiline-except.adoc[leveloffset=+1]
 
 include::modules/logging-loki-alerts.adoc[leveloffset=+1]
diff --git a/modules/cluster-logging-about.adoc b/modules/cluster-logging-about.adoc
@@ -11,10 +11,32 @@
 [id="cluster-logging-about_{context}"]
 = About deploying the {logging-title}
 
-ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
-{product-title} cluster administrators can deploy the {logging} using the {product-title} web console or CLI to install the OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator. When the Operators are installed, you create a `ClusterLogging` custom resource (CR) to schedule {logging} pods and other resources necessary to support the {logging}. The Operators are responsible for deploying, upgrading, and maintaining the {logging}.
-endif::openshift-enterprise,openshift-webscale,openshift-origin[]
-
-The `ClusterLogging` CR defines a complete {logging} environment that includes all the components of the logging stack to collect, store and visualize logs. The Red Hat OpenShift Logging Operator watches the {logging} CR and adjusts the logging deployment accordingly.
+Administrators can deploy the {logging} by using the {product-title} web console or CLI to install the {logging} Operators. The Operators are responsible for deploying, upgrading, and maintaining the {logging}.
 
 Administrators and application developers can view the logs of the projects for which they have view access.
+
+[id="cluster-logging-about-custom-resources_{context}"]
+== Logging custom resources
+
+You can configure your {logging} deployment with custom resource (CR) YAML files implemented by each Operator.
+
+*Red Hat Openshift Logging Operator*:
+
+* `ClusterLogging` (CL) - After the Operators are installed, you create a `ClusterLogging` custom resource (CR) to schedule {logging} pods and other resources necessary to support the {logging}. The `ClusterLogging` CR deploys the collector and forwarder, which currently are both implemented by a daemonset running on each node. The Red Hat OpenShift Logging Operator watches the `ClusterLogging` CR and adjusts the logging deployment accordingly.
+
+* `ClusterLogForwarder` (CLF) - Generates collector configuration to forward logs per user configuration.
+
+*Loki Operator*:
+
+* `LokiStack` - Controls the Loki cluster as log store and the web proxy with OpenShift Container Platform authentication integration to enforce multi-tenancy.
+
+*OpenShift Elasticsearch Operator*:
+
+[NOTE]
+====
+These CRs are generated and managed by the Red Hat OpenShift Elasticsearch Operator. Manual changes cannot be made without being overwritten by the Operator.
+====
+
+* `ElasticSearch` - Configure and deploy an Elasticsearch instance as the default log store.
+
+* `Kibana` - Configure and deploy Kibana instance to search, query and view logs.
diff --git a/modules/cluster-logging-release-notes-5.3.z.adoc b/modules/cluster-logging-release-notes-5.3.z.adoc
diff --git a/modules/cluster-logging-rn-5.3.10.adoc b/modules/cluster-logging-rn-5.3.10.adoc
diff --git a/modules/cluster-logging-rn-5.3.11.adoc b/modules/cluster-logging-rn-5.3.11.adoc
diff --git a/modules/cluster-logging-rn-5.3.12.adoc b/modules/cluster-logging-rn-5.3.12.adoc
diff --git a/modules/cluster-logging-rn-5.3.13.adoc b/modules/cluster-logging-rn-5.3.13.adoc
diff --git a/modules/cluster-logging-rn-5.3.14.adoc b/modules/cluster-logging-rn-5.3.14.adoc