forked from openshift/openshift-docs
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Distributed tracing 2.9 openshift#62410
- Loading branch information
Showing
108 changed files
with
3,374 additions
and
730 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
../images/ | ||
../../images/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
../modules/ | ||
../../modules/ |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
94 changes: 0 additions & 94 deletions
94
distr_tracing/distr_tracing_install/distr-tracing-deploying-jaeger.adoc
This file was deleted.
Oops, something went wrong.
11 changes: 0 additions & 11 deletions
11
distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
91 changes: 91 additions & 0 deletions
91
distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
:_content-type: ASSEMBLY | ||
[id="distr-tracing-jaeger-configuring"] | ||
= Configuring and deploying the distributed tracing platform Jaeger | ||
include::_attributes/common-attributes.adoc[] | ||
:context: distr-tracing-jaeger-configuring | ||
|
||
toc::[] | ||
|
||
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]. | ||
|
||
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. | ||
|
||
.Jaeger custom resource file showing deployment strategy | ||
[source,yaml] | ||
---- | ||
apiVersion: jaegertracing.io/v1 | ||
kind: Jaeger | ||
metadata: | ||
name: MyConfigFile | ||
spec: | ||
strategy: production <1> | ||
---- | ||
<1> Deployment strategy. | ||
|
||
[id="supported-deployment-strategies"] | ||
== Supported deployment strategies | ||
|
||
The {JaegerName} Operator currently supports the following deployment strategies: | ||
|
||
`allInOne`:: - This strategy is intended for development, testing, and demo purposes; it is not intended for production use. The main backend components, Agent, Collector, and Query service, are all packaged into a single executable which is configured, by default. to use in-memory storage. | ||
+ | ||
[NOTE] | ||
==== | ||
In-memory storage is not persistent, which means that if the {JaegerShortName} 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. | ||
|
||
`streaming`:: The streaming strategy is designed to augment the production strategy by providing a streaming capability that effectively sits between the Collector and the Elasticsearch backend storage. 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]). | ||
+ | ||
[NOTE] | ||
==== | ||
* The streaming strategy requires an additional Red Hat subscription for AMQ Streams. | ||
* The streaming deployment strategy is currently unsupported on {ibmzProductName}. | ||
==== | ||
|
||
include::modules/distr-tracing-deploy-default.adoc[leveloffset=+1] | ||
|
||
include::modules/distr-tracing-deploy-production-es.adoc[leveloffset=+1] | ||
|
||
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=+2] | ||
|
||
[id="customizing-your-deployment"] | ||
== Customizing your deployment | ||
|
||
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. | ||
endif::[] | ||
|
||
include::modules/distr-tracing-config-default.adoc[leveloffset=+2] | ||
|
||
include::modules/distr-tracing-config-jaeger-collector.adoc[leveloffset=+2] | ||
|
||
include::modules/distr-tracing-config-sampling.adoc[leveloffset=+2] | ||
|
||
include::modules/distr-tracing-config-storage.adoc[leveloffset=+2] | ||
|
||
include::modules/distr-tracing-config-query.adoc[leveloffset=+2] | ||
|
||
include::modules/distr-tracing-config-ingester.adoc[leveloffset=+2] | ||
|
||
[id="injecting-sidecars"] | ||
== Injecting sidecars | ||
|
||
The {JaegerName} relies on a proxy sidecar within the application's pod to provide the Agent. The {JaegerName} Operator can inject Agent sidecars into deployment workloads. You can enable automatic sidecar injection or manage it manually. | ||
|
||
include::modules/distr-tracing-sidecar-automatic.adoc[leveloffset=+2] | ||
|
||
include::modules/distr-tracing-sidecar-manual.adoc[leveloffset=+2] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.