From 1868a136417e651e441635d50cd54295e2baeaec Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Mon, 25 Mar 2024 17:42:43 +0100 Subject: [PATCH] OBSDOCS-880: Fix style issues in DT/OTEL docs --- _topic_maps/_topic_map.yml | 28 +++++++++---------- ...istr-tracing-accessing-jaeger-console.adoc | 8 +++--- modules/distr-tracing-architecture.adoc | 10 +++---- modules/distr-tracing-config-default.adoc | 8 +++--- modules/distr-tracing-config-ingester.adoc | 8 +++--- ...distr-tracing-config-jaeger-collector.adoc | 8 +++--- modules/distr-tracing-config-query.adoc | 8 +++--- modules/distr-tracing-config-sampling.adoc | 8 +++--- modules/distr-tracing-config-storage.adoc | 28 +++++++++---------- modules/distr-tracing-deploy-default.adoc | 7 ++--- .../distr-tracing-deploy-production-es.adoc | 11 ++++---- modules/distr-tracing-deploy-streaming.adoc | 7 ++--- ...str-tracing-deployment-best-practices.adoc | 8 +++--- modules/distr-tracing-features.adoc | 9 +++--- .../distr-tracing-install-elasticsearch.adoc | 19 ++++++------- ...distr-tracing-install-jaeger-operator.adoc | 7 ++--- modules/distr-tracing-install-overview.adoc | 9 +++--- .../distr-tracing-removing-instance-cli.adoc | 7 ++--- modules/distr-tracing-removing-instance.adoc | 7 ++--- modules/distr-tracing-sidecar-automatic.adoc | 8 +++--- modules/distr-tracing-sidecar-manual.adoc | 8 +++--- .../distr-tracing-tempo-config-default.adoc | 6 ++-- ...str-tracing-tempo-config-multitenancy.adoc | 2 +- ...r-tracing-tempo-config-query-frontend.adoc | 2 +- ...istr-tracing-tempo-config-spanmetrics.adoc | 2 +- .../distr-tracing-tempo-config-storage.adoc | 2 +- ...ring-tempooperator-metrics-and-alerts.adoc | 4 +-- ...iguring-tempostack-metrics-and-alerts.adoc | 4 +-- modules/distr-tracing-tempo-install-cli.adoc | 8 +++--- ...str-tracing-tempo-install-web-console.adoc | 6 ++-- modules/distr-tracing-tempo-remove-cli.adoc | 4 +-- ...istr-tracing-tempo-remove-web-console.adoc | 4 +-- modules/distr-tracing-tempo-storage-ref.adoc | 2 +- modules/distr-tracing-upgrading-es5-es6.adoc | 7 ++--- modules/otel-collector-components.adoc | 2 +- modules/otel-collector-config-options.adoc | 2 +- modules/otel-config-instrumentation.adoc | 2 +- modules/otel-config-target-allocator.adoc | 2 +- modules/otel-install-cli.adoc | 2 +- modules/otel-install-web-console.adoc | 2 +- ...l-migrating-from-jaeger-with-sidecars.adoc | 4 +-- ...igrating-from-jaeger-without-sidecars.adoc | 4 +-- modules/otel-product-overview.adoc | 4 +-- modules/otel-remove-cli.adoc | 2 +- modules/otel-remove-web-console.adoc | 2 +- ...etrics-to-otel-collector-with-sidecar.adoc | 2 +- ...ics-to-otel-collector-without-sidecar.adoc | 2 +- modules/otel-troubleshoot-collector-logs.adoc | 2 +- ...-troubleshoot-logging-exporter-stdout.adoc | 2 +- modules/otel-troubleshoot-metrics.adoc | 4 +-- .../distr-tracing-jaeger-configuring.adoc | 2 +- .../distr-tracing-jaeger-installing.adoc | 2 +- .../distr-tracing-jaeger-removing.adoc | 4 +-- .../distr-tracing-jaeger-updating.adoc | 4 +-- .../distr-tracing-rn-past-releases.adoc | 12 ++++---- .../distr-tracing-tempo-configuring.adoc | 6 ++-- .../distr-tracing-tempo-installing.adoc | 2 +- .../distr-tracing-tempo-removing.adoc | 2 +- .../distr-tracing-tempo-updating.adoc | 2 +- ...-config-send-metrics-monitoring-stack.adoc | 2 +- ...otel-configuration-of-instrumentation.adoc | 2 +- .../otel-configuration-of-otel-collector.adoc | 2 +- observability/otel/otel-forwarding.adoc | 6 ++-- observability/otel/otel-installing.adoc | 2 +- observability/otel/otel-migrating.adoc | 2 +- observability/otel/otel-removing.adoc | 2 +- ...-traces-and-metrics-to-otel-collector.adoc | 2 +- observability/otel/otel-troubleshooting.adoc | 2 +- observability/otel/otel-updating.adoc | 2 +- .../otel/otel_rn/otel-rn-past-releases.adoc | 8 +++--- 70 files changed, 186 insertions(+), 196 deletions(-) diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 4c4bd0d94729..53230f35ceff 100644 --- 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 index 5794717c27c8..773b44e37d52 100644 --- 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 index 6f9dcee607aa..cefe1d703843 100644 --- 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 index 36f14cb22c78..c6dc2e4f5483 100644 --- 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 index 533286b9f3db..25c791ea1c51 100644 --- 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 index 3c8cdef80b60..4fee53e3132a 100644 --- 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 index 0071d3b4742e..aeb563a71dbb 100644 --- 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 index f3aeeba8b74b..bfdf3b06dce0 100644 --- 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 index 3d893c0b43fa..36281c8f5718 100644 --- 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-: "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 index 90688dbc3c1f..ae5d4921ef60 100644 --- 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 index 4e04535f1a61..edceee6e8b9c 100644 --- 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 index 341f038b68f5..800c8b8a36d5 100644 --- 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 index 9d8a59b1036c..c27c3716c2e5 100644 --- 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 index 127c08d91319..c2f850dcb144 100644 --- 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 index e55afe299b70..9fcaa6afa68e 100644 --- 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 index e041bd01d9fc..869d51425f9d 100644 --- 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 index 7e0a7711daff..1143133f9c76 100644 --- 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. diff --git a/modules/distr-tracing-removing-instance-cli.adoc b/modules/distr-tracing-removing-instance-cli.adoc index 4140602816ef..0b0621e8f218 100644 --- a/modules/distr-tracing-removing-instance-cli.adoc +++ b/modules/distr-tracing-removing-instance-cli.adoc @@ -1,7 +1,6 @@ -//// -This module included in the following assemblies: -- distr_tracing_install/dist-tracing-removing.adoc -//// +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr_tracing_jaeger/dist-tracing-removing.adoc [id="distr-tracing-removing-instance-cli_{context}"] = Removing a {JaegerShortName} instance by using the CLI diff --git a/modules/distr-tracing-removing-instance.adoc b/modules/distr-tracing-removing-instance.adoc index 0a03a8bb83fd..488279b056ad 100644 --- a/modules/distr-tracing-removing-instance.adoc +++ b/modules/distr-tracing-removing-instance.adoc @@ -1,7 +1,6 @@ -//// -This module included in the following assemblies: -- distr_tracing_install/dist-tracing-removing.adoc -//// +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr_tracing_jaeger/dist-tracing-removing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-removing-instance_{context}"] diff --git a/modules/distr-tracing-sidecar-automatic.adoc b/modules/distr-tracing-sidecar-automatic.adoc index c71455add8fc..2a2d4ec782c7 100644 --- a/modules/distr-tracing-sidecar-automatic.adoc +++ b/modules/distr-tracing-sidecar-automatic.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="dist-tracing-sidecar-automatic_{context}"] = Automatically injecting sidecars diff --git a/modules/distr-tracing-sidecar-manual.adoc b/modules/distr-tracing-sidecar-manual.adoc index 132edd5cb939..ba16b52120a7 100644 --- a/modules/distr-tracing-sidecar-manual.adoc +++ b/modules/distr-tracing-sidecar-manual.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-sidecar-manual_{context}"] = Manually injecting sidecars diff --git a/modules/distr-tracing-tempo-config-default.adoc b/modules/distr-tracing-tempo-config-default.adoc index 573fe9815dd0..7717e6676bc1 100644 --- a/modules/distr-tracing-tempo-config-default.adoc +++ b/modules/distr-tracing-tempo-config-default.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-config-default_{context}"] -= Distributed tracing default configuration options += Default configuration options The Tempo custom resource (CR) defines the architecture and settings to be used when creating the {TempoShortName} resources. You can modify these parameters to customize your {TempoShortName} implementation to your business needs. @@ -62,7 +62,7 @@ spec: |N/A |resources: -|Resources assigned to the TempoStack. +|Resources assigned to the TempoStack instance. | | diff --git a/modules/distr-tracing-tempo-config-multitenancy.adoc b/modules/distr-tracing-tempo-config-multitenancy.adoc index 4310887e58ef..001211eb72b0 100644 --- a/modules/distr-tracing-tempo-config-multitenancy.adoc +++ b/modules/distr-tracing-tempo-config-multitenancy.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-config-multitenancy_{context}"] diff --git a/modules/distr-tracing-tempo-config-query-frontend.adoc b/modules/distr-tracing-tempo-config-query-frontend.adoc index 807255b377a8..0c35fff646ff 100644 --- a/modules/distr-tracing-tempo-config-query-frontend.adoc +++ b/modules/distr-tracing-tempo-config-query-frontend.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-config-query_{context}"] diff --git a/modules/distr-tracing-tempo-config-spanmetrics.adoc b/modules/distr-tracing-tempo-config-spanmetrics.adoc index 65645d773f14..710f6572b34d 100644 --- a/modules/distr-tracing-tempo-config-spanmetrics.adoc +++ b/modules/distr-tracing-tempo-config-spanmetrics.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-config-spanmetrics_{context}"] diff --git a/modules/distr-tracing-tempo-config-storage.adoc b/modules/distr-tracing-tempo-config-storage.adoc index b2c71d4b4dcb..986946c9f6af 100644 --- a/modules/distr-tracing-tempo-config-storage.adoc +++ b/modules/distr-tracing-tempo-config-storage.adoc @@ -5,7 +5,7 @@ :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-config-storage_{context}"] -= The {TempoShortName} storage configuration += Storage configuration You can configure object storage for the {TempoShortName} in the `TempoStack` custom resource under `spec.storage`. You can choose from among several storage providers that are supported. diff --git a/modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc b/modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc index 4f69fe640442..bcc4a8d2d427 100644 --- a/modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc +++ b/modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: PROCEDURE [id="configuring-tempooperator-metrics-and-alerts_{context}"] -= Configuring {TempoOperator} metrics and alerts += Configuring the {TempoOperator} metrics and alerts When installing the {TempoOperator} from the web console, you can select the *Enable Operator recommended cluster monitoring on this Namespace* checkbox, which enables creating metrics and alerts of the {TempoOperator}. diff --git a/modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc b/modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc index 9f5da550c25d..ef34241439e4 100644 --- a/modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc +++ b/modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: PROCEDURE [id="configuring-tempostack-metrics-and-alerts_{context}"] -= Configuring TempoStack metrics and alerts += Configuring the TempoStack metrics and alerts You can enable metrics and alerts of TempoStack instances. diff --git a/modules/distr-tracing-tempo-install-cli.adoc b/modules/distr-tracing-tempo-install-cli.adoc index 442a412e2f2a..082db5bb1f43 100644 --- a/modules/distr-tracing-tempo-install-cli.adoc +++ b/modules/distr-tracing-tempo-install-cli.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -//* distr_tracing_tempo/distr-tracing-tempo-installing.adoc +//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-cli_{context}"] -= Installing the {TempoShortName} by using the CLI += Installing by using the CLI You can install the {TempoShortName} from the command line. @@ -84,7 +84,7 @@ spec: EOF ---- -.. Check the operator status by running the following command: +.. Check the Operator status by running the following command: + [source,terminal] ---- @@ -153,7 +153,7 @@ spec: <2> The value of the `name` in the `metadata` of the secret. <3> The accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or Red Hat OpenShift Data Foundation. + -.Example of a TempoStack CR for AWS S3 and MinIO storage +.Example of a `TempoStack` CR for AWS S3 and MinIO storage [source,yaml] ---- apiVersion: tempo.grafana.com/v1alpha1 diff --git a/modules/distr-tracing-tempo-install-web-console.adoc b/modules/distr-tracing-tempo-install-web-console.adoc index 6e30a290c116..7f6591eb406f 100644 --- a/modules/distr-tracing-tempo-install-web-console.adoc +++ b/modules/distr-tracing-tempo-install-web-console.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -//* distr_tracing_tempo/distr-tracing-tempo-installing.adoc +//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-web-console_{context}"] -= Installing the {TempoShortName} from the web console += Installing by using the web console You can install the {TempoShortName} from the *Administrator* view of the web console. @@ -92,7 +92,7 @@ spec: <2> The value of the `name` in the `metadata` of the secret. <3> The accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or Red Hat OpenShift Data Foundation. + -.Example of a TempoStack CR for AWS S3 and MinIO storage +.Example of a `TempoStack` CR for AWS S3 and MinIO storage [source,yaml] ---- apiVersion: tempo.grafana.com/v1alpha1 diff --git a/modules/distr-tracing-tempo-remove-cli.adoc b/modules/distr-tracing-tempo-remove-cli.adoc index ec4024467557..76a366afa330 100644 --- a/modules/distr-tracing-tempo-remove-cli.adoc +++ b/modules/distr-tracing-tempo-remove-cli.adoc @@ -1,10 +1,10 @@ //Module included in the following assemblies: // -//* distr_tracing_install/dist-tracing-tempo-removing.adoc +//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-removing-tempo-instance-cli_{context}"] -= Removing a TempoStack instance by using the CLI += Removing by using the CLI You can remove a TempoStack instance on the command line. diff --git a/modules/distr-tracing-tempo-remove-web-console.adoc b/modules/distr-tracing-tempo-remove-web-console.adoc index be42f2a7c6e2..0922f64627ce 100644 --- a/modules/distr-tracing-tempo-remove-web-console.adoc +++ b/modules/distr-tracing-tempo-remove-web-console.adoc @@ -1,10 +1,10 @@ //Module included in the following assemblies: // -//* distr_tracing_install/dist-tracing-tempo-removing.adoc +//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-removing-tempo-instance_{context}"] -= Removing a TempoStack instance by using the web console += Removing by using the web console You can remove a TempoStack instance in the *Administrator* view of the web console. diff --git a/modules/distr-tracing-tempo-storage-ref.adoc b/modules/distr-tracing-tempo-storage-ref.adoc index 27289a6709f7..595c23232259 100644 --- a/modules/distr-tracing-tempo-storage-ref.adoc +++ b/modules/distr-tracing-tempo-storage-ref.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -//* distr_tracing_tempo/distr-tracing-tempo-installing.adoc +//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-object-storage-setup_{context}"] diff --git a/modules/distr-tracing-upgrading-es5-es6.adoc b/modules/distr-tracing-upgrading-es5-es6.adoc index 16f12e08c0c2..99de106ccdc1 100644 --- a/modules/distr-tracing-upgrading-es5-es6.adoc +++ b/modules/distr-tracing-upgrading-es5-es6.adoc @@ -1,7 +1,6 @@ -//// -This module included in the following assemblies: -- distr_tracing_install/distr-tracing-updating -//// +// Module included in the following assemblies: +// +// * observability/distr_tracing/distr_tracing_jaeger//distr-tracing-updating [id="distr-tracing-upgrading-es5-es6_{context}"] = Upgrading from Elasticsearch 5 to 6 diff --git a/modules/otel-collector-components.adoc b/modules/otel-collector-components.adoc index 3b34fde00c42..2b8452d259d2 100644 --- a/modules/otel-collector-components.adoc +++ b/modules/otel-collector-components.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-configuration-of-collector.adoc +// * observability/otel/otel-configuration-of-collector.adoc :_mod-docs-content-type: REFERENCE [id="otel-collector-components_{context}"] diff --git a/modules/otel-collector-config-options.adoc b/modules/otel-collector-config-options.adoc index 43793cf123d8..cef3f00c0708 100644 --- a/modules/otel-collector-config-options.adoc +++ b/modules/otel-collector-config-options.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-configuration-of-collector.adoc +// * observability/otel/otel-configuration-of-collector.adoc :_mod-docs-content-type: REFERENCE [id="otel-collector-config-options_{context}"] diff --git a/modules/otel-config-instrumentation.adoc b/modules/otel-config-instrumentation.adoc index 93e2e4e2d957..00b9758bcd78 100644 --- a/modules/otel-config-instrumentation.adoc +++ b/modules/otel-config-instrumentation.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-instrumentation.adoc +// * observability/otel/otel-instrumentation.adoc :_mod-docs-content-type: REFERENCE [id="otel-instrumentation-config_{context}"] diff --git a/modules/otel-config-target-allocator.adoc b/modules/otel-config-target-allocator.adoc index bda205341ae2..e891a4a737fc 100644 --- a/modules/otel-config-target-allocator.adoc +++ b/modules/otel-config-target-allocator.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-configuration-of-collector.adoc +// * observability/otel/otel-configuration-of-collector.adoc :_mod-docs-content-type: REFERENCE [id="otel-config-target-allocator_{context}"] diff --git a/modules/otel-install-cli.adoc b/modules/otel-install-cli.adoc index 53959c1fb965..b45bda5046b4 100644 --- a/modules/otel-install-cli.adoc +++ b/modules/otel-install-cli.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -//* otel/otel-installing.adoc +//* observability/otel/otel-installing.adoc :_mod-docs-content-type: PROCEDURE [id="installing-otel-by-using-the-cli_{context}"] diff --git a/modules/otel-install-web-console.adoc b/modules/otel-install-web-console.adoc index f6654ac6888a..584fdbdb8a82 100644 --- a/modules/otel-install-web-console.adoc +++ b/modules/otel-install-web-console.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-installing.adoc +// * observability/otel/otel-installing.adoc :_mod-docs-content-type: PROCEDURE [id="installing-otel-by-using-the-web-console_{context}"] diff --git a/modules/otel-migrating-from-jaeger-with-sidecars.adoc b/modules/otel-migrating-from-jaeger-with-sidecars.adoc index 8900fe7f354b..4910bba09661 100644 --- a/modules/otel-migrating-from-jaeger-with-sidecars.adoc +++ b/modules/otel-migrating-from-jaeger-with-sidecars.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * otel-migrating.adoc +// * observability/otel/otel-migrating.adoc :_mod-docs-content-type: PROCEDURE [id="migrating-to-otel-from-jaeger-with-sidecars_{context}"] -= Migrating from the {JaegerShortName} to the {OTELShortName} with sidecars += Migrating with sidecars The {OTELShortName} Operator supports sidecar injection into deployment workloads, so you can migrate from a {JaegerShortName} sidecar to a {OTELShortName} sidecar. diff --git a/modules/otel-migrating-from-jaeger-without-sidecars.adoc b/modules/otel-migrating-from-jaeger-without-sidecars.adoc index 7f74f3d02f35..5cc7841e20f2 100644 --- a/modules/otel-migrating-from-jaeger-without-sidecars.adoc +++ b/modules/otel-migrating-from-jaeger-without-sidecars.adoc @@ -1,10 +1,10 @@ // Module included in the following assemblies: // -// * otel/otel-migrating.adoc +// * observability/otel/otel-migrating.adoc :_mod-docs-content-type: PROCEDURE [id="migrating-to-otel-from-jaeger-without-sidecars_{context}"] -= Migrating from the {JaegerShortName} to the {OTELShortName} without sidecars += Migrating without sidecars You can migrate from the {JaegerShortName} to the {OTELShortName} without sidecar deployment. diff --git a/modules/otel-product-overview.adoc b/modules/otel-product-overview.adoc index 26a135e216c5..2cc205f961f5 100644 --- a/modules/otel-product-overview.adoc +++ b/modules/otel-product-overview.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * otel/otel_rn/otel-rn-3-1.adoc -// * otel/otel_tracing_rn/otel-rn-past-releases.adoc +// * observability/otel/otel_rn/otel-rn-3-1.adoc +// * observability/otel/otel_rn/otel-rn-past-releases.adoc :_mod-docs-content-type: CONCEPT [id="otel-product-overview_{context}"] diff --git a/modules/otel-remove-cli.adoc b/modules/otel-remove-cli.adoc index 0da6916b8a47..762060909e2e 100644 --- a/modules/otel-remove-cli.adoc +++ b/modules/otel-remove-cli.adoc @@ -1,6 +1,6 @@ //Module included in the following assemblies: // -// * otel/otel-removing.adoc +// * observability/otel/otel-removing.adoc :_mod-docs-content-type: PROCEDURE [id="removing-otel-instance-cli_{context}"] diff --git a/modules/otel-remove-web-console.adoc b/modules/otel-remove-web-console.adoc index a2c6c6aa2453..66f4774bbb50 100644 --- a/modules/otel-remove-web-console.adoc +++ b/modules/otel-remove-web-console.adoc @@ -1,6 +1,6 @@ //Module included in the following assemblies: // -// * otel/otel-removing.adoc +// * observability/otel/otel-removing.adoc :_mod-docs-content-type: PROCEDURE [id="removing-otel-instance_{context}"] diff --git a/modules/otel-send-traces-and-metrics-to-otel-collector-with-sidecar.adoc b/modules/otel-send-traces-and-metrics-to-otel-collector-with-sidecar.adoc index 471668061a99..8d54e7037c91 100644 --- a/modules/otel-send-traces-and-metrics-to-otel-collector-with-sidecar.adoc +++ b/modules/otel-send-traces-and-metrics-to-otel-collector-with-sidecar.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-sending-traces-and-metrics-to-otel-collector.adoc +// * observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc :_mod-docs-content-type: PROCEDURE [id="sending-traces-and-metrics-to-otel-collector-with-sidecar_{context}"] diff --git a/modules/otel-send-traces-and-metrics-to-otel-collector-without-sidecar.adoc b/modules/otel-send-traces-and-metrics-to-otel-collector-without-sidecar.adoc index a5588984b53d..8dd9cd25e0fc 100644 --- a/modules/otel-send-traces-and-metrics-to-otel-collector-without-sidecar.adoc +++ b/modules/otel-send-traces-and-metrics-to-otel-collector-without-sidecar.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-sending-traces-and-metrics-to-otel-collector.adoc +// * observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc :_mod-docs-content-type: PROCEDURE [id="sending-traces-and-metrics-to-otel-collector-without-sidecar_{context}"] diff --git a/modules/otel-troubleshoot-collector-logs.adoc b/modules/otel-troubleshoot-collector-logs.adoc index ff5a8741fac1..8452ff816d9a 100644 --- a/modules/otel-troubleshoot-collector-logs.adoc +++ b/modules/otel-troubleshoot-collector-logs.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-troubleshooting.adoc +// * observability/otel/otel-troubleshooting.adoc :_mod-docs-content-type: PROCEDURE [id="getting-otel-collector-logs_{context}"] diff --git a/modules/otel-troubleshoot-logging-exporter-stdout.adoc b/modules/otel-troubleshoot-logging-exporter-stdout.adoc index ca2b0046755b..f7d81994392f 100644 --- a/modules/otel-troubleshoot-logging-exporter-stdout.adoc +++ b/modules/otel-troubleshoot-logging-exporter-stdout.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-troubleshooting.adoc +// * observability/otel/otel-troubleshooting.adoc :_mod-docs-content-type: PROCEDURE [id="debug-exporter-to-stdout_{context}"] diff --git a/modules/otel-troubleshoot-metrics.adoc b/modules/otel-troubleshoot-metrics.adoc index 6001d0e8127b..c195dca1b26a 100644 --- a/modules/otel-troubleshoot-metrics.adoc +++ b/modules/otel-troubleshoot-metrics.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * otel/otel-troubleshooting.adoc +// * observability/otel/otel-troubleshooting.adoc :_mod-docs-content-type: PROCEDURE [id="exposing-metrics_{context}"] @@ -15,7 +15,7 @@ The OpenTelemetry Collector exposes the metrics about the data volumes it has pr `otelcol_exporter_enqueue_failed_spans`:: The number of spans failed to be added to the sending queue. -The operator creates a `-collector-monitoring` telemetry service that you can use to scrape the metrics endpoint. +The Operator creates a `-collector-monitoring` telemetry service that you can use to scrape the metrics endpoint. .Procedure diff --git a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc index 02966066a64e..bfc4d7ea7653 100644 --- a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="distr-tracing-jaeger-configuring"] -= Configuring and deploying the distributed tracing platform Jaeger += Configuring include::_attributes/common-attributes.adoc[] :context: distr-tracing-jaeger-configuring diff --git a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc index 531c32082609..439c80a0cfc1 100644 --- a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-jaeger-installing"] -= Installing the distributed tracing platform Jaeger += Installing include::_attributes/common-attributes.adoc[] :context: dist-tracing-jaeger-installing diff --git a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc index e42cf6dfda8d..4275ed6f7dae 100644 --- a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-jaeger-removing"] -= Removing the distributed tracing platform Jaeger += Removing include::_attributes/common-attributes.adoc[] :context: dist-tracing-jaeger-removing @@ -27,4 +27,4 @@ include::modules/distr-tracing-removing-instance-cli.adoc[leveloffset=+1] . Follow the instructions in xref:../../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster] to remove the {JaegerName} Operator. -. Optional: After the {JaegerName} Operator has been removed, remove the OpenShift Elasticsearch Operator. +. Optional: After the {JaegerName} Operator has been removed, remove the {es-op}. diff --git a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc index a35ded0877d5..48400f386789 100644 --- a/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-jaeger-updating"] -= Updating the distributed tracing platform Jaeger += Upgrading include::_attributes/common-attributes.adoc[] :context: dist-tracing-jaeger-updating @@ -16,7 +16,7 @@ During an update, the {DTProductName} Operators upgrade the managed {DTShortName [IMPORTANT] ==== -If you have not already updated your OpenShift Elasticsearch Operator as described in xref:../../../logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading_cluster-logging-upgrading[Updating OpenShift Logging], complete that update before updating your {JaegerName} Operator. +If you have not already updated your {es-op} as described in xref:../../../logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading_cluster-logging-upgrading[Updating OpenShift Logging], complete that update before updating your {JaegerName} Operator. ==== [role="_additional-resources"] diff --git a/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc b/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc index 8d45edb5a8b0..0d207abf4754 100644 --- a/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc +++ b/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc @@ -151,7 +151,7 @@ This update introduces the following enhancements for the {JaegerShortName}: 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]) +* 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 @@ -184,7 +184,7 @@ This update introduces the following enhancements for the {TempoShortName}: 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, 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"] @@ -265,7 +265,7 @@ $ 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: +. Disable the mTLS in the Operator configuration by updating the YAML file: + [source,yaml] ---- @@ -383,7 +383,7 @@ $ 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: +. Disable the mTLS in the Operator configuration by updating the YAML file: + [source,yaml] ---- @@ -551,7 +551,7 @@ $ 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: +. Disable the mTLS in the Operator configuration by updating the YAML file: + [source,yaml] ---- @@ -737,7 +737,7 @@ Self-provisioning by using the {JaegerName} Operator to call the {es-op} during + [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. +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"] diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc index c0ea2b831e69..d9515965a062 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="distr-tracing-tempo-configuring"] -= Configuring and deploying the {TempoShortName} += Configuring include::_attributes/common-attributes.adoc[] :context: distr-tracing-tempo-configuring @@ -31,9 +31,9 @@ include::modules/distr-tracing-tempo-config-spanmetrics.adoc[leveloffset=+2] include::modules/distr-tracing-tempo-config-multitenancy.adoc[leveloffset=+2] [id="setting-up-monitoring-for-tempo"] -== Setting up monitoring for the {TempoShortName} +== Configuring monitoring and alerts -The {TempoOperator} supports monitoring and alerting of each TempoStack component such as distributor, ingester, and so on, and exposes upgrade and operational metrics about the Operator itself. +The {TempoOperator} supports monitoring and alerts about each TempoStack component such as distributor, ingester, and so on, and exposes upgrade and operational metrics about the Operator itself. include::modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc[leveloffset=+2] diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc index 0eba043b15fd..ca3f3be753df 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-tempo-installing"] -= Installing the {TempoShortName} += Installing include::_attributes/common-attributes.adoc[] :context: dist-tracing-tempo-installing diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc index 4ea4a2c7feb9..26ea86d27263 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-tempo-removing"] -= Removing the {TempoName} += Removing include::_attributes/common-attributes.adoc[] :context: dist-tracing-tempo-removing diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc index e37dca6cb61b..9c0d2e6949be 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-tempo-updating"] -= Updating the {TempoShortName} += Upgrading include::_attributes/common-attributes.adoc[] :context: dist-tracing-tempo-updating diff --git a/observability/otel/otel-config-send-metrics-monitoring-stack.adoc b/observability/otel/otel-config-send-metrics-monitoring-stack.adoc index d06a82faf01a..34adbd5ed799 100644 --- a/observability/otel/otel-config-send-metrics-monitoring-stack.adoc +++ b/observability/otel/otel-config-send-metrics-monitoring-stack.adoc @@ -29,7 +29,7 @@ spec: receivers: [otlp] exporters: [prometheus] ---- -<1> Configures the operator to create the Prometheus `ServiceMonitor` CR to scrape the collector's internal metrics endpoint and Prometheus exporter metric endpoints. The metrics will be stored in the OpenShift monitoring stack. +<1> Configures the Operator to create the Prometheus `ServiceMonitor` CR to scrape the Collector's internal metrics endpoint and Prometheus exporter metric endpoints. The metrics will be stored in the OpenShift monitoring stack. Alternatively, a manually created Prometheus `PodMonitor` can provide fine control, for example removing duplicated labels added during Prometheus scraping. diff --git a/observability/otel/otel-configuration-of-instrumentation.adoc b/observability/otel/otel-configuration-of-instrumentation.adoc index 86ebd4ab3560..aa576a1a90e5 100644 --- a/observability/otel/otel-configuration-of-instrumentation.adoc +++ b/observability/otel/otel-configuration-of-instrumentation.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="otel-configuration-of-instrumentation"] -= Configuration of the instrumentation += Configuring the instrumentation include::_attributes/common-attributes.adoc[] :context: otel-configuration-of-instrumentation diff --git a/observability/otel/otel-configuration-of-otel-collector.adoc b/observability/otel/otel-configuration-of-otel-collector.adoc index 18cb4704872b..1b859d992407 100644 --- a/observability/otel/otel-configuration-of-otel-collector.adoc +++ b/observability/otel/otel-configuration-of-otel-collector.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="otel-configuration-of-otel-collector"] -= Configuration of the OpenTelemetry Collector += Configuring the Collector include::_attributes/common-attributes.adoc[] :context: otel-configuration-of-otel-collector diff --git a/observability/otel/otel-forwarding.adoc b/observability/otel/otel-forwarding.adoc index 8175bcd3d8e8..9f528f827e78 100644 --- a/observability/otel/otel-forwarding.adoc +++ b/observability/otel/otel-forwarding.adoc @@ -1,16 +1,16 @@ :_mod-docs-content-type: ASSEMBLY [id="otel-forwarding-traces"] -= Forwarding traces to a TempoStack += Forwarding traces to a TempoStack instance include::_attributes/common-attributes.adoc[] :context: otel-forwarding-traces -To configure forwarding traces to a TempoStack, you can deploy and configure the OpenTelemetry Collector. You can deploy the OpenTelemetry Collector in the deployment mode by using the specified processors, receivers, and exporters. For other modes, see the OpenTelemetry Collector documentation linked in _Additional resources_. +To configure forwarding traces to a TempoStack instance, you can deploy and configure the OpenTelemetry Collector. You can deploy the OpenTelemetry Collector in the deployment mode by using the specified processors, receivers, and exporters. For other modes, see the OpenTelemetry Collector documentation linked in _Additional resources_. .Prerequisites * The {OTELOperator} is installed. * The {TempoOperator} is installed. -* A TempoStack is deployed on the cluster. +* A TempoStack instance is deployed on the cluster. .Procedure diff --git a/observability/otel/otel-installing.adoc b/observability/otel/otel-installing.adoc index 20f47a56b2eb..851bcd16d01b 100644 --- a/observability/otel/otel-installing.adoc +++ b/observability/otel/otel-installing.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="install-otel"] -= Installing the {OTELShortName} += Installing include::_attributes/common-attributes.adoc[] :context: install-otel diff --git a/observability/otel/otel-migrating.adoc b/observability/otel/otel-migrating.adoc index 3718f17f1c50..3a87acc4a389 100644 --- a/observability/otel/otel-migrating.adoc +++ b/observability/otel/otel-migrating.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-otel-migrating"] -= Migrating from the {JaegerShortName} to the {OTELShortName} += Migrating include::_attributes/common-attributes.adoc[] :context: dist-tracing-otel-migrating diff --git a/observability/otel/otel-removing.adoc b/observability/otel/otel-removing.adoc index 4233e6256dd0..4e65d491363f 100644 --- a/observability/otel/otel-removing.adoc +++ b/observability/otel/otel-removing.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-otel-removing"] -= Removing the {OTELShortName} += Removing include::_attributes/common-attributes.adoc[] :context: dist-tracing-otel-removing diff --git a/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc b/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc index a850e6afaadb..58fc8cb9828b 100644 --- a/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc +++ b/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can set up and use the {OTELShortName} to send traces to the OpenTelemetry Collector or the TempoStack. +You can set up and use the {OTELShortName} to send traces to the OpenTelemetry Collector or the TempoStack instance. Sending traces and metrics to the OpenTelemetry Collector is possible with or without sidecar injection. diff --git a/observability/otel/otel-troubleshooting.adoc b/observability/otel/otel-troubleshooting.adoc index cbdb41fb14c1..080335c54704 100644 --- a/observability/otel/otel-troubleshooting.adoc +++ b/observability/otel/otel-troubleshooting.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="otel-troubleshoot"] -= Troubleshooting the {OTELShortName} += Troubleshooting include::_attributes/common-attributes.adoc[] :context: otel-troubleshoot diff --git a/observability/otel/otel-updating.adoc b/observability/otel/otel-updating.adoc index ec3c5cd31f75..d161b2ccec27 100644 --- a/observability/otel/otel-updating.adoc +++ b/observability/otel/otel-updating.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="dist-tracing-otel-updating"] -= Updating the {OTELShortName} += Upgrading include::_attributes/common-attributes.adoc[] :context: dist-tracing-otel-updating diff --git a/observability/otel/otel_rn/otel-rn-past-releases.adoc b/observability/otel/otel_rn/otel-rn-past-releases.adoc index 43a9418da00c..2e72413f4a2b 100644 --- a/observability/otel/otel_rn/otel-rn-past-releases.adoc +++ b/observability/otel/otel_rn/otel-rn-past-releases.adoc @@ -165,7 +165,7 @@ include::snippets/technology-preview.adoc[leveloffset=+1] 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]) +* 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 @@ -186,7 +186,7 @@ include::snippets/technology-preview.adoc[leveloffset=+1] 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]) +* 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 @@ -203,7 +203,7 @@ 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}. +* 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. @@ -229,7 +229,7 @@ None. 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]) +* 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