From 31b33935fd94179b6bf8795f89af2886a7c41bb0 Mon Sep 17 00:00:00 2001
From: "stu126940@mail.uni-kiel.de" <stu126940@mail.uni-kiel.de>
Date: Mon, 23 Nov 2020 14:01:40 +0100
Subject: [PATCH] Add readme
---
execution/helm/README.md | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
create mode 100644 execution/helm/README.md
diff --git a/execution/helm/README.md b/execution/helm/README.md
new file mode 100644
index 000000000..0d63e7ccf
--- /dev/null
+++ b/execution/helm/README.md
@@ -0,0 +1,32 @@
+# Theodolite Helm Chart
+
+## Installation
+
+```sh
+helm install thedolite ./theodolite-chart
+```
+
+This chart installs requirements to execute benchmarks with theodolite.
+
+Dependencies and sub charts:
+
+- prometheus operator
+- prometheus
+- grafana (incl. dashboard and data source configuration)
+- kafka
+- kafka-client
+- zookeeper
+
+## Development
+
+### Sub charts
+
+Sub-diagrams can be added using a repository or a path to a directory containing the diagram 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.
+
+
+**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)
+ - Escape braces: {{ "{{" topic }}
+ - Let Helm render the template as raw string: {{ `{{ <config>}}` }}
+
\ No newline at end of file
--
GitLab