Distributed tracing 2.9 openshift#62410

Conflicts:
	distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc
	modules/distr-tracing-product-overview.adoc
	modules/distr-tracing-rn-known-issues.adoc
	modules/support.adoc
Committing a cherry-pick.

_attributes/common-attributes.adoc

@@ -116,18 +116,20 @@ ifdef::openshift-origin[]
 :VirtProductName: OKD Virtualization
 endif::[]
 //distributed tracing
-:DTProductName: Red Hat OpenShift distributed tracing
-:DTShortName: distributed tracing
-:DTProductVersion: 2.8
-:JaegerName: Red Hat OpenShift distributed tracing platform
-:JaegerShortName: distributed tracing platform
-:JaegerVersion: 1.42.0
+:DTProductName: Red Hat OpenShift distributed tracing platform
+:DTShortName: distributed tracing platform
+:DTProductVersion: 2.9
+:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger)
+:JaegerShortName: distributed tracing platform (Jaeger)
+:JaegerVersion: 1.47.0
 :OTELName: Red Hat OpenShift distributed tracing data collection
 :OTELShortName: distributed tracing data collection
-:OTELVersion: 0.74.0
-:TempoName: Tempo Operator
-:TempoShortName: Tempo
-:TempoVersion: 0.1.0
+:OTELOperator: Red Hat OpenShift distributed tracing data collection Operator
+:OTELVersion: 0.81.0
+:TempoName: Red Hat OpenShift distributed tracing platform (Tempo)
+:TempoShortName: distributed tracing platform (Tempo)
+:TempoOperator: Tempo Operator
+:TempoVersion: 2.1.1
 //logging
 :logging-title: logging subsystem for Red Hat OpenShift
 :logging-title-uc: Logging subsystem for Red Hat OpenShift

_topic_maps/_topic_map.yml

@@ -3283,25 +3283,68 @@ Dir: distr_tracing
 Distros: openshift-enterprise
 Topics:
 - Name: Distributed tracing release notes
-  File: distributed-tracing-release-notes
+  Dir: distr_tracing_rn
+  Topics:
+  - Name: "2.9"
+    File: distr-tracing-rn-2-9
+  - Name: "2.8"
+    File: distr-tracing-rn-2-8
+  - Name: "2.7"
+    File: distr-tracing-rn-2-7
+  - Name: "2.6"
+    File: distr-tracing-rn-2-6
+  - Name: "2.5"
+    File: distr-tracing-rn-2-5
+  - Name: "2.4"
+    File: distr-tracing-rn-2-4
+  - Name: "2.3"
+    File: distr-tracing-rn-2-3
+  - Name: "2.2"
+    File: distr-tracing-rn-2-2
+  - Name: "2.1"
+    File: distr-tracing-rn-2-1
+  - Name: "2.0"
+    File: distr-tracing-rn-2-0
 - Name: Distributed tracing architecture
   Dir: distr_tracing_arch
   Topics:
   - Name: Distributed tracing architecture
     File: distr-tracing-architecture
-- Name: Distributed tracing installation
-  Dir: distr_tracing_install
-  Topics:
-  - Name: Installing distributed tracing
-    File: distr-tracing-installing
-  - Name: Configuring the distributed tracing platform
-    File: distr-tracing-deploying-jaeger
-  - Name: Configuring distributed tracing data collection
-    File: distr-tracing-deploying-otel
-  - Name: Upgrading distributed tracing
-    File: distr-tracing-updating
-  - Name: Removing distributed tracing
-    File: distr-tracing-removing
+- Name: Distributed tracing platform (Jaeger)
+  Dir: distr_tracing_jaeger
+  Topics:
+    - Name: Installation
+      File: distr-tracing-jaeger-installing
+    - Name: Configuration
+      File: distr-tracing-jaeger-configuring
+    - Name: Updating
+      File: distr-tracing-jaeger-updating
+    - Name: Removal
+      File: distr-tracing-jaeger-removing
+- Name: Distributed tracing platform (Tempo)
+  Dir: distr_tracing_tempo
+  Topics:
+    - Name: Installation
+      File: distr-tracing-tempo-installing
+    - Name: Configuration
+      File: distr-tracing-tempo-configuring
+    - Name: Updating
+      File: distr-tracing-tempo-updating
+    - Name: Removal
+      File: distr-tracing-tempo-removing
+- Name: Distributed tracing data collection (OpenTelemetry)
+  Dir: distr_tracing_otel
+  Topics:
+    - Name: Installation
+      File: distr-tracing-otel-installing
+    - Name: Configuration
+      File: distr-tracing-otel-configuring
+    - Name: Use
+      File: distr-tracing-otel-using
+    - Name: Migration
+      File: distr-tracing-otel-migrating
+    - Name: Removal
+      File: distr-tracing-otel-removing
 ---
 Name: Virtualization
 Dir: virt

distr_tracing/distr_tracing_arch/images

@@ -1 +1 @@
-../images/
+../../images/

distr_tracing/distr_tracing_arch/modules

@@ -1 +1 @@
-../modules/
+../../modules/

distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc

@@ -0,0 +1,91 @@
+:_content-type: ASSEMBLY
+[id="distr-tracing-jaeger-configuring"]
+= Configuring and deploying the distributed tracing platform Jaeger
+include::_attributes/common-attributes.adoc[]
+:context: distr-tracing-jaeger-configuring
+
+toc::[]
+
+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].
+
+The {JaegerName} has predefined deployment strategies. You specify a deployment strategy in the custom resource file. When you create a {JaegerShortName} instance, the Operator uses this configuration file to create the objects necessary for the deployment.
+
+.Jaeger custom resource file showing deployment strategy
+[source,yaml]
+----
+apiVersion: jaegertracing.io/v1
+kind: Jaeger
+metadata:
+  name: MyConfigFile
+spec:
+  strategy: production <1>
+----
+<1> Deployment strategy.
+
+[id="supported-deployment-strategies"]
+== Supported deployment strategies
+
+The {JaegerName} Operator currently supports the following deployment strategies:
+
+`allInOne`:: - This strategy is intended for development, testing, and demo purposes; it is not intended for production use. The main backend components, Agent, Collector, and Query service, are all packaged into a single executable which is configured, by default. to use in-memory storage.
++
+[NOTE]
+====
+In-memory storage is not persistent, which means that if the {JaegerShortName} instance shuts down, restarts, or is replaced, that your trace data will be lost. And in-memory storage cannot be scaled, since each pod has its own memory. For persistent storage, you must use the `production` or `streaming` strategies, which use Elasticsearch as the default storage.
+====
+
+`production`:: The production strategy is intended for production environments, where long term storage of trace data is important, as well as a more scalable and highly available architecture is required. Each of the backend components is therefore deployed separately. The Agent can be injected as a sidecar on the instrumented application. The Query and Collector services are configured with a supported storage type - currently Elasticsearch. Multiple instances of each of these components can be provisioned as required for performance and resilience purposes.
+
+`streaming`:: The streaming strategy is designed to augment the production strategy by providing a streaming capability that effectively sits between the Collector and the Elasticsearch backend storage. This provides the benefit of reducing the pressure on the backend storage, under high load situations, and enables other trace post-processing capabilities to tap into the real time span data directly from the streaming platform (https://access.redhat.com/documentation/en-us/red_hat_amq/7.6/html/using_amq_streams_on_openshift/index[AMQ Streams]/ https://kafka.apache.org/documentation/[Kafka]).
++
+[NOTE]
+====
+
+* The streaming strategy requires an additional Red Hat subscription for AMQ Streams.
+
+* The streaming deployment strategy is currently unsupported on {ibmzProductName}.
+
+====
+
+include::modules/distr-tracing-deploy-default.adoc[leveloffset=+1]
+
+include::modules/distr-tracing-deploy-production-es.adoc[leveloffset=+1]
+
+include::modules/distr-tracing-deploy-streaming.adoc[leveloffset=+1]
+
+[id="validating-your-jaeger-deployment"]
+== Validating your deployment
+
+include::modules/distr-tracing-accessing-jaeger-console.adoc[leveloffset=+2]
+
+[id="customizing-your-deployment"]
+== Customizing your deployment
+
+include::modules/distr-tracing-deployment-best-practices.adoc[leveloffset=+2]
+
+ifdef::openshift-enterprise,openshift-dedicated[]
+For information about configuring persistent storage, see xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the appropriate configuration topic for your chosen storage option.
+endif::[]
+
+include::modules/distr-tracing-config-default.adoc[leveloffset=+2]
+
+include::modules/distr-tracing-config-jaeger-collector.adoc[leveloffset=+2]
+
+include::modules/distr-tracing-config-sampling.adoc[leveloffset=+2]
+
+include::modules/distr-tracing-config-storage.adoc[leveloffset=+2]
+
+include::modules/distr-tracing-config-query.adoc[leveloffset=+2]
+
+include::modules/distr-tracing-config-ingester.adoc[leveloffset=+2]
+
+[id="injecting-sidecars"]
+== Injecting sidecars
+
+The {JaegerName} relies on a proxy sidecar within the application's pod to provide the Agent. The {JaegerName} Operator can inject Agent sidecars into deployment workloads. You can enable automatic sidecar injection or manage it manually.
+
+include::modules/distr-tracing-sidecar-automatic.adoc[leveloffset=+2]
+
+include::modules/distr-tracing-sidecar-manual.adoc[leveloffset=+2]

distr_tracing/distr_tracing_install/distr-tracing-installing.adoc → distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc

@@ -1,8 +1,8 @@
 :_content-type: ASSEMBLY
-[id="installing-distributed-tracing"]
-= Installing distributed tracing
+[id="dist-tracing-jaeger-installing"]
+= Installing the distributed tracing platform Jaeger
 include::_attributes/common-attributes.adoc[]
-:context: install-distributed-tracing
+:context: dist-tracing-jaeger-installing
 
 toc::[]
 
@@ -12,6 +12,7 @@ You can install {DTProductName} on {product-title} in either of two ways:
 
 * If you do not want to install a service mesh, you can use the {DTProductName} Operators to install {DTShortName} by itself. To install {DTProductName} without a service mesh, use the following instructions.
 
+[id="prerequisites"]
 == Prerequisites
 
 Before you can install {DTProductName}, review the installation activities, and ensure that you meet the prerequisites:
@@ -25,7 +26,7 @@ Before you can install {DTProductName}, review the installation activities, and
 ** xref:../../installing/installing_aws/installing-aws-user-infra.adoc#installing-aws-user-infra[Install {product-title} {product-version} on user-provisioned AWS]
 ** xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install {product-title} {product-version} on bare metal]
 ** xref:../../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[Install {product-title} {product-version} on vSphere]
-* Install the version of the OpenShift CLI (`oc`) that matches your {product-title} version and add it to your path.
+* Install the version of the `oc` CLI tool that matches your {product-title} version and add it to your path.
 
 * An account with the `cluster-admin` role.
 
@@ -34,10 +35,3 @@ include::modules/distr-tracing-install-overview.adoc[leveloffset=+1]
 include::modules/distr-tracing-install-elasticsearch.adoc[leveloffset=+1]
 
 include::modules/distr-tracing-install-jaeger-operator.adoc[leveloffset=+1]
-
-include::modules/distr-tracing-install-otel-operator.adoc[leveloffset=+1]
-
-////
-== Next steps
-* xref:../../distr_tracing/distr_tracing_install/distr-tracing-deploying.adoc#deploying-distributed-tracing[Deploy {DTProductName}].
-////