diff --git a/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc b/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc index bb34bb21a712..ff905a8f4c22 100644 --- a/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc +++ b/distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc @@ -17,8 +17,6 @@ It is valuable for understanding serialization, parallelism, and sources of late A _span_ represents a logical unit of work in {DTProductName} that has an operation name, the start time of the operation, and the duration, as well as potentially tags and logs. Spans may be nested and ordered to model causal relationships. -// The following include statements pull in the module files that comprise the assembly. - include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] include::modules/distr-tracing-features.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc b/distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc index 04754f8995b3..0624b85b2cc6 100644 --- a/distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc +++ b/distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc @@ -46,12 +46,10 @@ The streaming deployment strategy is currently unsupported on IBM Z. [NOTE] ==== -There are two ways to install and use {DTProductName}, as part of a service mesh or as a stand alone component. If you have installed {DTShortName} as part of Red Hat OpenShift Service Mesh, you can perform basic configuration as part of the xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[ServiceMeshControlPlane] but for completely control you should configure a Jaeger CR and then xref:../../service_mesh/v2x/ossm-observability.html#ossm-config-external-jaeger_observability[reference your distributed tracing configuration file in the ServiceMeshControlPlane]. +There are two ways to install and use {DTProductName}, as part of a service mesh or as a stand alone component. 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 completely control you should configure a Jaeger CR and then xref:../../service_mesh/v2x/ossm-observability.html#ossm-config-external-jaeger_observability[reference your distributed tracing configuration file in the ServiceMeshControlPlane]. ==== -// The following include statements pull in the module files that comprise the assembly. - include::modules/distr-tracing-deploy-default.adoc[leveloffset=+1] include::modules/distr-tracing-deploy-production-es.adoc[leveloffset=+1] @@ -61,7 +59,7 @@ include::modules/distr-tracing-deploy-streaming.adoc[leveloffset=+1] [id="validating-your-jaeger-deployment"] == Validating your deployment -include::modules/distr-tracing-accessing-jaeger-console.adoc[leveloffset=+1] +include::modules/distr-tracing-accessing-jaeger-console.adoc[leveloffset=+2] [id="customizing-your-deployment"] == Customizing your deployment diff --git a/distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc b/distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc index 36e4f646f34e..d6067ce9d0cf 100644 --- a/distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc +++ b/distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc @@ -6,9 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -The {OTELName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {OTELName} resources. You can either install the default configuration or modify the file to better suit your business requirements. - -// The following include statements pull in the module files that comprise the assembly. +The {OTELName} Operator uses a custom resource definition (CRD) file that defines the architecture and configuration settings to be used when creating and deploying the {OTELName} resources. You can either install the default configuration or modify the file to better suit your business requirements. include::modules/distr-tracing-config-otel-collector.adoc[leveloffset=+1] diff --git a/distr_tracing/distr_tracing_install/distr-tracing-installing.adoc b/distr_tracing/distr_tracing_install/distr-tracing-installing.adoc index d9ea8c20dcc2..9a64b8c418e9 100644 --- a/distr_tracing/distr_tracing_install/distr-tracing-installing.adoc +++ b/distr_tracing/distr_tracing_install/distr-tracing-installing.adoc @@ -8,7 +8,7 @@ toc::[] You can install {DTProductName} on {product-title} in either of two ways: -* You can install {DTProductName} as part of Red Hat OpenShift Service Mesh. 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. @@ -29,8 +29,6 @@ Before you can install {DTProductName}, review the installation activities, and * An account with the `cluster-admin` role. -// The following include statements pull in the module files that comprise the assembly. - include::modules/distr-tracing-install-overview.adoc[leveloffset=+1] include::modules/distr-tracing-install-elasticsearch.adoc[leveloffset=+1] diff --git a/distr_tracing/distributed-tracing-release-notes.adoc b/distr_tracing/distributed-tracing-release-notes.adoc index f8beb303d1a9..fcac0d5f7275 100644 --- a/distr_tracing/distributed-tracing-release-notes.adoc +++ b/distr_tracing/distributed-tracing-release-notes.adoc @@ -6,8 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -// The following include statements pull in the module files that comprise the assembly. - include::modules/distr-tracing-product-overview.adoc[leveloffset=+1] include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/jaeger/jaeger_arch/rhbjaeger-architecture.adoc b/jaeger/jaeger_arch/rhbjaeger-architecture.adoc index 45d21d06b5c2..47be9116a92b 100644 --- a/jaeger/jaeger_arch/rhbjaeger-architecture.adoc +++ b/jaeger/jaeger_arch/rhbjaeger-architecture.adoc @@ -17,29 +17,8 @@ Jaeger records the execution of individual requests across the whole stack of mi A _span_ represents a logical unit of work in Jaeger that has an operation name, the start time of the operation, and the duration, as well as potentially tags and logs. Spans may be nested and ordered to model causal relationships. -// The following include statements pull in the module files that comprise the assembly. - include::modules/jaeger-product-overview.adoc[leveloffset=+1] include::modules/jaeger-features.adoc[leveloffset=+1] include::modules/jaeger-architecture.adoc[leveloffset=+1] - -//// -TODO -WRITE more detailed component docs - -include::modules/jaeger-client-java.adoc[leveloffset=+1] - -include::modules/jaeger-agent.adoc[leveloffset=+1] - -include::modules/jaeger-collector.adoc[leveloffset=+1] - -include::modules/jaeger-data-store.adoc[leveloffset=+1] - -include::modules/jaeger-query.adoc[leveloffset=+1] - -include::modules/jaeger-ingester.adoc[leveloffset=+1] - -include::modules/jaeger-console.adoc[leveloffset=+1] -//// diff --git a/jaeger/jaeger_install/rhbjaeger-deploying.adoc b/jaeger/jaeger_install/rhbjaeger-deploying.adoc index a14ba31c940a..8ac7c9119773 100644 --- a/jaeger/jaeger_install/rhbjaeger-deploying.adoc +++ b/jaeger/jaeger_install/rhbjaeger-deploying.adoc @@ -27,10 +27,10 @@ spec: + [NOTE] ==== -In-memory storage is not persistent, which means that if the Jaeger instance shuts down, restarts, or is replaced, that your trace data will be lost. And in-memory storage cannot be scaled, since each pod has its own memory. For persistent storage, you must use the `production` or `streaming` strategies, which use Elasticsearch as the default storage. +In-memory storage is not persistent, which means that if the Jaeger instance shuts down, restarts, or is replaced, that your trace data will be lost. And in-memory storage cannot be scaled, since each pod has its own memory. For persistent storage, you must use the `production` or `streaming` strategies, which use Elasticsearch as the default storage. ==== -* *production* - The production strategy is intended for production environments, where long term storage of trace data is important, as well as a more scalable and highly available architecture is required. Each of the backend components is therefore deployed separately. The Agent can be injected as a sidecar on the instrumented application. The Query and Collector services are configured with a supported storage type - currently Elasticsearch. Multiple instances of each of these components can be provisioned as required for performance and resilience purposes. +* *production* - The production strategy is intended for production environments, where long term storage of trace data is important, as well as a more scalable and highly available architecture is required. Each of the backend components is therefore deployed separately. The Agent can be injected as a sidecar on the instrumented application. The Query and Collector services are configured with a supported storage type - currently Elasticsearch. Multiple instances of each of these components can be provisioned as required for performance and resilience purposes. * *streaming* - The streaming strategy is designed to augment the production strategy by providing a streaming capability that effectively sits between the Collector and the backend storage (Elasticsearch). This provides the benefit of reducing the pressure on the backend storage, under high load situations, and enables other trace post-processing capabilities to tap into the real time span data directly from the streaming platform (https://access.redhat.com/documentation/en-us/red_hat_amq/7.6/html/using_amq_streams_on_openshift/index[AMQ Streams]/ https://kafka.apache.org/documentation/[Kafka]). + @@ -41,7 +41,7 @@ The streaming strategy requires an additional Red Hat subscription for AMQ Strea [NOTE] ==== -There are two ways to install and use Jaeger, as part of a service mesh or as a stand alone component. If you have installed Jaeger as part of Red Hat OpenShift Service Mesh, you can configure and deploy Jaeger as part of the xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[ServiceMeshControlPlane] or configure Jaeger and then xref:../../service_mesh/v2x/ossm-observability.html#ossm-config-external-jaeger_observability[reference your Jaeger configuration in the ServiceMeshControlPlane]. +There are two ways to install and use Jaeger, as part of a service mesh or as a stand alone component. If you have installed Jaeger as part of {SMProductName}, you can configure and deploy Jaeger as part of the xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[ServiceMeshControlPlane] or configure Jaeger and then xref:../../service_mesh/v2x/ossm-observability.html#ossm-config-external-jaeger_observability[reference your Jaeger configuration in the ServiceMeshControlPlane]. ==== diff --git a/jaeger/jaeger_install/rhbjaeger-installation.adoc b/jaeger/jaeger_install/rhbjaeger-installation.adoc index c8ea1a090451..9fcfaef0af30 100644 --- a/jaeger/jaeger_install/rhbjaeger-installation.adoc +++ b/jaeger/jaeger_install/rhbjaeger-installation.adoc @@ -8,7 +8,7 @@ toc::[] You can install Jaeger on {product-title} in either of two ways: -* You can install Jaeger as part of Red Hat OpenShift Service Mesh. Jaeger is included by default in the Service Mesh installation. To install Jaeger 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. Jaeger must be installed in the same namespace as your service mesh, that is, the `ServiceMeshControlPlane` and the Jaeger resources must be in the same namespace. +* You can install Jaeger as part of {SMProductName}. Jaeger is included by default in the Service Mesh installation. To install Jaeger 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. Jaeger must be installed in the same namespace as your service mesh, that is, the `ServiceMeshControlPlane` and the Jaeger resources must be in the same namespace. * If you do not want to install a service mesh, you can use the {JaegerName} Operator to install {JaegerShortName} by itself. To install Jaeger without a service mesh, use the following instructions. @@ -30,8 +30,6 @@ Before you can install {JaegerName}, review the installation activities, and ens * An account with the `cluster-admin` role. -// The following include statements pull in the module files that comprise the assembly. - include::modules/jaeger-install-overview.adoc[leveloffset=+1] include::modules/jaeger-install-elasticsearch.adoc[leveloffset=+1] diff --git a/jaeger/rhbjaeger-release-notes.adoc b/jaeger/rhbjaeger-release-notes.adoc index 13ca1c99752e..e06ca7be76e3 100644 --- a/jaeger/rhbjaeger-release-notes.adoc +++ b/jaeger/rhbjaeger-release-notes.adoc @@ -6,8 +6,6 @@ include::_attributes/common-attributes.adoc[] toc::[] -// The following include statements pull in the module files that comprise the assembly. - include::modules/jaeger-product-overview.adoc[leveloffset=+1] include::modules/making-open-source-more-inclusive.adoc[leveloffset=+1] diff --git a/modules/distr-tracing-accessing-jaeger-console.adoc b/modules/distr-tracing-accessing-jaeger-console.adoc index 5fc7083ed6db..43ea3ab829b9 100644 --- a/modules/distr-tracing-accessing-jaeger-console.adoc +++ b/modules/distr-tracing-accessing-jaeger-console.adoc @@ -1,8 +1,9 @@ //// Module included in the following assemblies: - +* distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc +* distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc //// - +:_content-type: PROCEDURE [id="distr-tracing-accessing-jaeger-console_{context}"] = Accessing the Jaeger console @@ -10,7 +11,7 @@ To access the Jaeger console you must have either {SMProductName} or {DTProductN The installation process creates a route to access the Jaeger console. -If you know the URL for the Jaeger console, you can access it directly. If you do not know the URL, use the following directions. +If you know the URL for the Jaeger console, you can access it directly. If you do not know the URL, use the following directions. .Procedure from OpenShift console . Log in to the {product-title} web console as a user with cluster-admin rights. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role. @@ -21,7 +22,7 @@ If you know the URL for the Jaeger console, you can access it directly. If you + The *Location* column displays the linked address for each route. + -. If necessary, use the filter to find the `jaeger` route. Click the route *Location* to launch the console. +. If necessary, use the filter to find the `jaeger` route. Click the route *Location* to launch the console. . Click *Log In With OpenShift*. diff --git a/modules/distr-tracing-change-operator-20.adoc b/modules/distr-tracing-change-operator-20.adoc index 29c47943b398..9ec4c14fad64 100644 --- a/modules/distr-tracing-change-operator-20.adoc +++ b/modules/distr-tracing-change-operator-20.adoc @@ -1,9 +1,9 @@ //// -This PROCEDURE module included in the following assemblies: -- /dist_tracing_install/dist-tracing-updating.adoc +This module included in the following assemblies: +- dist_tracing/dist_tracing_install/dist-tracing-updating.adoc //// -[id="distr-tracing-change-operator-20_{context}"] +[id="distr-tracing-changing-operator-channel_{context}"] = Changing the Operator channel for 2.0 {DTProductName} 2.0.0 made the following changes: diff --git a/modules/distr-tracing-config-otel-collector.adoc b/modules/distr-tracing-config-otel-collector.adoc index d23acc8ec8e9..fbda0cd2785a 100644 --- a/modules/distr-tracing-config-otel-collector.adoc +++ b/modules/distr-tracing-config-otel-collector.adoc @@ -19,9 +19,9 @@ The OpenTelemetry Collector consists of three components that access telemetry d * *Processors* - (Optional) Processors are run on data between being received and being exported. By default, no processors are enabled. Processors must be enabled for every data source. Not all processors support all data sources. Depending on the data source, it may be recommended that multiple processors be enabled. In addition, it is important to note that the order of processors matters. -* *Exporters* - An exporter, which can be push or pull based, is how you send data to one or more backends/destinations. By default, no exporters are configured. One or more exporters must be configured. Exporters may support one or more data sources. Exporters may come with default settings, but many require configuration to specify at least the destination and security settings. +* *Exporters* - An exporter, which can be push or pull based, is how you send data to one or more backends/destinations. By default, no exporters are configured. One or more exporters must be configured. Exporters may support one or more data sources. Exporters may come with default settings, but many require configuration to specify at least the destination and security settings. -You can define multiple instances of components in a custom resource YAML file. Once configured, these components must be enabled through pipelines defined in the `spec.config.service` section of the YAML file. As a best practice you should only enable the components that you need. +You can define multiple instances of components in a custom resource YAML file. Once configured, these components must be enabled through pipelines defined in the `spec.config.service` section of the YAML file. As a best practice you should only enable the components that you need. .sample OpenTelemetry collector custom resource file [source,yaml] diff --git a/modules/distr-tracing-deploy-default.adoc b/modules/distr-tracing-deploy-default.adoc index ba2c408ff51d..b21502b4cbb5 100644 --- a/modules/distr-tracing-deploy-default.adoc +++ b/modules/distr-tracing-deploy-default.adoc @@ -11,7 +11,7 @@ The custom resource definition (CRD) defines the configuration used when you dep [NOTE] ==== -In-memory storage is not persistent. If the Jaeger pod shuts down, restarts, or is replaced, your trace data will be lost. For persistent storage, you must use the `production` or `streaming` strategies, which use Elasticsearch as the default storage. +In-memory storage is not persistent. If the Jaeger pod shuts down, restarts, or is replaced, your trace data will be lost. For persistent storage, you must use the `production` or `streaming` strategies, which use Elasticsearch as the default storage. ==== .Prerequisites diff --git a/modules/distr-tracing-deploy-streaming.adoc b/modules/distr-tracing-deploy-streaming.adoc index e72508b1d655..0f1728c4a0bf 100644 --- a/modules/distr-tracing-deploy-streaming.adoc +++ b/modules/distr-tracing-deploy-streaming.adoc @@ -9,7 +9,7 @@ This module included in the following assemblies: The `streaming` deployment strategy is intended for production environments that require a more scalable and highly available architecture, and where long-term storage of trace data is important. -The `streaming` strategy provides a streaming capability that sits between the Collector and the Elasticsearch storage. This reduces the pressure on the storage under high load situations, and enables other trace post-processing capabilities to tap into the real-time span data in directly from the Kafka streaming platform. +The `streaming` strategy provides a streaming capability that sits between the Collector and the Elasticsearch storage. This reduces the pressure on the storage under high load situations, and enables other trace post-processing capabilities to tap into the real-time span data directly from the Kafka streaming platform. [NOTE] ==== diff --git a/modules/distr-tracing-deployment-best-practices.adoc b/modules/distr-tracing-deployment-best-practices.adoc index 37f055b56a0f..8e6098bc6140 100644 --- a/modules/distr-tracing-deployment-best-practices.adoc +++ b/modules/distr-tracing-deployment-best-practices.adoc @@ -10,6 +10,6 @@ This module included in the following assemblies: * If you have a multitenant implementation and tenants are separated by namespaces, deploy a {JaegerName} instance to each tenant namespace. -** Agent as a daemonset is not supported for multitenant installations or OpenShift Dedicated. Agent as a sidecar is the only supported configuration for these use cases. +** Agent as a daemonset is not supported for multitenant installations or {product-dedicated}. Agent as a sidecar is the only supported configuration for these use cases. -* If you are installing {DTShortName} as part of Red Hat OpenShift Service Mesh, the {DTShortName} resources must be installed in the same namespace as the `ServiceMeshControlPlane` resource. +* If you are installing {DTShortName} as part of {SMProductName}, the {DTShortName} resources must be installed in the same namespace as the `ServiceMeshControlPlane` resource. diff --git a/modules/distr-tracing-install-elasticsearch.adoc b/modules/distr-tracing-install-elasticsearch.adoc index b172f22e9d14..822df38406e2 100644 --- a/modules/distr-tracing-install-elasticsearch.adoc +++ b/modules/distr-tracing-install-elasticsearch.adoc @@ -4,7 +4,7 @@ This module included in the following assemblies: //// :_content-type: PROCEDURE -[id="distr-tracing-install-elasticsearch_{context}"] +[id="distr-tracing-operator-install-elasticsearch_{context}"] = Installing the OpenShift Elasticsearch Operator The default {JaegerName} deployment uses in-memory storage because it is designed to be installed quickly for those evaluating {DTProductName}, giving demonstrations, or using {JaegerName} in a test environment. If you plan to use {JaegerName} in production, you must install and configure a persistent storage option, in this case, Elasticsearch. diff --git a/modules/distr-tracing-install-jaeger-operator.adoc b/modules/distr-tracing-install-jaeger-operator.adoc index 272c75160f91..9abb706fc16d 100644 --- a/modules/distr-tracing-install-jaeger-operator.adoc +++ b/modules/distr-tracing-install-jaeger-operator.adoc @@ -4,7 +4,7 @@ This module included in the following assemblies: //// :_content-type: PROCEDURE -[id="distr-tracing-install-jaeger-operator_{context}"] +[id="distr-tracing-jaeger-operator-install_{context}"] = Installing the {JaegerName} Operator To install {JaegerName}, you use the link:https://operatorhub.io/[OperatorHub] to install the {JaegerName} Operator. @@ -36,7 +36,7 @@ Do not install Community versions of the Operators. Community Operators are not . On the *Install Operator* page, select the *stable* Update Channel. This automatically updates your Operator as new versions are released. //If you select a maintenance channel, for example, *Stable*, you will receive bug fixes and security patches for the length of the support cycle for that version. -. Accept the default *All namespaces on the cluster (default)*. This installs the Operator in the default `openshift-distributed-tracing` project and makes the Operator available to all projects in the cluster. +. Accept the default *All namespaces on the cluster (default)*. This installs the Operator in the default `openshift-operators` project and makes the Operator available to all projects in the cluster. * Accept the default *Automatic* approval strategy. By accepting the default, when a new version of this Operator is available, Operator Lifecycle Manager (OLM) automatically upgrades the running instance of your Operator without human intervention. If you select *Manual* updates, when a newer version of an Operator is available, OLM creates an update request. As a cluster administrator, you must then manually approve that update request to have the Operator updated to the new version. + diff --git a/modules/distr-tracing-sidecar-automatic.adoc b/modules/distr-tracing-sidecar-automatic.adoc index 270a2d793a31..9c425dc12c7a 100644 --- a/modules/distr-tracing-sidecar-automatic.adoc +++ b/modules/distr-tracing-sidecar-automatic.adoc @@ -3,10 +3,10 @@ This module included in the following assemblies: - distr_tracing_install/distr-tracing-deploying-jaeger.adoc //// :_content-type: REFERENCE -[id="distr-tracing-sidecar-automatic_{context}"] +[id="dist-tracing-sidecar-automatic_{context}"] = Automatically injecting sidecars -To enable this feature, add the `sidecar.jaegertracing.io/inject` annotation to either the string `true` or to the {JaegerShortName} instance name that is returned by running `$ oc get jaegers`. +The {JaegerName} Operator can inject Jaeger Agent sidecars into Deployment workloads. To enable automatic injection of sidecars, add the `sidecar.jaegertracing.io/inject` annotation set to either the string `true` or to the {JaegerShortName} instance name that is returned by running `$ oc get jaegers`. When you specify `true`, there should be only a single {JaegerShortName} instance for the same namespace as the deployment, otherwise, the Operator cannot determine which {JaegerShortName} instance to use. A specific {JaegerShortName} instance name on a deployment has a higher precedence than `true` applied on its namespace. The following snippet shows a simple application that will inject a sidecar, with the agent pointing to the single {JaegerShortName} instance available in the same namespace: @@ -34,6 +34,6 @@ spec: image: acme/myapp:myversion ---- - Set to either the string `true` or to the Jaeger instance name. +<1> Set to either the string `true` or to the Jaeger instance name. When the sidecar is injected, the agent can then be accessed at its default location on `localhost`. diff --git a/modules/distr-tracing-sidecar-manual.adoc b/modules/distr-tracing-sidecar-manual.adoc index a93c782b73e2..1f914ed319cb 100644 --- a/modules/distr-tracing-sidecar-manual.adoc +++ b/modules/distr-tracing-sidecar-manual.adoc @@ -6,9 +6,10 @@ This module included in the following assemblies: [id="distr-tracing-sidecar-manual_{context}"] = Manually injecting sidecars -For controller types other than `Deployments`, such as `StatefulSets`and `DaemonSets`, you can manually define the {JaegerShortName} agent sidecar in your specification. -The following snippet shows the manual definition you can include in your containers section for a {JaegerShortName} agent sidecar: +The {JaegerName} Operator can only automatically inject Jaeger Agent sidecars into Deployment workloads. For controller types other than `Deployments`, such as `StatefulSets`and `DaemonSets`, you can manually define the Jaeger agent sidecar in your specification. + +The following snippet shows the manual definition you can include in your containers section for a Jaeger agent sidecar: .Sidecar definition example for a `StatefulSet` [source,yaml] diff --git a/modules/distr-tracing-upgrading-es5-es6.adoc b/modules/distr-tracing-upgrading-es5-es6.adoc index c4821c313321..d2c0107a0622 100644 --- a/modules/distr-tracing-upgrading-es5-es6.adoc +++ b/modules/distr-tracing-upgrading-es5-es6.adoc @@ -8,7 +8,7 @@ This module included in the following assemblies: When updating from Elasticsearch 5 to 6, you must delete your {JaegerShortName} instance, and then recreate the {JaegerShortName} instance because of an issue with certificates. Re-creating the {JaegerShortName} instance triggers the creation of a new set of certificates. If you are using persistent storage, the same volumes can be mounted for the new {JaegerShortName} instance as long as the {JaegerShortName} name and namespace for the new {JaegerShortName} instance are the same as the deleted {JaegerShortName} instance. -.Procedure if {JaegerShortName} is installed as part of Red Hat Service Mesh +.Procedure if {JaegerShortName} is installed as part of {SMProductName} . Determine the name of your Jaeger custom resource file. In this example, `istio-system` is the control plane namespace. + @@ -54,7 +54,7 @@ $ rm /tmp/jaeger-cr.yaml ---- -.Procedure if {JaegerShortName} not installed as part of Red Hat Service Mesh +.Procedure if {JaegerShortName} not installed as part of {SMProductName} Before you begin, create a copy of your Jaeger custom resource file. diff --git a/modules/jaeger-config-collector.adoc b/modules/jaeger-config-collector.adoc index f263183d0eb5..55a334115b85 100644 --- a/modules/jaeger-config-collector.adoc +++ b/modules/jaeger-config-collector.adoc @@ -52,10 +52,11 @@ The collectors are stateless and thus many instances of Jaeger Collector can be |The `topic` parameter identifies the Kafka configuration used by the collector to produce the messages, and the ingester to consume the messages. |Label for the producer -|kafka: - producer: - brokers: my-cluster-kafka-brokers.kafka:9092 -|Identifies the Kafka configuration used by the Collector to produce the messages. If brokers are not specified, and you have AMQ Streams 1.4.0+ installed, Jaeger will self-provision Kafka. +|options: + kafka: + producer: + brokers: my-cluster-kafka-brokers.kafka:9092 +|Identifies the Kafka configuration used by the Collector to produce the messages. If brokers are not specified, and you have AMQ Streams 1.4.0+ installed, Jaeger will self-provision Kafka. | |log-level: diff --git a/modules/jaeger-config-ingester.adoc b/modules/jaeger-config-ingester.adoc index 1ee0573d5a17..6aacdb072921 100644 --- a/modules/jaeger-config-ingester.adoc +++ b/modules/jaeger-config-ingester.adoc @@ -6,7 +6,7 @@ This REFERENCE module included in the following assemblies: [id="jaeger-config-ingester_{context}"] = Jaeger Ingester configuration options -Ingester is a service that reads from a Kafka topic and writes to another storage backend (Elasticsearch). If you are using the `allInOne` or `production` deployment strategies, you do not need to configure the Ingester service. +Ingester is a service that reads from a Kafka topic and writes to another storage backend (Elasticsearch). If you are using the `allInOne` or `production` deployment strategies, you do not need to configure the Ingester service. .Jaeger parameters passed to the Ingester [options="header"] @@ -23,7 +23,7 @@ Ingester is a service that reads from a Kafka topic and writes to another storag deadlockInterval: |Specifies the interval (in seconds or minutes) that the Ingester should wait for a message before terminating. The deadlock interval is disabled by default (set to 0), to avoid the Ingester being terminated when no messages arrive while the system is being initialized. -|Minutes and seconds, for example, `1m0s`. Default value is `0`. +|Minutes and seconds, for example, `1m0s`. Default value is `0`. |options: kafka: diff --git a/modules/jaeger-config-sampling.adoc b/modules/jaeger-config-sampling.adoc index a1c0a66fb50d..1d6a84c7b4b7 100644 --- a/modules/jaeger-config-sampling.adoc +++ b/modules/jaeger-config-sampling.adoc @@ -8,14 +8,14 @@ This REFERENCE module included in the following assemblies: The Operator can be used to define sampling strategies that will be supplied to tracers that have been configured to use a remote sampler. -While all traces are generated, only a few are sampled. Sampling a trace marks the trace for further processing and storage. +While all traces are generated, only a few are sampled. Sampling a trace marks the trace for further processing and storage. [NOTE] ==== This is not relevant if a trace was started by the Istio proxy as the sampling decision is made there. The Jaeger sampling decision is only relevant when the trace is started by an application using the Jaeger tracer. ==== -When a service receives a request that contains no trace context, the Jaeger tracer will start a new trace, assign it a random trace ID, and make a sampling decision based on the currently installed sampling strategy. The sampling decision is propagated to all subsequent requests in the trace, so that other services are not making the sampling decision again. +When a service receives a request that contains no trace context, the Jaeger tracer will start a new trace, assign it a random trace ID, and make a sampling decision based on the currently installed sampling strategy. The sampling decision is propagated to all subsequent requests in the trace, so that other services are not making the sampling decision again. Jaeger libraries support the following samplers: diff --git a/modules/jaeger-config-storage.adoc b/modules/jaeger-config-storage.adoc index d29eb63e1ae8..55c8924247e0 100644 --- a/modules/jaeger-config-storage.adoc +++ b/modules/jaeger-config-storage.adoc @@ -77,7 +77,7 @@ When the `storage:type` is set to `elasticsearch` but there is no value set for If you already have installed Elasticsearch as part of OpenShift Logging, the Jaeger Operator can use the installed OpenShift Elasticsearch Operator to provision storage. ==== -The following configuration parameters are for a _self-provisioned_ Elasticsearch instance, that is an instance created by the Jaeger Operator using the OpenShift Elasticsearch Operator. You specify configuration options for self-provisioned Elasticsearch under `spec:storage:elasticsearch` in your configuration file. +The following configuration parameters are for a _self-provisioned_ Elasticsearch instance, that is an instance created by the Jaeger Operator using the OpenShift Elasticsearch Operator. You specify configuration options for self-provisioned Elasticsearch under `spec:storage:elasticsearch` in your configuration file. .Elasticsearch resource configuration parameters [options="header"] @@ -200,7 +200,7 @@ You can use an existing Elasticsearch cluster for storage with Jaeger, that is, 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. +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 [options="header"] @@ -239,13 +239,13 @@ The following configuration parameters are for an already existing Elasticsearch |es: sniffer-tls-enabled: -|Option to enable TLS when sniffing an Elasticsearch Cluster, The client uses the sniffing process to find all nodes automatically. Disabled by default +|Option to enable TLS when sniffing an Elasticsearch Cluster. The client uses the sniffing process to find all nodes automatically. Disabled by default |`true`/ `false` |`false` |es: timeout: -|Timeout used for queries. When set to zero there is no timeout. +|Timeout used for queries. When set to zero there is no timeout. | |0s @@ -316,7 +316,7 @@ The following configuration parameters are for an already existing Elasticsearch | |1000 -//What is the default here? The original text said "Set to zero to disable. By default, this is disabled." +//What is the default here? The original text said "Set to zero to disable. By default, this is disabled." |es: bulk: flush-interval: @@ -378,7 +378,7 @@ The following configuration parameters are for an already existing Elasticsearch |Override the expected TLS server name in the certificate of the remote server(s). | | -//Clarification of "if specified" for `token-file` and `username`, does that mean if this is set? Or that it only loads the CA if one is specified (that is, if es.tls.ca has a value?) +//Clarification of "if specified" for `token-file` and `username`, does that mean if this is set? Or that it only loads the CA if one is specified (that is, if es.tls.ca has a value?) |es: token-file: |Path to a file containing the bearer token. This flag also loads the Certification Authority (CA) file if it is specified. @@ -398,7 +398,7 @@ The following configuration parameters are for an already existing Elasticsearch | |0 -//What is the default here? The original text said "Set to zero to disable. By default, this is disabled." +//What is the default here? The original text said "Set to zero to disable. By default, this is disabled." |es-archive: bulk: flush-interval: @@ -488,13 +488,13 @@ The following configuration parameters are for an already existing Elasticsearch |es-archive: sniffer-tls-enabled: -|Option to enable TLS when sniffing an Elasticsearch Cluster, The client uses the sniffing process to find all nodes automatically. Disabled by default. +|Option to enable TLS when sniffing an Elasticsearch Cluster. The client uses the sniffing process to find all nodes automatically. Disabled by default. |`true`/ `false` |`false` |es-archive: timeout: -|Timeout used for queries. When set to zero there is no timeout. +|Timeout used for queries. When set to zero there is no timeout. | |0s @@ -533,7 +533,7 @@ The following configuration parameters are for an already existing Elasticsearch | | -//Clarification of "if specified" for next two rows, does that mean if this is set? Or that it only loads the CA if one is specified (that is, if es-archive.tls.ca has a value?) +//Clarification of "if specified" for next two rows, does that mean if this is set? Or that it only loads the CA if one is specified (that is, if es-archive.tls.ca has a value?) |es-archive: token-file: |Path to a file containing the bearer token. This flag also loads the Certification Authority (CA) file if it is specified. diff --git a/modules/jaeger-deploy-default.adoc b/modules/jaeger-deploy-default.adoc index 3da04508e36d..4dc260030d84 100644 --- a/modules/jaeger-deploy-default.adoc +++ b/modules/jaeger-deploy-default.adoc @@ -10,7 +10,7 @@ The custom resource definition (CRD) defines the configuration used when you dep [NOTE] ==== -In-memory storage is not persistent, which means that if the Jaeger pod shuts down, restarts, or is replaced, that your trace data will be lost. For persistent storage, you must use the `production` or `streaming` strategies, which use Elasticsearch as the default storage. +In-memory storage is not persistent, which means that if the Jaeger pod shuts down, restarts, or is replaced, that your trace data will be lost. For persistent storage, you must use the `production` or `streaming` strategies, which use Elasticsearch as the default storage. ==== @@ -41,7 +41,7 @@ Jaeger streaming is currently unsupported on IBM Z. . Navigate to *Operators* -> *Installed Operators*. -. If necessary, select `jaeger-system` from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project. +. If necessary, select `jaeger-system` from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project. . Click the {JaegerName} Operator. On the *Overview* tab, under *Provided APIs*, the Operator provides a single link. @@ -51,7 +51,7 @@ Jaeger streaming is currently unsupported on IBM Z. . On the *Jaegers* page, click the name of the Jaeger instance, for example, `jaeger-all-in-one-inmemory`. -. On the *Jaeger Details* page, click the *Resources* tab. Wait until the Pod has a status of "Running" before continuing. +. On the *Jaeger Details* page, click the *Resources* tab. Wait until the Pod has a status of "Running" before continuing. [id="jaeger-create-cli_{context}"] diff --git a/modules/jaeger-deploy-production-es.adoc b/modules/jaeger-deploy-production-es.adoc index 47ae4eecfcb1..7dbd701fde61 100644 --- a/modules/jaeger-deploy-production-es.adoc +++ b/modules/jaeger-deploy-production-es.adoc @@ -31,7 +31,7 @@ The `production` deployment strategy is intended for production environments, wh . Navigate to *Operators* -> *Installed Operators*. -. If necessary, select `jaeger-system` from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project. +. If necessary, select `jaeger-system` from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project. . Click the Jaeger Operator. On the *Overview* tab, under *Provided APIs*, the Operator provides a single link. @@ -70,7 +70,7 @@ spec: . On the *Jaegers* page, click the name of the Jaeger instance, for example, `jaeger-prod-elasticsearch`. -. On the *Jaeger Details* page, click the *Resources* tab. Wait until all the pods have a status of "Running" before continuing. +. On the *Jaeger Details* page, click the *Resources* tab. Wait until all the pods have a status of "Running" before continuing. [id="jaeger-deploy-production-cli_{context}"] diff --git a/modules/jaeger-deploy-streaming.adoc b/modules/jaeger-deploy-streaming.adoc index f9d02c4ae4a2..6796b86c6b5e 100644 --- a/modules/jaeger-deploy-streaming.adoc +++ b/modules/jaeger-deploy-streaming.adoc @@ -16,7 +16,7 @@ The streaming strategy requires an additional Red Hat subscription for AMQ Strea ==== .Prerequisites -* The AMQ Streams Operator must be installed. If using version 1.4.0 or higher you can use self-provisioning. If otherwise, you need to create the Kafka instance. +* The AMQ Streams Operator must be installed. If using version 1.4.0 or higher you can use self-provisioning. If otherwise, you need to create the Kafka instance. * The Jaeger Operator must be installed. * Review the instructions for how to customize the Jaeger installation. * An account with the `cluster-admin` role. @@ -42,7 +42,7 @@ Jaeger streaming is currently unsupported on IBM Z. . Navigate to *Operators* -> *Installed Operators*. -. If necessary, select `jaeger-system` from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project. +. If necessary, select `jaeger-system` from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project. . Click the Jaeger Operator. On the *Overview* tab, under *Provided APIs*, the Operator provides a single link. @@ -82,7 +82,7 @@ spec: . On the *Jaegers* page, click the name of the Jaeger instance, for example, `jaeger-streaming`. -. On the *Jaeger Details* page, click the *Resources* tab. Wait until all the pods have a status of "Running" before continuing. +. On the *Jaeger Details* page, click the *Resources* tab. Wait until all the pods have a status of "Running" before continuing. [id="jaeger-deploy-streaming-cli_{context}"] diff --git a/modules/jaeger-deployment-best-practices.adoc b/modules/jaeger-deployment-best-practices.adoc index e14d63cfac2d..ebe97037b820 100644 --- a/modules/jaeger-deployment-best-practices.adoc +++ b/modules/jaeger-deployment-best-practices.adoc @@ -12,6 +12,6 @@ This module included in the following assemblies: * If you have a multitenant implementation and tenants are separated by namespaces, deploy a Jaeger instance to each tenant namespace. -** Jaeger agent as a daemonset is not supported for multitenant installations or OpenShift Dedicated. Jaeger agent as a sidecar is the only supported configuration for these use cases. +** Jaeger agent as a daemonset is not supported for multitenant installations or {product-dedicated}. Jaeger agent as a sidecar is the only supported configuration for these use cases. -* If you are installing Jaeger as part of Red Hat OpenShift Service Mesh, Jaeger resources must be installed in the same namespace as the `ServiceMeshControlPlane` resource. +* If you are installing Jaeger as part of {SMProductName}, Jaeger resources must be installed in the same namespace as the `ServiceMeshControlPlane` resource. diff --git a/modules/jaeger-install.adoc b/modules/jaeger-install.adoc index b827ee1fd6b1..e57d7096ebf9 100644 --- a/modules/jaeger-install.adoc +++ b/modules/jaeger-install.adoc @@ -34,7 +34,7 @@ Do not install Community versions of the Operators. Community Operators are not . Click *Install*. -. On the *Install Operator* page, select the *stable* Update Channel. This will automatically update Jaeger as new versions are released. If you select a maintenance channel, for example, *1.17-stable*, you will receive bug fixes and security patches for the length of the support cycle for that version. +. On the *Install Operator* page, select the *stable* Update Channel. This will automatically update Jaeger as new versions are released. If you select a maintenance channel, for example, *1.17-stable*, you will receive bug fixes and security patches for the length of the support cycle for that version. . Select *All namespaces on the cluster (default)*. This installs the Operator in the default `openshift-operators` project and makes the Operator available to all projects in the cluster. diff --git a/modules/jaeger-rn-fixed-issues.adoc b/modules/jaeger-rn-fixed-issues.adoc index 0be6b28d3e87..25c4cc7d81de 100644 --- a/modules/jaeger-rn-fixed-issues.adoc +++ b/modules/jaeger-rn-fixed-issues.adoc @@ -9,10 +9,10 @@ Module included in the following assemblies: = Jaeger fixed issues //// Provide the following info for each issue if possible: -Consequence - What user action or situation would make this problem appear (If you have the foo option enabled and did x)? What did the customer experience as a result of the issue? What was the symptom? +Consequence - What user action or situation would make this problem appear (If you have the foo option enabled and did x)? What did the customer experience as a result of the issue? What was the symptom? Cause - Why did this happen? Fix - What did we change to fix the problem? -Result - How has the behavior changed as a result? Try to avoid “It is fixed” or “The issue is resolved” or “The error no longer presents”. +Result - How has the behavior changed as a result? Try to avoid “It is fixed” or “The issue is resolved” or “The error no longer presents”. //// * link:https://issues.redhat.com/browse/TRACING-2009[TRACING-2009] The Jaeger Operator has been updated to include support for the Strimzi Kafka Operator 0.23.0. diff --git a/modules/jaeger-rn-known-issues.adoc b/modules/jaeger-rn-known-issues.adoc index ff79f2b2c5e3..232cb364c78c 100644 --- a/modules/jaeger-rn-known-issues.adoc +++ b/modules/jaeger-rn-known-issues.adoc @@ -23,7 +23,7 @@ These limitations exist in Jaeger: These are the known issues in Jaeger: -* link:https://issues.redhat.com/browse/TRACING-2057[TRACING-2057] The Kafka API has been updated to `v1beta2` to support the Strimzi Kafka Operator 0.23.0. However, this API version is not supported by AMQ Streams 1.6.3. If you have the following environment, your Jaeger services will not be upgraded, and you cannot create new Jaeger services or modify existing Jaeger services: +* link:https://issues.redhat.com/browse/TRACING-2057[TRACING-2057] The Kafka API has been updated to `v1beta2` to support the Strimzi Kafka Operator 0.23.0. However, this API version is not supported by AMQ Streams 1.6.3. If you have the following environment, your Jaeger services will not be upgraded, and you cannot create new Jaeger services or modify existing Jaeger services: ** Jaeger Operator channel: *1.17.x stable* or *1.20.x stable* ** AMQ Streams Operator channel: *amq-streams-1.6.x* diff --git a/modules/jaeger-rn-new-features.adoc b/modules/jaeger-rn-new-features.adoc index 20471a7abd63..2e900687ee2c 100644 --- a/modules/jaeger-rn-new-features.adoc +++ b/modules/jaeger-rn-new-features.adoc @@ -9,7 +9,22 @@ Result – If changed, describe the current user experience. //// [id="jaeger-rn-new-features_{context}"] -== New features {JaegerName} 1.24.0 +== New features {ProductName} 1.24.0 + +This release of {ProductName} includes the following new features: + +* Adds support for the Red Hat Elasticsearch Operator 5.0 and 5.1. + +* Adds Elasticsearch rollover support. + +* Adds Elasticsearch tolerations support. + +* Updates the Jaeger Operator to include support for the Strimzi Kafka Operator 0.23.0. A known issue and workaround associated with this update is documented in the "Known Issues" section. + +* This release also addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. + +== New features {ProductName} 1.20.4 +This release of {ProductName} addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes. This release of {JaegerName} includes the following new features: diff --git a/modules/jaeger-rn-technology-preview.adoc b/modules/jaeger-rn-technology-preview.adoc index fe808c3a7636..626ca2c26ace 100644 --- a/modules/jaeger-rn-technology-preview.adoc +++ b/modules/jaeger-rn-technology-preview.adoc @@ -7,8 +7,8 @@ Module included in the following assemblies: = Technology Preview //// Provide the following info for each issue if possible: -Description - Describe the new functionality available to the customer. For enhancements, try to describe as specifically as possible where the customer will see changes. Avoid the word “supports” as in [product] now supports [feature] to avoid customer confusion with full support. Say, for example, “available as a Technology Preview.” -Package - A brief description of what the customer has to install or enable to use the Technology Preview feature. (e.g., available in quickstart.zip on customer portal, JDF website, container on registry, enable option, etc.) +Description -Describe the new functionality available to the customer. For enhancements, try to describe as specifically as possible where the customer will see changes. Avoid the word “supports” as in [product] now supports [feature] to avoid customer confusion with full support. Say, for example, “available as a Technology Preview.” +Package - A brief description of what the customer has to install or enable to use the Technology Preview feature. (e.g., available in quickstart.zip on customer portal, JDF website, container on registry, enable option, etc.) //// [IMPORTANT] @@ -18,6 +18,6 @@ These features provide early access to upcoming product features, enabling custo ==== == {JaegerName} 2.0.0 Technology Preview 1 -When you install the Jaeger Operator you can select a Technology Preview version of Jaeger. This gives you access to clients and infrastructure for exporting tracing data to Jaeger based on the link:https://opentelemetry.io/[OpenTelemetry framework]. Note that this version is not supported for production environments. +When you install the {JaegerName} Operator you can select a Technology Preview version of Jaeger. This gives you access to clients and infrastructure for exporting tracing data to Jaeger based on the link:https://opentelemetry.io/[OpenTelemetry framework]. Note that this version is not supported for production environments. The OpenTelemetry collector allows developers to instrument their code with vendor agnostic APIs, avoiding vendor lock-in and opening the door to a growing ecosystem of observability tooling. diff --git a/modules/jaeger-sidecar-automatic.adoc b/modules/jaeger-sidecar-automatic.adoc index c3b3650ffa0f..95124e48f3a2 100644 --- a/modules/jaeger-sidecar-automatic.adoc +++ b/modules/jaeger-sidecar-automatic.adoc @@ -8,7 +8,7 @@ This PROCEDURE module included in the following assemblies: :pantheon-module-type: PROCEDURE To enable this feature, you add the annotation `sidecar.jaegertracing.io/inject` set to either the string `true` or the Jaeger instance name as returned by `oc get jaegers`. -When you specify `true`, there should be only a single Jaeger instance for the same namespace as the deployment, otherwise, the Operator cannot determine which Jaeger instance to use. A specific Jaeger instance name on a deployment has a higher precedence than `true` applied on its namespace. +When you specify `true`, there should be only a single Jaeger instance for the same namespace as the deployment, otherwise, the Operator cannot determine which Jaeger instance to use. A specific Jaeger instance name on a deployment has a higher precedence than `true` applied on its namespace. The following snippet shows a simple application that will inject a sidecar, with the Jaeger Agent pointing to the single Jaeger instance available in the same namespace: diff --git a/modules/jaeger-sidecar-manual.adoc b/modules/jaeger-sidecar-manual.adoc index b4e5b07edcb1..7d337808ebb5 100644 --- a/modules/jaeger-sidecar-manual.adoc +++ b/modules/jaeger-sidecar-manual.adoc @@ -7,7 +7,7 @@ This PROCEDURE module included in the following assemblies: = Manually injecting sidecars :pantheon-module-type: PROCEDURE -For controller types other than `Deployments` (for example, `StatefulSets`, `DaemonSets`, etc.), you can manually define the Jaeger Agent sidecar in your specification. +For controller types other than `Deployments` (for example, `StatefulSets`, `DaemonSets`, etc.), you can manually define the Jaeger Agent sidecar in your specification. The following snippet shows the manual definition you can include in your containers section for a Jaeger Agent sidecar: diff --git a/modules/jaeger-upgrading-es.adoc b/modules/jaeger-upgrading-es.adoc index 2604ba22f77c..d55355c4bbf3 100644 --- a/modules/jaeger-upgrading-es.adoc +++ b/modules/jaeger-upgrading-es.adoc @@ -6,9 +6,9 @@ This PROCEDURE module included in the following assemblies: [id="upgrading_es5_es6_{context}"] = Upgrading from Elasticsearch 5 to Elasticsearch 6 -When updating from Elasticsearch 5 to Elasticsearch 6, you must delete your Jaeger instance, then recreate the Jaeger instance because of an issue with certificates. Re-creating the Jaeger instance triggers creating a new set of certificates. If you are using persistent storage the same volumes can be mounted for the new Jaeger instance as long as the Jaeger name and namespace for the new Jaeger instance are the same as the deleted Jaeger instance. +When updating from Elasticsearch 5 to Elasticsearch 6, you must delete your Jaeger instance, then recreate the Jaeger instance because of an issue with certificates. Re-creating the Jaeger instance triggers creating a new set of certificates. If you are using persistent storage the same volumes can be mounted for the new Jaeger instance as long as the Jaeger name and namespace for the new Jaeger instance are the same as the deleted Jaeger instance. -.Procedure if Jaeger is installed as part of Red Hat Service Mesh +.Procedure if Jaeger is installed as part of {SMProductName} . Determine the name of your Jaeger custom resource file. In this example, `istio-system` is the control plane namespace. + @@ -54,7 +54,7 @@ $ rm /tmp/jaeger-cr.yaml ---- -.Procedure if Jaeger not installed as part of Red Hat Service Mesh +.Procedure if Jaeger not installed as part of {SMProductName} Before you begin, create a copy of your Jaeger custom resource file.