mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-06 06:46:26 +01:00
127 lines
3.0 KiB
Plaintext
127 lines
3.0 KiB
Plaintext
////
|
|
This REFERENCE module included in the following assemblies:
|
|
- rhbjaeger-deploying.adoc
|
|
////
|
|
|
|
[id="jaeger-config-default_{context}"]
|
|
= Jaeger default configuration options
|
|
:pantheon-module-type: REFERENCE
|
|
|
|
The Jaeger custom resource (CR) defines the architecture and settings to be used when creating the Jaeger resources. You can modify these parameters to customize your Jaeger implementation to your business needs.
|
|
|
|
.Jaeger generic YAML example
|
|
[source,yaml]
|
|
----
|
|
apiVersion: jaegertracing.io/v1
|
|
kind: Jaeger
|
|
metadata:
|
|
name: name
|
|
spec:
|
|
strategy: <deployment_strategy>
|
|
allInOne:
|
|
options: {}
|
|
resources: {}
|
|
agent:
|
|
options: {}
|
|
resources: {}
|
|
collector:
|
|
options: {}
|
|
resources: {}
|
|
sampling:
|
|
options: {}
|
|
storage:
|
|
type:
|
|
options: {}
|
|
query:
|
|
options: {}
|
|
resources: {}
|
|
ingester:
|
|
options: {}
|
|
resources: {}
|
|
options: {}
|
|
----
|
|
|
|
.Jaeger parameters
|
|
[options="header"]
|
|
|===
|
|
|Parameter |Description |Values |Default value
|
|
|
|
|`apiVersion:`
|
|
|Version of the Application Program Interface to use when creating the object.
|
|
|`jaegertracing.io/v1`
|
|
|`jaegertracing.io/v1`
|
|
|
|
|`kind:`
|
|
|Defines the kind of Kubernetes object to create.
|
|
|`jaeger`
|
|
|
|
|
|
|
|`metadata:`
|
|
|Data that helps uniquely identify the object, including a `name` string, `UID`, and optional `namespace`.
|
|
|
|
|
|OpenShift automatically generates the `UID` and completes the `namespace` with the name of the project where the object is created.
|
|
|
|
|`name:`
|
|
|Name for the object.
|
|
|The name of your Jaeger instance.
|
|
|`jaeger-all-in-one-inmemory`
|
|
|
|
|`spec:`
|
|
|Specification for the object to be created.
|
|
|Contains all of the configuration parameters for your Jaeger instance. When a common definition (for all Jaeger components) is required, it is defined under the spec node. When the definition relates to an individual component, it is placed under the spec/<component> node.
|
|
|N/A
|
|
|
|
|`strategy:`
|
|
|Jaeger deployment strategy
|
|
|`allInOne`, `production`, or `streaming`
|
|
|`allInOne`
|
|
|
|
|`allInOne:`
|
|
|Because the allInOne image deploys the agent, collector, query, ingester, Jaeger UI in a single pod, configuration for this deployment should nest component configuration under the allInOne parameter.
|
|
|
|
|
|
|
|
|
|
|`agent:`
|
|
|Configuration options that define the Jaeger agent.
|
|
|
|
|
|
|
|
|
|
|`collector:`
|
|
|Configuration options that define the Jaeger Collector.
|
|
|
|
|
|
|
|
|
|
|`sampling:`
|
|
|Configuration options that define the sampling strategies for tracing.
|
|
|
|
|
|
|
|
|
|
|`storage:`
|
|
|Configuration options that define the storage. All storage related options should be placed under `storage`, rather than under the `allInOne` or other component options.
|
|
|
|
|
|
|
|
|
|
|`query:`
|
|
|Configuration options that define the Query service.
|
|
|
|
|
|
|
|
|
|
|`ingester:`
|
|
|Configuration options that define the Ingester service.
|
|
|
|
|
|
|
|
|
|
|===
|
|
|
|
|
|
The following example YAML is the minimum required to create a Jaeger instance using the default settings.
|
|
|
|
.Example minimum required jaeger-all-in-one.yaml
|
|
[source,yaml]
|
|
----
|
|
apiVersion: jaegertracing.io/v1
|
|
kind: Jaeger
|
|
metadata:
|
|
name: jaeger-all-in-one-inmemory
|
|
----
|