diff --git a/execution/helm/README.md b/execution/helm/README.md index 3330c31124ffb33c273713898709f8e920121bb8..a497821ebecde748b9c232cf5ea75e578a1212db 100644 --- a/execution/helm/README.md +++ b/execution/helm/README.md @@ -3,9 +3,11 @@ ## Installation ```sh -helm install thedolite ./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`** + This chart installs requirements to execute benchmarks with theodolite. Dependencies and sub charts: @@ -17,9 +19,24 @@ Dependencies and sub charts: - kafka-client - zookeeper +## Test + +Test the installation: + +```sh +helm test <release-name> +``` + +Our test files are located [here](./theodlote-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, helmet will stop testing. + + ## Configuration -In development environments Kubernetes resources are often low. To reduce resource consumption, we provide an `one broker-value.yaml` file. This file can be used with `helm install theodolite <path-to-chart> -f one-broker-values.yaml`. +In development environments Kubernetes resources are often low. To reduce resource consumption, we provide an `one broker-value.yaml` file. This file can be used with: + +```sh +helm install theodolite <path-to-chart> -f one-broker-values.yaml +``` ## Development