Skip to content

Commit 96d444c

Browse files
JSticklerJStickler
authored
Merge pull request #38877 from JStickler/OSSMDOC-385
OSSMDOC-385: Distributed tracing Release Notes.
2 parents 9c1138e + d7aab4f commit 96d444c

9 files changed

+228
-12
lines changed

‎_topic_map.yml‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2774,28 +2774,29 @@ Topics:
27742774
File: threescale-adapter
27752775
- Name: Removing Service Mesh
27762776
File: removing-ossm
2777+
27772778
---
2778-
Name: Jaeger
2779+
Name: Distributed tracing
27792780
Dir: jaeger
27802781
Distros: openshift-enterprise
27812782
Topics:
2782-
- Name: Jaeger release notes
2783-
File: rhbjaeger-release-notes
2784-
- Name: Jaeger architecture
2783+
- Name: Distributed tracing release notes
2784+
File: distributed-tracing-release-notes
2785+
- Name: Distributed tracing architecture
27852786
Dir: jaeger_arch
27862787
Topics:
2787-
- Name: Jaeger architecture
2788+
- Name: Distributed tracing architecture
27882789
File: rhbjaeger-architecture
2789-
- Name: Jaeger installation
2790+
- Name: Distributed tracing installation
27902791
Dir: jaeger_install
27912792
Topics:
2792-
- Name: Installing Jaeger
2793+
- Name: Installing distributed tracing
27932794
File: rhbjaeger-installation
2794-
- Name: Configuring Jaeger
2795+
- Name: Configuring distributed tracing
27952796
File: rhbjaeger-deploying
2796-
- Name: Upgrading Jaeger
2797+
- Name: Upgrading distributed tracing
27972798
File: rhbjaeger-updating
2798-
- Name: Removing Jaeger
2799+
- Name: Removing distributed tracing
27992800
File: rhbjaeger-removing
28002801
---
28012802
Name: Virtualization

‎jaeger/distributed-tracing-release-notes.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[id="distr-tracing-release-notes"]
2+
= Distributed tracing release notes
3+
include::modules/distr-tracing-document-attributes.adoc[]
4+
:context: distributed-tracing-release-notes
5+
6+
toc::[]
7+
8+
// The following include statements pull in the module files that comprise the assembly.
9+
10+
include::modules/distr-tracing-product-overview.adoc[leveloffset=+1]
11+
12+
include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1]
13+
14+
include::modules/support.adoc[leveloffset=+1]
15+
16+
include::modules/distr-tracing-rn-new-features.adoc[leveloffset=+1]
17+
18+
include::modules/distr-tracing-rn-technology-preview.adoc[leveloffset=+1]
19+
20+
include::modules/distr-tracing-rn-known-issues.adoc[leveloffset=+1]
21+
22+
include::modules/distr-tracing-rn-fixed-issues.adoc[leveloffset=+1]

‎modules/distr-tracing-document-attributes.adoc‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Standard document attributes to be used in the distributed tracing documentation
2+
//
3+
// The following are shared by all RH Build of distributed tracing documents:
4+
:toc:
5+
:toclevels: 4
6+
:toc-title:
7+
:experimental:
8+
//
9+
// Product content attributes, that is, substitution variables in the files.
10+
//
11+
:product-title: OpenShift Container Platform
12+
:ProductName: Red Hat OpenShift distributed tracing
13+
:ProductShortName: distributed tracing
14+
:ProductRelease:
15+
:ProductVersion: 2.0
16+
:product-build:
17+
:DownloadURL: registry.redhat.io
18+
:cloud-redhat-com: Red Hat OpenShift Cluster Manager
19+
:kebab: image:kebab.png[title="Options menu"]
20+
//
21+
// Documentation publishing attributes used in the master-docinfo.xml file
22+
// Note that the DocInfoProductName generates the URL for the product page.
23+
// Changing the value changes the generated URL.
24+
//
25+
26+
:DocInfoProductName: Red Hat OpenShift distributed tracing
27+
:DocInfoProductName: OpenShift distributed tracing
28+
:DocInfoProductNumber: 2.0
29+
//
30+
// Book Names:
31+
// Defining the book names in document attributes instead of hard-coding them in
32+
// the master.adoc files and in link references.
33+
//This makes it easy to change the book name if necessary.
34+
// Using the pattern ending in 'BookName' makes it easy to grep for occurrences
35+
// throughout the topics
36+
//
37+
:RN_BookName: Red Hat OpenShift distributed tracing Release Notes
38+
:Install_BookName: Installing Red Hat OpenShift distributed tracing
39+
:Using_BookName: Using Red Hat Red Hat OpenShift distributed tracing

‎modules/distr-tracing-product-overview.adoc‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
////
2+
This CONCEPT module included in the following assemblies:
3+
-service_mesh/v2x/ossm-architecture.adoc ??
4+
-distr-tracing-architecture.adoc
5+
////
6+
7+
[id="distr-tracing-product-overview_{context}"]
8+
= OpenShift distributed tracing overview
9+
10+
As a service owner, you can use distributed tracing to instrument your services to gather insights into your service architecture.
11+
You can use distributed tracing for monitoring, network profiling, and troubleshooting the interaction between components in modern, cloud-native, microservices-based applications.
12+
13+
Using distributed tracing lets you perform the following functions:
14+
15+
* Monitor distributed transactions
16+
17+
* Optimize performance and latency
18+
19+
* Perform root cause analysis
20+
21+
{ProductName} consists of two components:
22+
23+
* *Red Hat OpenShift distributed tracing platform* - This component is based on the open source link:https://www.jaegertracing.io/[Jaeger project].
24+
25+
* *Red Hat OpenShift distributed tracing data collection* - This component is based on the open source link:https://opentelemetry.io/[OpenTelemetry project].
26+
27+
Both of these components are based on the vendor-neutral link:https://opentracing.io/[OpenTracing] APIs and instrumentation.

‎modules/distr-tracing-rn-fixed-issues.adoc‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
////
2+
Module included in the following assemblies:
3+
* distr-tracing-release-notes.adoc
4+
* service_mesh/v2x/servicemesh-release-notes.adoc
5+
////
6+
7+
[id="distr-tracing-rn-fixed-issues_{context}"]
8+
= Distributed tracing fixed issues
9+
////
10+
Provide the following info for each issue if possible:
11+
Consequence - What user action or situation would make this problem appear (If you have the foo option enabled and did x)? What did the customer experience as a result of the issue? What was the symptom?
12+
Cause - Why did this happen?
13+
Fix - What did we change to fix the problem?
14+
Result - How has the behavior changed as a result? Try to avoid “It is fixed” or “The issue is resolved” or “The error no longer presents”.
15+
////
16+
17+
* link:https://issues.redhat.com/browse/TRACING-2009[TRACING-2009] The Jaeger Operator has been updated to include support for the Strimzi Kafka Operator 0.23.0.
18+
19+
* link:https://issues.redhat.com/browse/TRACING-1907[TRACING-1907] The Jaeger agent sidecar injection was failing due to missing config maps in the application namespace. The config maps were getting automatically deleted due to an incorrect `OwnerReference` field setting, and as a result, the application pods were not moving past the "ContainerCreating" stage. The incorrect settings have been removed.
20+
21+
* link:https://issues.redhat.com/browse/TRACING-1725[TRACING-1725] Follow-up to TRACING-1631. Additional fix to ensure that Elasticsearch certificates are properly reconciled when there are multiple Jaeger production instances, using same name but within different namespaces. See also link:https://bugzilla.redhat.com/show_bug.cgi?id=1918920[BZ-1918920].
22+
23+
* link:https://issues.jboss.org/browse/TRACING-1631[TRACING-1631] Multiple Jaeger production instances, using same name but within different namespaces, causing Elasticsearch certificate issue. When multiple service meshes were installed, all of the Jaeger Elasticsearch instances had the same Elasticsearch secret instead of individual secrets, which prevented the OpenShift Elasticsearch Operator from communicating with all of the Elasticsearch clusters.
24+
25+
* link:https://issues.redhat.com/browse/TRACING-1300[TRACING-1300] Failed connection between Agent and Collector when using Istio sidecar. An update of the Jaeger Operator enabled TLS communication by default between a Jaeger sidecar agent and the Jaeger Collector.
26+
27+
* link:https://issues.redhat.com/browse/TRACING-1208[TRACING-1208] Authentication "500 Internal Error" when accessing Jaeger UI. When trying to authenticate to the UI using OAuth, you get a 500 error because the oauth-proxy sidecar does not trust the custom CA bundle defined at installation time with the `additionalTrustBundle`. This was due to the config map with the `additionalTrustBundle` not being created in the Jaeger namespace.
28+
29+
* link:https://issues.redhat.com/browse/TRACING-1166[TRACING-1166] It is not currently possible to use the Jaeger streaming strategy within a disconnected environment. When a Kafka cluster is being provisioned, it results in a error: `Failed to pull image registry.redhat.io/amq7/amq-streams-kafka-24-rhel7@sha256:f9ceca004f1b7dccb3b82d9a8027961f9fe4104e0ed69752c0bdd8078b4a1076`.

‎modules/distr-tracing-rn-known-issues.adoc‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
////
2+
Module included in the following assemblies:
3+
* service_mesh/v2x/servicemesh-release-notes.adoc
4+
* distr-tracing--release-notes.adoc
5+
////
6+
7+
[id="distr-tracing-rn-known-issues_{context}"]
8+
= Distributed tracing known issues
9+
10+
////
11+
Consequence - What user action or situation would make this problem appear (Selecting the Foo option with the Bar version 1.3 plugin enabled results in an error message)? What did the customer experience as a result of the issue? What was the symptom?
12+
Cause (if it has been identified) - Why did this happen?
13+
Workaround (If there is one)- What can you do to avoid or negate the effects of this issue in the meantime? Sometimes if there is no workaround it is worthwhile telling readers to contact support for advice. Never promise future fixes.
14+
Result - If the workaround does not completely address the problem.
15+
////
16+
17+
The following limitations exist in Red Hat OpenShift distributed tracing platform:
18+
19+
* Apache Spark is not supported.
20+
21+
* Jaeger streaming via AMQ/Kafka is unsupported on IBM Z and IBM Power Systems.
22+
23+
These are the known issues in Red Hat OpenShift distributed tracing platform:
24+
25+
* link:https://issues.redhat.com/browse/TRACING-2057[TRACING-2057] The Kafka API has been updated to `v1beta2` to support the Strimzi Kafka Operator 0.23.0. However, this API version is not supported by AMQ Streams 1.6.3. If you have the following environment, your Jaeger services does not upgrade, and you cannot create new Jaeger services or modify existing Jaeger services:
26+
27+
** Jaeger Operator channel: *1.17.x stable* or *1.20.x stable*
28+
** AMQ Streams Operator channel: *amq-streams-1.6.x*
29+
+
30+
To resolve this issue, switch the subscription channel for your AMQ Streams Operator to either *amq-streams-1.7.x* or *stable*.
31+
32+
* link:https://bugzilla.redhat.com/show_bug.cgi?id=1918920[BZ-1918920] The Elasticsearch pods do not get restarted automatically after an update. As a workaround, restart the pods manually.
33+
34+
* link:https://issues.redhat.com/browse/TRACING-809[TRACING-809] Jaeger Ingester is incompatible with Kafka 2.3. When there are two or more instances of the Jaeger Ingester and enough traffic, the Ingester generates continuous rebalancing messages in the logs. The Ingester generates these logs because of a regression in Kafka 2.3. This regression was fixed in Kafka 2.3.1. For more information, see https://github.com/jaegertracing/jaeger/issues/1819[Jaegertracing-1819].

‎modules/distr-tracing-rn-new-features.adoc‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
////
2+
Module included in the following assemblies:
3+
* distr-tracing--release-notes.adoc
4+
////
5+
////
6+
Feature – Describe the new functionality available to the customer. For enhancements, try to describe as specifically as possible where the customer will see changes.
7+
Reason – If known, include why has the enhancement been implemented (use case, performance, technology, etc.). For example, showcases integration of X with Y, demonstrates Z API feature, includes latest framework bug fixes.
8+
Result – If changed, describe the current user experience.
9+
////
10+
11+
[id="distr-tracing-rn-new-features_{context}"]
12+
== New features and enhancements {ProductName} 2.0.0
13+
14+
This release marks the rebranding of Red Hat OpenShift Jaeger to {ProductName}. This effort includes the following:
15+
16+
* Updates {ProductShortName} Operator to Jaeger 1.28. Going forward, {ProductName} will only support the `stable` Operator channel. Channels for individual releases are no longer supported.
17+
18+
* Introduces a new OpenTelemetry Operator based on OpenTelemetry 0.33. Note that this Operator is a Technology Preview.
19+
20+
* Adds support for OpenTelemetry protocol (OTLP) to the Query service.
21+
22+
* Introduces a new distributed tracing icon that appears in the OpenShift OperatorHub.
23+
24+
* Includes rolling updates to the documentation to support the name change and new features.
25+
26+
This release also addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.
27+
28+
== Component versions supported in {ProductName} version {ProductVersion}
29+
30+
|===
31+
|Component |Version
32+
33+
|Jaeger
34+
|1.28.0
35+
36+
|OpenTelemetry
37+
|0.33.0
38+
|===

‎modules/distr-tracing-rn-technology-preview.adoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
////
2+
Module included in the following assemblies:
3+
* distr-tracing--release-notes.adoc
4+
////
5+
6+
[id="distr-tracing-rn-tech-preview_{context}"]
7+
= Technology Preview
8+
////
9+
Provide the following info for each issue if possible:
10+
Description - Describe the new functionality available to the customer. For enhancements, try to describe as specifically as possible where the customer will see changes. Avoid the word “supports” as in [product] now supports [feature] to avoid customer confusion with full support. Say, for example, “available as a Technology Preview.”
11+
Package - A brief description of what the customer has to install or enable to use the Technology Preview feature. (e.g., available in quickstart.zip on customer portal, JDF website, container on registry, enable option, etc.)
12+
////
13+
14+
[IMPORTANT]
15+
====
16+
Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production.
17+
These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/.
18+
====
19+
20+
== {ProductName} 2.0.0 Technology Preview
21+
22+
This release includes the addition of the distributed tracing data collection, which you install using the OpenTelemetry Operator.
23+
24+
{ProductName} data collection is based on the OpenTelemetry Operator and Collector. The Collector can be used to receive traces in either the OpenTelemetry or Jaeger protocol and send the trace data to the OpenShift distributed tracing platform. Other capabilities of the Collector are not supported at this time.
25+
26+
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.

‎service_mesh/v2x/servicemesh-release-notes.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ include::modules/ossm-rn-deprecated-features.adoc[leveloffset=+1]
1919

2020
include::modules/ossm-rn-known-issues.adoc[leveloffset=+1]
2121

22-
include::modules/jaeger-rn-known-issues.adoc[leveloffset=+2]
22+
include::modules/distr-tracing-rn-known-issues.adoc[leveloffset=+2]
2323

2424
include::modules/ossm-rn-fixed-issues.adoc[leveloffset=+1]
2525

26-
include::modules/jaeger-rn-fixed-issues.adoc[leveloffset=+2]
26+
include::modules/distr-tracing-rn-fixed-issues.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)