From 1d842c288a5ffb2b9a79acc8882b16380a84db81 Mon Sep 17 00:00:00 2001
From: "stu126940@mail.uni-kiel.de" <stu126940@mail.uni-kiel.de>
Date: Tue, 1 Dec 2020 13:50:45 +0100
Subject: [PATCH] Enhance documentation

Add information for testing
Add information for naming
---
 execution/helm/README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/execution/helm/README.md b/execution/helm/README.md
index 3330c3112..a497821eb 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
 
-- 
GitLab