You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: charts/jaeger/README.md
+32-30Lines changed: 32 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,15 +12,18 @@ This release is a refactor designed to simplify operation and configuration.
12
12
-**Configuration**: Storage is configured via the `config.extensions.jaeger_storage` section using native Jaeger/OTEL config syntax.
13
13
-**Cassandra Schema**: Jaeger v2 handles schema creation internally. The legacy schema job has been removed.
14
14
-**Service Consolidation**: A single Service now exposes all ports (agent, collector, query).
15
+
-**No provisioned storage**: Dependency charts have been removed. The user must deploy them separately and configure connection using the Otel config Syntax https://github.com/jaegertracing/jaeger/blob/main/cmd/jaeger/config.yaml
15
16
16
17
## Architecture
17
18
18
19
This chart uses the **All-In-One** deployment model.
19
20
-**Single Binary**: Runs as a `Deployment` scalable to multiple replicas.
20
21
-**Stateless**: Can connect to external persistent storage (Elasticsearch, Cassandra) for production use.
21
22
-**Default**: Memory storage (ephemeral), suitable for testing.
23
+
-**Scalable**: Increase replica count to scale horizontally
22
24
23
-
## Overriding the Jaeger Version
25
+
## Overriding the Jaeger Version
26
+
##### (chart only supports Jaever v2+)
24
27
25
28
You can customize the Jaeger image and tag using the following values:
Configure Jaeger to connect to Elasticsearch using the native config syntax.
65
67
66
-
You can either use the internal provisioned elasticsearch or point to an external elasticsearch.
68
+
This chart does not provision an ElasticSearch instance.
67
69
68
-
The internal elasticsearch is configured to __NOT__ require a password or username by default.
70
+
To use ElasticSearch storage, you must provide your own ElasticSearch instance and configure Jaeger via the native config syntax:
69
71
70
-
#### Internal Provisioned Elasticsearch example:
72
+
#### Elasticsearch example:
71
73
72
74
**values.yaml**
73
75
```yaml
74
-
# Use the provisioned Elasticsearch subchart
75
-
provisionDataStore:
76
-
elasticsearch: true
77
-
78
-
config:
79
-
extensions:
80
-
jaeger_query:
81
-
storage:
82
-
traces: primary_store_elasticsearch
83
-
traces_archive: archive_store_elasticsearch
84
-
exporters:
85
-
jaeger_storage_exporter:
86
-
trace_storage: primary_store_elasticsearch
87
-
```
88
-
89
-
#### External Elasticsearch example:
90
-
91
-
**values.yaml**
92
-
```yaml
93
-
# External is very similar but you need to configure the urls
94
-
config:
76
+
userconfig:
95
77
extensions:
96
78
jaeger_query:
97
79
storage:
@@ -119,17 +101,29 @@ config:
119
101
```
120
102
121
103
**Running Maintenance Jobs:**
122
-
To run Index Cleaner or Rollover jobs, enable them. They require configuration if using external by setting ```storage.type=elasticsearch``` and adjusting ```storage.elasticsearch``` values. See that section in values.yaml for more details.
104
+
105
+
To run Index Cleaner or Rollover jobs, enable them.
106
+
They require configuration by adjusting ```storage.elasticsearch``` values. See that section in values.yaml for more details.
123
107
124
108
```yaml
125
109
esIndexCleaner:
126
110
enabled: true
111
+
112
+
storage:
113
+
elasticsearch:
114
+
tls:
115
+
enabled: false
116
+
url: http://elasticsearch-master:9200
117
+
# user: elastic
118
+
# password: changeme
127
119
```
128
120
129
121
* es-rollover __requires__ elasticsearch to be running __BEFORE__ install so the hook job can run.
130
122
131
123
### 3. Cassandra
132
-
This chart does not provision a Cassandra cluster. To use Cassandra storage, you must provide your own Cassandra instance and configure Jaeger via the native config syntax:
124
+
This chart does not provision a Cassandra cluster.
125
+
126
+
To use Cassandra storage, you must provide your own Cassandra instance and configure Jaeger via the native config syntax:
133
127
134
128
**values.yaml Example:**
135
129
```yaml
@@ -158,7 +152,9 @@ To run the Spark dependencies job (for dependency links graph) set ```spark.enab
158
152
159
153
Below is an example of how to set overrides. Please see the values.yaml for more examples:
160
154
161
-
The values are populated under ```storage.elasticsearch``` Please see comments in values.yaml for more details.
155
+
The values are populated under ```storage.elasticsearch``` and ```storage.casandra``` Please see comments in values.yaml for more details.
156
+
157
+
You must choose the storage type with ```storage.type=elasticsearch``` or ```storage.type=cassandra```
162
158
163
159
```yaml
164
160
spark:
@@ -172,7 +168,11 @@ For a full list of supported environment variables, see the [Spark Dependencies
172
168
173
169
### 5. Query UI
174
170
175
-
To enable the query ui, you need to enable the ingress and fill at least one host:
171
+
To access the ui you can either:
172
+
173
+
* enable the ingress and fill at least one host
174
+
* provide your own ingress
175
+
* or port forward ```kubectl port-forward --namespace {{ .Release.Namespace }} $POD_NAME 16686:16686 --address 0.0.0.0``` and access at http://localhost:16686/
176
176
177
177
```yaml
178
178
jaeger:
@@ -182,6 +182,8 @@ jaeger:
182
182
- <fill a host here>
183
183
```
184
184
185
+
You can customize the UI by setting ```uiconfig```. Please see the values.yaml for examples or https://github.com/jaegertracing/jaeger/tree/main/cmd/jaeger
186
+
185
187
## Configuring the Collector
186
188
187
189
The Jaeger v2 configuration is defined in `config` using OpenTelemetry Collector syntax. You can override pipelines, receivers, and processors there.
0 commit comments