Skip to content

Commit 266cbbf

Browse files
Merge pull request #73592 from max-cx/OBSDOCS-892
OBSDOCS-892: Improve the release notes text in response to user feedback
2 parents d6d8678 + e22d3d0 commit 266cbbf

File tree

6 files changed

+50
-75
lines changed

6 files changed

+50
-75
lines changed

_attributes/common-attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ endif::[]
122122
:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
123123
:JaegerOperator: Red Hat OpenShift distributed tracing platform
124124
:JaegerShortName: distributed tracing platform (Jaeger)
125+
:JaegerOperator: Red Hat OpenShift distributed tracing platform
125126
:JaegerVersion: 1.53.0
126127
:OTELName: Red Hat build of OpenTelemetry
127128
:OTELShortName: Red Hat build of OpenTelemetry
Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// Module included in the following assemblies:
22
//
3-
// * distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc
4-
// * distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc
5-
// * distr_tracing_arch/distr-tracing-architecture.adoc
3+
// * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc
4+
// * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc
5+
// * observability/distr_tracing_arch/distr-tracing-architecture.adoc
66
// * service_mesh/v2x/ossm-architecture.adoc
77
// * serverless/serverless-tracing.adoc
88

@@ -20,16 +20,3 @@ With the {DTShortName}, you can perform the following functions:
2020
* Optimize performance and latency
2121
2222
* Perform root cause analysis
23-
24-
The {DTShortName} consists of three components:
25-
26-
* *{TempoName}*, which is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo project].
27-
28-
* *{OTELNAME}*, which is based on the open source link:https://opentelemetry.io/[OpenTelemetry project].
29-
30-
* *{JaegerName}*, which is based on the open source link:https://www.jaegertracing.io/[Jaeger project].
31-
+
32-
[IMPORTANT]
33-
====
34-
Jaeger does not use FIPS validated cryptographic modules.
35-
====

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

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,9 @@ toc::[]
88

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

11-
[id="distributed-tracing-rn_3-1-1_component-versions"]
12-
== Component versions in the {DTProductName} 3.1.1
11+
You can use the {DTShortName} xref:../../otel/otel-forwarding.adoc#otel-forwarding-traces[in combination with] the xref:../../otel/otel-installing.adoc#install-otel[{OTELName}].
1312

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-
|===
13+
This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.
3214

3315
[id="distributed-tracing-rn_3-1-1_cves"]
3416
== CVEs
@@ -39,6 +21,8 @@ This release fixes link:https://access.redhat.com/security/cve/cve-2023-39326[CV
3921
[id="distributed-tracing-rn_3-1-1_tempo-release-notes"]
4022
== {TempoName}
4123

24+
The {TempoName} is provided through the {TempoOperator}.
25+
4226
[id="distributed-tracing-rn_3-1-1_tempo-release-notes_known-issues"]
4327
=== Known issues
4428

@@ -52,6 +36,13 @@ There are currently known issues:
5236
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes"]
5337
== {JaegerName}
5438

39+
The {JaegerName} is provided through the {JaegerOperator} Operator.
40+
41+
[IMPORTANT]
42+
====
43+
Jaeger does not use FIPS validated cryptographic modules.
44+
====
45+
5546
[id="distributed-tracing-rn_3-1-1_jaeger-release-notes_support-for-elasticsearch-operator"]
5647
=== Support for {es-op}
5748

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

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,19 @@ toc::[]
88

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

11+
You can use the {DTShortName} xref:../../otel/otel-forwarding.adoc#otel-forwarding-traces[in combination with] the xref:../../otel/otel-installing.adoc#install-otel[{OTELName}].
12+
1113
[id="distributed-tracing-rn-3-1"]
1214
== Release notes for {DTProductName} 3.1
1315

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-
|===
16+
This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.
3517

3618
// Tempo section
3719
[id="distributed-tracing-rn_3-1_tempo-release-notes"]
3820
=== {TempoName}
3921

22+
The {TempoName} is provided through the {TempoOperator}.
23+
4024
////
4125
[id="technology-preview-features_jaeger-release-notes_distributed-tracing-rn-3-1"]
4226
==== Technology Preview features
@@ -54,6 +38,7 @@ include::snippets/technology-preview.adoc[leveloffset=+1]
5438

5539
This update introduces the following enhancements for the {TempoShortName}:
5640

41+
* {TempoName} 3.1 is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] 2.3.1.
5742
* Support for cluster-wide proxy environments.
5843
* Support for TraceQL to Gateway component.
5944

@@ -78,6 +63,13 @@ There are currently known issues:
7863
[id="distributed-tracing-rn_3-1_jaeger-release-notes"]
7964
=== {JaegerName}
8065

66+
The {JaegerName} is provided through the {JaegerOperator} Operator.
67+
68+
[IMPORTANT]
69+
====
70+
Jaeger does not use FIPS validated cryptographic modules.
71+
====
72+
8173
[id="distributed-tracing-rn_3-1_jaeger-release-notes_support-for-elasticsearch-operator"]
8274
==== Support for {es-op}
8375

@@ -90,12 +82,12 @@ In the {DTProductName} 3.1, Jaeger and support for Elasticsearch remain deprecat
9082

9183
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.
9284

93-
////
9485
[id="distributed-tracing-rn_3-1_jaeger-release-notes_new-features-and-enhancements"]
9586
==== New features and enhancements
87+
9688
This update introduces the following enhancements for the {JaegerShortName}:
97-
* Support for ...
98-
////
89+
90+
* {JaegerName} 3.1 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.53.0.
9991

10092
[id="distributed-tracing-rn_3-1_jaeger-release-notes_bug-fixes"]
10193
==== Bug fixes

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

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

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

11+
The {OTELName} is provided through the {OTELOperator}.
12+
1113
[id="otel-rn_3-1-1_cves"]
1214
== CVEs
1315

observability/otel/otel_rn/otel-rn-past-releases.adoc

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,15 @@ include::modules/otel-product-overview.adoc[leveloffset=+1]
1111
[id="otel-rn-3-1"]
1212
== Release notes for {OTELName} 3.1
1313

14+
The {OTELName} is provided through the {OTELOperator}.
15+
1416
[id="otel-rn_3-1_new-features-and-enhancements"]
1517
=== New features and enhancements
1618

1719
//plural: `enhancements:`
1820
This update introduces the following enhancements:
1921

20-
* {OTELName} 3.1 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.93.0.
22+
* {OTELName} 3.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.93.0.
2123

2224
* Support for the target allocator in the OpenTelemetry Collector. The target allocator is an optional component of the OpenTelemetry Operator that shards Prometheus receiver scrape targets across the deployed fleet of OpenTelemetry Collector instances. The target allocator provides integration with the Prometheus `PodMonitor` and `ServiceMonitor` custom resources.
2325

@@ -49,7 +51,7 @@ This update introduces the following bug fixes:
4951

5052
This update introduces the following enhancements:
5153

52-
* {OTELName} 3.0 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.89.0.
54+
* {OTELName} 3.0 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.89.0.
5355
* The *OpenShift distributed tracing data collection Operator* is renamed as the *{OTELOperator}*.
5456
* Support for the ARM architecture.
5557
* Support for the Prometheus receiver for metrics collection.
@@ -150,7 +152,7 @@ subjects:
150152
:FeatureName: The {OTELName}
151153
include::snippets/technology-preview.adoc[leveloffset=+1]
152154

153-
{OTELName} 2.9.2 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.81.0.
155+
{OTELName} 2.9.2 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.81.0.
154156

155157
[id="otel-rn_2-9-2_cves"]
156158
=== CVEs
@@ -171,7 +173,7 @@ There is currently a known issue:
171173
:FeatureName: The {OTELName}
172174
include::snippets/technology-preview.adoc[leveloffset=+1]
173175

174-
{OTELName} 2.9.1 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.81.0.
176+
{OTELName} 2.9.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.81.0.
175177

176178
[id="otel-rn_2-9-1_cves"]
177179
=== CVEs
@@ -192,7 +194,7 @@ There is currently a known issue:
192194
:FeatureName: The {OTELName}
193195
include::snippets/technology-preview.adoc[leveloffset=+1]
194196

195-
{OTELName} 2.9 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.81.0.
197+
{OTELName} 2.9 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.81.0.
196198

197199
[id="otel-rn_2-9_new-features-and-enhancements"]
198200
=== New features and enhancements
@@ -235,7 +237,7 @@ There is currently a known issue:
235237
:FeatureName: The {OTELName}
236238
include::snippets/technology-preview.adoc[leveloffset=+1]
237239

238-
{OTELName} 2.8 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.74.0.
240+
{OTELName} 2.8 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.74.0.
239241

240242
[id="otel-rn_2-8_bug-fixes"]
241243
=== Bug fixes
@@ -254,7 +256,7 @@ None.
254256
:FeatureName: The {OTELName}
255257
include::snippets/technology-preview.adoc[leveloffset=+1]
256258

257-
{OTELName} 2.7 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.63.1.
259+
{OTELName} 2.7 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.63.1.
258260

259261
[id="otel-rn_2-7_bug-fixes"]
260262
=== Bug fixes
@@ -267,7 +269,7 @@ This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes
267269
:FeatureName: The {OTELName}
268270
include::snippets/technology-preview.adoc[leveloffset=+1]
269271

270-
{OTELName} 2.6 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.60.
272+
{OTELName} 2.6 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.60.
271273

272274
[id="otel-rn_2-6_bug-fixes"]
273275
=== Bug fixes
@@ -280,7 +282,7 @@ This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes
280282
:FeatureName: The {OTELName}
281283
include::snippets/technology-preview.adoc[leveloffset=+1]
282284

283-
{OTELName} 2.5 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.56.
285+
{OTELName} 2.5 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.56.
284286

285287
[id="otel-rn_2-5_new-features-and-enhancements"]
286288
=== New features and enhancements
@@ -300,7 +302,7 @@ This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes
300302
:FeatureName: The {OTELName}
301303
include::snippets/technology-preview.adoc[leveloffset=+1]
302304

303-
{OTELName} 2.4 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.49.
305+
{OTELName} 2.4 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.49.
304306

305307
[id="otel-rn_2-4_bug-fixes"]
306308
=== Bug fixes
@@ -319,9 +321,9 @@ None.
319321
:FeatureName: The {OTELName}
320322
include::snippets/technology-preview.adoc[leveloffset=+1]
321323

322-
{OTELName} 2.3.1 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.44.1.
324+
{OTELName} 2.3.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.44.1.
323325

324-
{OTELName} 2.3.0 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.44.0.
326+
{OTELName} 2.3.0 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.44.0.
325327

326328
[id="otel-rn_2-3_bug-fixes"]
327329
=== Bug fixes
@@ -340,7 +342,7 @@ None.
340342
:FeatureName: The {OTELName}
341343
include::snippets/technology-preview.adoc[leveloffset=+1]
342344

343-
{OTELName} 2.2 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.42.0.
345+
{OTELName} 2.2 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.42.0.
344346

345347
[id="otel-rn_2-2_technology-preview-features"]
346348
=== Technology Preview features
@@ -364,7 +366,7 @@ None.
364366
:FeatureName: The {OTELName}
365367
include::snippets/technology-preview.adoc[leveloffset=+1]
366368

367-
{OTELName} 2.1 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.41.1.
369+
{OTELName} 2.1 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.41.1.
368370

369371
[id="otel-rn_2-1_technology-preview-features"]
370372
=== Technology Preview features
@@ -415,7 +417,7 @@ None.
415417
:FeatureName: The {OTELName}
416418
include::snippets/technology-preview.adoc[leveloffset=+1]
417419

418-
{OTELName} 2.0 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.33.0.
420+
{OTELName} 2.0 is based on the open source link:https://opentelemetry.io/[OpenTelemetry] release 0.33.0.
419421

420422
This release adds the {OTELName} as a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview], which you install using the {OTELName} Operator. {OTELName} is based on the link:https://opentelemetry.io/[OpenTelemetry] APIs and instrumentation. The {OTELName} includes the OpenTelemetry Operator and Collector. You can use the Collector to receive traces in the OpenTelemetry or Jaeger protocol and send the trace data to the {OTELName}. Other capabilities of the Collector are not supported at this time. The OpenTelemetry Collector allows developers to instrument their code with vendor agnostic APIs, avoiding vendor lock-in and enabling a growing ecosystem of observability tooling.
421423

0 commit comments

Comments
 (0)