Merge pull request #91760 from briandooley/logging-docs-6.2

Merging 6.2 into main

Author: kalexand-rh

_topic_maps/_topic_map.yml

@@ -3016,15 +3016,38 @@ Topics:
 #      File: logging-5-8-release-notes
 #    - Name: Logging 5.7
 #      File: logging-5-7-release-notes
+  - Name: Logging 6.2
+    Dir: logging-6.2
+    Topics:
+    - Name: Support
+      File: log62-cluster-logging-support
+    - Name: Release notes
+      File: log6x-release-notes-6.2
+    - Name: About logging 6.2
+      File: log6x-about-6.2
+    - Name: Configuring log forwarding
+      File: log6x-clf-6.2
+    - Name: Configuring the logging collector
+      File: 6x-cluster-logging-collector-6.2
+    - Name: Configuring LokiStack storage
+      File: log6x-loki-6.2
+    - Name: Configuring LokiStack for OTLP
+      File: log6x-configuring-lokistack-otlp-6.2
+    - Name: Visualization for logging
+      File: log6x-visual-6.2
   - Name: Logging 6.1
     Dir: logging-6.1
     Topics:
+    - Name: Support
+      File: log61-cluster-logging-support
     - Name: Release notes
       File: log6x-release-notes-6.1
     - Name: About logging 6.1
       File: log6x-about-6.1
     - Name: Configuring log forwarding
       File: log6x-clf-6.1
+    - Name: Configuring the logging collector
+      File: 6x-cluster-logging-collector-6.1
     - Name: Configuring LokiStack storage
       File: log6x-loki-6.1
     - Name: Configuring LokiStack for OTLP

modules/cluster-logging-maintenance-support-list-6x.adoc

@@ -0,0 +1,21 @@
+// Module included in the following assemblies:
+//
+// * observability/logging/logging-6.0/log60-cluster-logging-support.adoc
+// * observability/logging/logging-6.1/log61-cluster-logging-support.adoc
+// * observability/logging/logging-6.2/log62-cluster-logging-support.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="cluster-logging-maintenance-support-list_{context}"]
+= Unsupported configurations
+
+You must set the Red{nbsp}Hat OpenShift Logging Operator to the `Unmanaged` state to modify the following components:
+
+* The collector configuration file
+
+* The collector daemonset
+
+Explicitly unsupported cases include:
+
+* *Configuring the logging collector using environment variables*. You cannot use environment variables to modify the log collector.
+
+* *Configuring how the log collector normalizes logs*. You cannot modify default log normalization.

modules/cluster-logging-maintenance-support-list.adoc

@@ -7,19 +7,14 @@
 
 You must set the Red{nbsp}Hat OpenShift Logging Operator to the `Unmanaged` state to modify the following components:
 
-* 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 Elasticsearch deployment files.
+* The `vector.toml` file for Vector collector deployments
 
-Explicitly unsupported cases include:
 
-* *Configuring default log rotation*. You cannot modify the default log rotation configuration.
+Explicitly unsupported cases include:
 
 * *Configuring the collected log location*. You cannot change the location of the log collector output file, which by default is `/var/log/fluentd/fluentd.log`.
 

modules/log-collector-http-server.adoc

@@ -2,6 +2,9 @@
 //
 // * observability/logging/log_collection_forwarding/cluster-logging-collector.adoc
 
+
+//This file is for Logging 5.x
+
 :_mod-docs-content-type: PROCEDURE
 [id="log-collector-http-server_{context}"]
 = Configuring the collector to receive audit logs as an HTTP server
@@ -23,7 +26,7 @@ You can configure your log collector to listen for HTTP connections and receive
 .Example `ClusterLogForwarder` CR if you are using a multi log forwarder deployment
 [source,yaml]
 ----
-apiVersion: logging.openshift.io/v1beta1
+apiVersion: logging.openshift.io/v1
 kind: ClusterLogForwarder
 metadata:
 # ...

modules/log-collector-rsyslog-server.adoc

@@ -0,0 +1,57 @@
+// Module included in the following assemblies:
+//
+// * observability/logging/logging-6.2/log6x-release-notes-6.2.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="logging-release-notes-6-2-0_{context}"]
+= Logging 6.2.0 Release Notes
+
+////
+TOFIX
+This release includes link:https://access.redhat.com/errata/RHBA-2024:9038[{logging-uc} {for} Bug Fix Release 6.2.0].
+////
+
+[id="openshift-logging-release-notes-6-2-0-enhancements_{context}"]
+== New Features and Enhancements
+
+////
+TOFIX:
+=== Log Collection
+
+* This enhancement adds the source `iostream` to the attributes sent from collected container logs. The value is set to either `stdout` or `stderr` based on how the collector received it. (link:https://issues.redhat.com/browse/LOG-5292[LOG-5292])
+
+* With this update, the default memory limit for the collector increases from 1024 Mi to 2048 Mi. Users should adjust resource limits based on their cluster’s specific needs and specifications. (link:https://issues.redhat.com/browse/LOG-6072[LOG-6072])
+
+* With this update, users can now set the syslog output delivery mode of the `ClusterLogForwarder` CR to either `AtLeastOnce` or `AtMostOnce.` (link:https://issues.redhat.com/browse/LOG-6355[LOG-6355])
+
+=== Log Storage
+
+* With this update, the new `1x.pico` LokiStack size supports clusters with fewer workloads and lower log volumes (up to 50GB/day). (link:https://issues.redhat.com/browse/LOG-5939[LOG-5939])
+
+////
+
+[id="logging-release-notes-6-2-0-technology-preview-features_{context}"]
+== Technology Preview
+
+:FeatureName: The OpenTelemetry Protocol (OTLP) output log forwarder
+include::snippets/technology-preview.adoc[]
+
+////
+* With this update, a `dataModel` field has been added to the `lokiStack` output specification. Set the `dataModel` to `Otel` to configure log forwarding using the OpenTelemetry data format. The default is set to `Viaq`. For information about data mapping see link:https://opentelemetry.io/docs/specs/otlp/[OTLP Specification].
+
+////
+
+[id="logging-release-notes-6-2-0-bug-fixes_{context}"]
+== Bug Fixes
+////
+TOFIX:
+None.
+////
+
+[id="logging-release-notes-6-2-0-CVEs_{context}"]
+== CVEs
+////
+TOFIX:
+* link:https://access.redhat.com/security/cve/CVE-2024-6119[CVE-2024-6119]
+* link:https://access.redhat.com/security/cve/CVE-2024-6232[CVE-2024-6232]
+////

modules/log6x-6-2-0-rn.adoc

@@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * observability/logging/cluster-logging-collector.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="log6x-cluster-logging-collector-limits_{context}"]
+= Configure log collector CPU and memory limits
+
+Use the log collector to adjust the CPU and memory limits.
+
+.Procedure
+
+* Edit the `ClusterLogForwarder` custom resource (CR):
++
+[source,terminal]
+----
+$ oc -n openshift-logging edit ClusterLogging instance
+----
++
+[source,yaml]
+----
+apiVersion: observability.openshift.io/v1
+kind: ClusterLogForwarder
+metadata:
+  name: instance
+  namespace: openshift-logging
+spec:
+  collector:
+    resources:
+      limits: <1>
+        memory: 736Mi
+      requests:
+        cpu: 100m
+        memory: 736Mi
+# ...
+----
+<1> Specify the CPU and memory limits and requests as needed. The values shown are the default values.