openshift · abrennan89 · Nov 29, 2023 · Nov 13, 2023
diff --git a/_attributes/attributes-openshift-dedicated.adoc b/_attributes/attributes-openshift-dedicated.adoc
@@ -20,8 +20,17 @@
 :rhq-short: Red Hat Quay
 :SMProductName: Red Hat OpenShift Service Mesh
 :pipelines-title: Red Hat OpenShift Pipelines
+//logging
+:logging-title: logging subsystem for Red Hat OpenShift
+:logging-title-uc: Logging subsystem for Red Hat OpenShift
+:logging: logging subsystem
+:logging-uc: Logging subsystem
+:clo: Red Hat OpenShift Logging Operator
+:loki-op: Loki Operator
+:es-op: Elasticsearch Operator
 :logging-sd: Red Hat OpenShift Logging
 :log-plug: logging subsystem Console Plugin
+//
 :ServerlessProductName: OpenShift Serverless
 :rh-openstack-first: Red Hat OpenStack Platform (RHOSP)
 :rh-openstack: RHOSP

diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2543,8 +2543,6 @@ Topics:
   Dir: config
   Distros: openshift-enterprise,openshift-origin
   Topics:
-  - Name: About the Cluster Logging custom resource
-    File: cluster-logging-configuring-cr
   - Name: Configuring the log store
     File: cluster-logging-log-store
   - Name: Configuring CPU and memory limits for Logging components

diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml
@@ -1055,8 +1055,6 @@ Topics:
 - Name: Configuring your Logging deployment
   Dir: config
   Topics:
-  - Name: About the Cluster Logging custom resource
-    File: cluster-logging-configuring-cr
   - Name: Configuring the log store
     File: cluster-logging-log-store
   - Name: Configuring CPU and memory limits for Logging components

diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml
@@ -88,7 +88,7 @@ Topics:
 #  File: rosa-mobb-prerequisites-tutorial
 - Name: Verifying Permissions for a ROSA STS Deployment
   File: rosa-mobb-verify-permissions-sts-deployment
-- Name: Configuring the Cluster Log Forwarder for CloudWatch logs and STS
+- Name: Configuring log forwarding for CloudWatch logs and STS
   File: cloud-experts-rosa-cloudwatch-sts
 - Name: Using AWS WAF and Amazon CloudFront to protect ROSA workloads
   File: cloud-experts-using-cloudfront-and-waf
@@ -351,7 +351,7 @@ Topics:
   Topics:
   - Name: Installing the web terminal
     File: installing-web-terminal
-# Do not have sufficient permissions to read any cluster configuration. 
+# Do not have sufficient permissions to read any cluster configuration.
 #  - Name: Configuring the web terminal
 #    File: configuring-web-terminal
   - Name: Using the web terminal
@@ -1239,8 +1239,6 @@ Topics:
 - Name: Configuring your Logging deployment
   Dir: config
   Topics:
-  - Name: About the Cluster Logging custom resource
-    File: cluster-logging-configuring-cr
   - Name: Configuring the log store
     File: cluster-logging-log-store
   - Name: Configuring CPU and memory limits for Logging components

diff --git a/cloud_experts_tutorials/cloud-experts-rosa-cloudwatch-sts.adoc b/cloud_experts_tutorials/cloud-experts-rosa-cloudwatch-sts.adoc
@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="cloud-experts-rosa-cloudwatch-sts"]
-= Tutorial: Configuring the Cluster Log Forwarder for CloudWatch logs and STS
+= Configuring log forwarding for CloudWatch logs and STS
 include::_attributes/attributes-openshift-dedicated.adoc[]
 :context: cloud-experts-rosa-cloudwatch-sts
 
@@ -18,7 +18,7 @@ toc::[]
 //   - Connor Wooley
 // ---
 
-Use this tutorial to deploy the Cluster Log Forwarder Operator and configure it to use Security Token Services (STS) authentication to forward logs to CloudWatch.
+Use this tutorial to deploy the {clo} and configure it to use Security Token Services (STS) authentication to forward logs to CloudWatch.
 
 [id="cloud-experts-rosa-cloudwatch-sts-prerequisites"]
 .Prerequisites
@@ -58,7 +58,7 @@ $ echo "Cluster: ${ROSA_CLUSTER_NAME}, Region: ${REGION}, OIDC Endpoint: ${OIDC_
 [id="cloud-experts-rosa-cloudwatch-sts-prep-aws"]
 == Preparing your AWS account
 
-. Create an Identity Access Management (IAM) policy for OpenShift Log Forwarding:
+. Create an Identity Access Management (IAM) policy for the {logging}:
 +
 [source,terminal]
 ----
@@ -127,7 +127,7 @@ $ aws iam attach-role-policy --role-name "${ROSA_CLUSTER_NAME}-RosaCloudWatch" \
 [id="cloud-experts-rosa-cloudwatch-sts-deploy-Os"]
 == Deploying Operators
 
-. Deploy the Cluster Logging Operator:
+. Deploy the {clo}:
 +
 [source,terminal]
 ----
@@ -166,7 +166,7 @@ EOF
 [id="cloud-experts-rosa-cloudwatch-sts-configure-cluster-logging"]
 == Configuring cluster logging
 
-. Create a cluster-log forwarding resource:
+. Create a `ClusterLogForwarder` custom resource (CR):
 +
 [source,terminal]
 ----
@@ -197,7 +197,7 @@ $ cat << EOF | oc apply -f -
 EOF
 ----
 
-. Create a cluster logging resource:
+. Create a `ClusterLogging` CR:
 +
 [source,terminal]
 ----
@@ -258,14 +258,14 @@ If this is a new cluster, you might not see a log group for `application` logs a
 [id="cloud-experts-rosa-cloudwatch-sts-clean-up"]
 == Cleaning up your resources
 
-. Delete the cluster-log forwarding resource:
+. Delete the `ClusterLogForwarder` CR:
 +
 [source,terminal]
 ----
 $ oc delete -n openshift-logging clusterlogforwarder instance
 ----
 
-. Delete the cluster logging resource:
+. Delete the `ClusterLogging` CR:
 +
 [source,terminal]
 ----
@@ -305,4 +305,4 @@ $ aws iam delete-policy --policy-arn "${POLICY_ARN}"
 ----
 $ aws logs delete-log-group --log-group-name "rosa-${ROSA_CLUSTER_NAME}.audit"
 $ aws logs delete-log-group --log-group-name "rosa-${ROSA_CLUSTER_NAME}.infrastructure"
-----
+----
diff --git a/logging/cluster-logging-deploying.adoc b/logging/cluster-logging-deploying.adoc
@@ -43,8 +43,12 @@ include::modules/logging-install-es-operator.adoc[leveloffset=+2]
 [id="cluster-logging-deploying-postinstallation"]
 == Postinstallation tasks
 
-If your network plugin enforces network isolation, xref:#cluster-logging-deploy-multitenant_cluster-logging-deploying[allow network traffic between the projects that contain the {logging} Operators].
+After you have installed the {clo}, you can configure your deployment by creating and modifying a `ClusterLogging` custom resource (CR).
 
+include::modules/cluster-logging-about-crd.adoc[leveloffset=+2]
+include::modules/configuring-log-storage-cr.adoc[leveloffset=+2]
+include::modules/configuring-logging-collector.adoc[leveloffset=+2]
+include::modules/configuring-log-visualizer.adoc[leveloffset=+2]
 include::modules/cluster-logging-deploy-multitenant.adoc[leveloffset=+2]
 
 [role="_additional-resources"]

diff --git a/logging/cluster-logging-loki.adoc b/logging/cluster-logging-loki.adoc
@@ -26,6 +26,8 @@ include::modules/logging-loki-cli-install.adoc[leveloffset=+1]
 
 include::modules/logging-clo-cli-install.adoc[leveloffset=+1]
 
+include::modules/configuring-log-storage-cr.adoc[leveloffset=+1]
+
 include::modules/logging-loki-storage.adoc[leveloffset=+1]
 
 include::modules/logging-loki-storage-aws.adoc[leveloffset=+2]
@@ -79,10 +81,7 @@ xref:../authentication/using-rbac.adoc[Using RBAC to define and apply permission
 endif::[]
 
 include::modules/logging-loki-retention.adoc[leveloffset=+1]
-
-include::modules/cluster-logging-forwarding-lokistack.adoc[leveloffset=+1]
-
-include::modules/loki-rate-limit-errors.adoc[leveloffset=+2]
+include::modules/loki-rate-limit-errors.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 [id="additional-resources_cluster-logging-loki"]

diff --git a/logging/config/cluster-logging-configuring-cr.adoc b/logging/config/cluster-logging-configuring-cr.adoc
diff --git a/logging/log_collection_forwarding/cluster-logging-collector.adoc b/logging/log_collection_forwarding/cluster-logging-collector.adoc
@@ -11,6 +11,8 @@ 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).
 
+include::modules/configuring-logging-collector.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/log_visualization/log-visualization.adoc b/logging/log_visualization/log-visualization.adoc
@@ -11,6 +11,8 @@ You can visualize your log data in the {product-title} web console, or the Kiban
 
 include::snippets/logging-kibana-dep-snip.adoc[]
 
+include::modules/configuring-log-visualizer.adoc[leveloffset=+1]
+
 [id="log-visualization-resource-logs"]
 == Viewing logs for a resource
 

diff --git a/modules/cluster-logging-about-crd.adoc b/modules/cluster-logging-about-crd.adoc
@@ -3,18 +3,12 @@
 // * logging/cluster-logging.adoc
 
 :_mod-docs-content-type: CONCEPT
-[id="cluster-logging-configuring-crd_{context}"]
+[id="cluster-logging-about-crd_{context}"]
 = About the ClusterLogging custom resource
 
 To make changes to your {logging} environment, create and modify the `ClusterLogging` custom resource (CR).
 
-Instructions for creating or modifying a CR are provided in this documentation as appropriate.
-
-The following example shows a typical custom resource for the {logging}.
-
-[id="efk-logging-configuring-about-sample_{context}"]
 .Sample `ClusterLogging` custom resource (CR)
-ifdef::openshift-enterprise,openshift-rosa,openshift-dedicated,openshift-webscale,openshift-origin[]
 [source,yaml]
 ----
 apiVersion: "logging.openshift.io/v1"
@@ -24,52 +18,8 @@ metadata:
   namespace: "openshift-logging" <2>
 spec:
   managementState: "Managed" <3>
-  logStore:
-    type: "elasticsearch" <4>
-    retentionPolicy:
-      application:
-        maxAge: 1d
-      infra:
-        maxAge: 7d
-      audit:
-        maxAge: 7d
-    elasticsearch:
-      nodeCount: 3
-      resources:
-        limits:
-          memory: 16Gi
-        requests:
-          cpu: 500m
-          memory: 16Gi
-      storage:
-        storageClassName: "gp2"
-        size: "200G"
-      redundancyPolicy: "SingleRedundancy"
-  visualization: <5>
-    type: "kibana"
-    kibana:
-      resources:
-        limits:
-          memory: 736Mi
-        requests:
-          cpu: 100m
-          memory: 736Mi
-      replicas: 1
-  collection: <6>
-    logs:
-      type: "fluentd"
-      fluentd:
-        resources:
-          limits:
-            memory: 736Mi
-          requests:
-            cpu: 100m
-            memory: 736Mi
+# ...
 ----
 <1> The CR name must be `instance`.
 <2> The CR must be installed to the `openshift-logging` namespace.
 <3> The Red Hat OpenShift Logging Operator management state. When set to `unmanaged` the operator is in an unsupported state and will not get updates.
-<4> Settings for the log store, including retention policy, the number of nodes, the resource requests and limits, and the storage class.
-<5> Settings for the visualizer, including the resource requests and limits, and the number of pod replicas.
-<6> Settings for the log collector, including the resource requests and limits.
-endif::[]
diff --git a/modules/cluster-logging-collector-log-forward-syslog.adoc b/modules/cluster-logging-collector-log-forward-syslog.adoc
@@ -42,7 +42,7 @@ spec:
       procID: myproc
       rfc: RFC5424
       severity: debug
-     url: 'udp://rsyslogserver.west.example.com:514'
+     url: 'tcp://rsyslogserver.west.example.com:514'
   pipelines:
    - name: syslog-east <8>
      inputRefs: <9>

diff --git a/modules/cluster-logging-forwarding-lokistack.adoc b/modules/cluster-logging-forwarding-lokistack.adoc