diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 1b38dd62affb..39fb279542af 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -118,18 +118,18 @@ endif::[] //distributed tracing :DTProductName: Red Hat OpenShift distributed tracing platform :DTShortName: distributed tracing platform -:DTProductVersion: 3.0 +:DTProductVersion: 3.1 :JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger) :JaegerShortName: distributed tracing platform (Jaeger) -:JaegerVersion: 1.51.0 +:JaegerVersion: 1.53.0 :OTELName: Red Hat build of OpenTelemetry :OTELShortName: Red Hat build of OpenTelemetry :OTELOperator: Red Hat build of OpenTelemetry Operator -:OTELVersion: 0.89.0 +:OTELVersion: 0.93.0 :TempoName: Red Hat OpenShift distributed tracing platform (Tempo) :TempoShortName: distributed tracing platform (Tempo) :TempoOperator: Tempo Operator -:TempoVersion: 2.3.0 +:TempoVersion: 2.3.1 //telco ifdef::telco-ran[] :rds: telco RAN DU diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index bfa7a536cf83..60e74174558c 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2774,35 +2774,13 @@ Name: Distributed tracing Dir: distr_tracing Distros: openshift-enterprise Topics: -- Name: Distributed tracing release notes +- Name: Release notes Dir: distr_tracing_rn Topics: - - Name: Distributed tracing 3.0 - File: distr-tracing-rn-3-0 - - Name: Distributed tracing 2.9.2 - File: distr-tracing-rn-2-9-2 - - Name: Distributed tracing 2.9.1 - File: distr-tracing-rn-2-9-1 - - Name: Distributed tracing 2.9 - File: distr-tracing-rn-2-9 - - Name: Distributed tracing 2.8 - File: distr-tracing-rn-2-8 - - Name: Distributed tracing 2.7 - File: distr-tracing-rn-2-7 - - Name: Distributed tracing 2.6 - File: distr-tracing-rn-2-6 - - Name: Distributed tracing 2.5 - File: distr-tracing-rn-2-5 - - Name: Distributed tracing 2.4 - File: distr-tracing-rn-2-4 - - Name: Distributed tracing 2.3 - File: distr-tracing-rn-2-3 - - Name: Distributed tracing 2.2 - File: distr-tracing-rn-2-2 - - Name: Distributed tracing 2.1 - File: distr-tracing-rn-2-1 - - Name: Distributed tracing 2.0 - File: distr-tracing-rn-2-0 + - Name: Distributed tracing 3.1 + File: distr-tracing-rn-3-1 + - Name: Past releases + File: distr-tracing-rn-past-releases - Name: Distributed tracing architecture Dir: distr_tracing_arch Topics: @@ -2836,7 +2814,12 @@ Dir: otel Distros: openshift-enterprise Topics: - Name: Release notes - File: otel-release-notes + Dir: otel_rn + Topics: + - Name: Red Hat build of OpenTelemetry 3.1 + File: otel-rn-3.1 + - Name: Past releases + File: otel-rn-past-releases - Name: Installation File: otel-installing - Name: Collector configuration diff --git a/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc b/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc index 50862cf9a1f1..bf9c53d404a9 100644 --- a/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc +++ b/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc @@ -27,4 +27,5 @@ include::modules/distr-tracing-architecture.adoc[leveloffset=+1] [id="additional-resources_distributed-tracing-architecture"] == Additional resources -* xref:../../otel/otel-release-notes.adoc[{OTELName}] +// xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files +* xref:../../otel/otel-installing.adoc[{OTELName}] diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc index 704019cdd933..c91ca51d0a37 100644 --- a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc +++ b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc @@ -6,6 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] +:FeatureName: The {JaegerName} +include::modules/deprecated-feature.adoc[] + The {JaegerName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {JaegerShortName} resources. You can install the default configuration or modify the file. If you have installed {DTShortName} as part of {SMProductName}, you can perform basic configuration as part of the xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[ServiceMeshControlPlane], but for complete control, you must configure a Jaeger CR and then xref:../../service_mesh/v2x/ossm-observability.adoc#ossm-config-external-jaeger_observability[reference your distributed tracing configuration file in the ServiceMeshControlPlane]. diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc index 22fa9b182e40..242b46158d3b 100644 --- a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc +++ b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc @@ -6,10 +6,8 @@ include::_attributes/common-attributes.adoc[] toc::[] -[WARNING] -==== -Jaeger is deprecated in Red Hat OpenShift distributed tracing 3.0. -==== +:FeatureName: The {JaegerName} +include::modules/deprecated-feature.adoc[] You can install {DTProductName} on {product-title} in either of two ways: diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc index aa2b8356b60c..138f6418ea59 100644 --- a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc +++ b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc @@ -6,6 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] +:FeatureName: The {JaegerName} +include::modules/deprecated-feature.adoc[] + The steps for removing {DTProductName} from an {product-title} cluster are as follows: . Shut down any {DTProductName} pods. diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc index cbd6a29cbf80..e8818694af17 100644 --- a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc +++ b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc @@ -6,10 +6,8 @@ include::_attributes/common-attributes.adoc[] toc::[] -[WARNING] -==== -Jaeger is deprecated in Red Hat OpenShift distributed tracing 3.0. -==== +:FeatureName: The {JaegerName} +include::modules/deprecated-feature.adoc[] Operator Lifecycle Manager (OLM) controls the installation, upgrade, and role-based access control (RBAC) of Operators in a cluster. The OLM runs by default in {product-title}. OLM queries for available Operators as well as upgrades for installed Operators. diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-0.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-0.adoc deleted file mode 100644 index 3c73f8517305..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-0.adoc +++ /dev/null @@ -1,57 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-0"] -= Release notes for {DTProductName} 2.0 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-0 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-0"] -== Component versions in the {DTProductName} 2.0.0 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.28.0 - -|{OTELName} -|OpenTelemetry -|0.33.0 -|=== - -[id="new-features-and-enhancements_distributed-tracing-rn-2-0"] -== New features and enhancements - -This release introduces the following new features and enhancements: - -* Rebrands Red Hat OpenShift Jaeger as the {DTProductName}. - -* Updates {JaegerName} Operator to Jaeger 1.28. Going forward, the {DTProductName} will only support the `stable` Operator channel. -Channels for individual releases are no longer supported. - -* Adds support for OpenTelemetry protocol (OTLP) to the Query service. - -* Introduces a new distributed tracing icon that appears in the OperatorHub. - -* Includes rolling updates to the documentation to support the name change and new features. - -[id="technology-preview-features_distributed-tracing-rn-2-0"] -== Technology Preview features - -* 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 {DTProductName}. 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. - -[id="bug-fixes_distributed-tracing-rn-2-0"] -== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//[id="known-issues_distributed-tracing-rn-2-0"] -//== Known issues - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-1.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-1.adoc deleted file mode 100644 index a856cfa02a52..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-1.adoc +++ /dev/null @@ -1,68 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-1"] -= Release notes for {DTProductName} 2.1 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-1 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-1"] -== Component versions in the {DTProductName} 2.1.0 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.29.1 - -|{OTELName} -|OpenTelemetry -|0.41.1 -|=== - -[id="technology-preview-features_distributed-tracing-rn-2-1"] -== Technology Preview features - -* This release introduces a breaking change to how to configure certificates in the OpenTelemetry custom resource file. With this update, the `ca_file` moves under `tls` in the custom resource, as shown in the following examples. -+ -.CA file configuration for OpenTelemetry version 0.33 -+ -[source,yaml] ----- -spec: - mode: deployment - config: | - exporters: - jaeger: - endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 - ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" ----- -+ -.CA file configuration for OpenTelemetry version 0.41.1 -+ -[source,yaml] ----- -spec: - mode: deployment - config: | - exporters: - jaeger: - endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 - tls: - ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" ----- - -[id="bug-fixes_distributed-tracing-rn-2-1"] -== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//[id="known-issues_distributed-tracing-rn-2-1"] -//== Known issues - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-2.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-2.adoc deleted file mode 100644 index b88726c233d9..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-2.adoc +++ /dev/null @@ -1,23 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-2"] -= Release notes for {DTProductName} 2.2 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-2 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="technology-preview-features_distributed-tracing-rn-2-2"] -== Technology Preview features - -* The unsupported OpenTelemetry Collector components included in the 2.1 release are removed. - -[id="bug-fixes_distributed-tracing-rn-2-2"] -== Bug fixes - -This release of the {DTProductName} addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-3.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-3.adoc deleted file mode 100644 index 54d7ad9d8f27..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-3.adoc +++ /dev/null @@ -1,56 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-3"] -= Release notes for {DTProductName} 2.3 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-3 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions-2-3-0_distributed-tracing-rn-2-3"] -== Component versions in the {DTProductName} 2.3.0 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.30.1 - -|{OTELName} -|OpenTelemetry -|0.44.0 -|=== - -[id="component-versions-2-3-1_distributed-tracing-rn-2-3"] -== Component versions in the {DTProductName} 2.3.1 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.30.2 - -|{OTELName} -|OpenTelemetry -|0.44.1-1 -|=== - -[id="new-features-and-enhancements_distributed-tracing-rn-2-3"] -== New features and enhancements - -With this release, the {JaegerName} Operator is now installed to the `openshift-distributed-tracing` namespace by default. Before this update, the default installation had been in the `openshift-operators` namespace. - -[id="bug-fixes_distributed-tracing-rn-2-3"] -== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//[id="known-issues_distributed-tracing-rn-2-3"] -//== Known issues - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-4.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-4.adoc deleted file mode 100644 index ca95e0fddc47..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-4.adoc +++ /dev/null @@ -1,53 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-4"] -= Release notes for {DTProductName} 2.4 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-4 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-4"] -== Component versions in the {DTProductName} 2.4 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.34.1 - -|{OTELName} -|OpenTelemetry -|0.49 -|=== - -[id="new-features-and-enhancements_distributed-tracing-rn-2-4"] -== New features and enhancements - -This release adds support for auto-provisioning certificates using the Red Hat Elasticsearch Operator. - -* Self-provisioning by using the {JaegerName} Operator to call the Red Hat Elasticsearch Operator during installation. -+ -[IMPORTANT] -==== -When upgrading to the {DTProductName} 2.4, the operator recreates the Elasticsearch instance, which might take five to ten minutes. Distributed tracing will be down and unavailable for that period. -==== - -[id="technology-preview-features_distributed-tracing-rn-2-4"] -== Technology Preview features - -* Creating the Elasticsearch instance and certificates first and then configuring the {JaegerShortName} to use the certificate is a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] for this release. - -[id="bug-fixes_distributed-tracing-rn-2-4"] -== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//[id="known-issues_distributed-tracing-rn-2-4"] -//== Known issues - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-5.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-5.adoc deleted file mode 100644 index 518dee14538f..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-5.adoc +++ /dev/null @@ -1,45 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-5"] -= Release notes for {DTProductName} 2.5 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-5 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-5"] -== Component versions in the {DTProductName} 2.5 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.36 - -|{OTELName} -|OpenTelemetry -|0.56 -|=== - -[id="new-features-and-enhancements_distributed-tracing-rn-2-5"] -== New features and enhancements - -This release introduces support for ingesting OpenTelemetry protocol (OTLP) to the {JaegerName} Operator. -The Operator now automatically enables the OTLP ports: - -* Port 4317 for the OTLP gRPC protocol. -* Port 4318 for the OTLP HTTP protocol. - -This release also adds support for collecting Kubernetes resource attributes to the {OTELName} Operator. - -[id="bug-fixes_distributed-tracing-rn-2-5"] -== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] - diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-6.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-6.adoc deleted file mode 100644 index 02e7d8e94262..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-6.adoc +++ /dev/null @@ -1,34 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-6"] -= Release notes for {DTProductName} 2.6 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-6 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-6"] -== Component versions in the {DTProductName} 2.6 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.38 - -|{OTELName} -|OpenTelemetry -|0.60 -|=== - -[id="bug-fixes_distributed-tracing-rn-2-6"] -== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] - diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc deleted file mode 100644 index 9cd28c934485..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc +++ /dev/null @@ -1,33 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-7"] -= Release notes for {DTProductName} 2.7 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-7 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-7"] -== Component versions in the {DTProductName} 2.7 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.39 - -|{OTELName} -|OpenTelemetry -|0.63.1 -|=== - -[id="bug-fixes_distributed-tracing-rn-2-7"] -== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc deleted file mode 100644 index 1dddf2ee0f77..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc +++ /dev/null @@ -1,63 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-8"] -= Release notes for {DTProductName} 2.8 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-8 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-8"] -== Component versions in the {DTProductName} 2.8 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.42 - -|{OTELName} -|OpenTelemetry -|0.74.0 - -|{TempoName} -|Tempo -|0.1.0 -|=== - -[id="technology-preview-features_distributed-tracing-rn-2-8"] -== Technology Preview features - -This release introduces support for the {TempoName} as a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] feature for {DTProductName}. - -:FeatureName: The {TempoName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -The feature uses version 0.1.0 of the {TempoName} and version 2.0.1 of the upstream {TempoShortName} components. - -You can use the {TempoShortName} to replace Jaeger so that you can use S3-compatible storage instead of ElasticSearch. -Most users who use the {TempoShortName} instead of Jaeger will not notice any difference in functionality because the {TempoShortName} supports the same ingestion and query protocols as Jaeger and uses the same user interface. - -If you enable this Technology Preview feature, note the following limitations of the current implementation: - -* The {TempoShortName} currently does not support disconnected installations. (link:https://issues.redhat.com/browse/TRACING-3145[TRACING-3145]) - -* When you use the Jaeger user interface (UI) with the {TempoShortName}, the Jaeger UI lists only services that have sent traces within the last 15 minutes. For services that have not sent traces within the last 15 minutes, those traces are still stored even though they are not visible in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) - -Expanded support for the {TempoOperator} is planned for future releases of the {DTProductName}. -Possible additional features might include support for TLS authentication, multitenancy, and multiple clusters. -For more information about the {TempoOperator}, see the link:https://tempo-operator.netlify.app[Tempo community documentation]. - -[id="bug-fixes_distributed-tracing-rn-2-8"] -== Bug fixes - -This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. - -//[id="known-issues_distributed-tracing-rn-2-8"] -//== Known issues - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-1.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-1.adoc deleted file mode 100644 index 6fed09c6ee2a..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-1.adoc +++ /dev/null @@ -1,138 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="distributed-tracing-rn-2-9-1"] -= Release notes for {DTProductName} 2.9.1 -include::_attributes/common-attributes.adoc[] -:context: distributed-tracing-rn-2-9-1 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-9-1"] -== Component versions in the {DTProductName} 2.9.1 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.47.0 - -|{OTELName} -|OpenTelemetry -|0.81.0 - -|{TempoName} -|Tempo -|2.1.1 -|=== - -== CVEs - -This release fixes link:https://access.redhat.com/security/cve/cve-2023-44487[CVE-2023-44487]. - - -[id="jaeger-release-notes_distributed-tracing-rn-2-9-1"] -== {JaegerName} - -[id="known-issues_jaeger-release-notes_distributed-tracing-rn-2-9-1"] -=== Known issues - -* Apache Spark is not supported. -ifndef::openshift-rosa[] - -* The streaming deployment via AMQ/Kafka is unsupported on IBM Z and IBM Power Systems. -endif::openshift-rosa[] - -[id="tempo-release-notes_distributed-tracing-rn-2-9-1"] -== {TempoName} - -:FeatureName: The {TempoName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="known-issues_tempo-release-notes_distributed-tracing-rn-2-9-1"] -=== Known issues - -* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) - -* 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]) - -* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) -+ -.Workaround -+ -Disable mTLS as follows: -+ -. Open the {TempoOperator} ConfigMap for editing by running the following command: -+ -[source,terminal] ----- -$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> ----- -<1> The project where the {TempoOperator} is installed. - -. Disable the mTLS in the operator configuration by updating the YAML file: -+ -[source,yaml] ----- -data: - controller_manager_config.yaml: | - featureGates: - httpEncryption: false - grpcEncryption: false - builtInCertManagement: - enabled: false ----- - -. Restart the {TempoOperator} pod by running the following command: -+ -[source,terminal] ----- -$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator ----- - - -* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) -+ -.Workaround -+ -Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: -+ -[source,yaml] ----- -kind: ImageSetConfiguration -apiVersion: mirror.openshift.io/v1alpha2 -archiveSize: 20 -storageConfig: - local: - path: /home/user/images -mirror: - operators: - - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 - packages: - - name: tempo-product - channels: - - name: stable - additionalImages: - - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a - - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 - - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 - - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e ----- - -[id="otel-release-notes_distributed-tracing-rn-2-9-1"] -== {OTELName} - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="known-issues_otel-release-notes_distributed-tracing-rn-2-9-1"] -=== Known issues - -* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-2.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-2.adoc deleted file mode 100644 index e22fa34b09a5..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-2.adoc +++ /dev/null @@ -1,137 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/common-attributes.adoc[] -[id="distributed-tracing-rn-2-9-2"] -= Release notes for {DTProductName} 2.9.2 -:context: distributed-tracing-rn-2-9-2 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-9-2"] -== Component versions in the {DTProductName} 2.9.2 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.47.0 - -|{OTELName} -|OpenTelemetry -|0.81.0 - -|{TempoName} -|Tempo -|2.1.1 -|=== - -== CVEs - -This release fixes link:https://bugzilla.redhat.com/show_bug.cgi?id=2246470[CVE-2023-46234]. - -[id="jaeger-release-notes_distributed-tracing-rn-2-9-2"] -== {JaegerName} - -[id="known-issues_jaeger-release-notes_distributed-tracing-rn-2-9-2"] -=== Known issues - -* Apache Spark is not supported. -ifndef::openshift-rosa[] - -* The streaming deployment via AMQ/Kafka is unsupported on IBM Z and IBM Power Systems. -endif::openshift-rosa[] - -[id="tempo-release-notes_distributed-tracing-rn-2-9-2"] -== {TempoName} - -:FeatureName: The {TempoName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="known-issues_tempo-release-notes_distributed-tracing-rn-2-9-2"] -=== Known issues - -* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) - -* 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]) - -* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) -+ -.Workaround -+ -Disable mTLS as follows: -+ -. Open the {TempoOperator} ConfigMap for editing by running the following command: -+ -[source,terminal] ----- -$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> ----- -<1> The project where the {TempoOperator} is installed. - -. Disable the mTLS in the operator configuration by updating the YAML file: -+ -[source,yaml] ----- -data: - controller_manager_config.yaml: | - featureGates: - httpEncryption: false - grpcEncryption: false - builtInCertManagement: - enabled: false ----- - -. Restart the {TempoOperator} pod by running the following command: -+ -[source,terminal] ----- -$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator ----- - - -* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) -+ -.Workaround -+ -Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: -+ -[source,yaml] ----- -kind: ImageSetConfiguration -apiVersion: mirror.openshift.io/v1alpha2 -archiveSize: 20 -storageConfig: - local: - path: /home/user/images -mirror: - operators: - - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 - packages: - - name: tempo-product - channels: - - name: stable - additionalImages: - - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a - - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 - - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 - - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e ----- - -[id="otel-release-notes_distributed-tracing-rn-2-9-2"] -== {OTELName} - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="known-issues_otel-release-notes_distributed-tracing-rn-2-9-2"] -=== Known issues - -* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc deleted file mode 100644 index 5f66c28db987..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc +++ /dev/null @@ -1,207 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/common-attributes.adoc[] -[id="distributed-tracing-rn-2-9"] -= Release notes for {DTProductName} 2.9 -:context: distributed-tracing-rn-2-9 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-2-9"] -== Component versions in the {DTProductName} 2.9 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.47.0 - -|{OTELName} -|OpenTelemetry -|0.81.0 - -|{TempoName} -|Tempo -|2.1.1 -|=== - -[id="jaeger-release-notes_distributed-tracing-rn-2-9"] -== {JaegerName} - -[id="new-features-and-enhancements_jaeger-release-notes_distributed-tracing-rn-2-9"] -=== New features and enhancements - -* None. - -//[id="technology-preview-features_jaeger-release-notes_distributed-tracing-rn-2-9"] -//=== Technology Preview features -//not for 2.9 - -[id="bug-fixes_jaeger-release-notes_distributed-tracing-rn-2-9"] -=== Bug fixes - -* Before this update, connection was refused due to a missing gRPC port on the `jaeger-query` deployment. This issue resulted in `transport: Error while dialing: dial tcp :16685: connect: connection refused` error message. With this update, the Jaeger Query gRPC port (16685) is successfully exposed on the Jaeger Query service. (link:https://issues.redhat.com/browse/TRACING-3322[TRACING-3322]) - -* Before this update, the wrong port was exposed for `jaeger-production-query`, resulting in refused connection. With this update, the issue is fixed by exposing the Jaeger Query gRPC port (16685) on the Jaeger Query deployment. (link:https://issues.redhat.com/browse/TRACING-2968[TRACING-2968]) - -* Before this update, when deploying {SMProductShortName} on {sno} clusters in disconnected environments, the Jaeger pod frequently went into the `Pending` state. With this update, the issue is fixed. (link:https://issues.redhat.com/browse/TRACING-3312[TRACING-3312]) - -* Before this update, the Jaeger Operator pod restarted with the default memory value due to the `reason: OOMKilled` error message. With this update, this issue is fixed by removing the resource limits. (link:https://issues.redhat.com/browse/TRACING-3173[TRACING-3173]) - -[id="known-issues_jaeger-release-notes_distributed-tracing-rn-2-9"] -=== Known issues - -* Apache Spark is not supported. -ifndef::openshift-rosa[] - -* The streaming deployment via AMQ/Kafka is unsupported on IBM Z and IBM Power Systems. -endif::openshift-rosa[] - -[id="tempo-release-notes_distributed-tracing-rn-2-9"] -== {TempoName} - -:FeatureName: The {TempoName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="new-features-and-enhancements_tempo-release-notes_distributed-tracing-rn-2-9"] -=== New features and enhancements - -This release introduces the following enhancements for the {TempoShortName}: - -* Support the link:https://operatorframework.io/operator-capabilities/[operator maturity] Level IV, Deep Insights, which enables upgrading, monitoring, and alerting of `TempoStack` instances and the {TempoOperator}. - -* Add Ingress and Route configuration for the Gateway. - -* Support the `managed` and `unmanaged` states in the `TempoStack` custom resource. - -* Expose the following additional ingestion protocols in the Distributor service: Jaeger Thrift binary, Jaeger Thrift compact, Jaeger gRPC, and Zipkin. When the Gateway is enabled, only the OpenTelemetry protocol (OTLP) gRPC is enabled. - -* Expose the Jaeger Query gRPC endpoint on the Query Frontend service. - -* Support multitenancy without Gateway authentication and authorization. - -//[id="technology-preview-features_tempo-release-notes_distributed-tracing-rn-2-9"] -//=== Technology Preview features -//not for 2.9 - -[id="bug-fixes_tempo-release-notes_distributed-tracing-rn-2-9"] -=== Bug fixes - -* Before this update, the {TempoOperator} was not compatible with disconnected environments. With this update, the {TempoOperator} supports disconnected environments. (link:https://issues.redhat.com/browse/TRACING-3145[TRACING-3145]) - -* Before this update, the {TempoOperator} with TLS failed to start on {product-title}. With this update, the mTLS communication is enabled between Tempo components, the Operand starts successfully, and the Jaeger UI is accessible. (link:https://issues.redhat.com/browse/TRACING-3091[TRACING-3091]) - -* Before this update, the resource limits from the {TempoOperator} caused error messages such as `reason: OOMKilled`. With this update, the resource limits for the {TempoOperator} are removed to avoid such errors. (link:https://issues.redhat.com/browse/TRACING-3204[TRACING-3204]) - -[id="known-issues_tempo-release-notes_distributed-tracing-rn-2-9"] -=== Known issues - -* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) - -* 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]) - -* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) -+ -.Workaround -+ -Disable mTLS as follows: -+ -. Open the {TempoOperator} ConfigMap for editing by running the following command: -+ -[source,terminal] ----- -$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> ----- -<1> The project where the {TempoOperator} is installed. - -. Disable the mTLS in the operator configuration by updating the YAML file: -+ -[source,yaml] ----- -data: - controller_manager_config.yaml: | - featureGates: - httpEncryption: false - grpcEncryption: false - builtInCertManagement: - enabled: false ----- - -. Restart the {TempoOperator} pod by running the following command: -+ -[source,terminal] ----- -$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator ----- - - -* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) -+ -.Workaround -+ -Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: -+ -[source,yaml] ----- -kind: ImageSetConfiguration -apiVersion: mirror.openshift.io/v1alpha2 -archiveSize: 20 -storageConfig: - local: - path: /home/user/images -mirror: - operators: - - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 - packages: - - name: tempo-product - channels: - - name: stable - additionalImages: - - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a - - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 - - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 - - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e ----- - -[id="otel-release-notes_distributed-tracing-rn-2-9"] -== {OTELName} - -:FeatureName: The {OTELName} -include::snippets/technology-preview.adoc[leveloffset=+1] - -[id="new-features-and-enhancements_otel-release-notes_distributed-tracing-rn-2-9"] -=== New features and enhancements - -This release introduces the following enhancements for the {OTELShortName}: - -* Support OTLP metrics ingestion. The metrics can be forwarded and stored in the `user-workload-monitoring` via the Prometheus exporter. - -* Support the link:https://operatorframework.io/operator-capabilities/[operator maturity] Level IV, Deep Insights, which enables upgrading and monitoring of `OpenTelemetry Collector` instances and the {OTELOperator}. - -* Report traces and metrics from remote clusters using OTLP or HTTP and HTTPS. - -* Collect {product-title} resource attributes via the `resourcedetection` processor. - -* Support the `managed` and `unmanaged` states in the `OpenTelemetryCollector` custom resouce. - -//[id="technology-preview-features_otel-release-notes_distributed-tracing-rn-2-9"] -//=== Technology Preview features -//not for 2.9 - -[id="bug-fixes_otel-release-notes_distributed-tracing-rn-2-9"] -=== Bug fixes - -None. - -[id="known-issues_otel-release-notes_distributed-tracing-rn-2-9"] -=== Known issues - -* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-0.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-0.adoc deleted file mode 100644 index 63d903536b1f..000000000000 --- a/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-0.adoc +++ /dev/null @@ -1,95 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/common-attributes.adoc[] -[id="distributed-tracing-rn-3-0"] -= Release notes for {DTProductName} 3.0 -:context: distributed-tracing-rn-3-0 - -toc::[] - -include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] - -[id="component-versions_distributed-tracing-rn-3-0"] -== Component versions in the {DTProductName} 3.0 - -[options="header"] -|=== -|Operator |Component |Version -|{JaegerName} -|Jaeger -|1.51.0 - -|xref:../../otel/otel-release-notes.adoc[{OTELName}] -|OpenTelemetry -|0.89.0 - -|{TempoName} -|Tempo -|2.3.0 -|=== - -// Jaeger section -[id="jaeger-release-notes_distributed-tracing-rn-3-0"] -== {JaegerName} - -[id="deprecated-functionality_jaeger-release-notes_distributed-tracing-rn-3-0"] -=== Deprecated functionality - -In Red Hat OpenShift distributed tracing 3.0, Jaeger and 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. - -In Red Hat OpenShift distributed tracing 3.0, Tempo provided by the {TempoOperator} and the OpenTelemetry collector provided by the Red Hat build of OpenTelemetry 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="new-features-and-enhancements_jaeger-release-notes_distributed-tracing-rn-3-0"] -=== New features and enhancements - -This update introduces the following enhancements for the {JaegerShortName}: - -* Support for the ARM architecture. -* Support for cluster-wide proxy environments. - -[id="bug-fixes_jaeger-release-notes_distributed-tracing-rn-3-0"] -=== Bug fixes - -This update introduces the following bug fixes for the {JaegerShortName}: - -* Fixed support for disconnected environments when using the `oc adm catalog mirror` CLI command. (link:https://issues.redhat.com/browse/TRACING-3546[TRACING-3546]) - -[id="known-issues_jaeger-release-notes_distributed-tracing-rn-3-0"] -=== Known issues - -* Currently, Apache Spark is not supported. - -ifndef::openshift-rosa[] - -* Currently, the streaming deployment via AMQ/Kafka is not supported on the IBM Z and IBM Power Systems architectures. -endif::openshift-rosa[] - -// Tempo section -[id="tempo-release-notes_distributed-tracing-rn-3-0"] -== {TempoName} - -[id="new-features-and-enhancements_tempo-release-notes_distributed-tracing-rn-3-0"] -=== New features and enhancements - -This update introduces the following enhancements for the {TempoShortName}: - -* Support for the ARM architecture. -* Support for span request count, duration, and error count (RED) metrics. The metrics can be visualized in the Jaeger console deployed as part of Tempo or in the web console in the *Observe* menu. - -[id="bug-fixes_tempo-release-notes_distributed-tracing-rn-3-0"] -=== Bug fixes - -This update introduces the following bug fixes for the {TempoShortName}: - -* Fixed support for the custom TLS CA option for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) -* Fixed support for disconnected environments when using the `oc adm catalog mirror` CLI command. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) -* Fixed mTLS when Gateway is not deployed. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) - -[id="known-issues_tempo-release-notes_distributed-tracing-rn-3-0"] -=== Known issues - -* 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]) -* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc new file mode 100644 index 000000000000..4160d2e38b0f --- /dev/null +++ b/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc @@ -0,0 +1,117 @@ +:_mod-docs-content-type: ASSEMBLY +include::_attributes/common-attributes.adoc[] +[id="distributed-tracing-rn-3-1"] += Release notes for {DTProductName} 3.1 +:context: distributed-tracing-rn-3-1 + +toc::[] + +include::modules/distr-tracing-product-overview.adoc[leveloffset=+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-3.1.adoc[{OTELName}] +|OpenTelemetry +|0.93.0 + +|{JaegerName} (deprecated) +|Jaeger +|1.53.0 + +|=== + +// Tempo section +[id="distributed-tracing-rn_3-1_tempo-release-notes"] +== {TempoName} + +[id="technology-preview-features_jaeger-release-notes_distributed-tracing-rn-2-9"] +=== Technology Preview features + +This update introduces the following Technology Preview feature for the {TempoShortName}: + +* Monolithic custom resource. + +:FeatureName: The monolithic custom resource +include::snippets/technology-preview.adoc[leveloffset=+1] + +[id="distributed-tracing-rn_3-1_tempo-release-notes_new-features-and-enhancements"] +=== New features and enhancements + +This update introduces the following enhancements for the {TempoShortName}: + +* Support for cluster-wide proxy environments. +* Support for TraceQL to Gateway component. + +[id="distributed-tracing-rn_3-1_tempo-release-notes_bug-fixes"] +=== Bug fixes + +This update introduces the following bug fixes for the {TempoShortName}: + +* 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]) +* 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]) + +[id="distributed-tracing-rn_3-1_tempo-release-notes_known-issues"] +=== Known issues + +//There is currently a known issue: +There are currently known issues: + +* 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]) +* Currently, the {TempoShortName} fails on the IBM Z (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) + +// Jaeger section +[id="distributed-tracing-rn_3-1_jaeger-release-notes"] +== {JaegerName} + +[id="distributed-tracing-rn_3-1_jaeger-release-notes_support-for-elasticsearch-operator"] +=== Support for {es-op} + +{JaegerName} 3.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8. + +[id="distributed-tracing-rn_3-1_jaeger-release-notes_deprecated-functionality"] +=== Deprecated functionality + +In the {DTProductName} 3.1, 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. + +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 ... +//// + +[id="distributed-tracing-rn_3-1_jaeger-release-notes_bug-fixes"] +=== Bug fixes + +This update introduces the following bug fix for the {JaegerShortName}: + +* 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]) + +[id="distributed-tracing-rn_3-1_jaeger-release-notes_known-issues"] +=== Known issues + +//There is currently a known issue: +There are currently known issues: + +* Currently, Apache Spark is not supported. + +ifndef::openshift-rosa[] + +* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. +endif::openshift-rosa[] + +include::modules/support.adoc[leveloffset=+1] + +include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc b/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc new file mode 100644 index 000000000000..555cbb39b935 --- /dev/null +++ b/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc @@ -0,0 +1,793 @@ +:_mod-docs-content-type: ASSEMBLY +[id="distr-tracing-rn-past-releases"] += Release notes for past releases of {DTProductName} +include::_attributes/common-attributes.adoc[] +:context: distr-tracing-rn-past-releases + +toc::[] + +include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] + +[id="distr-tracing-rn_3.0"] +== Release notes for {DTProductName} 3.0 + +[id="distributed-tracing-rn_3-0_component-versions"] +=== Component versions in the {DTProductName} 3.0 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.51.0 + +|{TempoName} +|Tempo +|2.3.0 +|=== + +// Jaeger section +[id="distributed-tracing-rn_3-0_jaeger-release-notes"] +=== {JaegerName} + +[id="distributed-tracing-rn_3-0_jaeger-release-notes_deprecated-functionality"] +==== Deprecated functionality + +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. + +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. + +[id="distributed-tracing-rn_3-0_jaeger-release-notes_new-features-and-enhancements"] +==== New features and enhancements + +This update introduces the following enhancements for the {JaegerShortName}: + +* Support for the ARM architecture. +* Support for cluster-wide proxy environments. + +[id="distributed-tracing-rn_3-0_jaeger-release-notes_bug-fixes"] +==== Bug fixes + +This update introduces the following bug fix for the {JaegerShortName}: + +* Before this update, the {JaegerName} operator used other images than `relatedImages`. This caused the *ImagePullBackOff* error in disconnected network environments when launching the `jaeger` pod because the `oc adm catalog mirror` command mirrors images specified in `relatedImages`. This update provides support for disconnected environments when using the `oc adm catalog mirror` CLI command. (link:https://issues.redhat.com/browse/TRACING-3546[TRACING-3546]) + +[id="distributed-tracing-rn_3-0_jaeger-release-notes_known-issues"] +==== Known issues + +There is currently a known issue: +//There are currently known issues: + +* Currently, Apache Spark is not supported. + +ifndef::openshift-rosa[] + +* Currently, the streaming deployment via AMQ/Kafka is not supported on the {ibm-z-title} and {ibm-power-title} architectures. +endif::openshift-rosa[] + +// Tempo section +[id="distributed-tracing-rn_3-0_tempo-release-notes"] +=== {TempoName} + +[id="distributed-tracing-rn_3-0_tempo-release-notes_new-features-and-enhancements"] +==== New features and enhancements + +This update introduces the following enhancements for the {TempoShortName}: + +* Support for the ARM architecture. +* Support for span request count, duration, and error count (RED) metrics. The metrics can be visualized in the Jaeger console deployed as part of Tempo or in the web console in the *Observe* menu. + +[id="distributed-tracing-rn_3-0_tempo-release-notes_bug-fixes"] +==== Bug fixes + +This update introduces the following bug fixes for the {TempoShortName}: + +* Before this update, the `TempoStack` CRD was not accepting custom CA certificate despite the option to choose CA certificates. This update fixes support for the custom TLS CA option for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) +* Before this update, when mirroring the {DTProductName} operator images to a mirror registry for use in a disconnected cluster, the related operator images for `tempo`, `tempo-gateway`, `opa-openshift`, and `tempo-query` were not mirrored. This update fixes support for disconnected environments when using the `oc adm catalog mirror` CLI command. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) +* Before this update, the query frontend service of the {DTProductName} was using internal mTLS when gateway was not deployed. This caused endpoint failure errors. This update fixes mTLS when Gateway is not deployed. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) + +[id="distributed-tracing-rn_3-0_tempo-release-notes_known-issues"] +==== Known issues + +//There is currently a known issue: +There are currently known issues: + +* 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]) +* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) + +[id="distr-tracing-rn_2-9-2"] +== Release notes for {DTProductName} 2.9.2 + +[id="distr-tracing-rn_2-9-2_component-versions"] +=== Component versions in the {DTProductName} 2.9.2 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.47.0 + +|{TempoName} +|Tempo +|2.1.1 +|=== + +=== CVEs + +This release fixes link:https://bugzilla.redhat.com/show_bug.cgi?id=2246470[CVE-2023-46234]. + +[id="distr-tracing-rn_2-9-2_jaeger-release-notes"] +=== {JaegerName} + +[id="distr-tracing-rn_2-9-2_jaeger-release-notes_known-issues"] +==== Known issues + +//There is currently a known issue: +There are currently known issues: + +* Apache Spark is not supported. +ifndef::openshift-rosa[] + +* The streaming deployment via AMQ/Kafka is unsupported on the {ibm-z-title} and {ibm-power-title} architectures. +endif::openshift-rosa[] + +[id="distr-tracing-rn_2-9-2_tempo-release-notes"] +=== {TempoName} + +:FeatureName: The {TempoName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +[id="distr-tracing-rn_2-9-2_tempo-release-notes_known-issues"] +==== Known issues + +//There is currently a known issue: +There are currently known issues: + +* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) + +* 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]) + +* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) + +* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) ++ +.Workaround ++ +Disable mTLS as follows: ++ +. Open the {TempoOperator} ConfigMap for editing by running the following command: ++ +[source,terminal] +---- +$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> +---- +<1> The project where the {TempoOperator} is installed. + +. Disable the mTLS in the operator configuration by updating the YAML file: ++ +[source,yaml] +---- +data: + controller_manager_config.yaml: | + featureGates: + httpEncryption: false + grpcEncryption: false + builtInCertManagement: + enabled: false +---- + +. Restart the {TempoOperator} pod by running the following command: ++ +[source,terminal] +---- +$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator +---- + + +* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) ++ +.Workaround ++ +Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: ++ +[source,yaml] +---- +kind: ImageSetConfiguration +apiVersion: mirror.openshift.io/v1alpha2 +archiveSize: 20 +storageConfig: + local: + path: /home/user/images +mirror: + operators: + - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 + packages: + - name: tempo-product + channels: + - name: stable + additionalImages: + - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a + - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 + - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 + - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e +---- + +[id="distr-tracing-rn_2-9-1"] +== Release notes for {DTProductName} 2.9.1 + +[id="distr-tracing-rn_2-9-1_component-versions"] +=== Component versions in the {DTProductName} 2.9.1 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.47.0 + +|{TempoName} +|Tempo +|2.1.1 +|=== + +=== CVEs + +This release fixes link:https://access.redhat.com/security/cve/cve-2023-44487[CVE-2023-44487]. + +[id="distr-tracing-rn_2-9-1_jaeger-release-notes"] +=== {JaegerName} + +[id="distr-tracing-rn_2-9-1_jaeger-release-notes_known-issues"] +==== Known issues + +//There is currently a known issue: +There are currently known issues: + +* Apache Spark is not supported. +ifndef::openshift-rosa[] + +* The streaming deployment via AMQ/Kafka is unsupported on the {ibm-z-title} and {ibm-power-title} architectures. +endif::openshift-rosa[] + +[id="distr-tracing-rn_2-9-1_tempo-release-notes"] +=== {TempoName} + +:FeatureName: The {TempoName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +[id="distr-tracing-rn_2-9-1_tempo-release-notes_known-issues"] +==== Known issues + +//There is currently a known issue: +There are currently known issues: + +* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) + +* 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]) + +* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) + +* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) ++ +.Workaround ++ +Disable mTLS as follows: ++ +. Open the {TempoOperator} ConfigMap for editing by running the following command: ++ +[source,terminal] +---- +$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> +---- +<1> The project where the {TempoOperator} is installed. + +. Disable the mTLS in the operator configuration by updating the YAML file: ++ +[source,yaml] +---- +data: + controller_manager_config.yaml: | + featureGates: + httpEncryption: false + grpcEncryption: false + builtInCertManagement: + enabled: false +---- + +. Restart the {TempoOperator} pod by running the following command: ++ +[source,terminal] +---- +$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator +---- + +* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) ++ +.Workaround ++ +Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: ++ +[source,yaml] +---- +kind: ImageSetConfiguration +apiVersion: mirror.openshift.io/v1alpha2 +archiveSize: 20 +storageConfig: + local: + path: /home/user/images +mirror: + operators: + - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 + packages: + - name: tempo-product + channels: + - name: stable + additionalImages: + - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a + - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 + - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 + - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e +---- + +[id="distr-tracing-rn_2-9"] +== Release notes for {DTProductName} 2.9 + +[id="distr-tracing-rn_2-9_component-versions"] +=== Component versions in the {DTProductName} 2.9 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.47.0 + +|{TempoName} +|Tempo +|2.1.1 +|=== + +[id="distr-tracing-rn_2-9_jaeger-release-notes"] +=== {JaegerName} + +//// +[id="distr-tracing-rn_2-9_jaeger-release-notes_new-features-and-enhancements"] +==== New features and enhancements +* None. +//// + +//// +[id="technology-preview-features_jaeger-release-notes_distributed-tracing-rn-2-9"] +==== Technology Preview features +None. +//// + +[id="distr-tracing-rn_2-9_jaeger-release-notes_bug-fixes"] +==== Bug fixes + +* Before this update, connection was refused due to a missing gRPC port on the `jaeger-query` deployment. This issue resulted in `transport: Error while dialing: dial tcp :16685: connect: connection refused` error message. With this update, the Jaeger Query gRPC port (16685) is successfully exposed on the Jaeger Query service. (link:https://issues.redhat.com/browse/TRACING-3322[TRACING-3322]) + +* Before this update, the wrong port was exposed for `jaeger-production-query`, resulting in refused connection. With this update, the issue is fixed by exposing the Jaeger Query gRPC port (16685) on the Jaeger Query deployment. (link:https://issues.redhat.com/browse/TRACING-2968[TRACING-2968]) + +* Before this update, when deploying {SMProductShortName} on {sno} clusters in disconnected environments, the Jaeger pod frequently went into the `Pending` state. With this update, the issue is fixed. (link:https://issues.redhat.com/browse/TRACING-3312[TRACING-3312]) + +* Before this update, the Jaeger Operator pod restarted with the default memory value due to the `reason: OOMKilled` error message. With this update, this issue is fixed by removing the resource limits. (link:https://issues.redhat.com/browse/TRACING-3173[TRACING-3173]) + +[id="distr-tracing-rn_2-9_jaeger-release-notes_known-issues"] +==== Known issues + +//There is currently a known issue: +There are currently known issues: + +* Apache Spark is not supported. +ifndef::openshift-rosa[] + +* The streaming deployment via AMQ/Kafka is unsupported on the {ibm-z-title} and {ibm-power-title} architectures. +endif::openshift-rosa[] + +[id="distr-tracing-rn_2-9_tempo-release-notes"] +=== {TempoName} + +:FeatureName: The {TempoName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +[id="distr-tracing-rn_2-9_tempo-release-notes_new-features-and-enhancements"] +==== New features and enhancements + +This release introduces the following enhancements for the {TempoShortName}: + +* Support the link:https://operatorframework.io/operator-capabilities/[operator maturity] Level IV, Deep Insights, which enables upgrading, monitoring, and alerting of the TempoStack instances and the {TempoOperator}. + +* Add Ingress and Route configuration for the Gateway. + +* Support the `managed` and `unmanaged` states in the `TempoStack` custom resource. + +* Expose the following additional ingestion protocols in the Distributor service: Jaeger Thrift binary, Jaeger Thrift compact, Jaeger gRPC, and Zipkin. When the Gateway is enabled, only the OpenTelemetry protocol (OTLP) gRPC is enabled. + +* Expose the Jaeger Query gRPC endpoint on the Query Frontend service. + +* Support multitenancy without Gateway authentication and authorization. + +//// +[id="distributed-tracing-rn_2-9_tempo-release-notes_technology-preview-features"] +=== Technology Preview features +None. +//// + +[id="distr-tracing-rn_2-9_tempo-release-notes_bug-fixes"] +==== Bug fixes + +* Before this update, the {TempoOperator} was not compatible with disconnected environments. With this update, the {TempoOperator} supports disconnected environments. (link:https://issues.redhat.com/browse/TRACING-3145[TRACING-3145]) + +* Before this update, the {TempoOperator} with TLS failed to start on {product-title}. With this update, the mTLS communication is enabled between Tempo components, the Operand starts successfully, and the Jaeger UI is accessible. (link:https://issues.redhat.com/browse/TRACING-3091[TRACING-3091]) + +* Before this update, the resource limits from the {TempoOperator} caused error messages such as `reason: OOMKilled`. With this update, the resource limits for the {TempoOperator} are removed to avoid such errors. (link:https://issues.redhat.com/browse/TRACING-3204[TRACING-3204]) + +[id="distr-tracing-rn_2-9_tempo-release-notes_known-issues"] +==== Known issues + +//There is currently a known issue: +There are currently known issues: + +* Currently, the custom TLS CA option is not implemented for connecting to object storage. (link:https://issues.redhat.com/browse/TRACING-3462[TRACING-3462]) + +* 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]) + +* Currently, the {TempoShortName} fails on the {ibm-z-title} (`s390x`) architecture. (link:https://issues.redhat.com/browse/TRACING-3545[TRACING-3545]) + +* Currently, the Tempo query frontend service must not use internal mTLS when Gateway is not deployed. This issue does not affect the Jaeger Query API. The workaround is to disable mTLS. (link:https://issues.redhat.com/browse/TRACING-3510[TRACING-3510]) ++ +.Workaround ++ +Disable mTLS as follows: ++ +. Open the {TempoOperator} ConfigMap for editing by running the following command: ++ +[source,terminal] +---- +$ oc edit configmap tempo-operator-manager-config -n openshift-tempo-operator <1> +---- +<1> The project where the {TempoOperator} is installed. + +. Disable the mTLS in the operator configuration by updating the YAML file: ++ +[source,yaml] +---- +data: + controller_manager_config.yaml: | + featureGates: + httpEncryption: false + grpcEncryption: false + builtInCertManagement: + enabled: false +---- + +. Restart the {TempoOperator} pod by running the following command: ++ +[source,terminal] +---- +$ oc rollout restart deployment.apps/tempo-operator-controller -n openshift-tempo-operator +---- + + +* Missing images for running the {TempoOperator} in restricted environments. The {TempoName} CSV is missing references to the operand images. (link:https://issues.redhat.com/browse/TRACING-3523[TRACING-3523]) ++ +.Workaround ++ +Add the {TempoOperator} related images in the mirroring tool to mirror the images to the registry: ++ +[source,yaml] +---- +kind: ImageSetConfiguration +apiVersion: mirror.openshift.io/v1alpha2 +archiveSize: 20 +storageConfig: + local: + path: /home/user/images +mirror: + operators: + - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.13 + packages: + - name: tempo-product + channels: + - name: stable + additionalImages: + - name: registry.redhat.io/rhosdt/tempo-rhel8@sha256:e4295f837066efb05bcc5897f31eb2bdbd81684a8c59d6f9498dd3590c62c12a + - name: registry.redhat.io/rhosdt/tempo-gateway-rhel8@sha256:b62f5cedfeb5907b638f14ca6aaeea50f41642980a8a6f87b7061e88d90fac23 + - name: registry.redhat.io/rhosdt/tempo-gateway-opa-rhel8@sha256:8cd134deca47d6817b26566e272e6c3f75367653d589f5c90855c59b2fab01e9 + - name: registry.redhat.io/rhosdt/tempo-query-rhel8@sha256:0da43034f440b8258a48a0697ba643b5643d48b615cdb882ac7f4f1f80aad08e +---- + +[id="distr-tracing-rn_2-8"] +== Release notes for {DTProductName} 2.8 + +[id="distr-tracing-rn_2-8_component-versions"] +=== Component versions in the {DTProductName} 2.8 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.42 + +|{TempoName} +|Tempo +|0.1.0 +|=== + +[id="distr-tracing-rn_2-8_technology-preview-features"] +=== Technology Preview features + +This release introduces support for the {TempoName} as a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] feature for {DTProductName}. + +:FeatureName: The {TempoName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +The feature uses version 0.1.0 of the {TempoName} and version 2.0.1 of the upstream {TempoShortName} components. + +You can use the {TempoShortName} to replace Jaeger so that you can use S3-compatible storage instead of ElasticSearch. +Most users who use the {TempoShortName} instead of Jaeger will not notice any difference in functionality because the {TempoShortName} supports the same ingestion and query protocols as Jaeger and uses the same user interface. + +If you enable this Technology Preview feature, note the following limitations of the current implementation: + +* The {TempoShortName} currently does not support disconnected installations. (link:https://issues.redhat.com/browse/TRACING-3145[TRACING-3145]) + +* When you use the Jaeger user interface (UI) with the {TempoShortName}, the Jaeger UI lists only services that have sent traces within the last 15 minutes. For services that have not sent traces within the last 15 minutes, those traces are still stored even though they are not visible in the Jaeger UI. (link:https://issues.redhat.com/browse/TRACING-3139[TRACING-3139]) + +Expanded support for the {TempoOperator} is planned for future releases of the {DTProductName}. +Possible additional features might include support for TLS authentication, multitenancy, and multiple clusters. +For more information about the {TempoOperator}, see the link:https://tempo-operator.netlify.app[Tempo community documentation]. + +[id="distr-tracing-rn_2-8_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="distr-tracing-rn_2-7"] +== Release notes for {DTProductName} 2.7 + +[id="distr-tracing-rn_2-7_component-versions"] +=== Component versions in the {DTProductName} 2.7 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.39 +|=== + +[id="distr-tracing-rn_2-7_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="distr-tracing-rn_2-6"] +== Release notes for {DTProductName} 2.6 + +[id="distr-tracing-rn_2-6_component-versions"] +=== Component versions in the {DTProductName} 2.6 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.38 +|=== + +[id="distr-tracing-rn_2-6_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="distr-tracing-rn_2-5"] +== Release notes for {DTProductName} 2.5 + +[id="distr-tracing-rn_2-5_component-versions"] +=== Component versions in the {DTProductName} 2.5 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.36 +|=== + +[id="distr-tracing-rn_2-5_new-features-and-enhancements"] +=== New features and enhancements + +This release introduces support for ingesting OpenTelemetry protocol (OTLP) to the {JaegerName} Operator. +The Operator now automatically enables the OTLP ports: + +* Port 4317 for the OTLP gRPC protocol. +* Port 4318 for the OTLP HTTP protocol. + +This release also adds support for collecting Kubernetes resource attributes to the {OTELName} Operator. + +[id="distr-tracing-rn_2-5_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="distr-tracing-rn_2-4"] +== Release notes for {DTProductName} 2.4 + +[id="distr-tracing-rn_2-4_component-versions"] +=== Component versions in the {DTProductName} 2.4 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.34.1 +|=== + +[id="distr-tracing-rn_2-4_new-features-and-enhancements"] +=== New features and enhancements + +This release adds support for auto-provisioning certificates using the {es-op}. + +Self-provisioning by using the {JaegerName} Operator to call the {es-op} during installation. ++ +[IMPORTANT] +==== +When upgrading to the {DTProductName} 2.4, the operator recreates the Elasticsearch instance, which might take five to ten minutes. Distributed tracing will be down and unavailable for that period. +==== + +[id="distr-tracing-rn_2-4_technology-preview-features"] +=== Technology Preview features + +Creating the Elasticsearch instance and certificates first and then configuring the {JaegerShortName} to use the certificate is a link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview] for this release. + +[id="distr-tracing-rn_2-4_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="distr-tracing-rn_2-3"] +== Release notes for {DTProductName} 2.3 + +[id="distr-tracing-rn_2-3_component-versions_2-3-1"] +=== Component versions in the {DTProductName} 2.3.1 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.30.2 +|=== + +[id="distr-tracing-rn_2-3_component-versions_2-3-0"] +=== Component versions in the {DTProductName} 2.3.0 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.30.1 +|=== + +[id="distr-tracing-rn_2-3_new-features-and-enhancements"] +=== New features and enhancements + +With this release, the {JaegerName} Operator is now installed to the `openshift-distributed-tracing` namespace by default. Before this update, the default installation had been in the `openshift-operators` namespace. + +[id="distr-tracing-rn_2-3_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="distr-tracing-rn_2-2"] +== Release notes for {DTProductName} 2.2 + +[id="distr-tracing-rn_2-2_technology-preview-features"] +=== Technology Preview features + +The unsupported OpenTelemetry Collector components included in the 2.1 release are removed. + +[id="distr-tracing-rn_2-2_bug-fixes"] +=== Bug fixes + +This release of the {DTProductName} addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="distr-tracing-rn_2-1"] +== Release notes for {DTProductName} 2.1 + +[id="distr-tracing-rn_2-1_component-versions"] +=== Component versions in the {DTProductName} 2.1 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.29.1 +|=== + +[id="distr-tracing-rn_2-1_technology-preview-features"] +=== Technology Preview features + +* This release introduces a breaking change to how to configure certificates in the OpenTelemetry custom resource file. With this update, the `ca_file` moves under `tls` in the custom resource, as shown in the following examples. ++ +.CA file configuration for OpenTelemetry version 0.33 ++ +[source,yaml] +---- +spec: + mode: deployment + config: | + exporters: + jaeger: + endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 + ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" +---- ++ +.CA file configuration for OpenTelemetry version 0.41.1 ++ +[source,yaml] +---- +spec: + mode: deployment + config: | + exporters: + jaeger: + endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 + tls: + ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" +---- + +[id="distr-tracing-rn_2-1_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="distr-tracing-rn_2-0"] +== Release notes for {DTProductName} 2.0 + +[id="distr-tracing-rn_2-0_component-versions"] +=== Component versions in the {DTProductName} 2.0 + +[options="header"] +|=== +|Operator |Component |Version +|{JaegerName} +|Jaeger +|1.28.0 +|=== + +[id="distr-tracing-rn_2-0_new-features-and-enhancements"] +=== New features and enhancements + +This release introduces the following new features and enhancements: + +* Rebrands Red Hat OpenShift Jaeger as the {DTProductName}. + +* Updates {JaegerName} Operator to Jaeger 1.28. Going forward, the {DTProductName} will only support the `stable` Operator channel. +Channels for individual releases are no longer supported. + +* Adds support for OpenTelemetry protocol (OTLP) to the Query service. + +* Introduces a new distributed tracing icon that appears in the OperatorHub. + +* Includes rolling updates to the documentation to support the name change and new features. + +[id="distr-tracing-rn_2-0_technology-preview-features"] +=== Technology Preview features + +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 {DTProductName}. 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. + +[id="distr-tracing-rn_2-0_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +include::modules/support.adoc[leveloffset=+1] + +include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/modules/distr-tracing-product-overview.adoc b/modules/distr-tracing-product-overview.adoc index a7768e395e9c..90bde809cae8 100644 --- a/modules/distr-tracing-product-overview.adoc +++ b/modules/distr-tracing-product-overview.adoc @@ -1,16 +1,7 @@ // Module included in the following assemblies: // -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-0.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-1.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-2.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-3.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-4.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-5.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-6.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc -// * distr_tracing/distr_tracing_rn/distr-tracing-rn-3-0.adoc +// * 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 // * service_mesh/v2x/ossm-architecture.adoc // * serverless/serverless-tracing.adoc diff --git a/modules/otel-product-overview.adoc b/modules/otel-product-overview.adoc new file mode 100644 index 000000000000..f6bc9c68df5f --- /dev/null +++ b/modules/otel-product-overview.adoc @@ -0,0 +1,28 @@ +// Module included in the following assemblies: +// +// * otel/otel_rn/otel-rn-3-1.adoc +// * otel/otel_tracing_rn/otel-rn-past-releases.adoc + +:_mod-docs-content-type: CONCEPT +[id="otel-product-overview_{context}"] += {OTELName} overview + +{OTELName} is based on the open source link:https://opentelemetry.io/[OpenTelemetry project], which aims to provide unified, standardized, and vendor-neutral telemetry data collection for cloud-native software. {OTELName} product provides support for deploying and managing the OpenTelemetry Collector and simplifying the workload instrumentation. + +The link:https://opentelemetry.io/docs/collector/[OpenTelemetry Collector] can receive, process, and forward telemetry data in multiple formats, making it the ideal component for telemetry processing and interoperability between telemetry systems. The Collector provides a unified solution for collecting and processing metrics, traces, and logs. + +The OpenTelemetry Collector has a number of features including the following: + +Data Collection and Processing Hub:: It acts as a central component that gathers telemetry data like metrics and traces from various sources. This data can be created from instrumented applications and infrastructure. + +Customizable telemetry data pipeline:: The OpenTelemetry Collector is designed to be customizable. It supports various processors, exporters, and receivers. + +Auto-instrumentation features:: Automatic instrumentation simplifies the process of adding observability to applications. Developers don't need to manually instrument their code for basic telemetry data. + +Here are some of the use cases for the OpenTelemetry Collector: + +Centralized data collection:: In a microservices architecture, the Collector can be deployed to aggregate data from multiple services. + +Data enrichment and processing:: Before forwarding data to analysis tools, the Collector can enrich, filter, and process this data. + +Multi-backend receiving and exporting:: The Collector can receive and send data to multiple monitoring and analysis platforms simultaneously. diff --git a/observability/index.adoc b/observability/index.adoc index f7b2a37b42a6..a0a7214c5476 100644 --- a/observability/index.adoc +++ b/observability/index.adoc @@ -45,8 +45,8 @@ For more information, see xref:../distr_tracing/distr_tracing_arch/distr-tracing == {OTELName} Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open source backends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate. -For more information, see xref:../otel/otel-release-notes.adoc#otel-release-notes[{OTELName} release notes]. -//after the file is added to the observability directory, update xref path to ../observability/otel/otel-release-notes.adoc#otel-release-notes[{OTELName} release notes]. +For more information, see xref:../otel/otel_rn/otel-rn-3.1.adoc[{OTELName}]. +//possibly outdated comment: after the file is added to the observability directory, update xref path to ../observability/otel/otel-release-notes.adoc#otel-release-notes[{OTELName} release notes]. [id="network-observability-overview-index"] == Network Observability diff --git a/otel/otel-migrating.adoc b/otel/otel-migrating.adoc index 75bed9b697a5..3718f17f1c50 100644 --- a/otel/otel-migrating.adoc +++ b/otel/otel-migrating.adoc @@ -6,6 +6,9 @@ include::_attributes/common-attributes.adoc[] toc::[] +:FeatureName: The {JaegerName} +include::modules/deprecated-feature.adoc[] + If you are already using the {JaegerName} for your applications, you can migrate to the {OTELName}, which is based on the link:https://opentelemetry.io/[OpenTelemetry] open-source project. The {OTELShortName} provides a set of APIs, libraries, agents, and instrumentation to facilitate observability in distributed systems. The OpenTelemetry Collector in the {OTELShortName} can ingest the Jaeger protocol, so you do not need to change the SDKs in your applications. diff --git a/otel/otel-release-notes.adoc b/otel/otel-release-notes.adoc deleted file mode 100644 index 9507f420f587..000000000000 --- a/otel/otel-release-notes.adoc +++ /dev/null @@ -1,136 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/common-attributes.adoc[] -[id="otel-release-notes"] -= Release notes for {OTELName} -:context: otel-release-notes - -toc::[] - -[id="otel-product-overview"] -== {OTELName} overview - -{OTELName} is based on the open source link:https://opentelemetry.io/[OpenTelemetry project], which aims to provide unified, standardized, and vendor-neutral telemetry data collection for cloud-native software. {OTELName} product provides support for deploying and managing the OpenTelemetry Collector and simplifying the workload instrumentation. - -The link:https://opentelemetry.io/docs/collector/[OpenTelemetry Collector] can receive, process, and forward telemetry data in multiple formats, making it the ideal component for telemetry processing and interoperability between telemetry systems. The Collector provides a unified solution for collecting and processing metrics, traces, and logs. - -The OpenTelemetry Collector has a number of features including the following: - -Data Collection and Processing Hub:: It acts as a central component that gathers telemetry data like metrics and traces from various sources. This data can be created from instrumented applications and infrastructure. - -Customizable telemetry data pipeline:: The OpenTelemetry Collector is designed to be customizable. It supports various processors, exporters, and receivers. - -Auto-instrumentation features:: Automatic instrumentation simplifies the process of adding observability to applications. Developers don't need to manually instrument their code for basic telemetry data. - -Here are some of the use cases for the OpenTelemetry Collector: - -Centralized data collection:: In a microservices architecture, the Collector can be deployed to aggregate data from multiple services. - -Data enrichment and processing:: Before forwarding data to analysis tools, the Collector can enrich, filter, and process this data. - -Multi-backend receiving and exporting:: The Collector can receive and send data to multiple monitoring and analysis platforms simultaneously. - -[id="otel-3-0-rn"] -== {OTELName} {DTProductVersion} - -{OTELName} {DTProductVersion} is based on link:https://opentelemetry.io/[OpenTelemetry] {OTELVersion}. - -[id="new-features-and-enhancements_otel-3-0-rn"] -=== New features and enhancements - -This update introduces the following enhancements: - -* 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. -* Support for the Kafka receiver and exporter for sending traces and metrics to Kafka. -* Support for cluster-wide proxy environments. -* The {OTELOperator} creates the Prometheus `ServiceMonitor` custom resource if the Prometheus exporter is enabled. -* The Operator enables the `Instrumentation` custom resource that allows injecting upstream OpenTelemetry auto-instrumentation libraries. - -[id="removal-notice_otel-3-0-rn"] -=== Removal notice - -* In {OTELName} {DTProductVersion}, the Jaeger exporter has been removed. Bug fixes and support are provided only through the end of the 2.9 lifecycle. As an alternative to the Jaeger exporter for sending data to the Jaeger collector, you can use the OTLP exporter instead. - -[id="bug-fixes_otel-3-0-rn"] -=== Bug fixes - -This update introduces the following bug fixes: - -* Fixed support for disconnected environments when using the `oc adm catalog mirror` CLI command. - -[id="known-issues_otel-3-0-rn"] -=== Known issues - -Currently, the cluster monitoring of the {OTELOperator} is disabled due to a bug (link:https://issues.redhat.com/browse/TRACING-3761[TRACING-3761]). The bug is preventing the cluster monitoring from scraping metrics from the {OTELOperator} due to a missing label `openshift.io/cluster-monitoring=true` - that is required for the cluster monitoring and service monitor object. - -.Workaround - -You can enable the cluster monitoring as follows: - -. Add the following label in the Operator namespace: `oc label namespace openshift-opentelemetry-operator openshift.io/cluster-monitoring=true` - -. Create a service monitor, role, and role binding: -+ -[source,yaml] ----- -apiVersion: monitoring.coreos.com/v1 -kind: ServiceMonitor -metadata: - name: opentelemetry-operator-controller-manager-metrics-service - namespace: openshift-opentelemetry-operator -spec: - endpoints: - - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token - path: /metrics - port: https - scheme: https - tlsConfig: - insecureSkipVerify: true - selector: - matchLabels: - app.kubernetes.io/name: opentelemetry-operator - control-plane: controller-manager ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: Role -metadata: - name: otel-operator-prometheus - namespace: openshift-opentelemetry-operator - annotations: - include.release.openshift.io/self-managed-high-availability: "true" - include.release.openshift.io/single-node-developer: "true" -rules: -- apiGroups: - - "" - resources: - - services - - endpoints - - pods - verbs: - - get - - list - - watch ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: RoleBinding -metadata: - name: otel-operator-prometheus - namespace: openshift-opentelemetry-operator - annotations: - include.release.openshift.io/self-managed-high-availability: "true" - include.release.openshift.io/single-node-developer: "true" -roleRef: - apiGroup: rbac.authorization.k8s.io - kind: Role - name: otel-operator-prometheus -subjects: -- kind: ServiceAccount - name: prometheus-k8s - namespace: openshift-monitoring ----- - -include::modules/support.adoc[leveloffset=+1] - -include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/otel/otel_rn/_attributes b/otel/otel_rn/_attributes new file mode 120000 index 000000000000..20cc1dcb77bf --- /dev/null +++ b/otel/otel_rn/_attributes @@ -0,0 +1 @@ +../../_attributes/ \ No newline at end of file diff --git a/otel/otel_rn/images b/otel/otel_rn/images new file mode 120000 index 000000000000..847b03ed0541 --- /dev/null +++ b/otel/otel_rn/images @@ -0,0 +1 @@ +../../images/ \ No newline at end of file diff --git a/otel/otel_rn/modules b/otel/otel_rn/modules new file mode 120000 index 000000000000..36719b9de743 --- /dev/null +++ b/otel/otel_rn/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/otel/otel_rn/otel-rn-3.1.adoc b/otel/otel_rn/otel-rn-3.1.adoc new file mode 100644 index 000000000000..834d3fe59db4 --- /dev/null +++ b/otel/otel_rn/otel-rn-3.1.adoc @@ -0,0 +1,43 @@ +:_mod-docs-content-type: ASSEMBLY +include::_attributes/common-attributes.adoc[] +[id="otel-rn-3-1"] += Release notes for {OTELName} 3.1 +:context: otel-rn-3-1 + +toc::[] + +include::modules/otel-product-overview.adoc[leveloffset=+1] + +[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. + +* 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. + +//// +[id="otel-rn_3-1_removal-notice"] +=== Removal notice +* +//// + +//// +[id="otel-rn_3-1_bug-fixes"] +=== Bug fixes +This update introduces the following bug fixes: +* Fixed support for ... +//// + +//// +[id="otel-rn_3-1_known-issues"] +=== Known issues +//There is currently a known issue: +//There are currently known issues: +//// + +include::modules/support.adoc[leveloffset=+1] + +include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/otel/otel_rn/otel-rn-past-releases.adoc b/otel/otel_rn/otel-rn-past-releases.adoc new file mode 100644 index 000000000000..46811c3cf148 --- /dev/null +++ b/otel/otel_rn/otel-rn-past-releases.adoc @@ -0,0 +1,398 @@ +:_mod-docs-content-type: ASSEMBLY +[id="otel-rn-past-releases"] += Release notes for past releases of {OTELName} +include::_attributes/common-attributes.adoc[] +:context: otel-rn-past-releases + +toc::[] + +include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] + +[id="otel-rn_3-0"] +== Release notes for {OTELName} 3.0 + +{OTELName} 3.0 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.89.0. + +[id="otel-rn_3-0_new-features-and-enhancements"] +=== New features and enhancements + +This update introduces the following enhancements: + +* 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. +* Support for the Kafka receiver and exporter for sending traces and metrics to Kafka. +* Support for cluster-wide proxy environments. +* The {OTELOperator} creates the Prometheus `ServiceMonitor` custom resource if the Prometheus exporter is enabled. +* The Operator enables the `Instrumentation` custom resource that allows injecting upstream OpenTelemetry auto-instrumentation libraries. + +[id="otel-rn_3-0_removal-notice"] +=== Removal notice + +In {OTELName} 3.0, the Jaeger exporter has been removed. Bug fixes and support are provided only through the end of the 2.9 lifecycle. As an alternative to the Jaeger exporter for sending data to the Jaeger collector, you can use the OTLP exporter instead. + +[id="otel-rn_3-0_bug-fixes"] +=== Bug fixes + +This update introduces the following bug fixes: + +* Fixed support for disconnected environments when using the `oc adm catalog mirror` CLI command. + +[id="otel-rn_3-0_known-issues"] +=== Known issues + +There is currently a known issue: +//There are currently known issues: + +* Curently, the cluster monitoring of the {OTELOperator} is disabled due to a bug (link:https://issues.redhat.com/browse/TRACING-3761[TRACING-3761]). The bug is preventing the cluster monitoring from scraping metrics from the {OTELOperator} due to a missing label `openshift.io/cluster-monitoring=true` that is required for the cluster monitoring and service monitor object. ++ +.Workaround ++ +You can enable the cluster monitoring as follows: ++ +. Add the following label in the Operator namespace: `oc label namespace openshift-opentelemetry-operator openshift.io/cluster-monitoring=true` ++ +. Create a service monitor, role, and role binding: ++ +[source,yaml] +---- +apiVersion: monitoring.coreos.com/v1 +kind: ServiceMonitor +metadata: + name: opentelemetry-operator-controller-manager-metrics-service + namespace: openshift-opentelemetry-operator +spec: + endpoints: + - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token + path: /metrics + port: https + scheme: https + tlsConfig: + insecureSkipVerify: true + selector: + matchLabels: + app.kubernetes.io/name: opentelemetry-operator + control-plane: controller-manager +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: Role +metadata: + name: otel-operator-prometheus + namespace: openshift-opentelemetry-operator + annotations: + include.release.openshift.io/self-managed-high-availability: "true" + include.release.openshift.io/single-node-developer: "true" +rules: +- apiGroups: + - "" + resources: + - services + - endpoints + - pods + verbs: + - get + - list + - watch +--- +apiVersion: rbac.authorization.k8s.io/v1 +kind: RoleBinding +metadata: + name: otel-operator-prometheus + namespace: openshift-opentelemetry-operator + annotations: + include.release.openshift.io/self-managed-high-availability: "true" + include.release.openshift.io/single-node-developer: "true" +roleRef: + apiGroup: rbac.authorization.k8s.io + kind: Role + name: otel-operator-prometheus +subjects: +- kind: ServiceAccount + name: prometheus-k8s + namespace: openshift-monitoring +---- + +[id="otel-rn_2-9-2"] +== Release notes for {OTELName} 2.9.2 + +: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. + +[id="otel-rn_2-9-2_cves"] +=== CVEs + +* This release fixes link:https://bugzilla.redhat.com/show_bug.cgi?id=2246470[CVE-2023-46234]. + +[id="otel-rn_2-9-2_known-issues"] +=== Known issues + +There is currently a known issue: +//There are currently known issues: + +* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) + +[id="otel-rn_2-9-1"] +== Release notes for {OTELName} 2.9.1 + +: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. + +[id="otel-rn_2-9-1_cves"] +=== CVEs + +* This release fixes link:https://access.redhat.com/security/cve/cve-2023-44487[CVE-2023-44487]. + +[id="otel-rn_2-9-1_known-issues"] +=== Known issues + +There is currently a known issue: +//There are currently known issues: + +* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) + +[id="otel-rn_2-9"] +== Release notes for {OTELName} 2.9 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.9 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.81.0. + +[id="otel-rn_2-9_new-features-and-enhancements"] +=== New features and enhancements + +This release introduces the following enhancements for the {OTELShortName}: + +* Support OTLP metrics ingestion. The metrics can be forwarded and stored in the `user-workload-monitoring` via the Prometheus exporter. + +* Support the link:https://operatorframework.io/operator-capabilities/[operator maturity] Level IV, Deep Insights, which enables upgrading and monitoring of `OpenTelemetry Collector` instances and the {OTELOperator}. + +* Report traces and metrics from remote clusters using OTLP or HTTP and HTTPS. + +* Collect {product-title} resource attributes via the `resourcedetection` processor. + +* Support the `managed` and `unmanaged` states in the `OpenTelemetryCollector` custom resouce. + +//// +[id="otel-rn_2-9_technology-preview-features"] +==== Technology Preview features +None. +//// + +//// +[id="otel-rn_2-9_bug-fixes"] +==== Bug fixes +None. +//// + +[id="otel-rn_2-9_known-issues"] +=== Known issues + +There is currently a known issue: +//There are currently known issues: + +* Currently, you must manually set link:https://operatorframework.io/operator-capabilities/[operator maturity] to Level IV, Deep Insights. (link:https://issues.redhat.com/browse/TRACING-3431[TRACING-3431]) + +[id="otel-rn_2-8"] +== Release notes for {OTELName} 2.8 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.8 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.74.0. + +[id="otel-rn_2-8_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +//// +[id="otel-rn_2-8_known-issues"] +== Known issues +None. +//// + +[id="otel-rn_2-7"] +== Release notes for {OTELName} 2.7 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.7 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.63.1. + +[id="otel-rn_2-7_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="otel-rn_2-6"] +== Release notes for {OTELName} 2.6 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.6 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.60. + +[id="otel-rn_2-6_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="otel-rn_2-5"] +== Release notes for {OTELName} 2.5 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.5 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.56. + +[id="otel-rn_2-5_new-features-and-enhancements"] +=== New features and enhancements + +This update introduces the following enhancement: + +* Support for collecting Kubernetes resource attributes to the {OTELName} Operator. + +[id="otel-rn_2-5_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +[id="otel-rn_2-4"] +== Release notes for {OTELName} 2.4 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.4 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.49. + +[id="otel-rn_2-4_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +//// +[id="otel-rn_2-4_known-issues"] +=== Known issues +None. +//// + +[id="otel-rn_2-3"] +== Release notes for {OTELName} 2.3 + +: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.0 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.44.0. + +[id="otel-rn_2-3_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +//// +[id="otel-rn_2-3_known-issues"] +=== Known issues +None. +//// + +[id="otel-rn_2-2"] +== Release notes for {OTELName} 2.2 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.2 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.42.0. + +[id="otel-rn_2-2_technology-preview-features"] +=== Technology Preview features + +The unsupported OpenTelemetry Collector components included in the 2.1 release are removed. + +[id="otel-rn_2-2_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +//// +[id="otel-rn_2-2_known-issues"] +=== Known issues +None. +//// + +[id="otel-rn_2-1"] +== Release notes for {OTELName} 2.1 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.1 is based on link:https://opentelemetry.io/[OpenTelemetry] 0.41.1. + +[id="otel-rn_2-1_technology-preview-features"] +=== Technology Preview features + +This release introduces a breaking change to how to configure certificates in the OpenTelemetry custom resource file. With this update, the `ca_file` moves under `tls` in the custom resource, as shown in the following examples. + +.CA file configuration for OpenTelemetry version 0.33 + +[source,yaml] +---- +spec: + mode: deployment + config: | + exporters: + jaeger: + endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 + ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" +---- + +.CA file configuration for OpenTelemetry version 0.41.1 + +[source,yaml] +---- +spec: + mode: deployment + config: | + exporters: + jaeger: + endpoint: jaeger-production-collector-headless.tracing-system.svc:14250 + tls: + ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt" +---- + +[id="otel-rn_2-1_bug-fixes"] +=== Bug fixes + +This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +//// +[id="otel-rn_2-1_known-issues"] +=== Known issues +None. +//// + +[id="otel-rn_2-0"] +== Release notes for {OTELName} 2.0 + +:FeatureName: The {OTELName} +include::snippets/technology-preview.adoc[leveloffset=+1] + +{OTELName} 2.0 is based on link:https://opentelemetry.io/[OpenTelemetry] 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. + +//// +[id="otel-rn_2-0_known-issues"] +=== Known issues +None. +//// + +include::modules/support.adoc[leveloffset=+1] + +include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/otel/otel_rn/snippets b/otel/otel_rn/snippets new file mode 120000 index 000000000000..5a3f5add140e --- /dev/null +++ b/otel/otel_rn/snippets @@ -0,0 +1 @@ +../../snippets/ \ No newline at end of file diff --git a/welcome/index.adoc b/welcome/index.adoc index 06faa1e142a7..5b1dfc2a6ebd 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -298,7 +298,8 @@ Use the Cluster Version Operator (CVO) to upgrade your {product-title} cluster. - **xref:../distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc[Red Hat OpenShift distributed tracing platform]**: Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use the distributed tracing platform for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications. -- **xref:../otel/otel-release-notes.adoc[Red Hat build of OpenTelemetry]**: Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open source backends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate. +// xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files +- **xref:../otel/otel-installing.adoc[Red Hat build of OpenTelemetry]**: Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open source backends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate. // CHECK IN CLOSER TO THE GA DATE BECAUSE FEATURE WORK IS NOT MERGED; ESTIMATED MERGE BY 19 FEB. ADD xref:../network_observability/metrics-alerts-dashboards.adoc#network-observability-viewing-dashboards_metrics-dashboards-alerts to [view dashbaords text. - **xref:../network_observability/network-observability-overview.adoc[Network Observability]**: Observe network traffic for {product-title} clusters by using eBPF technology to create and enrich network flows. You can view dashboards and xref:../network_observability/observing-network-traffic.adoc#network-observability-trafficflow_nw-observe-network-traffic[analyze network flow] information for further insight and troubleshooting.