Skip to content
Snippets Groups Projects
Commit ea1cd6f0 authored by Sören Henning's avatar Sören Henning
Browse files

Improve Helm readme

parent 50400c99
No related branches found
No related tags found
1 merge request!60Introduce a Theodolite Helm chart for deploying all dependencies
...@@ -14,18 +14,18 @@ Install the chart: ...@@ -14,18 +14,18 @@ Install the chart:
helm install my-confluent ./theodolite-chart helm install my-confluent ./theodolite-chart
``` ```
**Please note: The execution python scripts uses hard-coded urls, to connect to Kafka and Zookeeper. For that reason, the name of this chart must be `my-confluent`** **Please note: Theodolite uses hard-coded URLs, to connect to Kafka and Zookeeper. For that reason, the name of this chart must be `my-confluent`.** We will change this behavior soon.
This chart installs requirements to execute benchmarks with theodolite. This chart installs requirements to execute benchmarks with theodolite.
Dependencies and subcharts: Dependencies and subcharts:
- prometheus operator - Prometheus Operator
- prometheus - Prometheus
- grafana (incl. dashboard and data source configuration) - Grafana (incl. dashboard and data source configuration)
- kafka - Kafka
- kafka-client - Zookeeper
- zookeeper - A Kafka client pod
## Test ## Test
...@@ -39,7 +39,7 @@ Our test files are located [here](./theodolite-chart/templates/../../theodolite- ...@@ -39,7 +39,7 @@ Our test files are located [here](./theodolite-chart/templates/../../theodolite-
Please note: If a test fails, Helm will stop testing. Please note: If a test fails, Helm will stop testing.
It is possible that the tests are not running successfully at the moment. This is because the Helm tests of the sub chart cp-confluent receive a timeout exception. There is an [issue](https://github.com/confluentinc/cp-helm-charts/issues/318) for this problem on github. It is possible that the tests are not running successfully at the moment. This is because the Helm tests of the subchart cp-confluent receive a timeout exception. There is an [issue](https://github.com/confluentinc/cp-helm-charts/issues/318) for this problem on GitHub.
## Configuration ## Configuration
...@@ -53,12 +53,12 @@ helm install theodolite <path-to-chart> -f one-broker-values.yaml ...@@ -53,12 +53,12 @@ helm install theodolite <path-to-chart> -f one-broker-values.yaml
### Subcharts ### Subcharts
Sub charts can be added using a repository or a path to a directory containing the chart files. Currently we cannot add cp-confluent-chart and the kafka-lag-exporter with a repository URL. This might be possible in the future. The folder [dependencies](./dependencies) contains the required files. Subcharts can be added using a repository or a path to a directory containing the chart files. Currently we cannot add cp-confluent-chart with a repository URL. This might be possible in the future. The folder [dependencies](./dependencies) contains the required files.
**Hints**: **Hints**:
- Grafana configuration: Grafana config maps contains expressions like {{ topic }}. Helm uses the same syntax for template function. More information [here](https://github.com/helm/helm/issues/2798) - Grafana configuration: Grafana ConfigMaps contains expressions like {{ topic }}. Helm uses the same syntax for template function. More information [here](https://github.com/helm/helm/issues/2798)
- Escape braces: {{ "{{" topic }} - Escape braces: {{ "{{" topic }}
- Let Helm render the template as raw string: {{ `{{ <config>}}` }} - Let Helm render the template as raw string: {{ `{{ <config>}}` }}
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment