openshift · pavolloffay · Jun 7, 2023 · Jun 26, 2023 · Jun 26, 2023 · Jun 26, 2023
diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc
@@ -114,18 +114,19 @@ ifdef::openshift-origin[]
 :CNVSubscriptionSpecName: community-kubevirt-hyperconverged
 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
+: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

diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -3538,19 +3538,40 @@ Topics:
   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: Installing
+      File: distr-tracing-jaeger-installing
+    - Name: Configuring
+      File: distr-tracing-jaeger-configuring
+    - Name: Updating
+      File: distr-tracing-jaeger-updating
+    - Name: Removing
+      File: distr-tracing-jaeger-removing
+- Name: Distributed tracing platform (Tempo)
+  Dir: distr_tracing_tempo
+  Topics:
+    - Name: Installing
+      File: distr-tracing-tempo-installing
+    - Name: Configuring
+      File: distr-tracing-tempo-configuring
+    - Name: Updating
+      File: distr-tracing-tempo-updating
+    - Name: Removing
+      File: distr-tracing-tempo-removing
+- Name: Distributed tracing data collection (OpenTelemetry)
+  Dir: distr_tracing_otel
+  Topics:
+    - Name: Installing
+      File: distr-tracing-otel-installing
+    - Name: Configuring
+      File: distr-tracing-otel-configuring
+    - Name: Forwarding
+      File: distr-tracing-otel-forwarding
+    - Name: Migrating
+      File: distr-tracing-otel-migrating
+
 ---
 Name: Virtualization
 Dir: virt

diff --git a/distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc b/distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc
diff --git a/distr_tracing/distr_tracing_jaeger/_attributes b/distr_tracing/distr_tracing_jaeger/_attributes
@@ -0,0 +1 @@
+../../_attributes/
diff --git a/...stall/distr-tracing-deploying-jaeger.adoc → ...ger/distr-tracing-jaeger-configuring.adoc b/...stall/distr-tracing-deploying-jaeger.adoc → ...ger/distr-tracing-jaeger-configuring.adoc
@@ -1,8 +1,8 @@
 :_content-type: ASSEMBLY
-[id="distr-tracing-deploying"]
-= Configuring and deploying distributed tracing
+[id="distr-tracing-jaeger-configuring"]
+= Configuring and deploying distributed tracing platform Jaeger
 include::_attributes/common-attributes.adoc[]
-:context: deploying-distr-tracing-platform
+:context: distr-tracing-jaeger-configuring
 
 toc::[]
 
@@ -20,7 +20,6 @@ metadata:
 spec:
   strategy: production <1>
 ----
-
 <1> The {JaegerName} Operator currently supports the following deployment strategies:
 
 * *allInOne* (Default) - 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.
@@ -47,7 +46,6 @@ The streaming deployment strategy is currently unsupported on {ibmzProductName}.
 [NOTE]
 ====
 There are two ways to install and use {DTProductName}, as part of a service mesh or as a stand alone component. 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 completely control you should 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].
-
 ====
 
 include::modules/distr-tracing-deploy-default.adoc[leveloffset=+1]
@@ -74,8 +72,6 @@ include::modules/distr-tracing-config-default.adoc[leveloffset=+2]
 
 include::modules/distr-tracing-config-jaeger-collector.adoc[leveloffset=+2]
 
-//include::modules/distr-tracing-config-otel-collector.adoc[leveloffset=+2]
-
 include::modules/distr-tracing-config-sampling.adoc[leveloffset=+2]
 
 include::modules/distr-tracing-config-storage.adoc[leveloffset=+2]

diff --git a/...ing_install/distr-tracing-installing.adoc → ...eger/distr-tracing-jaeger-installing.adoc b/...ing_install/distr-tracing-installing.adoc → ...eger/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 distributed tracing platform Jaeger
 include::_attributes/common-attributes.adoc[]
-:context: install-distributed-tracing
+:context: dist-tracing-jaeger-installing
 
 toc::[]
 
@@ -34,10 +34,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}].
-////
diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc
@@ -0,0 +1,31 @@
+:_content-type: ASSEMBLY
+[id="dist-tracing-jaeger-removing"]
+= Removing distributed tracing platform Jaeger
+include::_attributes/common-attributes.adoc[]
+:context: dist-tracing-jaeger-removing
+
+toc::[]
+
+The steps for removing {DTProductName} from an {product-title} cluster are as follows:
+
+. Shut down any {DTProductName} pods.
+. Remove any {DTProductName} instances.
+. Remove the {JaegerName} Operator.
+. Remove the {OTELName} Operator.
+
+include::modules/distr-tracing-removing-instance.adoc[leveloffset=+1]
+
+include::modules/distr-tracing-removing-instance-cli.adoc[leveloffset=+1]
+
+
+== Removing the {DTProductName} Operators
+
+.Procedure
+
+. Follow the instructions for xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster].
+
+* Remove the {JaegerName} Operator.
+
+//* Remove the {OTELName} Operator.
+
+* After the {JaegerName} Operator has been removed, if appropriate, remove the OpenShift Elasticsearch Operator.
diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc b/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc
@@ -0,0 +1,24 @@
+:_content-type: ASSEMBLY
+[id="dist-tracing-jaeger-updating"]
+= Updating distributed tracing platform Jaeger
+include::_attributes/common-attributes.adoc[]
+:context: dist-tracing-jaeger-updating
+
+toc::[]
+
+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.
+For more information about how {product-title} handles upgrades, see the xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager] documentation.
+
+During an update, the {DTProductName} Operators upgrade the managed {DTShortName} instances to the version associated with the Operator. Whenever a new version of the {JaegerName} Operator is installed, all the {JaegerShortName} application instances managed by the Operator are upgraded to the Operator's version. For example, after upgrading the Operator from 1.10 installed to 1.11, the Operator scans for running {JaegerShortName} instances and upgrades them to 1.11 as well.
+
+For specific instructions on how to update the OpenShift Elasticsearch Operator, see xref:../../logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading_cluster-logging-upgrading[Updating OpenShift Logging].
+
+include::modules/distr-tracing-change-operator-20.adoc[leveloffset=+1]
+
+[IMPORTANT]
+====
+If you have not already updated your OpenShift Elasticsearch Operator as described in xref:../../logging/cluster-logging-upgrading.adoc[Updating OpenShift Logging] complete that update before updating your {JaegerName} Operator.
+====
+
+For instructions on how to update the Operator channel, see xref:../../operators/admin/olm-upgrading-operators.adoc[Updating installed Operators].
diff --git a/distr_tracing/distr_tracing_jaeger/images b/distr_tracing/distr_tracing_jaeger/images
@@ -0,0 +1 @@
+../images/
diff --git a/distr_tracing/distr_tracing_jaeger/modules b/distr_tracing/distr_tracing_jaeger/modules
@@ -0,0 +1 @@
+../modules/
diff --git a/distr_tracing/distr_tracing_jaeger/snippets b/distr_tracing/distr_tracing_jaeger/snippets
@@ -0,0 +1 @@
+../../snippets/
diff --git a/distr_tracing/distr_tracing_otel/_attributes b/distr_tracing/distr_tracing_otel/_attributes
@@ -0,0 +1 @@
+../../_attributes/
diff --git a/distr_tracing/distr_tracing_otel/distr-tracing-otel-configuring.adoc b/distr_tracing/distr_tracing_otel/distr-tracing-otel-configuring.adoc
@@ -0,0 +1,18 @@
+:_content-type: ASSEMBLY
+[id="distr-tracing-otel-configuring"]
+= Configuring and deploying distributed tracing data collection OpenTelemetry
+include::_attributes/common-attributes.adoc[]
+:context: distr-tracing-otel-configuring
+
+toc::[]
+
+The {OTELName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {OTELName} resources. You can either install the default configuration or modify the file to better suit your business requirements.
+
+include::modules/distr-tracing-config-otel-collector.adoc[leveloffset=+1]
+
+include::modules/distr-tracing-config-otel-send-metrics-monitoring-stack.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+[id="additional-resources_deploy-otel"]
+== Additional resources
+* xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc[Enabling monitoring for user-defined projects]
diff --git a/distr_tracing/distr_tracing_otel/distr-tracing-otel-forwarding.adoc b/distr_tracing/distr_tracing_otel/distr-tracing-otel-forwarding.adoc
@@ -0,0 +1,136 @@
+:_content-type: PROCEDURE
+[id="distr-tracing-otel-forwarding"]
+= Forwarding traces to TempoStack by using OpenTelemetry Collector
+include::_attributes/common-attributes.adoc[]
+:context: distr-tracing-otel-forwarding
+
+To configure log forwarding to the TempoStack, you deploy and configure an OpenTelemetry collector.
+
+.Prerequisites
+
+* Tempo Operator is installed.
+* TempoStack is deployed on the cluster.
+* Red Hat OpenShift distributed tracing data collection operator is installed.
+
+.Procedure
+
+For the following steps, we will deploy an OpenTelemetry collector using the recomended processors/receivers/explorters, this example will deploy the collector in deployment mode, for other modes see the OpenTelemetry collector documentation.
+
+. Create a service account for the OpenTelemetry collector, here is an example:
++
+----
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: otel-collector-deployment
+----
+
+. Create a cluster role, this cluster role will  be associated with the service account created in the first step:
++
+----
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: otel-collector
+rules:
+# Permissions for pods and namespaces resources are needed for the k8sattributesprocessor
+# Permissions for infrastructures and infrastructures/status are needed for resourcedetectionprocessor
+- apiGroups: ["", "config.openshift.io"]
+  resources: ["pods", "namespaces", "infrastructures", "infrastructures/status"]
+  verbs: ["get", "watch", "list"]
+----
+
+Some permissions are neccesary to make the `k8sattributesprocessor` and `resourcedetectionprocessor` works, and those are recomended.
+
+. Bind the cluster role to the service account:
++
+----
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: otel-collector
+subjects:
+- kind: ServiceAccount
+  name: otel-collector-deployment
+  namespace: otel-collector-example
+roleRef:
+  kind: ClusterRole
+  name: otel-collector
+  apiGroup: rbac.authorization.k8s.io
+----
+
+. Create the YAML file that will define the `OpenTelemetryCollector` custom resource (CR):
++
+----
+apiVersion: opentelemetry.io/v1alpha1
+kind: OpenTelemetryCollector
+metadata:
+  name: otel
+spec:
+  mode: deployment
+  serviceAccount: otel-collector-deployment
+  config: |
+    receivers:
+      jaeger:
+        protocols:
+          grpc:
+          thrift_binary:
+          thrift_compact:
+          thrift_http:
+      opencensus:
+      otlp:
+        protocols:
+          grpc:
+          http:
+      zipkin:
+    processors:
+      batch:
+      k8sattributes:
+      memory_limiter:
+        check_interval: 1s
+        limit_percentage: 50
+        spike_limit_percentage: 30
+      resourcedetection:
+        detectors: [openshift]
+    exporters:
+      otlp:
+        endpoint: "tempo-simplest-distributor:4317" # Endpoint for the tempo distributor.
+        tls:
+          insecure: true
+    service:
+      pipelines:
+        traces:
+          receivers: [jaeger, opencensus, otlp, zipkin]
+          processors: [memory_limiter, k8sattributes, resourcedetection, batch]
+          exporters: [otlp]
+----
+
+The collector is configured with a receiver for Jaeger traces, OpenCensus traces over the OpenCensus protocol, Zipkin traces over the Zipkin protocol and OTLP traces over the GRPC protocol. The collector exporter is configured to export OTLP, and is pointing to the tempo distributor endpoint, in this case "tempo-simplest-distributor:4317" which should be already created.
+
+You can find more examples of how to deploy OpenTelemetry with tempo in sidecar mode and multitenant here: https://github.com/os-observability/redhat-rhosdt-samples
+
+[TIP]
+====
+You can deploy the `tracegen` as a test:
+----
+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: tracegen
+spec:
+  template:
+    spec:
+      containers:
+        - name: tracegen
+          image: ghcr.io/open-telemetry/opentelemetry-collector-contrib/tracegen:latest
+          command:
+            - "./tracegen"
+          args:
+            - -otlp-endpoint=otel-collector:4317
+            - -otlp-insecure
+            - -duration=30s
+            - -workers=1
+      restartPolicy: Never
+  backoffLimit: 4
+----
+====