|
| 1 | + |
| 2 | +--- |
| 3 | + |
| 4 | +# Jaeger Helm-chart Documentation |
| 5 | + |
| 6 | +## Overview |
| 7 | +This documentation provides step-by-step setup and configuration instructions for running Jaeger in various modes, with sections for both the `all-in-one` mode and the `Elasticsearch` configuration, followed by details on optional `--set` flags for custom configurations. |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +### 1. Jaeger All-in-One Mode |
| 12 | + |
| 13 | +Jaeger’s all-in-one mode combines the Jaeger Agent, Collector, and Query into a single pod for simplicity. Use this mode for testing or lightweight deployments. |
| 14 | + |
| 15 | +#### **Command to Run All-in-One** |
| 16 | + |
| 17 | +```bash |
| 18 | +helm install <chart_name> charts/jaeger \ |
| 19 | + --set-file userconfig=path/to/configfile.yaml # Optional: user-specific config |
| 20 | +``` |
| 21 | + |
| 22 | +- **Flags Explained**: |
| 23 | + - `provisionDataStore.cassandra=false`: Disable Cassandra provision. |
| 24 | + - `storage.type=memory`: Use in-memory storage (non-persistent). |
| 25 | + - `allInOne.enabled=true`: Enable the all-in-one Jaeger setup. |
| 26 | + - `agent.enabled=false`, `collector.enabled=false`, `query.enabled=false`: Disable separate components since they’re embedded in all-in-one. |
| 27 | + - `userconfig`: Optional file for additional configuration. |
| 28 | + |
| 29 | + |
| 30 | +--- |
| 31 | + |
| 32 | +### 2. Elasticsearch Mode with Provisioned Data Store |
| 33 | + |
| 34 | +This mode configures Jaeger to store trace data in an Elasticsearch backend, suitable for production-level usage. |
| 35 | + |
| 36 | +#### **Command to Run with Elasticsearch** |
| 37 | + |
| 38 | +1. **Single Master Node Configuration** |
| 39 | + For a basic setup with only one Elasticsearch master node, use this command: |
| 40 | + |
| 41 | + ```bash |
| 42 | + helm install <chart_name> charts/jaeger \ |
| 43 | + --set provisionDataStore.elasticsearch=true \ |
| 44 | + --set allInOne.enabled=false \ |
| 45 | + --set storage.type=elasticsearch \ |
| 46 | + --set elasticsearch.master.masterOnly=false \ |
| 47 | + --set elasticsearch.master.replicaCount=1 \ |
| 48 | + --set elasticsearch.data.replicaCount=0 \ |
| 49 | + --set elasticsearch.coordinating.replicaCount=0 \ |
| 50 | + --set elasticsearch.ingest.replicaCount=0 |
| 51 | + --set agent.enabled=true \ |
| 52 | + --set collector.enabled=true \ |
| 53 | + --set query.enabled=true |
| 54 | + --set-file userconfig=path/to/configfile.yaml # Optional: user-specific config |
| 55 | + ``` |
| 56 | + |
| 57 | +2. **Default Configuration** |
| 58 | + For a more straightforward setup with default Elasticsearch configuration, use: |
| 59 | + |
| 60 | + ```bash |
| 61 | + helm install <chart_name> charts/jaeger \ |
| 62 | + --set provisionDataStore.elasticsearch=true \ |
| 63 | + --set allInOne.enabled=false \ |
| 64 | + --set storage.type=elasticsearch \ |
| 65 | + --set agent.enabled=true \ |
| 66 | + --set collector.enabled=true \ |
| 67 | + --set query.enabled=true |
| 68 | + --set-file userconfig=path/to/configfile.yaml # Optional: user-specific config |
| 69 | + ``` |
| 70 | + |
| 71 | +- **Flags Explained**: |
| 72 | + - `provisionDataStore.cassandra=false`: Disable Cassandra provision. |
| 73 | + - `provisionDataStore.elasticsearch=true`: Enable Elasticsearch as the storage. |
| 74 | + - `storage.type=elasticsearch`: Use Elasticsearch for storage. |
| 75 | + - **Single Master Node Settings** (optional for simplified configuration): |
| 76 | + - `elasticsearch.master.masterOnly=false` |
| 77 | + - `elasticsearch.master.replicaCount=1` |
| 78 | + - `elasticsearch.data.replicaCount=0` |
| 79 | + - `elasticsearch.coordinating.replicaCount=0` |
| 80 | + - `elasticsearch.ingest.replicaCount=0` |
| 81 | + - `userconfig`: Optional file for additional configuration. |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | + |
| 86 | +### 3. Additional `--set` Configuration Options |
| 87 | + |
| 88 | +For custom configurations, the following flags are commonly used. These cover primary Elasticsearch storage settings and additional archive configurations. |
| 89 | + |
| 90 | +#### **Primary Storage Settings** |
| 91 | +- `.Values.config.extensions.jaeger_storage.backends.primary_store.elasticsearch.index_prefix`: Set the prefix for Elasticsearch indices. |
| 92 | +- `.Values.config.extensions.jaeger_storage.backends.primary_store.elasticsearch.host`: Specify the Elasticsearch host. |
| 93 | +- `.Values.config.extensions.jaeger_storage.backends.primary_store.elasticsearch.user`: Username for Elasticsearch authentication. |
| 94 | +- `.Values.config.extensions.jaeger_storage.backends.primary_store.elasticsearch.password`: Password for Elasticsearch authentication. |
| 95 | + |
| 96 | +Here’s the updated documentation with the archive storage settings referenced and with similar flags specified for archive configurations. |
| 97 | + |
| 98 | + |
| 99 | +#### **Archive Storage Settings** |
| 100 | +- Similar flags for archive configurations can be used to manage archived trace data. |
| 101 | + |
| 102 | +The `values.yaml` file shows archive configurations under `jaeger_storage` with the `archive_store` section for Elasticsearch. You can configure these with the following flags: |
| 103 | + |
| 104 | +- `.Values.config.extensions.jaeger_storage.backends.archive_store.elasticsearch.index_prefix` |
| 105 | +- `.Values.config.extensions.jaeger_storage.backends.archive_store.elasticsearch.server_urls` |
| 106 | +- `.Values.config.extensions.jaeger_storage.backends.archive_store.elasticsearch.username` |
| 107 | +- `.Values.config.extensions.jaeger_storage.backends.archive_store.elasticsearch.password` |
| 108 | + |
| 109 | +--- |
0 commit comments