From f3efd2cba2018ed655eb689287c8c5c05c33e3be Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Fri, 2 May 2025 14:06:09 +0200 Subject: [PATCH] OBSDOCS-1629: Flatten the Distributed tracing docs structure --- _attributes/common-attributes.adoc | 16 +++--- _topic_maps/_topic_map.yml | 56 +++++++++---------- modules/distr-tracing-architecture.adoc | 4 +- modules/distr-tracing-features.adoc | 2 +- modules/distr-tracing-product-overview.adoc | 2 +- .../distr-tracing-tempo-config-default.adoc | 2 +- ...r-tracing-tempo-config-query-frontend.adoc | 2 +- ...nfig-receiver-tls-for-tempomonolithic.adoc | 2 +- ...po-config-receiver-tls-for-tempostack.adoc | 2 +- ...istr-tracing-tempo-config-spanmetrics.adoc | 2 +- ...ring-tempooperator-metrics-and-alerts.adoc | 2 +- ...iguring-tempostack-metrics-and-alerts.adoc | 2 +- modules/distr-tracing-tempo-install-cli.adoc | 2 +- ...empo-install-gateway-read-permissions.adoc | 2 +- ...mpo-install-gateway-write-permissions.adoc | 2 +- ...ing-tempo-install-tempomonolithic-cli.adoc | 2 +- ...o-install-tempomonolithic-web-console.adoc | 2 +- ...-tracing-tempo-install-tempostack-cli.adoc | 2 +- ...-tempo-install-tempostack-web-console.adoc | 2 +- ...str-tracing-tempo-install-web-console.adoc | 2 +- ...-object-storage-setup-aws-sts-install.adoc | 2 +- ...empo-object-storage-setup-ibm-storage.adoc | 2 +- modules/distr-tracing-tempo-remove-cli.adoc | 2 +- ...istr-tracing-tempo-remove-web-console.adoc | 2 +- modules/distr-tracing-tempo-storage-ref.adoc | 2 +- ...ing-diagnostic-data-from-command-line.adoc | 2 +- ...nfig-receive-metrics-monitoring-stack.adoc | 2 +- .../distr-tracing-architecture.adoc | 4 +- .../distr_tracing/distr-tracing-rn.adoc | 20 +++---- .../distr-tracing-tempo-configuring.adoc | 27 +++++---- .../distr-tracing-tempo-installing.adoc | 27 +++++---- .../distr-tracing-tempo-removing.adoc | 29 ++++++++++ .../distr-tracing-tempo-troubleshooting.adoc | 6 +- .../distr-tracing-tempo-updating.adoc | 13 +++-- .../distr_tracing_arch/_attributes | 1 - .../distr_tracing/distr_tracing_arch/images | 1 - .../distr_tracing/distr_tracing_arch/modules | 1 - .../distr_tracing/distr_tracing_arch/snippets | 1 - .../distr-tracing-jaeger-configuring.adoc | 2 +- .../distr-tracing-jaeger-installing.adoc | 2 +- .../distr-tracing-jaeger-removing.adoc | 2 +- .../distr-tracing-jaeger-updating.adoc | 2 +- .../distr_tracing_tempo/_attributes | 1 - .../distr-tracing-tempo-removing.adoc | 24 -------- .../distr_tracing/distr_tracing_tempo/images | 1 - .../distr_tracing/distr_tracing_tempo/modules | 1 - .../distr_tracing_tempo/snippets | 1 - observability/otel/otel-migrating.adoc | 4 +- observability/otel/otel-removing.adoc | 4 +- observability/otel/otel-updating.adoc | 4 +- observability/overview/index.adoc | 2 +- service_mesh/v2x/ossm-observability.adoc | 4 +- welcome/learn_more_about_openshift.adoc | 2 +- 53 files changed, 159 insertions(+), 151 deletions(-) rename observability/distr_tracing/{distr_tracing_arch => }/distr-tracing-architecture.adoc (95%) rename observability/distr_tracing/{distr_tracing_tempo => }/distr-tracing-tempo-configuring.adoc (54%) rename observability/distr_tracing/{distr_tracing_tempo => }/distr-tracing-tempo-installing.adoc (76%) create mode 100644 observability/distr_tracing/distr-tracing-tempo-removing.adoc rename observability/distr_tracing/{distr_tracing_tempo => }/distr-tracing-tempo-troubleshooting.adoc (72%) rename observability/distr_tracing/{distr_tracing_tempo => }/distr-tracing-tempo-updating.adoc (54%) delete mode 120000 observability/distr_tracing/distr_tracing_arch/_attributes delete mode 120000 observability/distr_tracing/distr_tracing_arch/images delete mode 120000 observability/distr_tracing/distr_tracing_arch/modules delete mode 120000 observability/distr_tracing/distr_tracing_arch/snippets delete mode 120000 observability/distr_tracing/distr_tracing_tempo/_attributes delete mode 100644 observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc delete mode 120000 observability/distr_tracing/distr_tracing_tempo/images delete mode 120000 observability/distr_tracing/distr_tracing_tempo/modules delete mode 120000 observability/distr_tracing/distr_tracing_tempo/snippets diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index a9f5c169b6ec..66e183444d95 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -126,20 +126,20 @@ endif::[] :ove-first: Red Hat OpenShift Virtualization Engine :ove: OpenShift Virtualization Engine //distributed tracing -:DTProductName: Red Hat OpenShift distributed tracing platform -:DTShortName: distributed tracing platform +:DTProductName: Red{nbsp}Hat OpenShift Distributed Tracing Platform +:DTShortName: Distributed Tracing Platform :DTProductVersion: 3.1 -:JaegerName: Red Hat OpenShift distributed tracing platform (Jaeger) -:JaegerOperator: Red Hat OpenShift distributed tracing platform -:JaegerShortName: distributed tracing platform (Jaeger) -:JaegerOperator: Red Hat OpenShift distributed tracing platform +:JaegerName: Red{nbsp}Hat OpenShift Distributed Tracing Platform (Jaeger) +:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform +:JaegerShortName: Distributed Tracing Platform (Jaeger) +:JaegerOperator: Red{nbsp}Hat OpenShift Distributed Tracing Platform :JaegerVersion: 1.53.0 :OTELName: Red Hat build of OpenTelemetry :OTELShortName: Red Hat build of OpenTelemetry :OTELOperator: Red Hat build of OpenTelemetry Operator :OTELVersion: 0.93.0 -:TempoName: Red Hat OpenShift distributed tracing platform (Tempo) -:TempoShortName: distributed tracing platform (Tempo) +:TempoName: Red{nbsp}Hat OpenShift Distributed Tracing Platform +:TempoShortName: Distributed Tracing Platform :TempoOperator: Tempo Operator :TempoVersion: 2.3.1 //telco diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index c84012ab1b3f..45e3edad9295 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -3167,48 +3167,42 @@ Topics: # File: logging-5-6-reference # - Name: Glossary # File: logging-common-terms -- Name: Distributed tracing +- Name: Distributed Tracing Dir: distr_tracing Distros: openshift-enterprise Topics: - - Name: Release notes + - Name: Release notes for the Distributed Tracing Platform File: distr-tracing-rn - - 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: Installing - File: distr-tracing-tempo-installing - - Name: Configuring - File: distr-tracing-tempo-configuring - - Name: Troubleshooting - File: distr-tracing-tempo-troubleshooting - - Name: Upgrading - File: distr-tracing-tempo-updating - - Name: Removing - File: distr-tracing-tempo-removing - - Name: Distributed tracing platform (Jaeger) + - Name: About the Distributed Tracing Platform + File: distr-tracing-architecture + - Name: Installing the Distributed Tracing Platform + File: distr-tracing-tempo-installing + - Name: Configuring the Distributed Tracing Platform + File: distr-tracing-tempo-configuring + - Name: Troubleshooting the Distributed Tracing Platform + File: distr-tracing-tempo-troubleshooting + - Name: Upgrading the Distributed Tracing Platform + File: distr-tracing-tempo-updating + - Name: Removing the Distributed Tracing Platform + File: distr-tracing-tempo-removing + - Name: Distributed Tracing Platform (Jaeger) Dir: distr_tracing_jaeger Topics: - - Name: Installing + - Name: Installing the Distributed Tracing Platform (Jaeger) File: distr-tracing-jaeger-installing - - Name: Configuring + - Name: Configuring the Distributed Tracing Platform (Jaeger) File: distr-tracing-jaeger-configuring - - Name: Upgrading + - Name: Upgrading the Distributed Tracing Platform (Jaeger) File: distr-tracing-jaeger-updating - - Name: Removing + - Name: Removing the Distributed Tracing Platform (Jaeger) File: distr-tracing-jaeger-removing - Name: Red Hat build of OpenTelemetry Dir: otel Distros: openshift-enterprise Topics: - - Name: Release notes + - Name: Release notes for the Red Hat build of OpenTelemetry File: otel-rn - - Name: Installing + - Name: Installing the Red Hat build of OpenTelemetry File: otel-installing - Name: Configuring the Collector Dir: otel-collector @@ -3239,13 +3233,13 @@ Topics: File: otel-configuring-otelcol-metrics - Name: Gathering the observability data from multiple clusters File: otel-config-multicluster - - Name: Troubleshooting + - Name: Troubleshooting the Red Hat build of OpenTelemetry File: otel-troubleshooting - - Name: Migrating + - Name: Migrating to the Red Hat build of OpenTelemetry File: otel-migrating - - Name: Upgrading + - Name: Upgrading the Red Hat build of OpenTelemetry File: otel-updating - - Name: Removing + - Name: Removing the Red Hat build of OpenTelemetry File: otel-removing - Name: Network Observability Dir: network_observability diff --git a/modules/distr-tracing-architecture.adoc b/modules/distr-tracing-architecture.adoc index 0eb88e1e0b85..6dce77467abc 100644 --- a/modules/distr-tracing-architecture.adoc +++ b/modules/distr-tracing-architecture.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * service_mesh/v2x/ossm-architecture.adoc -// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc +// * observability/distr_tracing/distr-tracing-architecture.adoc :_mod-docs-content-type: CONCEPT [id="distr-tracing-architecture_{context}"] @@ -27,6 +27,8 @@ ** *OpenTelemetry Collector* - The OpenTelemetry Collector is a vendor-agnostic way to receive, process, and export telemetry data. The OpenTelemetry Collector supports open-source observability data formats, for example, Jaeger and Prometheus, sending to one or more open-source or commercial back-ends. The Collector is the default location instrumentation libraries export their telemetry data. +// when removing the Jaeger docs, remove all the following lines to the end of the file + * *{JaegerName}* - This component is based on the open source link:https://www.jaegertracing.io/[Jaeger project]. + :FeatureName: The {JaegerName} diff --git a/modules/distr-tracing-features.adoc b/modules/distr-tracing-features.adoc index c2f850dcb144..7ff22dcff003 100644 --- a/modules/distr-tracing-features.adoc +++ b/modules/distr-tracing-features.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * service_mesh/v2x/ossm-architecture.adoc -// * observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc +// * observability/distr_tracing/distr-tracing-architecture.adoc [id="distr-tracing-features_{context}"] = {DTProductName} features diff --git a/modules/distr-tracing-product-overview.adoc b/modules/distr-tracing-product-overview.adoc index ca5201d9b5b9..23f23deccf46 100644 --- a/modules/distr-tracing-product-overview.adoc +++ b/modules/distr-tracing-product-overview.adoc @@ -2,7 +2,7 @@ // // * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1.adoc // * observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc -// * observability/distr_tracing_arch/distr-tracing-architecture.adoc +// * observability/distr-tracing-architecture.adoc // * service_mesh/v2x/ossm-architecture.adoc // * serverless/serverless-tracing.adoc diff --git a/modules/distr-tracing-tempo-config-default.adoc b/modules/distr-tracing-tempo-config-default.adoc index f501bb555547..b0059ac1b85c 100644 --- a/modules/distr-tracing-tempo-config-default.adoc +++ b/modules/distr-tracing-tempo-config-default.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-config-default_{context}"] diff --git a/modules/distr-tracing-tempo-config-query-frontend.adoc b/modules/distr-tracing-tempo-config-query-frontend.adoc index 06a346743d1a..1797678204dc 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: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/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-receiver-tls-for-tempomonolithic.adoc b/modules/distr-tracing-tempo-config-receiver-tls-for-tempomonolithic.adoc index fe29e1fb35a4..79d420afdd25 100644 --- a/modules/distr-tracing-tempo-config-receiver-tls-for-tempomonolithic.adoc +++ b/modules/distr-tracing-tempo-config-receiver-tls-for-tempomonolithic.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-config-receiver-tls-for-tempomonolithic_{context}"] diff --git a/modules/distr-tracing-tempo-config-receiver-tls-for-tempostack.adoc b/modules/distr-tracing-tempo-config-receiver-tls-for-tempostack.adoc index a3504e9591bf..14dbd5d6d41d 100644 --- a/modules/distr-tracing-tempo-config-receiver-tls-for-tempostack.adoc +++ b/modules/distr-tracing-tempo-config-receiver-tls-for-tempostack.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-config-receiver-tls-for-tempostack_{context}"] diff --git a/modules/distr-tracing-tempo-config-spanmetrics.adoc b/modules/distr-tracing-tempo-config-spanmetrics.adoc index dc9624cf03bd..93997f99ae74 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: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-config-spanmetrics_{context}"] 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 bcc4a8d2d427..8b0dcc407c37 100644 --- a/modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc +++ b/modules/distr-tracing-tempo-configuring-tempooperator-metrics-and-alerts.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: PROCEDURE [id="configuring-tempooperator-metrics-and-alerts_{context}"] 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 ef34241439e4..461eecd7f6fc 100644 --- a/modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc +++ b/modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +// * observability/distr_tracing/distr-tracing-tempo-configuring.adoc :_mod-docs-content-type: PROCEDURE [id="configuring-tempostack-metrics-and-alerts_{context}"] diff --git a/modules/distr-tracing-tempo-install-cli.adoc b/modules/distr-tracing-tempo-install-cli.adoc index e41645978088..aa664b787930 100644 --- a/modules/distr-tracing-tempo-install-cli.adoc +++ b/modules/distr-tracing-tempo-install-cli.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +// * observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-cli_{context}"] diff --git a/modules/distr-tracing-tempo-install-gateway-read-permissions.adoc b/modules/distr-tracing-tempo-install-gateway-read-permissions.adoc index cda3591332fe..34038deaba23 100644 --- a/modules/distr-tracing-tempo-install-gateway-read-permissions.adoc +++ b/modules/distr-tracing-tempo-install-gateway-read-permissions.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +// * observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-gateway-read-permissions_{context}"] diff --git a/modules/distr-tracing-tempo-install-gateway-write-permissions.adoc b/modules/distr-tracing-tempo-install-gateway-write-permissions.adoc index 33a26843b8fa..6a6af2cbc7ba 100644 --- a/modules/distr-tracing-tempo-install-gateway-write-permissions.adoc +++ b/modules/distr-tracing-tempo-install-gateway-write-permissions.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +// * observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-gateway-write-permissions_{context}"] diff --git a/modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc b/modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc index 306db2b658da..6252c0813236 100644 --- a/modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc +++ b/modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +// * observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-tempomonolithic-cli_{context}"] diff --git a/modules/distr-tracing-tempo-install-tempomonolithic-web-console.adoc b/modules/distr-tracing-tempo-install-tempomonolithic-web-console.adoc index 5055d47b94b2..e4a72e8860db 100644 --- a/modules/distr-tracing-tempo-install-tempomonolithic-web-console.adoc +++ b/modules/distr-tracing-tempo-install-tempomonolithic-web-console.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +// * observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-tempomonolithic-web-console_{context}"] diff --git a/modules/distr-tracing-tempo-install-tempostack-cli.adoc b/modules/distr-tracing-tempo-install-tempostack-cli.adoc index 0118b76c6c3a..0d648e22bdeb 100644 --- a/modules/distr-tracing-tempo-install-tempostack-cli.adoc +++ b/modules/distr-tracing-tempo-install-tempostack-cli.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +// * observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-tempostack-cli_{context}"] diff --git a/modules/distr-tracing-tempo-install-tempostack-web-console.adoc b/modules/distr-tracing-tempo-install-tempostack-web-console.adoc index 47a84836cf42..e075bcd6a494 100644 --- a/modules/distr-tracing-tempo-install-tempostack-web-console.adoc +++ b/modules/distr-tracing-tempo-install-tempostack-web-console.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +// * observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-tempostack-web-console_{context}"] diff --git a/modules/distr-tracing-tempo-install-web-console.adoc b/modules/distr-tracing-tempo-install-web-console.adoc index cd7b6ed8cb72..52180f570be3 100644 --- a/modules/distr-tracing-tempo-install-web-console.adoc +++ b/modules/distr-tracing-tempo-install-web-console.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +// * observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-install-web-console_{context}"] diff --git a/modules/distr-tracing-tempo-object-storage-setup-aws-sts-install.adoc b/modules/distr-tracing-tempo-object-storage-setup-aws-sts-install.adoc index 7b5022590eb3..21390a15c6ec 100644 --- a/modules/distr-tracing-tempo-object-storage-setup-aws-sts-install.adoc +++ b/modules/distr-tracing-tempo-object-storage-setup-aws-sts-install.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +//* observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-object-storage-setup-aws-sts-install_{context}"] diff --git a/modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc b/modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc index 1d6719f2852d..20ff34807793 100644 --- a/modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc +++ b/modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +//* observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-object-storage-setup-ibm-storage_{context}"] diff --git a/modules/distr-tracing-tempo-remove-cli.adoc b/modules/distr-tracing-tempo-remove-cli.adoc index 76a366afa330..09aee02a8946 100644 --- a/modules/distr-tracing-tempo-remove-cli.adoc +++ b/modules/distr-tracing-tempo-remove-cli.adoc @@ -1,6 +1,6 @@ //Module included in the following assemblies: // -//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc +//* observability/distr_tracing/dist-tracing-tempo-removing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-removing-tempo-instance-cli_{context}"] diff --git a/modules/distr-tracing-tempo-remove-web-console.adoc b/modules/distr-tracing-tempo-remove-web-console.adoc index 0922f64627ce..4dd7b972bd16 100644 --- a/modules/distr-tracing-tempo-remove-web-console.adoc +++ b/modules/distr-tracing-tempo-remove-web-console.adoc @@ -1,6 +1,6 @@ //Module included in the following assemblies: // -//* observability/distr_tracing/distr_tracing_tempo/dist-tracing-tempo-removing.adoc +//* observability/distr_tracing/dist-tracing-tempo-removing.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-removing-tempo-instance_{context}"] diff --git a/modules/distr-tracing-tempo-storage-ref.adoc b/modules/distr-tracing-tempo-storage-ref.adoc index a7f33bd726ad..bf28da291c70 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: // -//* observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +//* observability/distr_tracing/distr-tracing-tempo-installing.adoc :_mod-docs-content-type: REFERENCE [id="distr-tracing-tempo-object-storage-setup_{context}"] diff --git a/modules/distr-tracing-tempo-troubleshoot-collecting-diagnostic-data-from-command-line.adoc b/modules/distr-tracing-tempo-troubleshoot-collecting-diagnostic-data-from-command-line.adoc index 5358ea428211..1a7985d7de86 100644 --- a/modules/distr-tracing-tempo-troubleshoot-collecting-diagnostic-data-from-command-line.adoc +++ b/modules/distr-tracing-tempo-troubleshoot-collecting-diagnostic-data-from-command-line.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc +// * observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc :_mod-docs-content-type: PROCEDURE [id="distr-tracing-tempo-collecting-diagnostic-data-from-command-line_{context}"] diff --git a/modules/otel-config-receive-metrics-monitoring-stack.adoc b/modules/otel-config-receive-metrics-monitoring-stack.adoc index 90aa3a06215b..dc00e9c7d55f 100644 --- a/modules/otel-config-receive-metrics-monitoring-stack.adoc +++ b/modules/otel-config-receive-metrics-monitoring-stack.adoc @@ -28,7 +28,7 @@ kind: ConfigMap apiVersion: v1 metadata: name: cabundle - namespce: observability + namespace: observability annotations: service.beta.openshift.io/inject-cabundle: "true" # <2> --- diff --git a/observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc b/observability/distr_tracing/distr-tracing-architecture.adoc similarity index 95% rename from observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc rename to observability/distr_tracing/distr-tracing-architecture.adoc index debad7e41e15..64f731ebdfef 100644 --- a/observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc +++ b/observability/distr_tracing/distr-tracing-architecture.adoc @@ -1,6 +1,6 @@ :_mod-docs-content-type: ASSEMBLY [id="distr-tracing-architecture"] -= Distributed tracing architecture += About the {DTShortName} include::_attributes/common-attributes.adoc[] :context: distributed-tracing-architecture @@ -28,4 +28,4 @@ include::modules/distr-tracing-architecture.adoc[leveloffset=+1] == Additional resources // xreffing to the installation page until further notice because OTEL content is currently planned for internal restructuring across pages that is likely to result in renamed page files -* xref:../../otel/otel-installing.adoc#install-otel[{OTELName}] +* xref:../otel/otel-installing.adoc#install-otel[{OTELName}] diff --git a/observability/distr_tracing/distr-tracing-rn.adoc b/observability/distr_tracing/distr-tracing-rn.adoc index 322cb27c1fa1..cbac293cd1f0 100644 --- a/observability/distr_tracing/distr-tracing-rn.adoc +++ b/observability/distr_tracing/distr-tracing-rn.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="distr-tracing-rn"] -= Release notes for the {DTProductName} += Release notes for the {DTShortName} :context: distr-tracing-rn toc::[] @@ -117,11 +117,11 @@ The {JaegerOperator} Operator (Jaeger) will be removed from the `redhat-operator You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see the following resources: -* xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] ({OTELShortName} documentation) +* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] ({OTELShortName} documentation) * xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] ({OTELName} documentation) -* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] ({TempoShortName} documentation) +* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] ({TempoShortName} documentation) * link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift] (Red Hat Knowledgebase solution) @@ -146,9 +146,9 @@ The {JaegerName} 3.5 is supported for use with the {es-op} 5.6, 5.7, and 5.8. [role="_additional-resources"] .Additional resources * link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift] (Red Hat Knowledgebase) -* xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] ({OTELName} documentation) +* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] ({OTELName} documentation) * xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] ({OTELName} documentation) -* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] (Distributed tracing platform (Tempo) documentation) +* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] ({DTShortName} documentation) //// [id="distr-tracing_3-5_jaeger-release-notes_bug-fixes_{context}"] @@ -268,14 +268,14 @@ Red{nbsp}Hat will provide support for these components and fixes for CVEs and bu The {JaegerOperator} Operator (Jaeger) will be removed from the `redhat-operators` catalog in a future release. For more information, see the Red Hat Knowledgebase solution link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift]. -You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating] in the {OTELShortName} documentation, xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] in the {OTELName} documentation, and xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing] in the {TempoShortName} documentation. +You must migrate to the {OTELName} Operator and the {TempoOperator} for distributed tracing collection and storage. For more information, see xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating] in the {OTELShortName} documentation, xref:../../observability/otel/otel-installing.adoc#install-otel[Installing] in the {OTELName} documentation, and xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing] in the {TempoShortName} documentation. [role="_additional-resources"] .Additional resources * link:https://access.redhat.com/solutions/7083722[Jaeger Deprecation and Removal in OpenShift (Red Hat Knowledgebase)] -* xref:../../observability/otel/otel-migrating.adoc#dist-tracing-otel-migrating[Migrating ({OTELName} documentation)] +* xref:../../observability/otel/otel-migrating.adoc#distr-tracing-otel-migrating[Migrating ({OTELName} documentation)] * xref:../../observability/otel/otel-installing.adoc#install-otel[Installing ({OTELName} documentation)] -* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing (Distributed tracing platform (Tempo) documentation)] +* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing ({DTShortName} documentation)] [id="distr-tracing_3-4_jaeger-release-notes_bug-fixes_{context}"] ==== Bug fixes @@ -393,7 +393,7 @@ The {JaegerName} 3.3.1 is supported for use with the {es-op} 5.6, 5.7, and 5.8. In the {DTProductName} 3.3.1, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements. -The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../otel/otel-migrating.adoc#dist-tracing-otel-migrating[migrate] to the xref:distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[{TempoOperator}] and the xref:../otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage. +The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[{TempoOperator}] and the xref:../otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage. //// [id="distr-tracing_3-3-1_jaeger-release-notes_removal-notice_{context}"] @@ -522,7 +522,7 @@ The {JaegerName} 3.3 is supported for use with the {es-op} 5.6, 5.7, and 5.8. In the {DTProductName} 3.3, Jaeger and support for Elasticsearch remain deprecated, and both are planned to be removed in a future release. Red{nbsp}Hat will provide support for these components and fixes for CVEs and bugs with critical and higher severity during the current release lifecycle, but these components will no longer receive feature enhancements. -The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../otel/otel-migrating.adoc#dist-tracing-otel-migrating[migrate] to the xref:distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[{TempoOperator}] and the xref:../otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage. +The {JaegerOperator} Operator (Jaeger) link:https://access.redhat.com/solutions/7083722[will be removed] from the `redhat-operators` catalog in a future release. Users must xref:../otel/otel-migrating.adoc#distr-tracing-otel-migrating[migrate] to the xref:distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[{TempoOperator}] and the xref:../otel/otel-installing.adoc#install-otel[{OTELName}] for distributed tracing collection and storage. //// [id="distr-tracing_3-3_jaeger-release-notes_removal-notice_{context}"] diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc b/observability/distr_tracing/distr-tracing-tempo-configuring.adoc similarity index 54% rename from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc rename to observability/distr_tracing/distr-tracing-tempo-configuring.adoc index 9ee00f7655a1..6bdb1cff3a9d 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +++ b/observability/distr_tracing/distr-tracing-tempo-configuring.adoc @@ -1,38 +1,43 @@ :_mod-docs-content-type: ASSEMBLY [id="distr-tracing-tempo-configuring"] -= Configuring += Configuring the {DTShortName} include::_attributes/common-attributes.adoc[] :context: distr-tracing-tempo-configuring toc::[] +[TIP] +==== +For information about configuring the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-jaeger-configuring[Configuring] in the {JaegerShortName} documentation. +==== + The {TempoOperator} uses a custom resource definition (CRD) file that defines the architecture and configuration settings for creating and deploying the {TempoShortName} resources. You can install the default configuration or modify the file. ifdef::openshift-enterprise,openshift-dedicated[] [id="configuring-storages_{context}"] == Configuring back-end storage -For information about configuring the back-end storage, see xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage] and the relevant configuration section 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 relevant configuration section for your chosen storage option. endif::[] include::modules/distr-tracing-tempo-config-default.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing a TempoStack instance] -* xref:../../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Installing a TempoMonolithic instance] +* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing a TempoStack instance] +* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing a TempoMonolithic instance] include::modules/distr-tracing-tempo-config-query-frontend.adoc[leveloffset=+1] [role="_additional-resources"] .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=+1] [role="_additional-resources"] .Additional resources -* xref:../../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc#dist-tracing-tempo-installing[Configuring the permissions and tenants] +* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Configuring the permissions and tenants] [id="config-receiver-tls_{context}"] == Configuring the receiver TLS @@ -44,16 +49,16 @@ include::modules/distr-tracing-tempo-config-receiver-tls-for-tempostack.adoc[lev [role="_additional-resources"] .Additional resources -* xref:../../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates] -* xref:../../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates] +* xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates] +* xref:../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates] include::modules/distr-tracing-tempo-config-receiver-tls-for-tempomonolithic.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates] -* xref:../../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates] +* xref:../../security/certificates/service-serving-certificate.adoc#understanding-service-serving_service-serving-certificate[Understanding service serving certificates] +* xref:../../security/certificate_types_descriptions/service-ca-certificates.adoc#cert-types-service-ca-certificates[Service CA certificates] [id="taints-and-tolerations_{context}"] == Using taints and tolerations @@ -69,6 +74,6 @@ include::modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.a [role="_additional-resources"] .Additional resources -* xref:../../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects] +* xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects] include::modules/distr-tracing-tempo-configuring-tempooperator-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-installing.adoc similarity index 76% rename from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc rename to observability/distr_tracing/distr-tracing-tempo-installing.adoc index 80a9ea235878..9c387a08e01c 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +++ b/observability/distr_tracing/distr-tracing-tempo-installing.adoc @@ -1,11 +1,16 @@ :_mod-docs-content-type: ASSEMBLY -[id="dist-tracing-tempo-installing"] -= Installing +[id="distr-tracing-tempo-installing"] += Installing the {DTShortName} include::_attributes/common-attributes.adoc[] -:context: dist-tracing-tempo-installing +:context: distr-tracing-tempo-installing toc::[] +[TIP] +==== +For information about installing the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc#dist-tracing-jaeger-installing[Installing] in the {JaegerShortName} documentation. +==== + Installing the {TempoShortName} involves the following steps: . Installing the {TempoOperator}. @@ -38,7 +43,7 @@ include::modules/distr-tracing-tempo-object-storage-setup-aws-sts-install.adoc[l * link:https://docs.aws.amazon.com/iam/[AWS Identity and Access Management Documentation] (AWS documentation) * link:https://docs.aws.amazon.com/cli/[AWS Command Line Interface Documentation] (AWS documentation) -* xref:../../../authentication/identity_providers/configuring-oidc-identity-provider.adoc#configuring-oidc-identity-provider[Configuring an OpenID Connect identity provider] +* xref:../../authentication/identity_providers/configuring-oidc-identity-provider.adoc#configuring-oidc-identity-provider[Configuring an OpenID Connect identity provider] * link:https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html[Identify AWS resources with Amazon Resource Names (ARNs)] (AWS documentation) include::modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc[leveloffset=+2] @@ -46,7 +51,7 @@ include::modules/distr-tracing-tempo-object-storage-setup-ibm-storage.adoc[level [role="_additional-resources"] .Additional resources -* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[Getting started with the OpenShift CLI] +* xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[Getting started with the OpenShift CLI] * link:https://cloud.ibm.com/docs/cli?topic=cli-getting-started[Getting started with the {ibm-cloud-title} CLI] ({ibm-cloud-title} Docs) * link:https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-provision[Choosing a plan and creating an instance] ({ibm-cloud-title} Docs) * link:https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-getting-started-cloud-object-storage&q=credential&tags=cloud-object-storage&offset=10#getting-started[Getting started with {ibm-cloud-title} Object Storage: Before you begin] ({ibm-cloud-title} Docs) @@ -86,7 +91,7 @@ include::modules/distr-tracing-tempo-install-gateway-write-permissions.adoc[leve [role="_additional-resources"] .Additional resources -* xref:../../../observability/otel/otel-installing.adoc#install-otel[Creating the required RBAC resources automatically] +* xref:../../observability/otel/otel-installing.adoc#install-otel[Creating the required RBAC resources automatically] [id="installing-a-tempostack-instance_{context}"] == Installing a TempoStack instance @@ -125,9 +130,9 @@ include::modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc[leveloffse [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources -* xref:../../../post_installation_configuration/preparing-for-users.adoc#creating-cluster-admin_post-install-preparing-for-users[Creating a cluster admin] +* 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] +* 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] diff --git a/observability/distr_tracing/distr-tracing-tempo-removing.adoc b/observability/distr_tracing/distr-tracing-tempo-removing.adoc new file mode 100644 index 000000000000..92b082203833 --- /dev/null +++ b/observability/distr_tracing/distr-tracing-tempo-removing.adoc @@ -0,0 +1,29 @@ +:_mod-docs-content-type: ASSEMBLY +[id="distr-tracing-tempo-removing"] += Removing the {DTShortName} +include::_attributes/common-attributes.adoc[] +:context: distr-tracing-tempo-removing + +toc::[] + +[TIP] +==== +For information about removing the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc#dist-tracing-jaeger-removing[Removing] in the {JaegerShortName} documentation. +==== + +The steps for removing the {TempoName} from an {product-title} cluster are as follows: + +. Shut down all {TempoShortName} pods. +. Remove any TempoStack instances. +. Remove the {TempoOperator}. + +include::modules/distr-tracing-tempo-remove-web-console.adoc[leveloffset=+1] + +include::modules/distr-tracing-tempo-remove-cli.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_{context}"] +== 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] diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc b/observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc similarity index 72% rename from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc rename to observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc index d4fae1d9f37e..c39b327057a5 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc +++ b/observability/distr_tracing/distr-tracing-tempo-troubleshooting.adoc @@ -1,8 +1,8 @@ :_mod-docs-content-type: ASSEMBLY -[id="dist-tracing-tempo-troubleshooting"] -= Troubleshooting +[id="distr-tracing-tempo-troubleshooting"] += Troubleshooting the {DTShortName} include::_attributes/common-attributes.adoc[] -:context: dist-tracing-tempo-troubleshooting +:context: distr-tracing-tempo-troubleshooting toc::[] diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc b/observability/distr_tracing/distr-tracing-tempo-updating.adoc similarity index 54% rename from observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc rename to observability/distr_tracing/distr-tracing-tempo-updating.adoc index 3e29748ec757..bb5bb9433c61 100644 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc +++ b/observability/distr_tracing/distr-tracing-tempo-updating.adoc @@ -1,11 +1,16 @@ :_mod-docs-content-type: ASSEMBLY -[id="dist-tracing-tempo-updating"] +[id="distr-tracing-tempo-updating"] = Upgrading include::_attributes/common-attributes.adoc[] -:context: dist-tracing-tempo-updating +:context: distr-tracing-tempo-updating toc::[] +[TIP] +==== +For information about upgrading the deprecated {JaegerShortName}, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc#dist-tracing-jaeger-updating[Upgrading] in the {JaegerShortName} documentation. +==== + For version upgrades, the {TempoOperator} uses the Operator Lifecycle Manager (OLM), which controls installation, upgrade, and role-based access control (RBAC) of Operators in a cluster. The OLM runs in the {product-title} by default. The OLM queries for available Operators as well as upgrades for installed Operators. @@ -15,5 +20,5 @@ When the {TempoOperator} is upgraded to the new version, it scans for running Te [id="additional-resources_{context}"] == 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:../../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] diff --git a/observability/distr_tracing/distr_tracing_arch/_attributes b/observability/distr_tracing/distr_tracing_arch/_attributes deleted file mode 120000 index 20cc1dcb77bf..000000000000 --- a/observability/distr_tracing/distr_tracing_arch/_attributes +++ /dev/null @@ -1 +0,0 @@ -../../_attributes/ \ No newline at end of file diff --git a/observability/distr_tracing/distr_tracing_arch/images b/observability/distr_tracing/distr_tracing_arch/images deleted file mode 120000 index 847b03ed0541..000000000000 --- a/observability/distr_tracing/distr_tracing_arch/images +++ /dev/null @@ -1 +0,0 @@ -../../images/ \ No newline at end of file diff --git a/observability/distr_tracing/distr_tracing_arch/modules b/observability/distr_tracing/distr_tracing_arch/modules deleted file mode 120000 index 36719b9de743..000000000000 --- a/observability/distr_tracing/distr_tracing_arch/modules +++ /dev/null @@ -1 +0,0 @@ -../../modules/ \ No newline at end of file diff --git a/observability/distr_tracing/distr_tracing_arch/snippets b/observability/distr_tracing/distr_tracing_arch/snippets deleted file mode 120000 index 5a3f5add140e..000000000000 --- a/observability/distr_tracing/distr_tracing_arch/snippets +++ /dev/null @@ -1 +0,0 @@ -../../snippets/ \ No newline at end of file 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 8b69b3ac5347..fb8eb58ead40 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 += Configuring the {JaegerShortName} 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 3a99de54d519..b9ae937d3158 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 += Installing the {JaegerShortName} 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 7aa43e266347..8199cbf68037 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 += Removing the {JaegerShortName} include::_attributes/common-attributes.adoc[] :context: dist-tracing-jaeger-removing 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 93f33d668450..12d652d35562 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"] -= Upgrading += Upgrading the {JaegerShortName} include::_attributes/common-attributes.adoc[] :context: dist-tracing-jaeger-updating diff --git a/observability/distr_tracing/distr_tracing_tempo/_attributes b/observability/distr_tracing/distr_tracing_tempo/_attributes deleted file mode 120000 index 20cc1dcb77bf..000000000000 --- a/observability/distr_tracing/distr_tracing_tempo/_attributes +++ /dev/null @@ -1 +0,0 @@ -../../_attributes/ \ No newline at end of file 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 deleted file mode 100644 index e53d2afb90bf..000000000000 --- a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc +++ /dev/null @@ -1,24 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="dist-tracing-tempo-removing"] -= Removing -include::_attributes/common-attributes.adoc[] -:context: dist-tracing-tempo-removing - -toc::[] - -The steps for removing the {TempoName} from an {product-title} cluster are as follows: - -. Shut down all {TempoShortName} pods. -. Remove any TempoStack instances. -. Remove the {TempoOperator}. - -include::modules/distr-tracing-tempo-remove-web-console.adoc[leveloffset=+1] - -include::modules/distr-tracing-tempo-remove-cli.adoc[leveloffset=+1] - -[role="_additional-resources"] -[id="additional-resources_{context}"] -== 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] diff --git a/observability/distr_tracing/distr_tracing_tempo/images b/observability/distr_tracing/distr_tracing_tempo/images deleted file mode 120000 index 847b03ed0541..000000000000 --- a/observability/distr_tracing/distr_tracing_tempo/images +++ /dev/null @@ -1 +0,0 @@ -../../images/ \ No newline at end of file diff --git a/observability/distr_tracing/distr_tracing_tempo/modules b/observability/distr_tracing/distr_tracing_tempo/modules deleted file mode 120000 index 36719b9de743..000000000000 --- a/observability/distr_tracing/distr_tracing_tempo/modules +++ /dev/null @@ -1 +0,0 @@ -../../modules/ \ No newline at end of file diff --git a/observability/distr_tracing/distr_tracing_tempo/snippets b/observability/distr_tracing/distr_tracing_tempo/snippets deleted file mode 120000 index 5a3f5add140e..000000000000 --- a/observability/distr_tracing/distr_tracing_tempo/snippets +++ /dev/null @@ -1 +0,0 @@ -../../snippets/ \ No newline at end of file diff --git a/observability/otel/otel-migrating.adoc b/observability/otel/otel-migrating.adoc index 542b62e4a364..3b4f382db8dd 100644 --- a/observability/otel/otel-migrating.adoc +++ b/observability/otel/otel-migrating.adoc @@ -1,8 +1,8 @@ :_mod-docs-content-type: ASSEMBLY -[id="dist-tracing-otel-migrating"] +[id="otel-migrating"] = Migrating include::_attributes/common-attributes.adoc[] -:context: dist-tracing-otel-migrating +:context: otel-migrating toc::[] diff --git a/observability/otel/otel-removing.adoc b/observability/otel/otel-removing.adoc index bc775701bac9..a4ddefdffef2 100644 --- a/observability/otel/otel-removing.adoc +++ b/observability/otel/otel-removing.adoc @@ -1,8 +1,8 @@ :_mod-docs-content-type: ASSEMBLY -[id="dist-tracing-otel-removing"] +[id="otel-removing"] = Removing include::_attributes/common-attributes.adoc[] -:context: dist-tracing-otel-removing +:context: otel-removing toc::[] diff --git a/observability/otel/otel-updating.adoc b/observability/otel/otel-updating.adoc index 7e884fc13d71..3ba2b0a94962 100644 --- a/observability/otel/otel-updating.adoc +++ b/observability/otel/otel-updating.adoc @@ -1,8 +1,8 @@ :_mod-docs-content-type: ASSEMBLY -[id="dist-tracing-otel-updating"] +[id="otel-updating"] = Upgrading include::_attributes/common-attributes.adoc[] -:context: dist-tracing-otel-updating +:context: otel-updating toc::[] diff --git a/observability/overview/index.adoc b/observability/overview/index.adoc index 8ccc9d605128..49174b5047ab 100644 --- a/observability/overview/index.adoc +++ b/observability/overview/index.adoc @@ -53,7 +53,7 @@ ifdef::openshift-enterprise,openshift-origin[] == Distributed tracing Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use it for monitoring distributed transactions, gathering insights into your instrumented services, network profiling, performance and latency optimization, root cause analysis, and troubleshooting the interaction between components in modern cloud-native microservices-based applications. -For more information, see xref:../../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture]. +For more information, see xref:../../observability/distr_tracing/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture]. [id="otel-release-notes-index_{context}"] == {OTELName} diff --git a/service_mesh/v2x/ossm-observability.adoc b/service_mesh/v2x/ossm-observability.adoc index 241502ca7fbf..5fdccd3a37af 100644 --- a/service_mesh/v2x/ossm-observability.adoc +++ b/service_mesh/v2x/ossm-observability.adoc @@ -29,7 +29,7 @@ include::modules/ossm-config-sampling.adoc[leveloffset=+2] include::modules/ossm-jaeger-accessing-console.adoc[leveloffset=+1] ifdef::openshift-enterprise[] -For more information about configuring Jaeger, see the xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-deploy-default_deploying-distributed-tracing-platform[distributed tracing documentation]. +For more information about configuring Jaeger, see the xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-deploy-default_deploying-distributed-tracing-platform[{DTShortName} documentation]. endif::[] include::modules/ossm-access-grafana.adoc[leveloffset=+1] @@ -45,6 +45,6 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] == Additional resources * xref:../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects] -* xref:../../observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc[Installing the distributed tracing platform (Tempo)] +* xref:../../observability/distr_tracing/distr-tracing-tempo-installing.adoc#distr-tracing-tempo-installing[Installing the {DTShortName}] * xref:../../observability/otel/otel-installing.adoc[Installing the Red Hat build of OpenTelemetry] endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/welcome/learn_more_about_openshift.adoc b/welcome/learn_more_about_openshift.adoc index 3caf197d391c..14448d01dad8 100644 --- a/welcome/learn_more_about_openshift.adoc +++ b/welcome/learn_more_about_openshift.adoc @@ -215,7 +215,7 @@ a|* xref:../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-cr // | | xref:../observability/distr_tracing/distr-tracing-rn.adoc#distr-tracing-rn[Release notes for the {DTProductName}] -| xref:../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distr-tracing-architecture[{jaegername}] +| xref:../observability/distr_tracing/distr-tracing-architecture.adoc#distr-tracing-architecture[{jaegername}] | xref:../observability/otel/otel-installing.adoc#install-otel[Red Hat build of OpenTelemetry] | xref:../observability/otel/otel-config-multicluster.adoc#otel-config-multicluster[Gathering the observability data from multiple clusters]