Skip to content

Commit 799528b

Browse files
committed
standalone logging docs - release notes for 6.0
1 parent 2ea6dd0 commit 799528b

9 files changed

+297
-0
lines changed

_topic_maps/_topic_map.yml

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ Name: About OpenShift Logging
33
Dir: about
44
Distros: openshift-logging
55
Topics:
6+
- Name: Release notes
7+
File: logging-release-notes-6-0
68
- Name: Logging overview
79
File: about-logging
810
- Name: Cluster logging support

about/logging-release-notes-6-0.adoc

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="logging-release-notes-6-0"]
4+
= Release notes
5+
:context: logging-release-notes-6-0
6+
7+
toc::[]
8+
9+
include::modules/logging-release-notes-6-0-7.adoc[leveloffset=+1]
10+
11+
include::modules/logging-release-notes-6-0-6.adoc[leveloffset=+1]
12+
13+
include::modules/logging-release-notes-6-0-5.adoc[leveloffset=+1]
14+
15+
include::modules/logging-release-notes-6-0-4.adoc[leveloffset=+1]
16+
17+
include::modules/logging-release-notes-6-0-3.adoc[leveloffset=+1]
18+
19+
include::modules/logging-release-notes-6-0-2.adoc[leveloffset=+1]
20+
21+
include::modules/logging-release-notes-6-0-1.adoc[leveloffset=+1]
22+
23+
[id="log6x0-release-notes"]
24+
== Logging 6.0.0
25+
This release includes link:https://access.redhat.com/errata/RHBA-2024:6693[{logging-uc} {for} Bug Fix Release 6.0.0]
26+
27+
include::snippets/logging-compatibility-snip.adoc[]
28+
29+
.Upstream component versions
30+
[options="header"]
31+
|===
32+
33+
| {logging} Version 6+| Component Version
34+
35+
| Operator | `eventrouter` | `logfilemetricexporter` | `loki` | `lokistack-gateway` | `opa-openshift` | `vector`
36+
37+
|6.0 | 0.4 | 1.1 | 3.1.0 | 0.1 | 0.1 | 0.37.1
38+
39+
|===
40+
41+
[id="log6x-release-notes-6-0-0-removal-notice"]
42+
== Removal notice
43+
44+
* With this release, {logging} no longer supports the `ClusterLogging.logging.openshift.io` and `ClusterLogForwarder.logging.openshift.io` custom resources. Refer to the product documentation for details on the replacement features. (link:https://issues.redhat.com/browse/LOG-5803[LOG-5803])
45+
46+
* With this release, {logging} no longer manages or deploys log storage (such as Elasticsearch), visualization (such as Kibana), or Fluentd-based log collectors. (link:https://issues.redhat.com/browse/LOG-5368[LOG-5368])
47+
48+
[NOTE]
49+
====
50+
In order to continue to use Elasticsearch and Kibana managed by the elasticsearch-operator, the administrator must modify those object's ownerRefs before deleting the ClusterLogging resource.
51+
====
52+
53+
[id="log6x-release-notes-6-0-0-enhancements"]
54+
== New features and enhancements
55+
56+
* This feature introduces a new architecture for {logging} {for} by shifting component responsibilities to their relevant Operators, such as for storage, visualization, and collection. It introduces the `ClusterLogForwarder.observability.openshift.io` API for log collection and forwarding. Support for the `ClusterLogging.logging.openshift.io` and `ClusterLogForwarder.logging.openshift.io` APIs, along with the Red Hat managed Elastic stack (Elasticsearch and Kibana), is removed. Users are encouraged to migrate to the Red Hat `LokiStack` for log storage. Existing managed Elasticsearch deployments can be used for a limited time. Automated migration for log collection is not provided, so administrators need to create a new ClusterLogForwarder.observability.openshift.io specification to replace their previous custom resources. Refer to the official product documentation for more details. (link:https://issues.redhat.com/browse/LOG-3493[LOG-3493])
57+
58+
* With this release, the responsibility for deploying the {logging} view plugin shifts from the {clo} to the {coo-first}. For new log storage installations that need visualization, the {coo-full} and the associated UIPlugin resource must be deployed. Refer to the link:https://docs.openshift.com/container-platform/latest/observability/cluster_observability_operator/cluster-observability-operator-overview.html#cluster-observability-operator-overview[Cluster Observability Operator Overview] product documentation for more details. (link:https://issues.redhat.com/browse/LOG-5461[LOG-5461])
59+
60+
* This enhancement sets default requests and limits for Vector collector deployments' memory and CPU usage based on Vector documentation recommendations. (link:https://issues.redhat.com/browse/LOG-4745[LOG-4745])
61+
62+
* This enhancement updates Vector to align with the upstream version v0.37.1. (link:https://issues.redhat.com/browse/LOG-5296[LOG-5296])
63+
64+
* This enhancement introduces an alert that triggers when log collectors buffer logs to a node's file system and use over 15% of the available space, indicating potential back pressure issues. (link:https://issues.redhat.com/browse/LOG-5381[LOG-5381])
65+
66+
* This enhancement updates the selectors for all components to use common Kubernetes labels. (link:https://issues.redhat.com/browse/LOG-5906[LOG-5906])
67+
68+
* This enhancement changes the collector configuration to deploy as a ConfigMap instead of a secret, allowing users to view and edit the configuration when the ClusterLogForwarder is set to Unmanaged. (link:https://issues.redhat.com/browse/LOG-5599[LOG-5599])
69+
70+
* This enhancement adds the ability to configure the Vector collector log level using an annotation on the ClusterLogForwarder, with options including trace, debug, info, warn, error, or off. (link:https://issues.redhat.com/browse/LOG-5372[LOG-5372])
71+
72+
* This enhancement adds validation to reject configurations where Amazon CloudWatch outputs use multiple AWS roles, preventing incorrect log routing. (link:https://issues.redhat.com/browse/LOG-5640[LOG-5640])
73+
* This enhancement removes the Log Bytes Collected and Log Bytes Sent graphs from the metrics dashboard. (link:https://issues.redhat.com/browse/LOG-5964[LOG-5964])
74+
75+
* This enhancement updates the must-gather functionality to only capture information for inspecting Logging 6.0 components, including Vector deployments from ClusterLogForwarder.observability.openshift.io resources and the Red Hat managed LokiStack. (link:https://issues.redhat.com/browse/LOG-5949[LOG-5949])
76+
77+
* This enhancement improves Azure storage secret validation by providing early warnings for specific error conditions. (link:https://issues.redhat.com/browse/LOG-4571[LOG-4571])
78+
79+
* This enhancement updates the `ClusterLogForwarder` API to follow the Kubernetes standards. (link:https://issues.redhat.com/browse/LOG-5977[LOG-5977])
80+
+
81+
.Example of a new configuration in the `ClusterLogForwarder` custom resource for the updated API
82+
[source,yaml]
83+
----
84+
apiVersion: observability.openshift.io/v1
85+
kind: ClusterLogForwarder
86+
metadata:
87+
name: <name>
88+
spec:
89+
outputs:
90+
- name: <output_name>
91+
type: <output_type>
92+
<output_type>:
93+
tuning:
94+
deliveryMode: AtMostOnce
95+
----
96+
97+
[id="log6x-release-notes-6-0-0-technology-preview-features"]
98+
== Technology Preview features
99+
100+
* This release introduces a Technology Preview feature for log forwarding using OpenTelemetry. A new output type,` OTLP`, allows sending JSON-encoded log records using the OpenTelemetry data model and resource semantic conventions. (link:https://issues.redhat.com/browse/LOG-4225[LOG-4225])
101+
102+
[id="log6x-release-notes-6-0-0-bug-fixes"]
103+
== Bug fixes
104+
105+
* Before this update, the `CollectorHighErrorRate` and `CollectorVeryHighErrorRate` alerts were still present. With this update, both alerts are removed in the {logging} 6.0 release but might return in a future release. (link:https://issues.redhat.com/browse/LOG-3432[LOG-3432])
106+
107+
[id="log6x-release-notes-6-0-0-CVEs"]
108+
== CVEs
109+
110+
* link:https://access.redhat.com/security/cve/CVE-2024-34397[CVE-2024-34397]
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:_mod-docs-content-type: REFERENCE
2+
[id="logging-release-notes-6-0-1_{context}"]
3+
= Logging 6.0.1
4+
This release includes link:https://access.redhat.com/errata/RHSA-2024:8315[OpenShift Logging Bug Fix Release 6.0.1].
5+
6+
// 4.17
7+
8+
[id="openshift-logging-6-0-1-bug-fixes_{context}"]
9+
== Bug fixes
10+
11+
* With this update, the default memory limit for the collector has been increased from 1024 Mi to 2024 Mi. However, users should always adjust their resource limits according to their cluster specifications and needs. (link:https://issues.redhat.com/browse/LOG-6180[LOG-6180])
12+
13+
* Before this update, the Loki Operator failed to add the default `namespace` label to all `AlertingRule` resources, which caused the User-Workload-Monitoring Alertmanager to skip routing these alerts. This update adds the rule namespace as a label to all alerting and recording rules, resolving the issue and restoring proper alert routing in Alertmanager.
14+
(link:https://issues.redhat.com/browse/LOG-6151[LOG-6151])
15+
16+
* Before this update, the LokiStack ruler component view did not initialize properly, causing an invalid field error when the ruler component was disabled. This update ensures that the component view initializes with an empty value, resolving the issue.
17+
(link:https://issues.redhat.com/browse/LOG-6129[LOG-6129])
18+
19+
* Before this update, it was possible to set `log_source` in the prune filter, which could lead to inconsistent log data. With this update, the configuration is validated before being applied, and any configuration that includes `log_source` in the prune filter is rejected.
20+
(link:https://issues.redhat.com/browse/LOG-6202[LOG-6202])
21+
22+
[id="openshift-logging-6-0-1-CVEs_{context}"]
23+
== CVEs
24+
25+
* link:https://access.redhat.com/security/cve/CVE-2024-24791[CVE-2024-24791]
26+
* link:https://access.redhat.com/security/cve/CVE-2024-34155[CVE-2024-34155]
27+
* link:https://access.redhat.com/security/cve/CVE-2024-34156[CVE-2024-34156]
28+
* link:https://access.redhat.com/security/cve/CVE-2024-34158[CVE-2024-34158]
29+
* link:https://access.redhat.com/security/cve/CVE-2024-6104[CVE-2024-6104]
30+
* link:https://access.redhat.com/security/cve/CVE-2024-6119[CVE-2024-6119]
31+
* link:https://access.redhat.com/security/cve/CVE-2024-45490[CVE-2024-45490]
32+
* link:https://access.redhat.com/security/cve/CVE-2024-45491[CVE-2024-45491]
33+
* link:https://access.redhat.com/security/cve/CVE-2024-45492[CVE-2024-45492]
+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: REFERENCE
2+
[id="logging-release-notes-6-0-2_{context}"]
3+
= Logging 6.0.2
4+
This release includes link:https://access.redhat.com/errata/RHBA-2024:10051[RHBA-2024:10051].
5+
6+
[id="logging-release-notes-6-0-2-bug-fixes_{context}"]
7+
== Bug fixes
8+
9+
* Before this update, Loki did not correctly load some configurations, which caused issues when using Alibaba Cloud or IBM Cloud object storage. This update fixes the configuration-loading code in Loki, resolving the issue. (link:https://issues.redhat.com/browse/LOG-5325[LOG-5325])
10+
11+
* Before this update, the collector would discard audit log messages that exceeded the configured threshold. This modifies the audit configuration thresholds for the maximum line size as well as the number of bytes read during a read cycle. (link:https://issues.redhat.com/browse/LOG-5998[LOG-5998])
12+
13+
* Before this update, the Cluster Logging Operator did not watch and reconcile resources associated with an instance of a ClusterLogForwarder like it did in prior releases. This update modifies the operator to watch and reconcile all resources it owns and creates. (link:https://issues.redhat.com/browse/LOG-6264[LOG-6264])
14+
15+
* Before this update, log events with an unknown severity level sent to Google Cloud Logging would trigger a warning in the vector collector, which would then default the severity to 'DEFAULT'. With this update, log severity levels are now standardized to match Google Cloud Logging specifications, and audit logs are assigned a severity of 'INFO'. (link:https://issues.redhat.com/browse/LOG-6296[LOG-6296])
16+
17+
* Before this update, when infrastructure namespaces were included in application inputs, the `log_type` was set as `application`. With this update, the `log_type` of infrastructure namespaces included in application inputs is set to `infrastructure`. (link:https://issues.redhat.com/browse/LOG-6354[LOG-6354])
18+
19+
* Before this update, specifying a value for the `syslog.enrichment` field of the ClusterLogForwarder added `namespace_name`, `container_name`, and `pod_name` to the messages of non-container logs. With this update, only container logs include `namespace_name`, `container_name`, and `pod_name` in their messages when `syslog.enrichment` is set. (link:https://issues.redhat.com/browse/LOG-6402[LOG-6402])
20+
21+
[id="logging-release-notes-6-0-2-CVEs_{context}"]
22+
== CVEs
23+
24+
* link:https://access.redhat.com/security/cve/CVE-2024-6119[CVE-2024-6119]
25+
* link:https://access.redhat.com/security/cve/CVE-2024-6232[CVE-2024-6232]
+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
:_mod-docs-content-type: REFERENCE
2+
[id="logging-release-notes-6-0-3_{context}"]
3+
= Logging 6.0.3
4+
5+
This release includes link:https://access.redhat.com/errata/RHBA-2024:10991[RHBA-2024:10991].
6+
7+
[id="logging-release-notes-6-0-3-enhancements_{context}"]
8+
== New features and enhancements
9+
10+
* With this update, the {loki-op} supports the configuring of the workload identity federation on the {gcp-first} by using the Cluster Credential Operator (CCO) in {product-title} 4.17 or later. (link:https://issues.redhat.com/browse/LOG-6421[LOG-6421])
11+
12+
[id="logging-release-notes-6-0-3-bug-fixes_{context}"]
13+
== Bug fixes
14+
15+
* Before this update, the collector used the default settings to collect audit logs, which did not account for back pressure from output receivers. With this update, the audit log collection is optimized for file handling and log reading. (link:https://issues.redhat.com/browse/LOG-6034[LOG-6034])
16+
17+
* Before this update, any namespace containing `openshift` or `kube` was treated as an infrastructure namespace. With this update, only the following namespaces are treated as infrastructure namespaces: `default`, `kube`, `openshift`, and namespaces that begin with `openshift-` or `kube-`. (link:https://issues.redhat.com/browse/LOG-6204[LOG-6204])
18+
19+
* Before this update, an input receiver service was repeatedly created and deleted, causing issues with mounting the TLS secrets. With this update, the service is created once and only deleted if it is not defined in the `ClusterLogForwarder` custom resource. (link:https://issues.redhat.com/browse/LOG-6343[LOG-6343])
20+
21+
* Before this update, pipeline validation might enter an infinite loop if a name was a substring of another name. With this update, stricter name equality checks prevent the infinite loop. (link:https://issues.redhat.com/browse/LOG-6352[LOG-6352])
22+
23+
* Before this update, the collector alerting rules included the summary and message fields. With this update, the collector alerting rules include the summary and description fields. (link:https://issues.redhat.com/browse/LOG-6406[LOG-6406])
24+
25+
* Before this update, setting up the custom audit inputs in the `ClusterLogForwarder` custom resource with configured `LokiStack` output caused errors due to the nil pointer dereference. With this update, the Operator performs the nil checks, preventing such errors. (link:https://issues.redhat.com/browse/LOG-6441[LOG-6441])
26+
27+
* Before this update, the collector did not correctly mount the `/var/log/oauth-server/` path, which prevented the collection of the audit logs. With this update, the volume mount is added, and the audit logs are collected as expected. (link:https://issues.redhat.com/browse/LOG-6486[LOG-6486])
28+
29+
* Before this update, the collector did not correctly mount the `oauth-apiserver` audit log file. As a result, such audit logs were not collected. With this update, the volume mount is correctly mounted, and the logs are collected as expected. (link:https://issues.redhat.com/browse/LOG-6543[LOG-6543])
30+
31+
[id="logging-release-notes-6-0-3-CVEs_{context}"]
32+
== CVEs
33+
34+
* link:https://access.redhat.com/security/cve/CVE-2019-12900[CVE-2019-12900]
35+
* link:https://access.redhat.com/security/cve/CVE-2024-2511[CVE-2024-2511]
36+
* link:https://access.redhat.com/security/cve/CVE-2024-3596[CVE-2024-3596]
37+
* link:https://access.redhat.com/security/cve/CVE-2024-4603[CVE-2024-4603]
38+
* link:https://access.redhat.com/security/cve/CVE-2024-4741[CVE-2024-4741]
39+
* link:https://access.redhat.com/security/cve/CVE-2024-5535[CVE-2024-5535]
40+
* link:https://access.redhat.com/security/cve/CVE-2024-10963[CVE-2024-10963]
41+
* link:https://access.redhat.com/security/cve/CVE-2024-50602[CVE-2024-50602]
+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
:_mod-docs-content-type: REFERENCE
2+
[id="logging-release-notes-6-0-4_{context}"]
3+
= Logging 6.0.4
4+
This release includes link:https://access.redhat.com/errata/RHBA-2025:1228[RHBA-2025:1228].
5+
6+
[id="logging-release-notes-6-0-4-enhancements_{context}"]
7+
== New features and enhancements
8+
9+
* This enhancement adds `OTel` semantic stream labels to the `lokiStack` output so that you can query logs by using both `ViaQ` and `OTel` stream labels.
10+
(link:https://issues.redhat.com/browse/LOG-6580[LOG-6580])
11+
12+
[id="logging-release-notes-6-0-4-bug-fixes_{context}"]
13+
== Bug fixes
14+
15+
* Before this update, the Operator used a cached client to fetch the `SecurityContextConstraint` cluster resource, which could result in an error when the cache is invalid. With this update, the Operator now always retrieves data from the API server instead of using the cache.
16+
(link:https://issues.redhat.com/browse/LOG-6130[LOG-6130])
17+
18+
* Before this update, the Vector startup script attempted to delete buffer lock files during startup. With this update, the Vector startup script no longer attempts to delete buffer lock files during startup.
19+
(link:https://issues.redhat.com/browse/LOG-6348[LOG-6348])
20+
21+
* Before this update, a bug in the `must-gather` script for the `cluster-logging-operator` prevented the `LokiStack` from being gathered correctly when it existed. With this update, the `LokiStack` is gathered correctly.
22+
(link:https://issues.redhat.com/browse/LOG-6499[LOG-6499])
23+
24+
* Before this update, the collector metrics dashboard could get removed after an Operator upgrade due to a race condition during the change from the old to the new pod deployment. With this update, labels are added to the dashboard `ConfigMap` to identify the upgraded deployment as the current owner so that it will not be removed.
25+
(link:https://issues.redhat.com/browse/LOG-6608[LOG-6608])
26+
27+
* Before this update, the logging `must-gather` did not collect resources such as `UIPlugin`, `ClusterLogForwarder`, `LogFileMetricExporter` and `LokiStack` CR. With this update, these resources are now collected in their namespace directory instead of the cluster-logging one.
28+
(link:https://issues.redhat.com/browse/LOG-6654[LOG-6654])
29+
30+
* Before this update, Vector did not retain process information, such as the program name, app-name, procID, and other details, when forwarding journal logs by using the syslog protocol. This could lead to the loss of important information. With this update, the Vector collector now preserves all required process information, and the data format adheres to the specifications of `RFC3164` and `RFC5424`.
31+
(link:https://issues.redhat.com/browse/LOG-6659[LOG-6659])
+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:_mod-docs-content-type: REFERENCE
2+
[id="logging-release-notes-6-0-5_{context}"]
3+
= Logging 6.0.5
4+
This release includes link:https://access.redhat.com/errata/RHBA-2025:1986[RHBA-2025:1986].
5+
6+
[id="logging-release-notes-6-0-5-cves_{context}"]
7+
== CVEs
8+
9+
* link:https://access.redhat.com/security/cve/CVE-2020-11023[CVE-2020-11023]
10+
* link:https://access.redhat.com/security/cve/CVE-2024-9287[CVE-2024-9287]
11+
* link:https://access.redhat.com/security/cve/CVE-2024-12797[CVE-2024-12797]

0 commit comments

Comments
 (0)