From 1edaf9ce977e363008b86a3d96617f32d6c27c41 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Mon, 4 Mar 2024 11:39:34 +0100 Subject: [PATCH] OBSDOCS-694 move 'distr_tracing' and 'otel' dirs into 'observability' dir update xref's in 'distr_tracing' and 'otel' dirs update xref's in 'welcome/index.adoc' file update xref's in 'observability/index.adoc' file --- _topic_maps/_topic_map.yml | 148 +++++++++--------- modules/distr-tracing-config-storage.adoc | 5 - ...iguring-tempostack-metrics-and-alerts.adoc | 2 +- modules/ossm-config-sampling.adoc | 2 +- .../distr_tracing}/_attributes | 0 .../distr_tracing_arch/_attributes | 0 .../distr-tracing-architecture.adoc | 0 .../distr_tracing}/distr_tracing_arch/images | 0 .../distr_tracing}/distr_tracing_arch/modules | 0 .../distr_tracing_arch/snippets | 0 .../distr_tracing_jaeger/_attributes | 0 .../distr-tracing-jaeger-configuring.adoc | 4 +- .../distr-tracing-jaeger-installing.adoc | 12 +- .../distr-tracing-jaeger-removing.adoc | 2 +- .../distr-tracing-jaeger-updating.adoc | 8 +- .../distr_tracing_jaeger/images | 0 .../distr_tracing_jaeger/modules | 0 .../distr_tracing_jaeger/snippets | 0 .../distr_tracing_rn/_attributes | 0 .../distr-tracing-rn-3-1.adoc | 0 .../distr-tracing-rn-past-releases.adoc | 0 .../distr_tracing}/distr_tracing_rn/images | 0 .../distr_tracing}/distr_tracing_rn/modules | 0 .../distr_tracing}/distr_tracing_rn/snippets | 0 .../distr_tracing_tempo/_attributes | 0 .../distr-tracing-tempo-configuring.adoc | 11 +- .../distr-tracing-tempo-installing.adoc | 31 ++++ .../distr-tracing-tempo-removing.adoc | 4 +- .../distr-tracing-tempo-updating.adoc | 4 +- .../distr_tracing}/distr_tracing_tempo/images | 0 .../distr_tracing_tempo/modules | 0 .../distr_tracing_tempo/snippets | 0 .../distr_tracing}/images | 0 .../distr_tracing}/modules | 0 .../distr_tracing}/snippets | 0 observability/index.adoc | 5 +- {otel => observability/otel}/_attributes | 0 {otel => observability/otel}/images | 0 {otel => observability/otel}/modules | 0 .../otel}/otel-config-multicluster.adoc | 0 ...-config-send-metrics-monitoring-stack.adoc | 0 ...otel-configuration-of-instrumentation.adoc | 0 .../otel-configuration-of-otel-collector.adoc | 0 .../otel-configuring-otelcol-metrics.adoc | 2 +- .../otel}/otel-forwarding.adoc | 0 .../otel/otel-installing.adoc | 24 ++- .../otel}/otel-migrating.adoc | 0 .../otel}/otel-removing.adoc | 4 +- ...-traces-and-metrics-to-otel-collector.adoc | 0 .../otel}/otel-troubleshooting.adoc | 0 .../otel}/otel-updating.adoc | 4 +- .../otel}/otel_rn/_attributes | 0 {otel => observability/otel}/otel_rn/images | 0 {otel => observability/otel}/otel_rn/modules | 0 .../otel}/otel_rn/otel-rn-3.1.adoc | 0 .../otel}/otel_rn/otel-rn-past-releases.adoc | 0 {otel => observability/otel}/otel_rn/snippets | 0 {otel => observability/otel}/snippets | 0 otel/otel-installing.adoc | 27 ---- service_mesh/v2x/ossm-observability.adoc | 2 +- service_mesh/v2x/ossm-reference-jaeger.adoc | 4 +- welcome/index.adoc | 4 +- 62 files changed, 153 insertions(+), 156 deletions(-) rename {distr_tracing => observability/distr_tracing}/_attributes (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_arch/_attributes (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_arch/distr-tracing-architecture.adoc (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_arch/images (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_arch/modules (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_arch/snippets (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_jaeger/_attributes (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc (89%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc (57%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc (80%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc (66%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_jaeger/images (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_jaeger/modules (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_jaeger/snippets (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_rn/_attributes (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_rn/distr-tracing-rn-3-1.adoc (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_rn/distr-tracing-rn-past-releases.adoc (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_rn/images (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_rn/modules (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_rn/snippets (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_tempo/_attributes (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc (67%) create mode 100644 observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc rename {distr_tracing => observability/distr_tracing}/distr_tracing_tempo/distr-tracing-tempo-removing.adoc (70%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_tempo/distr-tracing-tempo-updating.adoc (76%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_tempo/images (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_tempo/modules (100%) rename {distr_tracing => observability/distr_tracing}/distr_tracing_tempo/snippets (100%) rename {distr_tracing => observability/distr_tracing}/images (100%) rename {distr_tracing => observability/distr_tracing}/modules (100%) rename {distr_tracing => observability/distr_tracing}/snippets (100%) rename {otel => observability/otel}/_attributes (100%) rename {otel => observability/otel}/images (100%) rename {otel => observability/otel}/modules (100%) rename {otel => observability/otel}/otel-config-multicluster.adoc (100%) rename {otel => observability/otel}/otel-config-send-metrics-monitoring-stack.adoc (100%) rename {otel => observability/otel}/otel-configuration-of-instrumentation.adoc (100%) rename {otel => observability/otel}/otel-configuration-of-otel-collector.adoc (100%) rename {otel => observability/otel}/otel-configuring-otelcol-metrics.adoc (88%) rename {otel => observability/otel}/otel-forwarding.adoc (100%) rename distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc => observability/otel/otel-installing.adoc (56%) rename {otel => observability/otel}/otel-migrating.adoc (100%) rename {otel => observability/otel}/otel-removing.adoc (70%) rename {otel => observability/otel}/otel-sending-traces-and-metrics-to-otel-collector.adoc (100%) rename {otel => observability/otel}/otel-troubleshooting.adoc (100%) rename {otel => observability/otel}/otel-updating.adoc (76%) rename {otel => observability/otel}/otel_rn/_attributes (100%) rename {otel => observability/otel}/otel_rn/images (100%) rename {otel => observability/otel}/otel_rn/modules (100%) rename {otel => observability/otel}/otel_rn/otel-rn-3.1.adoc (100%) rename {otel => observability/otel}/otel_rn/otel-rn-past-releases.adoc (100%) rename {otel => observability/otel}/otel_rn/snippets (100%) rename {otel => observability/otel}/snippets (100%) delete mode 100644 otel/otel-installing.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index ba436cb2af59..63b954a357be 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -2486,6 +2486,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 @@ -2639,81 +2712,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 diff --git a/modules/distr-tracing-config-storage.adoc b/modules/distr-tracing-config-storage.adoc index 8e02995c6a42..77831bebfe15 100644 --- a/modules/distr-tracing-config-storage.adoc +++ b/modules/distr-tracing-config-storage.adoc @@ -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 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 ad639edda6e4..9f5da550c25d 100644 --- a/modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc +++ b/modules/distr-tracing-tempo-configuring-tempostack-metrics-and-alerts.adoc @@ -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 diff --git a/modules/ossm-config-sampling.adoc b/modules/ossm-config-sampling.adoc index fd7cb6f14d42..cbd05e6ac7bd 100644 --- a/modules/ossm-config-sampling.adoc +++ b/modules/ossm-config-sampling.adoc @@ -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::[] ==== diff --git a/distr_tracing/_attributes b/observability/distr_tracing/_attributes similarity index 100% rename from distr_tracing/_attributes rename to observability/distr_tracing/_attributes diff --git a/distr_tracing/distr_tracing_arch/_attributes b/observability/distr_tracing/distr_tracing_arch/_attributes similarity index 100% rename from distr_tracing/distr_tracing_arch/_attributes rename to observability/distr_tracing/distr_tracing_arch/_attributes diff --git a/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc b/observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc similarity index 100% rename from distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc rename to observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc diff --git a/distr_tracing/distr_tracing_arch/images b/observability/distr_tracing/distr_tracing_arch/images similarity index 100% rename from distr_tracing/distr_tracing_arch/images rename to observability/distr_tracing/distr_tracing_arch/images diff --git a/distr_tracing/distr_tracing_arch/modules b/observability/distr_tracing/distr_tracing_arch/modules similarity index 100% rename from distr_tracing/distr_tracing_arch/modules rename to observability/distr_tracing/distr_tracing_arch/modules diff --git a/distr_tracing/distr_tracing_arch/snippets b/observability/distr_tracing/distr_tracing_arch/snippets similarity index 100% rename from distr_tracing/distr_tracing_arch/snippets rename to observability/distr_tracing/distr_tracing_arch/snippets diff --git a/distr_tracing/distr_tracing_jaeger/_attributes b/observability/distr_tracing/distr_tracing_jaeger/_attributes similarity index 100% rename from distr_tracing/distr_tracing_jaeger/_attributes rename to observability/distr_tracing/distr_tracing_jaeger/_attributes diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc similarity index 89% rename from distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc rename to observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc index 18b94341004c..4513538ea5df 100644 --- a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc @@ -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. @@ -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] diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc similarity index 57% rename from distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc rename to observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc index 438041e9a84a..6a35812483d5 100644 --- a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc @@ -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. @@ -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. diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc similarity index 80% rename from distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc rename to observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc index 138f6418ea59..e42cf6dfda8d 100644 --- a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-removing.adoc @@ -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. diff --git a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc similarity index 66% rename from distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc rename to observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc index e8818694af17..a35ded0877d5 100644 --- a/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc +++ b/observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-updating.adoc @@ -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] diff --git a/distr_tracing/distr_tracing_jaeger/images b/observability/distr_tracing/distr_tracing_jaeger/images similarity index 100% rename from distr_tracing/distr_tracing_jaeger/images rename to observability/distr_tracing/distr_tracing_jaeger/images diff --git a/distr_tracing/distr_tracing_jaeger/modules b/observability/distr_tracing/distr_tracing_jaeger/modules similarity index 100% rename from distr_tracing/distr_tracing_jaeger/modules rename to observability/distr_tracing/distr_tracing_jaeger/modules diff --git a/distr_tracing/distr_tracing_jaeger/snippets b/observability/distr_tracing/distr_tracing_jaeger/snippets similarity index 100% rename from distr_tracing/distr_tracing_jaeger/snippets rename to observability/distr_tracing/distr_tracing_jaeger/snippets diff --git a/distr_tracing/distr_tracing_rn/_attributes b/observability/distr_tracing/distr_tracing_rn/_attributes similarity index 100% rename from distr_tracing/distr_tracing_rn/_attributes rename to observability/distr_tracing/distr_tracing_rn/_attributes diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc b/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc similarity index 100% rename from distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc rename to observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1.adoc diff --git a/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc b/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc similarity index 100% rename from distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc rename to observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases.adoc diff --git a/distr_tracing/distr_tracing_rn/images b/observability/distr_tracing/distr_tracing_rn/images similarity index 100% rename from distr_tracing/distr_tracing_rn/images rename to observability/distr_tracing/distr_tracing_rn/images diff --git a/distr_tracing/distr_tracing_rn/modules b/observability/distr_tracing/distr_tracing_rn/modules similarity index 100% rename from distr_tracing/distr_tracing_rn/modules rename to observability/distr_tracing/distr_tracing_rn/modules diff --git a/distr_tracing/distr_tracing_rn/snippets b/observability/distr_tracing/distr_tracing_rn/snippets similarity index 100% rename from distr_tracing/distr_tracing_rn/snippets rename to observability/distr_tracing/distr_tracing_rn/snippets diff --git a/distr_tracing/distr_tracing_tempo/_attributes b/observability/distr_tracing/distr_tracing_tempo/_attributes similarity index 100% rename from distr_tracing/distr_tracing_tempo/_attributes rename to observability/distr_tracing/distr_tracing_tempo/_attributes diff --git a/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc similarity index 67% rename from distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc rename to observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc index 508196c2dca4..0e6fc151643b 100644 --- a/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc @@ -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] @@ -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] @@ -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] diff --git a/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc new file mode 100644 index 000000000000..0eba043b15fd --- /dev/null +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc @@ -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] diff --git a/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc similarity index 70% rename from distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc rename to observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc index 8b19fa766987..4ea4a2c7feb9 100644 --- a/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-removing.adoc @@ -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] \ No newline at end of file +* 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] \ No newline at end of file diff --git a/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc similarity index 76% rename from distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc rename to observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc index 05a7b4dd24b8..e37dca6cb61b 100644 --- a/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc +++ b/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-updating.adoc @@ -15,5 +15,5 @@ When the {TempoOperator} is upgraded to the new version, it scans for running Te [id="additional-resources_dist-tracing-tempo-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:../../../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/distr_tracing/distr_tracing_tempo/images b/observability/distr_tracing/distr_tracing_tempo/images similarity index 100% rename from distr_tracing/distr_tracing_tempo/images rename to observability/distr_tracing/distr_tracing_tempo/images diff --git a/distr_tracing/distr_tracing_tempo/modules b/observability/distr_tracing/distr_tracing_tempo/modules similarity index 100% rename from distr_tracing/distr_tracing_tempo/modules rename to observability/distr_tracing/distr_tracing_tempo/modules diff --git a/distr_tracing/distr_tracing_tempo/snippets b/observability/distr_tracing/distr_tracing_tempo/snippets similarity index 100% rename from distr_tracing/distr_tracing_tempo/snippets rename to observability/distr_tracing/distr_tracing_tempo/snippets diff --git a/distr_tracing/images b/observability/distr_tracing/images similarity index 100% rename from distr_tracing/images rename to observability/distr_tracing/images diff --git a/distr_tracing/modules b/observability/distr_tracing/modules similarity index 100% rename from distr_tracing/modules rename to observability/distr_tracing/modules diff --git a/distr_tracing/snippets b/observability/distr_tracing/snippets similarity index 100% rename from distr_tracing/snippets rename to observability/distr_tracing/snippets diff --git a/observability/index.adoc b/observability/index.adoc index 401afefe13f5..e7f0ee842540 100644 --- a/observability/index.adoc +++ b/observability/index.adoc @@ -37,15 +37,14 @@ For more information, see xref:../logging/cluster-logging.adoc#cluster-logging[A == 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:../distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distr-tracing-architecture[Distributed tracing architecture]. +For more information, see xref:distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture]. //after the file is added to the observability directory, update xref path to ../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distributed-tracing-architecture[Distributed tracing architecture]. [id="otel-release-notes-index"] == {OTELName} Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open source backends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate. -For more information, see xref:../otel/otel-installing.adoc#install-otel[Red Hat build of OpenTelemetry]. -//after the file is added to the observability directory, update xref path to ../observability/otel/otel-release-notes.adoc#otel-release-notes[{OTELName} release notes]. +For more information, see xref:otel/otel_rn/otel-rn-3.1.adoc#otel-rn-3-1[{OTELName}]. [id="network-observability-overview-index"] == Network Observability diff --git a/otel/_attributes b/observability/otel/_attributes similarity index 100% rename from otel/_attributes rename to observability/otel/_attributes diff --git a/otel/images b/observability/otel/images similarity index 100% rename from otel/images rename to observability/otel/images diff --git a/otel/modules b/observability/otel/modules similarity index 100% rename from otel/modules rename to observability/otel/modules diff --git a/otel/otel-config-multicluster.adoc b/observability/otel/otel-config-multicluster.adoc similarity index 100% rename from otel/otel-config-multicluster.adoc rename to observability/otel/otel-config-multicluster.adoc diff --git a/otel/otel-config-send-metrics-monitoring-stack.adoc b/observability/otel/otel-config-send-metrics-monitoring-stack.adoc similarity index 100% rename from otel/otel-config-send-metrics-monitoring-stack.adoc rename to observability/otel/otel-config-send-metrics-monitoring-stack.adoc diff --git a/otel/otel-configuration-of-instrumentation.adoc b/observability/otel/otel-configuration-of-instrumentation.adoc similarity index 100% rename from otel/otel-configuration-of-instrumentation.adoc rename to observability/otel/otel-configuration-of-instrumentation.adoc diff --git a/otel/otel-configuration-of-otel-collector.adoc b/observability/otel/otel-configuration-of-otel-collector.adoc similarity index 100% rename from otel/otel-configuration-of-otel-collector.adoc rename to observability/otel/otel-configuration-of-otel-collector.adoc diff --git a/otel/otel-configuring-otelcol-metrics.adoc b/observability/otel/otel-configuring-otelcol-metrics.adoc similarity index 88% rename from otel/otel-configuring-otelcol-metrics.adoc rename to observability/otel/otel-configuring-otelcol-metrics.adoc index 155bbf528be5..632117ace63c 100644 --- a/otel/otel-configuring-otelcol-metrics.adoc +++ b/observability/otel/otel-configuring-otelcol-metrics.adoc @@ -37,4 +37,4 @@ You can use the *Administrator* view of the web console to verify successful con * Go to *Observe* -> *Targets*, filter by *Source: User*, and check that the *ServiceMonitors* in the `opentelemetry-collector-` format have the *Up* status. .Additional resources -* xref:../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects] +* xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects] diff --git a/otel/otel-forwarding.adoc b/observability/otel/otel-forwarding.adoc similarity index 100% rename from otel/otel-forwarding.adoc rename to observability/otel/otel-forwarding.adoc diff --git a/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc b/observability/otel/otel-installing.adoc similarity index 56% rename from distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc rename to observability/otel/otel-installing.adoc index 03c7bcf37c22..20f47a56b2eb 100644 --- a/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-installing.adoc +++ b/observability/otel/otel-installing.adoc @@ -1,27 +1,23 @@ :_mod-docs-content-type: ASSEMBLY -[id="dist-tracing-tempo-installing"] -= Installing the {TempoShortName} +[id="install-otel"] += Installing the {OTELShortName} include::_attributes/common-attributes.adoc[] -:context: dist-tracing-tempo-installing +:context: install-otel toc::[] -Installing the {TempoShortName} involves the following steps: +Installing the {OTELShortName} 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. +. Installing the {OTELOperator}. +. Creating a namespace for an OpenTelemetry Collector instance. +. Creating an `OpenTelemetryCollector` custom resource to deploy the OpenTelemetry Collector instance. -include::modules/distr-tracing-tempo-storage-ref.adoc[leveloffset=+1] +include::modules/otel-install-web-console.adoc[leveloffset=+1] -include::modules/distr-tracing-tempo-install-web-console.adoc[leveloffset=+1] - -include::modules/distr-tracing-tempo-install-cli.adoc[leveloffset=+1] +include::modules/otel-install-cli.adoc[leveloffset=+1] [role="_additional-resources"] -[id="additional-resources_dist-tracing-tempo-installing"] +[id="additional-resources_otel-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] diff --git a/otel/otel-migrating.adoc b/observability/otel/otel-migrating.adoc similarity index 100% rename from otel/otel-migrating.adoc rename to observability/otel/otel-migrating.adoc diff --git a/otel/otel-removing.adoc b/observability/otel/otel-removing.adoc similarity index 70% rename from otel/otel-removing.adoc rename to observability/otel/otel-removing.adoc index 18b650898bc8..4233e6256dd0 100644 --- a/otel/otel-removing.adoc +++ b/observability/otel/otel-removing.adoc @@ -20,5 +20,5 @@ include::modules/otel-remove-cli.adoc[leveloffset=+1] [id="additional-resources_dist-tracing-otel-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] diff --git a/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc b/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc similarity index 100% rename from otel/otel-sending-traces-and-metrics-to-otel-collector.adoc rename to observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc diff --git a/otel/otel-troubleshooting.adoc b/observability/otel/otel-troubleshooting.adoc similarity index 100% rename from otel/otel-troubleshooting.adoc rename to observability/otel/otel-troubleshooting.adoc diff --git a/otel/otel-updating.adoc b/observability/otel/otel-updating.adoc similarity index 76% rename from otel/otel-updating.adoc rename to observability/otel/otel-updating.adoc index 98b55d8316bd..ec3c5cd31f75 100644 --- a/otel/otel-updating.adoc +++ b/observability/otel/otel-updating.adoc @@ -16,5 +16,5 @@ When the {OTELOperator} is upgraded to the new version, it scans for running Ope [id="additional-resources_dist-tracing-otel-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:../../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/otel/otel_rn/_attributes b/observability/otel/otel_rn/_attributes similarity index 100% rename from otel/otel_rn/_attributes rename to observability/otel/otel_rn/_attributes diff --git a/otel/otel_rn/images b/observability/otel/otel_rn/images similarity index 100% rename from otel/otel_rn/images rename to observability/otel/otel_rn/images diff --git a/otel/otel_rn/modules b/observability/otel/otel_rn/modules similarity index 100% rename from otel/otel_rn/modules rename to observability/otel/otel_rn/modules diff --git a/otel/otel_rn/otel-rn-3.1.adoc b/observability/otel/otel_rn/otel-rn-3.1.adoc similarity index 100% rename from otel/otel_rn/otel-rn-3.1.adoc rename to observability/otel/otel_rn/otel-rn-3.1.adoc diff --git a/otel/otel_rn/otel-rn-past-releases.adoc b/observability/otel/otel_rn/otel-rn-past-releases.adoc similarity index 100% rename from otel/otel_rn/otel-rn-past-releases.adoc rename to observability/otel/otel_rn/otel-rn-past-releases.adoc diff --git a/otel/otel_rn/snippets b/observability/otel/otel_rn/snippets similarity index 100% rename from otel/otel_rn/snippets rename to observability/otel/otel_rn/snippets diff --git a/otel/snippets b/observability/otel/snippets similarity index 100% rename from otel/snippets rename to observability/otel/snippets diff --git a/otel/otel-installing.adoc b/otel/otel-installing.adoc deleted file mode 100644 index a0ba70096a75..000000000000 --- a/otel/otel-installing.adoc +++ /dev/null @@ -1,27 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="install-otel"] -= Installing the {OTELShortName} -include::_attributes/common-attributes.adoc[] -:context: install-otel - -toc::[] - -Installing the {OTELShortName} involves the following steps: - -. Installing the {OTELOperator}. -. Creating a namespace for an OpenTelemetry Collector instance. -. Creating an `OpenTelemetryCollector` custom resource to deploy the OpenTelemetry Collector instance. - -include::modules/otel-install-web-console.adoc[leveloffset=+1] - -include::modules/otel-install-cli.adoc[leveloffset=+1] - -[role="_additional-resources"] -[id="additional-resources_otel-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] diff --git a/service_mesh/v2x/ossm-observability.adoc b/service_mesh/v2x/ossm-observability.adoc index e55dab0cbdac..dcdf5d042472 100644 --- a/service_mesh/v2x/ossm-observability.adoc +++ b/service_mesh/v2x/ossm-observability.adoc @@ -27,7 +27,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:../../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[distributed tracing documentation]. endif::[] include::modules/ossm-access-grafana.adoc[leveloffset=+1] diff --git a/service_mesh/v2x/ossm-reference-jaeger.adoc b/service_mesh/v2x/ossm-reference-jaeger.adoc index 0125b8a6618b..50478bca6d4f 100644 --- a/service_mesh/v2x/ossm-reference-jaeger.adoc +++ b/service_mesh/v2x/ossm-reference-jaeger.adoc @@ -37,9 +37,9 @@ include::modules/distr-tracing-config-sampling.adoc[leveloffset=+2] include::modules/distr-tracing-config-storage.adoc[leveloffset=+2] ifdef::openshift-enterprise,openshift-dedicated[] -For more information about configuring Elasticsearch with {product-title}, see xref:../../logging/log_storage/logging-config-es-store.adoc#logging-config-es-store[Configuring the Elasticsearch log store] or xref:../../distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc[Configuring and deploying distributed tracing]. +For more information about configuring Elasticsearch with {product-title}, see xref:../../logging/log_storage/logging-config-es-store.adoc#logging-config-es-store[Configuring the Elasticsearch log store] or xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc[Configuring and deploying distributed tracing]. -//TO DO For information about connecting to an external Elasticsearch instance, see xref:../../distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#jaeger-config-external-es_jaeger-deploying[Connecting to an existing Elasticsearch instance]. +//TO DO For information about connecting to an external Elasticsearch instance, see xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#jaeger-config-external-es_jaeger-deploying[Connecting to an existing Elasticsearch instance]. endif::[] include::modules/distr-tracing-config-query.adoc[leveloffset=+2] diff --git a/welcome/index.adoc b/welcome/index.adoc index bf99bc343a5e..adcac194ab62 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -295,10 +295,10 @@ xref:../updating/updating-disconnected-cluster.adoc#updating-disconnected-cluste - **xref:../logging/cluster-logging.adoc#cluster-logging[Work with OpenShift Logging]**: Learn about OpenShift Logging and configure different OpenShift Logging types, such as Elasticsearch, Fluentd, and Kibana. -- **xref:../distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distr-tracing-architecture[Red Hat OpenShift distributed tracing platform]**: Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use the distributed tracing platform 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. +- **xref:../observability/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc#distr-tracing-architecture[Red Hat OpenShift distributed tracing platform]**: Store and visualize large volumes of requests passing through distributed systems, across the whole stack of microservices, and under heavy loads. Use the distributed tracing platform 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. // 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[Red Hat build of OpenTelemetry]**: Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open source backends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate. +- **xref:../observability/otel/otel-installing.adoc#install-otel[Red Hat build of OpenTelemetry]**: Instrument, generate, collect, and export telemetry traces, metrics, and logs to analyze and understand your software's performance and behavior. Use open source backends like Tempo or Prometheus, or use commercial offerings. Learn a single set of APIs and conventions, and own the data that you generate. // CHECK IN CLOSER TO THE GA DATE BECAUSE FEATURE WORK IS NOT MERGED; ESTIMATED MERGE BY 19 FEB. ADD xref:../network_observability/metrics-alerts-dashboards.adoc#network-observability-viewing-dashboards_metrics-dashboards-alerts to [view dashbaords text. - **xref:../network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability]**: Observe network traffic for {product-title} clusters by using eBPF technology to create and enrich network flows. You can view dashboards and xref:../network_observability/observing-network-traffic.adoc#network-observability-trafficflow_nw-observe-network-traffic[analyze network flow] information for further insight and troubleshooting.