Merge pull request #90136 from openshift/logging-docs-6.2-4.17

Logging docs 6.2 4.17

Author: ousleyp

_topic_maps/_topic_map.yml

@@ -2993,41 +2993,42 @@ Topics:
   Dir: logging
   Distros: openshift-enterprise,openshift-origin
   Topics:
-#  - Name: Release notes
-#    Dir: logging_release_notes
-#    Topics:
-#    - Name: Logging 5.9
-#      File: logging-5-9-release-notes
-#    - Name: Logging 5.8
-#      File: logging-5-8-release-notes
-#    - Name: Logging 5.7
-#      File: logging-5-7-release-notes
-  - Name: Logging 6.0
-    Dir: logging-6.0
+  - Name: Logging 6.2
+    Dir: logging-6.2
     Topics:
-      - Name: Release notes
-        File: log6x-release-notes
-      - Name: About logging 6.0
-        File: log6x-about
-      - Name: Upgrading to Logging 6.0
-        File: log6x-upgrading-to-6
-      - Name: Configuring log forwarding
-        File: log6x-clf
-      - Name: Configuring LokiStack storage
-        File: log6x-loki
-      - Name: Visualization for logging
-        File: log6x-visual
-#      - Name: API reference 6.0
-#        File: log6x-api-reference
+    - 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: Installing Logging
+      File: 6x-cluster-logging-deploying-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: Installing Logging
+      File: 6x-cluster-logging-deploying-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
@@ -3036,6 +3037,36 @@ Topics:
       File: log6x-opentelemetry-data-model-6.1
     - Name: Visualization for logging
       File: log6x-visual-6.1
+  - Name: Logging 6.0
+    Dir: logging-6.0
+    Topics:
+    - Name: Release notes
+      File: log6x-release-notes
+    - Name: About logging 6.0
+      File: log6x-about
+    - Name: Installing Logging
+      File: 6x-cluster-logging-deploying-6.0
+    - Name: Upgrading to Logging 6.0
+      File: log6x-upgrading-to-6
+    - Name: Configuring log forwarding
+      File: log6x-clf
+#    - Name: Configuring the logging collector
+#      File: 6x-cluster-logging-collector-6.0
+    - Name: Configuring LokiStack storage
+      File: log6x-loki
+    - Name: Visualization for logging
+      File: log6x-visual
+    # - Name: API reference 6.0
+    #   File: log6x-api-reference
+  - Name: Logging 5.8
+    Dir: logging_release_notes
+    Topics:
+    - Name: Release notes
+      File: logging-5-8-release-notes
+    - Name: Installing Logging
+      File: cluster-logging-deploying
+#    - Name: Configuring the logging collector
+#      File: cluster-logging-collector
 #  - Name: Support
 #    File: cluster-logging-support
 #  - Name: Troubleshooting logging

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,65 @@
+// 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
+
+This release includes link:https://access.redhat.com/errata/RHBA-2025:2398[{logging-uc} {for} Bug Fix Release 6.2.0].
+
+[id="openshift-logging-release-notes-6-2-0-enhancements_{context}"]
+== New Features and Enhancements
+
+
+=== Log Collection
+
+* With this update, HTTP outputs include a `proxy` field that you can use to send log data through an HTTP proxy. (link:https://issues.redhat.com/browse/LOG-6069[LOG-6069])
+
+=== Log Storage
+
+* With this update, time-based stream sharding in Loki is now enabled by the {loki-op}. This solves the issue of ingesting log entries older than the sliding time-window used by Loki. (link:https://issues.redhat.com/browse/LOG-6757[LOG-6757])
+
+* With this update, you can configure a custom certificate authority (CA) certificate with {loki-op} when using Swift as an object store. (link:https://issues.redhat.com/browse/LOG-4818[LOG-4818])
+
+* With this update, you can configure workload identity federation on {gcp-first} by using the Cluster Credential Operator in OpenShift 4.17 and later releases with the {loki-op}. (link:https://issues.redhat.com/browse/LOG-6158[LOG-6158])
+
+[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, OpenTelemetry support offered by OpenShift {logging-uc} continues to improve, specifically in the area of enabling migrations from the ViaQ data model to `OpenTelemetry` when forwarding to `LokiStack`. (link:https://issues.redhat.com/browse/LOG-6146[LOG-6146])
+
+* With this update, the `structuredMetadata` field has been removed from {loki-op} in the `otlp` configuration because structured metadata is now the default type. Additionally, the update introduces a `drop` field that administrators can use to drop `OpenTelemetry` attributes when receiving data through `OpenTelemetry` protocol (OTLP). (link:https://issues.redhat.com/browse/LOG-6507[LOG-6507])
+
+[id="logging-release-notes-6-2-0-bug-fixes_{context}"]
+== Bug Fixes
+
+* Before this update, the timestamp shown in the console logs did not match the `@timestamp` field in the message. With this update the timestamp is correctly shown in the console. (link:https://issues.redhat.com/browse/LOG-6222[LOG-6222])
+
+* The introduction of `ClusterLogForwarder` 6.x modified the `ClusterLogForwarder` API to allow for a consistent templating mechanism. However, this was not applied to the `syslog` output spec API for the `facility` and `severity` fields. This update adds the required validation to the `ClusterLogForwarder` API for the `facility` and `severity` fields. (https://issues.redhat.com/browse/LOG-6661[LOG-6661])
+
+* Before this update, an error in the {loki-op} generating the Loki configuration caused the amount of workers to delete to be zero when `1x.pico` was set as the `LokiStack` size. With this update, the number of workers to delete is set to 10. (https://issues.redhat.com/browse/LOG-6781[LOG-6781])
+
+[id="logging-release-notes-6-2-0-known-issues_{context}"]
+== Known Issues
+
+* The previous data model encoded all information in JSON. The console still uses the query of the previous data model to decode both old and new entries. The logs that are stored by using the new `OpenTelemetry` data model for the `LokiStack` output display the following error in the logging console:
++
+----
+__error__ JSONParserErr 
+__error_details__ Value looks like object, but can't find closing '}' symbol
+----
++
+You can ignore the error as it is only a result of the query and not a data-related error. (https://issues.redhat.com/browse/LOG-6808[LOG-6808])
+
+* Currently, the API documentation incorrectly mentions `OpenTelemetry` protocol (OTLP) attributes as `included` instead of `excluded` in the descriptions of the `drop` field. (https://issues.redhat.com/browse/LOG-6839[LOG-6839]).
+
+
+[id="logging-release-notes-6-2-0-CVEs_{context}"]
+== CVEs
+
+* link:https://access.redhat.com/security/cve/CVE-2020-11023[CVE-2020-11023]
+* link:https://access.redhat.com/security/cve/CVE-2024-12797[CVE-2024-12797]

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.