Skip to content

[enterprise-4.15] OBSDOCS-892: Improve the release notes text in response to user feedback #74670

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2024
Merged

[enterprise-4.15] OBSDOCS-892: Improve the release notes text in response to user feedback #74670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _attributes/common-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ endif::[]
:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
:JaegerOperator: Red Hat OpenShift distributed tracing platform
:JaegerShortName: distributed tracing platform (Jaeger)
:JaegerOperator: Red Hat OpenShift distributed tracing platform
:JaegerVersion: 1.53.0
:OTELName: Red Hat build of OpenTelemetry
:OTELShortName: Red Hat build of OpenTelemetry
Expand Down
19 changes: 3 additions & 16 deletions modules/distr-tracing-product-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Module included in the following assemblies:
//
// * distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc
// * distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc
// * distr_tracing_arch/distr-tracing-architecture.adoc
// * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc
// * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc
// * observability/distr_tracing_arch/distr-tracing-architecture.adoc
// * service_mesh/v2x/ossm-architecture.adoc
// * serverless/serverless-tracing.adoc

Expand All @@ -20,16 +20,3 @@ With the {DTShortName}, you can perform the following functions:
* Optimize performance and latency

* Perform root cause analysis

The {DTShortName} consists of three components:

* *{TempoName}*, which is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo project].

* *{OTELNAME}*, which is based on the open source link:https://opentelemetry.io/[OpenTelemetry project].

* *{JaegerName}*, which is based on the open source link:https://www.jaegertracing.io/[Jaeger project].
+
[IMPORTANT]
====
Jaeger does not use FIPS validated cryptographic modules.
====
31 changes: 11 additions & 20 deletions observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,9 @@ toc::[]

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

[id="distributed-tracing-rn_3-1-1_component-versions"]
== Component versions in the {DTProductName} 3.1.1
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}].

[options="header"]
|===
|Operator |Component |Version

|{TempoName}
|Tempo
|2.3.1

//for each new release, update the release number in the xref path on the following line
|xref:../../otel/otel_rn/otel-rn-3-1-1.adoc#otel-rn-3-1-1[{OTELName}]
|OpenTelemetry
|0.93.0

|{JaegerName} (deprecated)
|Jaeger
|1.53.0

|===
This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.

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

The {TempoName} is provided through the {TempoOperator}.

[id="distributed-tracing-rn_3-1-1_tempo-release-notes_known-issues"]
=== Known issues

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

The {JaegerName} is provided through the {JaegerOperator} Operator.

[IMPORTANT]
====
Jaeger does not use FIPS validated cryptographic modules.
====

[id="distributed-tracing-rn_3-1-1_jaeger-release-notes_support-for-elasticsearch-operator"]
=== Support for {es-op}

Expand Down
40 changes: 16 additions & 24 deletions observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,19 @@ toc::[]

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

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}].

[id="distributed-tracing-rn-3-1"]
== Release notes for {DTProductName} 3.1

[id="distributed-tracing-rn_3-1_component-versions"]
=== Component versions in the {DTProductName} 3.1

[options="header"]
|===
|Operator |Component |Version

|{TempoName}
|Tempo
|2.3.1

//for each new release, update the release number in the xref path on the following line
|xref:../../otel/otel_rn/otel-rn-past-releases.adoc#otel-rn-past-releases[{OTELName}]
|OpenTelemetry
|0.93.0

|{JaegerName} (deprecated)
|Jaeger
|1.53.0

|===
This release of the {DTProductName} includes the {TempoName} and the deprecated {JaegerName}.

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

The {TempoName} is provided through the {TempoOperator}.

////
[id="technology-preview-features_jaeger-release-notes_distributed-tracing-rn-3-1"]
==== Technology Preview features
Expand All @@ -54,6 +38,7 @@ include::snippets/technology-preview.adoc[leveloffset=+1]

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

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

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

The {JaegerName} is provided through the {JaegerOperator} Operator.

[IMPORTANT]
====
Jaeger does not use FIPS validated cryptographic modules.
====

[id="distributed-tracing-rn_3-1_jaeger-release-notes_support-for-elasticsearch-operator"]
==== Support for {es-op}

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

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.

////
[id="distributed-tracing-rn_3-1_jaeger-release-notes_new-features-and-enhancements"]
==== New features and enhancements

This update introduces the following enhancements for the {JaegerShortName}:
* Support for ...
////

* {JaegerName} 3.1 is based on the open source link:https://www.jaegertracing.io/[Jaeger] release 1.53.0.

[id="distributed-tracing-rn_3-1_jaeger-release-notes_bug-fixes"]
==== Bug fixes
Expand Down
2 changes: 2 additions & 0 deletions observability/otel/otel_rn/otel-rn-3-1-1.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ toc::[]

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

The {OTELName} is provided through the {OTELOperator}.

[id="otel-rn_3-1-1_cves"]
== CVEs

Expand Down
32 changes: 17 additions & 15 deletions observability/otel/otel_rn/otel-rn-past-releases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ include::modules/otel-product-overview.adoc[leveloffset=+1]
[id="otel-rn-3-1"]
== Release notes for {OTELName} 3.1

The {OTELName} is provided through the {OTELOperator}.

[id="otel-rn_3-1_new-features-and-enhancements"]
=== New features and enhancements

//plural: `enhancements:`
This update introduces the following enhancements:

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

* 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.

Expand Down Expand Up @@ -49,7 +51,7 @@ This update introduces the following bug fixes:

This update introduces the following enhancements:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

Expand Down