Skip to content

Commit 7fa3a10

Browse files
authored
Merge pull request #73697 from max-cx/OBSDOCS-880
OBSDOCS-880: Fix style issues in DT/OTEL docs
2 parents 325ca95 + 629293d commit 7fa3a10

File tree

70 files changed

+186
-196
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+186
-196
lines changed

_topic_maps/_topic_map.yml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2665,24 +2665,24 @@ Topics:
26652665
- Name: Distributed tracing platform (Tempo)
26662666
Dir: distr_tracing_tempo
26672667
Topics:
2668-
- Name: Installation
2668+
- Name: Installing
26692669
File: distr-tracing-tempo-installing
2670-
- Name: Configuration
2670+
- Name: Configuring
26712671
File: distr-tracing-tempo-configuring
2672-
- Name: Updating
2672+
- Name: Upgrading
26732673
File: distr-tracing-tempo-updating
2674-
- Name: Removal
2674+
- Name: Removing
26752675
File: distr-tracing-tempo-removing
26762676
- Name: Distributed tracing platform (Jaeger)
26772677
Dir: distr_tracing_jaeger
26782678
Topics:
2679-
- Name: Installation
2679+
- Name: Installing
26802680
File: distr-tracing-jaeger-installing
2681-
- Name: Configuration
2681+
- Name: Configuring
26822682
File: distr-tracing-jaeger-configuring
2683-
- Name: Updating
2683+
- Name: Upgrading
26842684
File: distr-tracing-jaeger-updating
2685-
- Name: Removal
2685+
- Name: Removing
26862686
File: distr-tracing-jaeger-removing
26872687
- Name: Red Hat build of OpenTelemetry
26882688
Dir: otel
@@ -2695,11 +2695,11 @@ Topics:
26952695
File: otel-rn-3-1-1
26962696
- Name: Past releases
26972697
File: otel-rn-past-releases
2698-
- Name: Installation
2698+
- Name: Installing
26992699
File: otel-installing
2700-
- Name: Configuration of the OpenTelemetry Collector
2700+
- Name: Configuring the Collector
27012701
File: otel-configuration-of-otel-collector
2702-
- Name: Configuration of the instrumentation
2702+
- Name: Configuring the instrumentation
27032703
File: otel-configuration-of-instrumentation
27042704
- Name: Sending traces and metrics to the Collector
27052705
File: otel-sending-traces-and-metrics-to-otel-collector
@@ -2713,11 +2713,11 @@ Topics:
27132713
File: otel-config-multicluster
27142714
- Name: Troubleshooting
27152715
File: otel-troubleshooting
2716-
- Name: Migration
2716+
- Name: Migrating
27172717
File: otel-migrating
2718-
- Name: Updating
2718+
- Name: Upgrading
27192719
File: otel-updating
2720-
- Name: Removal
2720+
- Name: Removing
27212721
File: otel-removing
27222722
- Name: Network Observability
27232723
Dir: network_observability

modules/distr-tracing-accessing-jaeger-console.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
////
2-
Module included in the following assemblies:
3-
* distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4+
55
:_mod-docs-content-type: PROCEDURE
66
[id="distr-tracing-accessing-jaeger-console_{context}"]
77
= Accessing the Jaeger console

modules/distr-tracing-architecture.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
////
2-
This module included in the following assemblies:
3-
-service_mesh/v2x/ossm-architecture.adoc
4-
-dist_tracing_arch/distr-tracing-architecture.adoc
5-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * service_mesh/v2x/ossm-architecture.adoc
4+
// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
5+
66
:_mod-docs-content-type: CONCEPT
77
[id="distr-tracing-architecture_{context}"]
88
= {DTProductName} architecture

modules/distr-tracing-config-default.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
////
2-
This module included in the following assemblies:
3-
- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4+
55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-config-default_{context}"]
77
= Distributed tracing default configuration options

modules/distr-tracing-config-ingester.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
////
2-
This module included in the following assemblies:
3-
- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4+
55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-config-ingester_{context}"]
77
= Ingester configuration options

modules/distr-tracing-config-jaeger-collector.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
////
2-
This module included in the following assemblies:
3-
- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4+
55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-config-jaeger-collector_{context}"]
77
= Jaeger Collector configuration options

modules/distr-tracing-config-query.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
////
2-
This module included in the following assemblies:
3-
- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4+
55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-config-query_{context}"]
77
= Query configuration options

modules/distr-tracing-config-sampling.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
////
2-
This module included in the following assemblies:
3-
- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4+
55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-config-sampling_{context}"]
77
= Distributed tracing sampling configuration options

modules/distr-tracing-config-storage.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
////
2-
This module included in the following assemblies:
3-
- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4+
55
:_mod-docs-content-type: REFERENCE
66
[id="distr-tracing-config-storage_{context}"]
77
= Distributed tracing storage configuration options
@@ -65,11 +65,11 @@ Memory storage is only appropriate for development, testing, demonstrations, and
6565
[id="distributed-tracing-config-auto-provisioning-es_{context}"]
6666
== Auto-provisioning an Elasticsearch instance
6767
68-
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:
68+
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:
6969
7070
* `spec.storage:type` is set to `elasticsearch`
7171
* `spec.storage.elasticsearch.doNotProvision` set to `false`
72-
* `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.
72+
* `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}.
7373
7474
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`.
7575
@@ -80,10 +80,10 @@ When provisioning Elasticsearch, the {JaegerName} Operator sets the Elasticsearc
8080
8181
[NOTE]
8282
====
83-
If you already have installed Elasticsearch as part of OpenShift Logging, the {JaegerName} Operator can use the installed OpenShift Elasticsearch Operator to provision storage.
83+
If you already have installed Elasticsearch as part of OpenShift Logging, the {JaegerName} Operator can use the installed {es-op} to provision storage.
8484
====
8585
86-
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.
86+
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.
8787
8888
.Elasticsearch resource configuration parameters
8989
[options="header"]
@@ -155,7 +155,7 @@ Minimum deployment = 16Gi*
155155

156156
|elasticsearch:
157157
useCertManagement:
158-
|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.
158+
|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.
159159
|`true`/`false`
160160
|`true`
161161

@@ -209,13 +209,13 @@ spec:
209209
redundancyPolicy: ZeroRedundancy
210210
----
211211

212-
<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.
212+
<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.
213213

214214

215215
[id="distributed-tracing-config-external-es_{context}"]
216216
== Connecting to an existing Elasticsearch instance
217217

218-
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.
218+
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}.
219219

220220
When you deploy a Jaeger custom resource, the {JaegerName} Operator will not provision Elasticsearch if the following configurations are set:
221221

@@ -649,12 +649,12 @@ ifndef::openshift-rosa,openshift-dedicated[]
649649
[id="distr-tracing-manage-es-certificates_{context}"]
650650
= Managing certificates with Elasticsearch
651651

652-
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.
652+
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.
653653

654654
:FeatureName: Managing certificates with Elasticsearch
655655
include::snippets/technology-preview.adoc[leveloffset=+1]
656656

657-
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:
657+
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:
658658

659659
* `logging.openshift.io/elasticsearch-cert-management: "true"`
660660
* `logging.openshift.io/elasticsearch-cert.jaeger-<shared-es-node-name>: "user.jaeger"`
@@ -721,5 +721,5 @@ spec:
721721

722722
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.
723723

724-
The certificates are provisioned by the Red Hat Elasticsearch Operator and the {JaegerName} Operator injects the certificates.
724+
The certificates are provisioned by the {es-op} and the {JaegerName} Operator injects the certificates.
725725
endif::openshift-rosa,openshift-dedicated[]

modules/distr-tracing-deploy-default.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
////
2-
This module included in the following assemblies:
3-
- distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
4-
////
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
54

65
:_mod-docs-content-type: PROCEDURE
76
[id="distr-tracing-deploy-default_{context}"]

0 commit comments

Comments
 (0)