Skip to content
Snippets Groups Projects
Commit 1d842c28 authored by Benedikt Wetzel's avatar Benedikt Wetzel Committed by Sören Henning
Browse files

Enhance documentation

Add information for testing
Add information for naming
parent 9282dd82
No related branches found
No related tags found
1 merge request!60Introduce a Theodolite Helm chart for deploying all dependencies
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment