Skip to content

Commit 40ee627

Browse files
committed
OBSDOCS-1521 COO GA 1.0 Release notes
1 parent 5ee41bc commit 40ee627

File tree

1 file changed

+66
-7
lines changed

1 file changed

+66
-7
lines changed

observability/cluster_observability_operator/cluster-observability-operator-release-notes.adoc

Lines changed: 66 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,83 @@ include::_attributes/common-attributes.adoc[]
77

88
toc::[]
99

10-
:FeatureName: The Cluster Observability Operator
11-
include::snippets/technology-preview.adoc[leveloffset=+2]
12-
1310
The {coo-first} is an optional {product-title} Operator that enables administrators to create standalone monitoring stacks that are independently configurable for use by different services and users.
1411

1512
The {coo-short} complements the built-in monitoring capabilities of {product-title}. You can deploy it in parallel with the default platform and user workload monitoring stacks managed by the {cmo-first}.
1613

1714
These release notes track the development of the {coo-full} in {product-title}.
1815

16+
[id="cluster-observability-operator-release-notes-1-0_{context}"]
17+
== {coo-full} 1.0
18+
19+
// Need to check if there is an advisory generated now that the build system has moved to Konflux
20+
// The following advisory is available for {coo-full} 1.0:
21+
//
22+
// * link:https://access.redhat.com/errata/RHSA-2024:????[RHEA-2024:??? {coo-full} 1.0]
23+
24+
25+
[id="cluster-observability-operator-1-0-new-features-enhancements_{context}"]
26+
=== New features and enhancements
27+
28+
* {coo-short} is now enabled for {product-title} platform monitoring. (link:https://issues.redhat.com/browse/COO-476[*COO-476*])
29+
** Implements HTTPS support for {coo-short} web server. (link:https://issues.redhat.com/browse/COO-480[*COO-480*])
30+
** Implements authn/authz for {coo-short} web server. (link:https://issues.redhat.com/browse/COO-481[*COO-481*])
31+
** Configures ServiceMonitor resource to collect metrics from {coo-short}. (link:https://issues.redhat.com/browse/COO-482[*COO-482*])
32+
** Adds `operatorframework.io/cluster-monitoring=true` annotation to the OLM bundle. (link:https://issues.redhat.com/browse/COO-483[*COO-483*])
33+
** Defines the alerting strategy for {coo-short} . (link:https://issues.redhat.com/browse/COO-484[*COO-484*])
34+
** Configures PrometheusRule for alerting. (link:https://issues.redhat.com/browse/COO-485[*COO-485*])
35+
36+
* Support level annotations have been added to the `UIPlugin` CR when created. The support level is based on the plugin type, with values of `DevPreview`, `TechPreview`, or `GeneralAvailability`. (link:https://issues.redhat.com/browse/COO-318[*COO-318*])
37+
38+
// must-gather postponed to 1.1
39+
//* You can now gather debugging information about {coo-short} by using the `oc adm must-gather` CLI command. (link:https://issues.redhat.com/browse/COO-194[*COO-194*])
40+
41+
* You can now configure the Alertmanager `scheme` and `tlsConfig` fields in the Prometheus CR. (link:https://issues.redhat.com/browse/COO-219[*COO-219*])
42+
43+
// Dev preview so cannot document
44+
//* You can now install the Monitoring UI plugin using {coo-short}. (link:https://issues.redhat.com/browse/COO-262[*COO-262*])
45+
46+
* The extended Technical Preview for the troubleshooting panel adds support for correlating traces with Kubernetes resources and directly with other observable signals including logs, alerts, metrics, and network events. (link:https://issues.redhat.com/browse/COO-450[*COO-450*])
47+
** You can select a Tempo instance and tenant when you navigate to the tracing page by clicking *Observe -> Tracing* in the web console. The preview troubleshooting panel only works with the `openshift-tracing / platform` instance and the `platform` tenant.
48+
** The troubleshooting panel works best in the *Administrator* perspective. It has limited functionality in the Developer perspective due to authorization issues with some back ends, most notably Prometheus for metrics and alerts. This will be addressed in a future release.
49+
1950
The following table provides information about which features are available depending on the version of {coo-full} and {product-title}:
2051

52+
[cols="1,1,1,1,1", options="header"]
53+
|===
54+
| COO Version | OCP Versions | Distributed Tracing | Logging | Troubleshooting Panel
55+
| 1.0+ | 4.12 - 4.15 | ✔ | ✔ | ✘
56+
| 1.0+ | 4.16+ | ✔ | ✔ | ✔
57+
|===
58+
59+
60+
[id="cluster-observability-operator-1-0-CVEs"]
61+
=== CVEs
62+
63+
* link:https://access.redhat.com/security/cve/CVE-2023-26159[CVE-2023-26159]
64+
* link:https://access.redhat.com/security/cve/CVE-2024-28849[CVE-2024-28849]
65+
* link:https://access.redhat.com/security/cve/CVE-2024-45338[CVE-2024-45338]
66+
67+
[id="cluster-observability-operator-1-0-bug-fixes_{context}"]
68+
=== Bug fixes
69+
70+
* Previously, the default namespace for the {coo-short} installation was `openshift-operators`. With this release, the defaullt namespace changes to `openshift-cluster-observability-operator`. (link:https://issues.redhat.com/browse/COO-32[*COO-32*])
71+
72+
* Previously, `korrel8r` was only able to parse time series selector expressions. With this release, `korrel8r` can parse any valid PromQL expression to extract the time series selectors that it uses for correlation. (link:https://issues.redhat.com/browse/COO-558[*COO-558*])
73+
74+
* Previously, when viewing a Tempo instance from the Distributed Tracing UI plugin, the scatter plot graph showing the traces duration was not rendered correctly. The bubble size was too large and overlapped the x and y axis. With this release, the graph is rendered correctly. (link:https://issues.redhat.com/browse/COO-319[*COO-319*])
75+
76+
== Features available on older, Technology Preview releases
77+
78+
The following table provides information about which features are available depending on older version of {coo-full} and {product-title}:
79+
2180
[cols="1,1,1,1,1,1", options="header"]
2281
|===
23-
| COO Version | OCP Versions | Dashboards | Distributed Tracing | Logging | Troubleshooting Panel
82+
| COO Version | OCP Versions | Dashboards | Distributed Tracing | Logging | Troubleshooting Panel
2483

25-
| 0.2.0 | 4.11 | ✔ | ✘ | ✘ | ✘
26-
| 0.3.0+ | 4.11 - 4.15 | ✔ | ✔ | ✔ | ✘
27-
| 0.3.0+ | 4.16+ | ✔ | ✔ | ✔ | ✔
84+
| 0.2.0 | 4.11 | ✔ | ✘ | ✘ | ✘
85+
| 0.3.0+, 0.4.0+ | 4.11 - 4.15 | ✔ | ✔ | ✔ | ✘
86+
| 0.3.0+, 0.4.0+ | 4.16+ | ✔ | ✔ | ✔ | ✔
2887
|===
2988

3089
[id="cluster-observability-operator-release-notes-0-4-1_{context}"]

0 commit comments

Comments
 (0)