Skip to content

Commit 92b0dde

Browse files
stevsmitstevsmit
authored
Merge pull request #84020 from openshift-cherrypick-robot/cherry-pick-83636-to-enterprise-4.13
[enterprise-4.13] OBSDOCS-1415: Release notes for the Distributed Tracing 3.3.1 patch
2 parents f29d915 + b7dc269 commit 92b0dde

File tree

2 files changed

+222
-12
lines changed

2 files changed

+222
-12
lines changed

‎observability/distr_tracing/distr-tracing-rn.adoc

+149-12
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,143 @@ You can use the {TempoName} xref:../otel/otel-forwarding-telemetry-data.adoc#ote
1212

1313
include::snippets/distr-tracing-and-otel-disclaimer-about-docs-for-supported-features-only.adoc[]
1414

15+
// git rebase marker 1
16+
17+
// git rebase marker 2
18+
19+
[id="distr-tracing_3-3-1_{context}"]
20+
== Release notes for {DTProductName} 3.3.1
21+
22+
The {DTProductName} 3.3.1 is a maintenance release with no changes because the {DTProductName} is bundled with the {OTELName} that is xref:../otel/otel-rn.adoc#otel-rn[released] with a bug fix.
23+
24+
This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.
25+
26+
////
27+
[id="distr-tracing_3-3-1_cves_{context}"]
28+
=== CVEs
29+
30+
This release fixes the following CVEs:
31+
32+
* link:https://access.redhat.com/security/cve/CVE-202?-????/[CVE-202?-????]
33+
////
34+
35+
[id="distr-tracing_3-3-1_tempo-release-notes_{context}"]
36+
=== {TempoName}
37+
38+
The {TempoName} is provided through the {TempoOperator}.
39+
40+
The {TempoName} 3.3.1 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.5.0.
41+
42+
////
43+
[id="distr-tracing_3-3-1_tempo-release-notes_technology-preview-features_{context}"]
44+
==== Technology Preview features
45+
46+
This update introduces the following Technology Preview feature:
47+
48+
* ???.
49+
50+
:FeatureName: The Tempo monolithic deployment
51+
include::snippets/technology-preview.adoc[leveloffset=+1]
52+
////
53+
54+
////
55+
[id="distr-tracing_3-3-1_tempo-release-notes_new-features-and-enhancements_{context}"]
56+
==== New features and enhancements
57+
58+
This update introduces the following enhancements:
59+
60+
* ???.
61+
////
62+
63+
////
64+
[id="distr-tracing_3-3-1_tempo-release-notes_deprecated-functionality_{context}"]
65+
==== Deprecated functionality
66+
67+
In the {TempoName} 3.3.1, ???.
68+
////
69+
70+
////
71+
[id="distr-tracing_3-3-1_tempo-release-notes_removal-notice_{context}"]
72+
==== Removal notice
73+
74+
In the {TempoName} 3.3.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead.
75+
////
76+
77+
////
78+
[id="distr-tracing_3-3-1_tempo-release-notes_bug-fixes_{context}"]
79+
==== Bug fixes
80+
81+
This update introduces the following bug fixes:
82+
83+
* ????. (link:https://issues.redhat.com/browse/TRACING-????[TRACING-????])
84+
////
85+
86+
[id="distr-tracing_3-3-1_tempo-release-notes_known-issues_{context}"]
87+
==== Known issues
88+
89+
There is currently a known issue:
90+
91+
* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545])
92+
93+
[id="distr-tracing_3-3-1_jaeger-release-notes_{context}"]
94+
=== {JaegerName}
95+
96+
The {JaegerName} is provided through the {JaegerOperator} Operator.
97+
98+
The {JaegerName} 3.3.1 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.57.0.
99+
100+
[IMPORTANT]
101+
====
102+
Jaeger does not use FIPS validated cryptographic modules.
103+
====
104+
105+
[id="distr-tracing_3-3-1_jaeger-release-notes_support-for-elasticsearch-operator_{context}"]
106+
==== Support for the {es-op}
107+
108+
The {JaegerName} 3.3.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
109+
110+
[id="distr-tracing_3-3-1_jaeger-release-notes_deprecated-functionality_{context}"]
111+
==== Deprecated functionality
112+
113+
In the {DTProductName} 3.3.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release.
114+
Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
115+
The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage.
116+
Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward.
117+
118+
In the {DTProductName} 3.3.1, the Jaeger agent is deprecated and planned to be removed in the following release.
119+
Red{nbsp}Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
120+
The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent.
121+
122+
////
123+
[id="distr-tracing_3-3-1_jaeger-release-notes_removal-notice_{context}"]
124+
==== Removal notice
125+
126+
In the {JaegerName} 3.3.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead.
127+
////
128+
129+
////
130+
[id="distr-tracing_3-3-1_jaeger-release-notes_bug-fixes_{context}"]
131+
==== Bug fixes
132+
133+
This update introduces the following bug fixes:
134+
135+
* Before this update, ???. With this update, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????])
136+
////
137+
138+
[id="distr-tracing_3-3-1_jaeger-release-notes_known-issues_{context}"]
139+
==== Known issues
140+
141+
There are currently known issues:
142+
143+
* Currently, Apache Spark is not supported.
144+
145+
ifndef::openshift-rosa[]
146+
147+
* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures.
148+
endif::openshift-rosa[]
149+
150+
// git rebase marker 3
151+
15152
[id="distr-tracing_3-3_{context}"]
16153
== Release notes for {DTProductName} 3.3
17154

@@ -109,12 +246,12 @@ The {JaegerName} 3.3 is supported for use with the {es-op} 5.6, 5.7, and 5.8.
109246
==== Deprecated functionality
110247

111248
In the {DTProductName} 3.3, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release.
112-
Red Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
249+
Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
113250
The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage.
114251
Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward.
115252

116253
In the {DTProductName} 3.3, the Jaeger agent is deprecated and planned to be removed in the following release.
117-
Red Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
254+
Red{nbsp}Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
118255
The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent.
119256

120257
////
@@ -235,12 +372,12 @@ Jaeger does not use FIPS validated cryptographic modules.
235372
==== Deprecated functionality
236373
237374
In the {DTProductName} 3.2.2, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release.
238-
Red Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
375+
Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
239376
The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage.
240377
Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward.
241378
242379
In the {DTProductName} 3.2.2, the Jaeger agent is deprecated and planned to be removed in the following release.
243-
Red Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
380+
Red{nbsp}Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
244381
The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent.
245382
////
246383

@@ -361,12 +498,12 @@ Jaeger does not use FIPS validated cryptographic modules.
361498
==== Deprecated functionality
362499
363500
In the {DTProductName} 3.2.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release.
364-
Red Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
501+
Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
365502
The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage.
366503
Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward.
367504
368505
In the {DTProductName} 3.2.1, the Jaeger agent is deprecated and planned to be removed in the following release.
369-
Red Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
506+
Red{nbsp}Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
370507
The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent.
371508
////
372509

@@ -482,12 +619,12 @@ Jaeger does not use FIPS validated cryptographic modules.
482619
==== Deprecated functionality
483620

484621
In the {DTProductName} 3.2, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release.
485-
Red Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
622+
Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements.
486623
The {TempoOperator} and the {OTELName} are the preferred Operators for distributed tracing collection and storage.
487624
Users must adopt the OpenTelemetry and Tempo distributed tracing stack because it is the stack to be enhanced going forward.
488625

489626
In the {DTProductName} 3.2, the Jaeger agent is deprecated and planned to be removed in the following release.
490-
Red Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
627+
Red{nbsp}Hat will provide bug fixes and support for the Jaeger agent during the current release lifecycle, but the Jaeger agent will no longer receive enhancements and will be removed.
491628
The OpenTelemetry Collector provided by the {OTELName} is the preferred Operator for injecting the trace collector agent.
492629

493630
////
@@ -560,7 +697,7 @@ Jaeger does not use FIPS validated cryptographic modules.
560697
[id="distr-tracing_3-1-1_jaeger-release-notes_deprecated-functionality_{context}"]
561698
==== Deprecated functionality
562699

563-
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.
700+
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{nbsp}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.
564701

565702
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.
566703

@@ -645,7 +782,7 @@ Jaeger does not use FIPS validated cryptographic modules.
645782
[id="distr-tracing_3-1_jaeger-release-notes_deprecated-functionality_{context}"]
646783
==== Deprecated functionality
647784

648-
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.
785+
In the {DTProductName} 3.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. Red{nbsp}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.
649786

650787
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.
651788

@@ -701,7 +838,7 @@ endif::openshift-rosa[]
701838
[id="distr-tracing_3-0_jaeger-release-notes_deprecated-functionality_{context}"]
702839
==== Deprecated functionality
703840

704-
In the {DTProductName} 3.0, Jaeger and support for Elasticsearch are 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.
841+
In the {DTProductName} 3.0, Jaeger and support for Elasticsearch are deprecated, and both are planned to be removed in a future release. Red{nbsp}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.
705842

706843
In the {DTProductName} 3.0, 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.
707844

@@ -1435,7 +1572,7 @@ This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes
14351572

14361573
This release introduces the following new features and enhancements:
14371574

1438-
* Rebrands Red Hat OpenShift Jaeger as the {DTProductName}.
1575+
* Rebrands Red{nbsp}Hat OpenShift Jaeger as the {DTProductName}.
14391576

14401577
* Updates {JaegerName} Operator to Jaeger 1.28. Going forward, the {DTProductName} will only support the `stable` Operator channel.
14411578
Channels for individual releases are no longer supported.

‎observability/otel/otel-rn.adoc

+73
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,79 @@ You can use the {OTELName} xref:otel-forwarding-telemetry-data.adoc#otel-forward
1212

1313
include::snippets/distr-tracing-and-otel-disclaimer-about-docs-for-supported-features-only.adoc[]
1414

15+
// git rebase marker 1
16+
17+
// git rebase marker 2
18+
19+
[id="otel_3-3-1_{context}"]
20+
== Release notes for {OTELName} 3.3.1
21+
22+
The {OTELName} is provided through the {OTELOperator}.
23+
24+
The {OTELName} 3.3.1 is based on the open source link:https://opentelemetry.io/docs/collector/[OpenTelemetry] release 0.107.0.
25+
26+
////
27+
[id="otel_3-3-1_cves_{context}"]
28+
=== CVEs
29+
30+
This release fixes the following CVEs:
31+
32+
* link:https://access.redhat.com/security/cve/CVE-2024-????[CVE-2024-????]
33+
////
34+
35+
////
36+
[id="otel_3-3-1_technology-preview-features_{context}"]
37+
=== Technology Preview features
38+
39+
This update introduces the following Technology Preview features:
40+
41+
* ???.
42+
43+
:FeatureName: Each of these features
44+
include::snippets/technology-preview.adoc[leveloffset=+1]
45+
////
46+
47+
////
48+
[id="otel_3-3-1_new-features-and-enhancements_{context}"]
49+
=== New features and enhancements
50+
51+
This update introduces the following enhancements:
52+
53+
* ???.
54+
////
55+
56+
////
57+
[id="otel_3-3-1_jaeger-release-notes_deprecated-functionality_{context}"]
58+
=== Deprecated functionality
59+
60+
In the {OTELName} 3.3.1, ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????])
61+
////
62+
63+
////
64+
[id="otel_3-3-1_removal-notice_{context}"]
65+
=== Removal notice
66+
67+
In the {OTELName} 3.3.1, the FEATURE has been removed. Bug fixes and support are provided only through the end of the 3.? lifecycle. As an alternative to the FEATURE for USE CASE, you can use the ALTERNATIVE instead.
68+
////
69+
70+
[id="otel_3-3-1_bug-fixes_{context}"]
71+
=== Bug fixes
72+
73+
This update introduces the following bug fix:
74+
75+
* Before this update, injection of the NGINX auto-instrumentation failed when copying the instrumentation libraries into the application container. With this update, the copy command is configured correctly, which fixes the issue. (link:https://issues.redhat.com/browse/TRACING-4673[TRACING-4673])
76+
77+
////
78+
[id="otel_3-3-1_known-issues_{context}"]
79+
=== Known issues
80+
81+
There are currently known issues:
82+
83+
* ???. (link:https://issues.redhat.com/browse/TRACING-????/[TRACING-????])
84+
////
85+
86+
// git rebase marker 3
87+
1588
[id="otel_3-3_{context}"]
1689
== Release notes for {OTELName} 3.3
1790

0 commit comments

Comments
 (0)