Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 73 additions & 75 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2393,6 +2393,79 @@ Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Observability overview
File: index
- Name: Distributed tracing
Dir: distr_tracing
Distros: openshift-enterprise
Topics:
- Name: Release notes
Dir: distr_tracing_rn
Topics:
- Name: Distributed tracing 3.1
File: distr-tracing-rn-3-1
- Name: Past releases
File: distr-tracing-rn-past-releases
- Name: Distributed tracing architecture
Dir: distr_tracing_arch
Topics:
- Name: Distributed tracing architecture
File: distr-tracing-architecture
- Name: Distributed tracing platform (Tempo)
Dir: distr_tracing_tempo
Topics:
- Name: Installation
File: distr-tracing-tempo-installing
- Name: Configuration
File: distr-tracing-tempo-configuring
- Name: Updating
File: distr-tracing-tempo-updating
- Name: Removal
File: distr-tracing-tempo-removing
- Name: Distributed tracing platform (Jaeger)
Dir: distr_tracing_jaeger
Topics:
- Name: Installation
File: distr-tracing-jaeger-installing
- Name: Configuration
File: distr-tracing-jaeger-configuring
- Name: Updating
File: distr-tracing-jaeger-updating
- Name: Removal
File: distr-tracing-jaeger-removing
- Name: Red Hat build of OpenTelemetry
Dir: otel
Distros: openshift-enterprise
Topics:
- Name: Release notes
Dir: otel_rn
Topics:
- Name: Red Hat build of OpenTelemetry 3.1
File: otel-rn-3.1
- Name: Past releases
File: otel-rn-past-releases
- Name: Installation
File: otel-installing
- Name: Configuration of the OpenTelemetry Collector
File: otel-configuration-of-otel-collector
- Name: Configuration of the instrumentation
File: otel-configuration-of-instrumentation
- Name: Sending traces and metrics to the Collector
File: otel-sending-traces-and-metrics-to-otel-collector
- Name: Sending metrics to the monitoring stack
File: otel-config-send-metrics-monitoring-stack
- Name: Forwarding traces to a TempoStack
File: otel-forwarding
- Name: Configuring the Collector metrics
File: otel-configuring-otelcol-metrics
- Name: Gathering the observability data from multiple clusters
File: otel-config-multicluster
- Name: Troubleshooting
File: otel-troubleshooting
- Name: Migration
File: otel-migrating
- Name: Updating
File: otel-updating
- Name: Removal
File: otel-removing
---
Name: Logging
Dir: logging
Expand Down Expand Up @@ -2550,81 +2623,6 @@ Topics:
- Name: Configuring the Cluster Observability Operator to monitor a service
File: configuring-the-cluster-observability-operator-to-monitor-a-service
---
Name: Distributed tracing
Dir: distr_tracing
Distros: openshift-enterprise
Topics:
- Name: Release notes
Dir: distr_tracing_rn
Topics:
- Name: Distributed tracing 3.1
File: distr-tracing-rn-3-1
- Name: Past releases
File: distr-tracing-rn-past-releases
- Name: Distributed tracing architecture
Dir: distr_tracing_arch
Topics:
- Name: Distributed tracing architecture
File: distr-tracing-architecture
- Name: Distributed tracing platform (Tempo)
Dir: distr_tracing_tempo
Topics:
- Name: Installation
File: distr-tracing-tempo-installing
- Name: Configuration
File: distr-tracing-tempo-configuring
- Name: Updating
File: distr-tracing-tempo-updating
- Name: Removal
File: distr-tracing-tempo-removing
- Name: Distributed tracing platform (Jaeger)
Dir: distr_tracing_jaeger
Topics:
- Name: Installation
File: distr-tracing-jaeger-installing
- Name: Configuration
File: distr-tracing-jaeger-configuring
- Name: Updating
File: distr-tracing-jaeger-updating
- Name: Removal
File: distr-tracing-jaeger-removing
---
Name: Red Hat build of OpenTelemetry
Dir: otel
Distros: openshift-enterprise
Topics:
- Name: Release notes
Dir: otel_rn
Topics:
- Name: Red Hat build of OpenTelemetry 3.1
File: otel-rn-3.1
- Name: Past releases
File: otel-rn-past-releases
- Name: Installation
File: otel-installing
- Name: Configuration of the OpenTelemetry Collector
File: otel-configuration-of-otel-collector
- Name: Configuration of the instrumentation
File: otel-configuration-of-instrumentation
- Name: Sending traces and metrics to the Collector
File: otel-sending-traces-and-metrics-to-otel-collector
- Name: Sending metrics to the monitoring stack
File: otel-config-send-metrics-monitoring-stack
- Name: Forwarding traces to a TempoStack
File: otel-forwarding
- Name: Configuring the Collector metrics
File: otel-configuring-otelcol-metrics
- Name: Gathering the observability data from multiple clusters
File: otel-config-multicluster
- Name: Troubleshooting
File: otel-troubleshooting
- Name: Migration
File: otel-migrating
- Name: Updating
File: otel-updating
- Name: Removal
File: otel-removing
---
Name: Network Observability
Dir: network_observability
Distros: openshift-enterprise,openshift-origin
Expand Down
5 changes: 0 additions & 5 deletions modules/distr-tracing-config-storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -229,11 +229,6 @@ The {JaegerName} Operator uses the Elasticsearch instance specified in `spec.sto

* You cannot share or reuse a {product-title} logging Elasticsearch instance with {JaegerShortName}. The Elasticsearch cluster is meant to be dedicated for a single {JaegerShortName} instance.

[NOTE]
====
Red Hat does not provide support for your external Elasticsearch instance. You can review the tested integrations matrix on the link:https://access.redhat.com/articles/5381021[Customer Portal].
====

The following configuration parameters are for an already existing Elasticsearch instance, also known as an _external_ Elasticsearch instance. In this case, you specify configuration options for Elasticsearch under `spec:storage:options:es` in your custom resource file.

.General ES configuration parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can enable metrics and alerts of TempoStack instances.

.Prerequisites

* Monitoring for user-defined projects is enabled in the cluster. See xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects].
* Monitoring for user-defined projects is enabled in the cluster.

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion modules/ossm-config-sampling.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The Envoy proxy sampling rate applies for applications that are available to a S

The Jaeger remote sampling rate applies to applications that are external to the Service Mesh, and do not use the Envoy proxy, such as a database. This sampling rate determines how much data the distributed tracing system collects and stores.
ifdef::openshift-enterprise[]
For more information, see xref:../../distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-config-sampling_deploying-distributed-tracing-platform[Distributed tracing configuration options].
For more information, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-config-sampling_deploying-distributed-tracing-platform[Distributed tracing configuration options].
endif::[]
====

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ include::modules/deprecated-feature.adoc[]

The {JaegerName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {JaegerShortName} resources. You can install the default configuration or modify the file.

If you have installed {DTShortName} as part of {SMProductName}, you can perform basic configuration as part of the xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[ServiceMeshControlPlane], but for complete control, you must configure a Jaeger CR and then xref:../../service_mesh/v2x/ossm-observability.adoc#ossm-config-external-jaeger_observability[reference your distributed tracing configuration file in the ServiceMeshControlPlane].
If you have installed {DTShortName} as part of {SMProductName}, you can perform basic configuration as part of the xref:../../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[ServiceMeshControlPlane], but for complete control, you must configure a Jaeger CR and then xref:../../../service_mesh/v2x/ossm-observability.adoc#ossm-config-external-jaeger_observability[reference your distributed tracing configuration file in the ServiceMeshControlPlane].

The {JaegerName} has predefined deployment strategies. You specify a deployment strategy in the custom resource file. When you create a {JaegerShortName} instance, the Operator uses this configuration file to create the objects necessary for the deployment.

Expand Down Expand Up @@ -69,7 +69,7 @@ include::modules/distr-tracing-accessing-jaeger-console.adoc[leveloffset=+2]
include::modules/distr-tracing-deployment-best-practices.adoc[leveloffset=+2]

ifdef::openshift-enterprise,openshift-dedicated[]
For information about configuring persistent storage, see xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the appropriate configuration topic for your chosen storage option.
For information about configuring persistent storage, see xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the appropriate configuration topic for your chosen storage option.
endif::[]

include::modules/distr-tracing-config-default.adoc[leveloffset=+2]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ include::modules/deprecated-feature.adoc[]

You can install {DTProductName} on {product-title} in either of two ways:

* You can install {DTProductName} as part of {SMProductName}. Distributed tracing is included by default in the Service Mesh installation. To install {DTProductName} as part of a service mesh, follow the xref:../../service_mesh/v2x/preparing-ossm-installation.adoc#preparing-ossm-installation[Red Hat Service Mesh Installation] instructions. You must install {DTProductName} in the same namespace as your service mesh, that is, the `ServiceMeshControlPlane` and the {DTProductName} resources must be in the same namespace.
* You can install {DTProductName} as part of {SMProductName}. Distributed tracing is included by default in the Service Mesh installation. To install {DTProductName} as part of a service mesh, follow the xref:../../../service_mesh/v2x/preparing-ossm-installation.adoc#preparing-ossm-installation[Red Hat Service Mesh Installation] instructions. You must install {DTProductName} in the same namespace as your service mesh, that is, the `ServiceMeshControlPlane` and the {DTProductName} resources must be in the same namespace.

* If you do not want to install a service mesh, you can use the {DTProductName} Operators to install {DTShortName} by itself. To install {DTProductName} without a service mesh, use the following instructions.

Expand All @@ -22,13 +22,13 @@ Before you can install {DTProductName}, review the installation activities, and

* Possess an active {product-title} subscription on your Red Hat account. If you do not have a subscription, contact your sales representative for more information.

* Review the xref:../../architecture/architecture-installation.adoc#installation-overview_architecture-installation[{product-title} {product-version} overview].
* Review the xref:../../../architecture/architecture-installation.adoc#installation-overview_architecture-installation[{product-title} {product-version} overview].
* Install {product-title} {product-version}.

** xref:../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Install {product-title} {product-version} on AWS]
** xref:../../installing/installing_aws/installing-aws-user-infra.adoc#installing-aws-user-infra[Install {product-title} {product-version} on user-provisioned AWS]
** xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install {product-title} {product-version} on bare metal]
** xref:../../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[Install {product-title} {product-version} on vSphere]
** xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Install {product-title} {product-version} on AWS]
** xref:../../../installing/installing_aws/installing-aws-user-infra.adoc#installing-aws-user-infra[Install {product-title} {product-version} on user-provisioned AWS]
** xref:../../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install {product-title} {product-version} on bare metal]
** xref:../../../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[Install {product-title} {product-version} on vSphere]
* Install the version of the `oc` CLI tool that matches your {product-title} version and add it to your path.

* An account with the `cluster-admin` role.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ include::modules/distr-tracing-removing-instance-cli.adoc[leveloffset=+1]

.Procedure

. 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.
. 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.
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ 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 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.
====

[role="_additional-resources"]
[id="additional-resources_dist-tracing-jaeger-updating"]
== Additional resources

* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources]
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators]
* xref:../../logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading_cluster-logging-upgrading[Updating OpenShift Logging]
* xref:../../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources]
* xref:../../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators]
* xref:../../../logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading_cluster-logging-upgrading[Updating OpenShift Logging]
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The {TempoOperator} uses a custom resource definition (CRD) file that defines th
== Customizing your deployment

ifdef::openshift-enterprise,openshift-dedicated[]
For information about configuring the back-end storage, see xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the appropriate configuration topic for your chosen storage option.
For information about configuring the back-end storage, see xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the appropriate configuration topic for your chosen storage option.
endif::[]

include::modules/distr-tracing-tempo-config-default.adoc[leveloffset=+2]
Expand All @@ -22,9 +22,9 @@ include::modules/distr-tracing-tempo-config-storage.adoc[leveloffset=+2]
include::modules/distr-tracing-tempo-config-query-frontend.adoc[leveloffset=+2]

[role="_additional-resources"]
[id="additional-resources_distr-tracing-tempo-configuring"]
[id="additional-resources_distr-tracing-tempo-configuring-query-frontend"]
==== Additional resources
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]
* xref:../../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]

include::modules/distr-tracing-tempo-config-spanmetrics.adoc[leveloffset=+2]

Expand All @@ -37,4 +37,9 @@ The {TempoOperator} supports monitoring and alerting of each TempoStack componen

include::modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc[leveloffset=+2]

[role="_additional-resources"]
[id="additional-resources_distr-tracing-tempo-configuring-tempostack-metrics-and-alerts"]
==== Additional resources
* xref:../../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]

include::modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc[leveloffset=+2]
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
:_mod-docs-content-type: ASSEMBLY
[id="dist-tracing-tempo-installing"]
= Installing the {TempoShortName}
include::_attributes/common-attributes.adoc[]
:context: dist-tracing-tempo-installing

toc::[]

Installing the {TempoShortName} involves the following steps:

. Setting up supported object storage.
. Installing the {TempoOperator}.
. Creating a secret for the object storage credentials.
. Creating a namespace for a TempoStack instance.
. Creating a `TempoStack` custom resource to deploy at least one TempoStack instance.

include::modules/distr-tracing-tempo-storage-ref.adoc[leveloffset=+1]

include::modules/distr-tracing-tempo-install-web-console.adoc[leveloffset=+1]

include::modules/distr-tracing-tempo-install-cli.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources_dist-tracing-tempo-installing"]
== Additional resources
* xref:../../../post_installation_configuration/preparing-for-users.adoc#creating-cluster-admin_post-install-preparing-for-users[Creating a cluster admin]
* link:https://operatorhub.io/[OperatorHub.io]
* xref:../../../web_console/web-console.adoc#web-console[Accessing the web console]
* xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]
* xref:../../../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[Creating applications from installed Operators]
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ include::modules/distr-tracing-tempo-remove-cli.adoc[leveloffset=+1]
[id="additional-resources_dist-tracing-tempo-removing"]
== Additional resources

* xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster]
* xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
* xref:../../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster]
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
Loading