Skip to content

Commit 0ce9da4

Browse files
max-cxmax-cx
committed
OBSDOCS-895: Create and publish release notes for the DT&OTEL 3.1.1 patch
1 parent a20ad4a commit 0ce9da4

File tree

7 files changed

+247
-168
lines changed

7 files changed

+247
-168
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2606,8 +2606,8 @@ Topics:
26062606
- Name: Release notes
26072607
Dir: distr_tracing_rn
26082608
Topics:
2609-
- Name: Distributed tracing 3.1
2610-
File: distr-tracing-rn-3-1
2609+
- Name: Distributed tracing 3.1.1
2610+
File: distr-tracing-rn-3-1-1
26112611
- Name: Past releases
26122612
File: distr-tracing-rn-past-releases
26132613
- Name: Distributed tracing architecture
@@ -2644,8 +2644,8 @@ Topics:
26442644
- Name: Release notes
26452645
Dir: otel_rn
26462646
Topics:
2647-
- Name: Red Hat build of OpenTelemetry 3.1
2648-
File: otel-rn-3.1
2647+
- Name: Red Hat build of OpenTelemetry 3.1.1
2648+
File: otel-rn-3-1-1
26492649
- Name: Past releases
26502650
File: otel-rn-past-releases
26512651
- Name: Installation

‎observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="distributed-tracing-rn-3-1-1"]
4+
= Release notes for {DTProductName} 3.1.1
5+
:context: distributed-tracing-rn-3-1-1
6+
7+
toc::[]
8+
9+
include::modules/distr-tracing-product-overview.adoc[leveloffset=+1]
10+
11+
[id="distributed-tracing-rn_3-1-1_component-versions"]
12+
== Component versions in the {DTProductName} 3.1.1
13+
14+
[options="header"]
15+
|===
16+
|Operator |Component |Version
17+
18+
|{TempoName}
19+
|Tempo
20+
|2.3.1
21+
22+
//for each new release, update the release number in the xref path on the following line
23+
|xref:../../otel/otel_rn/otel-rn-3-1-1.adoc#otel-rn-3-1-1[{OTELName}]
24+
|OpenTelemetry
25+
|0.93.0
26+
27+
|{JaegerName} (deprecated)
28+
|Jaeger
29+
|1.53.0
30+
31+
|===
32+
33+
[id="distributed-tracing-rn_3-1-1_cves"]
34+
== CVEs
35+
36+
This release fixes link:https://access.redhat.com/security/cve/cve-2023-39326[CVE-2023-39326].
37+
38+
// Tempo section
39+
[id="distributed-tracing-rn_3-1-1_tempo-release-notes"]
40+
== {TempoName}
41+
42+
[id="distributed-tracing-rn_3-1-1_tempo-release-notes_known-issues"]
43+
=== Known issues
44+
45+
//There is currently a known issue:
46+
There are currently known issues:
47+
48+
* Currently, when used with the {TempoOperator}, the Jaeger UI only displays services that have sent traces in the last 15 minutes. For services that did not send traces in the last 15 minutes, traces are still stored but not displayed in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139])
49+
* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545])
50+
51+
// Jaeger section
52+
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes"]
53+
== {JaegerName}
54+
55+
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes_support-for-elasticsearch-operator"]
56+
=== Support for {es-op}
57+
58+
{JaegerName} 3.1.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
59+
60+
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes_deprecated-functionality"]
61+
=== Deprecated functionality
62+
63+
In the {DTProductName} 3.1.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. Red Hat will provide critical and above CVE bug fixes and support for these components during the current release lifecycle, but these components will no longer receive feature enhancements.
64+
65+
In the {DTProductName} 3.1.1, Tempo provided by the {TempoOperator} and the OpenTelemetry Collector provided by the {OTELName} are the preferred Operators for distributed tracing collection and storage. The OpenTelemetry and Tempo distributed tracing stack is to be adopted by all users because this will be the stack that will be enhanced going forward.
66+
67+
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes_known-issues"]
68+
=== Known issues
69+
70+
//There is currently a known issue:
71+
There are currently known issues:
72+
73+
* Currently, Apache Spark is not supported.
74+
75+
ifndef::openshift-rosa[]
76+
77+
* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures.
78+
endif::openshift-rosa[]
79+
80+
include::modules/support.adoc[leveloffset=+1]
81+
82+
include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]

‎observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc

Lines changed: 0 additions & 119 deletions
This file was deleted.

‎observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,115 @@ toc::[]
88

99
include::modules/distr-tracing-product-overview.adoc[leveloffset=+1]
1010

11+
[id="distributed-tracing-rn-3-1"]
12+
== Release notes for {DTProductName} 3.1
13+
14+
[id="distributed-tracing-rn_3-1_component-versions"]
15+
=== Component versions in the {DTProductName} 3.1
16+
17+
[options="header"]
18+
|===
19+
|Operator |Component |Version
20+
21+
|{TempoName}
22+
|Tempo
23+
|2.3.1
24+
25+
//for each new release, update the release number in the xref path on the following line
26+
|xref:../../otel/otel_rn/otel-rn-past-releases.adoc#otel-rn-past-releases[{OTELName}]
27+
|OpenTelemetry
28+
|0.93.0
29+
30+
|{JaegerName} (deprecated)
31+
|Jaeger
32+
|1.53.0
33+
34+
|===
35+
36+
// Tempo section
37+
[id="distributed-tracing-rn_3-1_tempo-release-notes"]
38+
=== {TempoName}
39+
40+
////
41+
[id="technology-preview-features_jaeger-release-notes_distributed-tracing-rn-3-1"]
42+
==== Technology Preview features
43+
44+
This update introduces the following Technology Preview feature for the {TempoShortName}:
45+
46+
* Monolithic custom resource.
47+
48+
:FeatureName: The monolithic custom resource
49+
include::snippets/technology-preview.adoc[leveloffset=+1]
50+
////
51+
52+
[id="distributed-tracing-rn_3-1_tempo-release-notes_new-features-and-enhancements"]
53+
==== New features and enhancements
54+
55+
This update introduces the following enhancements for the {TempoShortName}:
56+
57+
* Support for cluster-wide proxy environments.
58+
* Support for TraceQL to Gateway component.
59+
60+
[id="distributed-tracing-rn_3-1_tempo-release-notes_bug-fixes"]
61+
==== Bug fixes
62+
63+
This update introduces the following bug fixes for the {TempoShortName}:
64+
65+
* Before this update, when a TempoStack instance was created with the `monitorTab` enabled in {product-title} 4.15, the required `tempo-redmetrics-cluster-monitoring-view` ClusterRoleBinding was not created. This update resolves the issue by fixing the Operator RBAC for the monitor tab when the Operator is deployed in an arbitrary namespace. (link:https://issues.redhat.com/browse/TRACING-3786[TRACING-3786])
66+
* Before this update, when a TempoStack instance was created on an {product-title} cluster with only an IPv6 networking stack, the compactor and ingestor pods ran in the `CrashLoopBackOff` state, resulting in multiple errors. This update provides support for IPv6 clusters.(link:https://issues.redhat.com/browse/TRACING-3226[TRACING-3226])
67+
68+
[id="distributed-tracing-rn_3-1_tempo-release-notes_known-issues"]
69+
==== Known issues
70+
71+
//There is currently a known issue:
72+
There are currently known issues:
73+
74+
* Currently, when used with the {TempoOperator}, the Jaeger UI only displays services that have sent traces in the last 15 minutes. For services that did not send traces in the last 15 minutes, traces are still stored but not displayed in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139])
75+
* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545])
76+
77+
// Jaeger section
78+
[id="distributed-tracing-rn_3-1_jaeger-release-notes"]
79+
=== {JaegerName}
80+
81+
[id="distributed-tracing-rn_3-1_jaeger-release-notes_support-for-elasticsearch-operator"]
82+
==== Support for {es-op}
83+
84+
{JaegerName} 3.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
85+
86+
[id="distributed-tracing-rn_3-1_jaeger-release-notes_deprecated-functionality"]
87+
==== Deprecated functionality
88+
89+
In the {DTProductName} 3.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. Red Hat will provide critical and above CVE bug fixes and support for these components during the current release lifecycle, but these components will no longer receive feature enhancements.
90+
91+
In the {DTProductName} 3.1, Tempo provided by the {TempoOperator} and the OpenTelemetry Collector provided by the {OTELName} are the preferred Operators for distributed tracing collection and storage. The OpenTelemetry and Tempo distributed tracing stack is to be adopted by all users because this will be the stack that will be enhanced going forward.
92+
93+
////
94+
[id="distributed-tracing-rn_3-1_jaeger-release-notes_new-features-and-enhancements"]
95+
==== New features and enhancements
96+
This update introduces the following enhancements for the {JaegerShortName}:
97+
* Support for ...
98+
////
99+
100+
[id="distributed-tracing-rn_3-1_jaeger-release-notes_bug-fixes"]
101+
==== Bug fixes
102+
103+
This update introduces the following bug fix for the {JaegerShortName}:
104+
105+
* Before this update, the connection target URL for the `jaeger-agent` container in the `jager-query` pod was overwritten with another namespace URL in {product-title} 4.13. This was caused by a bug in the sidecar injection code in the `jaeger-operator`, causing nondeterministic `jaeger-agent` injection. With this update, the Operator prioritizes the Jaeger instance from the same namespace as the target deployment. (link:https://issues.redhat.com/browse/TRACING-3722[TRACING-3722])
106+
107+
[id="distributed-tracing-rn_3-1_jaeger-release-notes_known-issues"]
108+
==== Known issues
109+
110+
//There is currently a known issue:
111+
There are currently known issues:
112+
113+
* Currently, Apache Spark is not supported.
114+
115+
ifndef::openshift-rosa[]
116+
117+
* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures.
118+
endif::openshift-rosa[]
119+
11120
[id="distr-tracing-rn_3.0"]
12121
== Release notes for {DTProductName} 3.0
13122

‎observability/otel/otel_rn/otel-rn-3-1-1.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="otel-rn-3-1-1"]
4+
= Release notes for {OTELName} 3.1.1
5+
:context: otel-rn-3-1-1
6+
7+
toc::[]
8+
9+
include::modules/otel-product-overview.adoc[leveloffset=+1]
10+
11+
[id="otel-rn_3-1-1_cves"]
12+
== CVEs
13+
14+
This release fixes link:https://access.redhat.com/security/cve/cve-2023-39326[CVE-2023-39326].
15+
16+
include::modules/support.adoc[leveloffset=+1]
17+
18+
include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)