diff --git a/execution/helm/README.md b/execution/helm/README.md index fbc772525a1dcc3242fb80e13d157ca48923de3a..9ce98c63e142320a4719690b8943d3774855487c 100644 --- a/execution/helm/README.md +++ b/execution/helm/README.md @@ -5,7 +5,7 @@ Load all dependencies: ```sh -helm dependencies update ./theodolite-chart +helm dependencies update ./theodolite-chart ``` Install the chart: @@ -14,18 +14,18 @@ Install the 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. -Dependencies and sub charts: +Dependencies and subcharts: -- prometheus operator -- prometheus -- grafana (incl. dashboard and data source configuration) -- kafka -- kafka-client -- zookeeper +- Prometheus Operator +- Prometheus +- Grafana (incl. dashboard and data source configuration) +- Kafka +- Zookeeper +- A Kafka client pod ## Test @@ -35,11 +35,11 @@ Test the installation: helm test <release-name> ``` -Our test files are located [here](./theodolite-chart/templates/../../theodolite-chart/templates/tests). Many sub charts have their own tests, these are also executed and are placed in the respective /templates folders. +Our test files are located [here](./theodolite-chart/templates/../../theodolite-chart/templates/tests). Many subcharts have their own tests, these are also executed and are placed in the respective /templates folders. 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 @@ -51,14 +51,14 @@ helm install theodolite <path-to-chart> -f one-broker-values.yaml ## Development -### Sub charts +### 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**: -- 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 }} - Let Helm render the template as raw string: {{ `{{ <config>}}` }} \ No newline at end of file