openshift · skrthomas · Apr 17, 2024 · Mar 25, 2024
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -2664,24 +2664,24 @@ Topics:
   - Name: Distributed tracing platform (Tempo)
     Dir: distr_tracing_tempo
     Topics:
-    - Name: Installation
+    - Name: Installing
       File: distr-tracing-tempo-installing
-    - Name: Configuration
+    - Name: Configuring
       File: distr-tracing-tempo-configuring
-    - Name: Updating
+    - Name: Upgrading
       File: distr-tracing-tempo-updating
-    - Name: Removal
+    - Name: Removing
       File: distr-tracing-tempo-removing
   - Name: Distributed tracing platform (Jaeger)
     Dir: distr_tracing_jaeger
     Topics:
-    - Name: Installation
+    - Name: Installing
       File: distr-tracing-jaeger-installing
-    - Name: Configuration
+    - Name: Configuring
       File: distr-tracing-jaeger-configuring
-    - Name: Updating
+    - Name: Upgrading
       File: distr-tracing-jaeger-updating
-    - Name: Removal
+    - Name: Removing
       File: distr-tracing-jaeger-removing
 - Name: Red Hat build of OpenTelemetry
   Dir: otel
@@ -2694,11 +2694,11 @@ Topics:
       File: otel-rn-3-1-1
     - Name: Past releases
       File: otel-rn-past-releases
-  - Name: Installation
+  - Name: Installing
     File: otel-installing
-  - Name: Configuration of the OpenTelemetry Collector
+  - Name: Configuring the Collector
     File: otel-configuration-of-otel-collector
-  - Name: Configuration of the instrumentation
+  - Name: Configuring the instrumentation
     File: otel-configuration-of-instrumentation
   - Name: Sending traces and metrics to the Collector
     File: otel-sending-traces-and-metrics-to-otel-collector
@@ -2712,11 +2712,11 @@ Topics:
     File: otel-config-multicluster
   - Name: Troubleshooting
     File: otel-troubleshooting
-  - Name: Migration
+  - Name: Migrating
     File: otel-migrating
-  - Name: Updating
+  - Name: Upgrading
     File: otel-updating
-  - Name: Removal
+  - Name: Removing
     File: otel-removing
 - Name: Network Observability
   Dir: network_observability

diff --git a/modules/distr-tracing-accessing-jaeger-console.adoc b/modules/distr-tracing-accessing-jaeger-console.adoc
@@ -1,7 +1,7 @@
-////
-Module included in the following assemblies:
-* distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
+
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-accessing-jaeger-console_{context}"]
 = Accessing the Jaeger console

diff --git a/modules/distr-tracing-architecture.adoc b/modules/distr-tracing-architecture.adoc
@@ -1,8 +1,8 @@
-////
-This module included in the following assemblies:
--service_mesh/v2x/ossm-architecture.adoc
--dist_tracing_arch/distr-tracing-architecture.adoc
-////
+// Module included in the following assemblies:
+//
+// * service_mesh/v2x/ossm-architecture.adoc
+// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
+
 :_mod-docs-content-type: CONCEPT
 [id="distr-tracing-architecture_{context}"]
 = {DTProductName} architecture

diff --git a/modules/distr-tracing-config-default.adoc b/modules/distr-tracing-config-default.adoc
@@ -1,7 +1,7 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
+
 :_mod-docs-content-type: REFERENCE
 [id="distr-tracing-config-default_{context}"]
 = Distributed tracing default configuration options

diff --git a/modules/distr-tracing-config-ingester.adoc b/modules/distr-tracing-config-ingester.adoc
@@ -1,7 +1,7 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
+
 :_mod-docs-content-type: REFERENCE
 [id="distr-tracing-config-ingester_{context}"]
 = Ingester configuration options

diff --git a/modules/distr-tracing-config-jaeger-collector.adoc b/modules/distr-tracing-config-jaeger-collector.adoc
@@ -1,7 +1,7 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
+
 :_mod-docs-content-type: REFERENCE
 [id="distr-tracing-config-jaeger-collector_{context}"]
 = Jaeger Collector configuration options

diff --git a/modules/distr-tracing-config-query.adoc b/modules/distr-tracing-config-query.adoc
@@ -1,7 +1,7 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
+
 :_mod-docs-content-type: REFERENCE
 [id="distr-tracing-config-query_{context}"]
 = Query configuration options

diff --git a/modules/distr-tracing-config-sampling.adoc b/modules/distr-tracing-config-sampling.adoc
@@ -1,7 +1,7 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
+
 :_mod-docs-content-type: REFERENCE
 [id="distr-tracing-config-sampling_{context}"]
 = Distributed tracing sampling configuration options

diff --git a/modules/distr-tracing-config-storage.adoc b/modules/distr-tracing-config-storage.adoc
@@ -1,7 +1,7 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
+
 :_mod-docs-content-type: REFERENCE
 [id="distr-tracing-config-storage_{context}"]
 = Distributed tracing storage configuration options
@@ -65,11 +65,11 @@ Memory storage is only appropriate for development, testing, demonstrations, and
 [id="distributed-tracing-config-auto-provisioning-es_{context}"]
 == Auto-provisioning an Elasticsearch instance
 
-When you deploy a Jaeger custom resource, the {JaegerName} Operator uses the OpenShift Elasticsearch Operator to create an Elasticsearch cluster based on the configuration provided in the `storage` section of the custom resource file. The {JaegerName} Operator will provision Elasticsearch if the following configurations are set:
+When you deploy a Jaeger custom resource, the {JaegerName} Operator uses the {es-op} to create an Elasticsearch cluster based on the configuration provided in the `storage` section of the custom resource file. The {JaegerName} Operator will provision Elasticsearch if the following configurations are set:
 
 * `spec.storage:type` is set to `elasticsearch`
 * `spec.storage.elasticsearch.doNotProvision` set to `false`
-* `spec.storage.options.es.server-urls` is not defined, that is, there is no connection to an Elasticsearch instance that was not provisioned by the Red Hat Elasticsearch Operator.
+* `spec.storage.options.es.server-urls` is not defined, that is, there is no connection to an Elasticsearch instance that was not provisioned by the {es-op}.
 
 When provisioning Elasticsearch, the {JaegerName} Operator sets the Elasticsearch custom resource `name` to the value of `spec.storage.elasticsearch.name` from the Jaeger custom resource.  If you do not specify a value for `spec.storage.elasticsearch.name`, the Operator uses `elasticsearch`.
 
@@ -80,10 +80,10 @@ When provisioning Elasticsearch, the {JaegerName} Operator sets the Elasticsearc
 
 [NOTE]
 ====
-If you already have installed Elasticsearch as part of OpenShift Logging, the {JaegerName} Operator can use the installed OpenShift Elasticsearch Operator to provision storage.
+If you already have installed Elasticsearch as part of OpenShift Logging, the {JaegerName} Operator can use the installed {es-op} to provision storage.
 ====
 
-The following configuration parameters are for a _self-provisioned_ Elasticsearch instance, that is an instance created by the {JaegerName} Operator using the OpenShift Elasticsearch Operator. You specify configuration options for self-provisioned Elasticsearch under `spec:storage:elasticsearch` in your configuration file.
+The following configuration parameters are for a _self-provisioned_ Elasticsearch instance, that is an instance created by the {JaegerName} Operator using the {es-op}. You specify configuration options for self-provisioned Elasticsearch under `spec:storage:elasticsearch` in your configuration file.
 
 .Elasticsearch resource configuration parameters
 [options="header"]
@@ -155,7 +155,7 @@ Minimum deployment = 16Gi*
 
 |elasticsearch:
   useCertManagement:
-|Use to specify whether or not {JaegerShortName} should use the certificate management feature of the Red Hat Elasticsearch Operator.  This feature was added to {logging-title} 5.2 in {product-title} 4.7 and is the preferred setting for new Jaeger deployments.
+|Use to specify whether or not {JaegerShortName} should use the certificate management feature of the {es-op}. This feature was added to {logging-title} 5.2 in {product-title} 4.7 and is the preferred setting for new Jaeger deployments.
 |`true`/`false`
 |`true`
 
@@ -209,13 +209,13 @@ spec:
       redundancyPolicy: ZeroRedundancy
 ----
 
-<1> Persistent storage configuration. In this case AWS `gp2` with `5Gi` size. When no value is specified, {JaegerShortName} uses `emptyDir`. The OpenShift Elasticsearch Operator provisions `PersistentVolumeClaim` and `PersistentVolume` which are not removed with {JaegerShortName} instance. You can mount the same volumes if you create a {JaegerShortName} instance with the same name and namespace.
+<1> Persistent storage configuration. In this case AWS `gp2` with `5Gi` size. When no value is specified, {JaegerShortName} uses `emptyDir`. The {es-op} provisions `PersistentVolumeClaim` and `PersistentVolume` which are not removed with {JaegerShortName} instance. You can mount the same volumes if you create a {JaegerShortName} instance with the same name and namespace.
 
 
 [id="distributed-tracing-config-external-es_{context}"]
 == Connecting to an existing Elasticsearch instance
 
-You can use an existing Elasticsearch cluster for storage with {DTShortName}. An existing Elasticsearch cluster, also known as an _external_ Elasticsearch instance, is an instance that was not installed by the {JaegerName} Operator or by the Red Hat Elasticsearch Operator.
+You can use an existing Elasticsearch cluster for storage with {DTShortName}. An existing Elasticsearch cluster, also known as an _external_ Elasticsearch instance, is an instance that was not installed by the {JaegerName} Operator or by the {es-op}.
 
 When you deploy a Jaeger custom resource, the {JaegerName} Operator will not provision Elasticsearch if the following configurations are set:
 
@@ -649,12 +649,12 @@ ifndef::openshift-rosa,openshift-dedicated[]
 [id="distr-tracing-manage-es-certificates_{context}"]
 = Managing certificates with Elasticsearch
 
-You can create and manage certificates using the Red Hat Elasticsearch Operator. Managing certificates using the Red Hat Elasticsearch Operator also lets you use a single Elasticsearch cluster with multiple Jaeger Collectors.
+You can create and manage certificates using the {es-op}. Managing certificates using the {es-op} also lets you use a single Elasticsearch cluster with multiple Jaeger Collectors.
 
 :FeatureName: Managing certificates with Elasticsearch
 include::snippets/technology-preview.adoc[leveloffset=+1]
 
-Starting with version 2.4, the {JaegerName} Operator delegates certificate creation to the Red Hat Elasticsearch Operator by using the following annotations in the Elasticsearch custom resource:
+Starting with version 2.4, the {JaegerName} Operator delegates certificate creation to the {es-op} by using the following annotations in the Elasticsearch custom resource:
 
 * `logging.openshift.io/elasticsearch-cert-management: "true"`
 * `logging.openshift.io/elasticsearch-cert.jaeger-<shared-es-node-name>: "user.jaeger"`
@@ -721,5 +721,5 @@ spec:
 
 The {JaegerName} Operator sets the Elasticsearch custom resource `name` to the value of `spec.storage.elasticsearch.name` from the Jaeger custom resource when provisioning Elasticsearch.
 
-The certificates are provisioned by the Red Hat Elasticsearch Operator and the {JaegerName} Operator injects the certificates.
+The certificates are provisioned by the {es-op} and the {JaegerName} Operator injects the certificates.
 endif::openshift-rosa,openshift-dedicated[]
diff --git a/modules/distr-tracing-deploy-default.adoc b/modules/distr-tracing-deploy-default.adoc
@@ -1,7 +1,6 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-deploy-default_{context}"]

diff --git a/modules/distr-tracing-deploy-production-es.adoc b/modules/distr-tracing-deploy-production-es.adoc
@@ -1,7 +1,6 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-deploy-production_{context}"]
@@ -11,7 +10,7 @@ The `production` deployment strategy is intended for production environments tha
 
 .Prerequisites
 
-* The OpenShift Elasticsearch Operator has been installed.
+* The {es-op} has been installed.
 * The {JaegerName} Operator has been installed.
 * You have reviewed the instructions for how to customize the deployment.
 * You have access to the cluster as a user with the `cluster-admin` role.
@@ -84,7 +83,7 @@ Follow this procedure to create an instance of {JaegerShortName} from the comman
 
 .Prerequisites
 
-* The OpenShift Elasticsearch Operator has been installed.
+* The {es-op} has been installed.
 * The {JaegerName} Operator has been installed.
 * You have reviewed the instructions for how to customize the deployment.
 * You have access to the {oc-first} that matches your {product-title} version.

diff --git a/modules/distr-tracing-deploy-streaming.adoc b/modules/distr-tracing-deploy-streaming.adoc
@@ -1,7 +1,6 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-deploy-streaming_{context}"]

diff --git a/modules/distr-tracing-deployment-best-practices.adoc b/modules/distr-tracing-deployment-best-practices.adoc
@@ -1,7 +1,7 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
+
 :_mod-docs-content-type: CONCEPT
 [id="distr-tracing-deployment-best-practices_{context}"]
 = Deployment best practices

diff --git a/modules/distr-tracing-features.adoc b/modules/distr-tracing-features.adoc
@@ -1,8 +1,7 @@
-////
-This module included in the following assemblies:
--service_mesh/v2x/ossm-architecture.adoc
--dist_tracing_arch/distr-tracing-architecture.adoc
-////
+// Module included in the following assemblies:
+//
+// * service_mesh/v2x/ossm-architecture.adoc
+// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
 
 [id="distr-tracing-features_{context}"]
 = {DTProductName} features

diff --git a/modules/distr-tracing-install-elasticsearch.adoc b/modules/distr-tracing-install-elasticsearch.adoc
@@ -1,11 +1,10 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-operator-install-elasticsearch_{context}"]
-= Installing the OpenShift Elasticsearch Operator
+= Installing the {es-op}
 
 The default {JaegerName} deployment uses in-memory storage because it is designed to be installed quickly for those evaluating {DTProductName}, giving demonstrations, or using {JaegerName} in a test environment. If you plan to use {JaegerName} in production, you must install and configure a persistent storage option, in this case, Elasticsearch.
 
@@ -20,7 +19,7 @@ Do not install Community versions of the Operators. Community Operators are not
 
 [NOTE]
 ====
-If you have already installed the OpenShift Elasticsearch Operator as part of OpenShift Logging, you do not need to install the OpenShift Elasticsearch Operator again. The {JaegerName} Operator creates the Elasticsearch instance using the installed OpenShift Elasticsearch Operator.
+If you have already installed the {es-op} as part of OpenShift Logging, you do not need to install the {es-op} again. The {JaegerName} Operator creates the Elasticsearch instance using the installed {es-op}.
 ====
 
 .Procedure
@@ -29,9 +28,9 @@ If you have already installed the OpenShift Elasticsearch Operator as part of Op
 
 . Navigate to *Operators* -> *OperatorHub*.
 
-. Type *Elasticsearch* into the filter box to locate the OpenShift Elasticsearch Operator.
+. Type *Elasticsearch* into the filter box to locate the {es-op}.
 
-. Click the *OpenShift Elasticsearch Operator* provided by Red Hat to display information about the Operator.
+. Click the *{es-op}* provided by Red Hat to display information about the Operator.
 
 . Click *Install*.
 
@@ -41,7 +40,7 @@ If you have already installed the OpenShift Elasticsearch Operator as part of Op
 +
 [NOTE]
 ====
-The Elasticsearch installation requires the *openshift-operators-redhat* namespace for the OpenShift Elasticsearch Operator. The other {DTProductName} Operators are installed in the `openshift-operators` namespace.
+The Elasticsearch installation requires the *openshift-operators-redhat* namespace for the {es-op}. The other {DTProductName} Operators are installed in the `openshift-operators` namespace.
 ====
 +
 
@@ -54,4 +53,4 @@ The *Manual* approval strategy requires a user with appropriate credentials to a
 
 . Click *Install*.
 
-. On the *Installed Operators* page, select the `openshift-operators-redhat` project. Wait until you see that the OpenShift Elasticsearch Operator shows a status of "InstallSucceeded" before continuing.
+. On the *Installed Operators* page, select the `openshift-operators-redhat` project. Wait for the *InstallSucceeded* status of the {es-op} before continuing.
diff --git a/modules/distr-tracing-install-jaeger-operator.adoc b/modules/distr-tracing-install-jaeger-operator.adoc
@@ -1,7 +1,6 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="distr-tracing-jaeger-operator-install_{context}"]

diff --git a/modules/distr-tracing-install-overview.adoc b/modules/distr-tracing-install-overview.adoc
@@ -1,7 +1,6 @@
-////
-This module included in the following assemblies:
-- distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
-////
+// Module included in the following assemblies:
+//
+// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="distr-tracing-install-overview_{context}"]
@@ -11,7 +10,7 @@ The steps for installing {DTProductName} are as follows:
 
 * Review the documentation and determine your deployment strategy.
 
-* If your deployment strategy requires persistent storage, install the OpenShift Elasticsearch Operator via the OperatorHub.
+* If your deployment strategy requires persistent storage, install the {es-op} via the OperatorHub.
 
 * Install the {JaegerName} Operator via the OperatorHub.