diff --git a/CITATION.cff b/CITATION.cff
index 52e6e13286c0ba0aca34005a4d245d73b9869874..4ec1e6c14d466c84478208ecff81e0f24629af0f 100644
--- a/CITATION.cff
+++ b/CITATION.cff
@@ -8,7 +8,7 @@ authors:
given-names: Wilhelm
orcid: "https://orcid.org/0000-0001-6625-4335"
title: Theodolite
-version: "0.4.0"
+version: "0.5.0"
repository-code: "https://github.com/cau-se/theodolite"
license: "Apache-2.0"
doi: "10.1016/j.bdr.2021.100209"
diff --git a/README.md b/README.md
index f2673f4b9ed0c46987963f8b455e19def802db79..804a193df21f3883ecf9a727af5a743b77a9cceb 100644
--- a/README.md
+++ b/README.md
@@ -4,20 +4,17 @@
Theodolite is a framework for benchmarking the horizontal and vertical scalability of stream processing engines. It consists of three modules:
-## Theodolite Benchmarks
-
-Theodolite contains 4 application benchmarks, which are based on typical use cases for stream processing within microservices. For each benchmark, a corresponding workload generator is provided. Currently, this repository provides benchmark implementations for Apache Kafka Streams and Apache Flink. The benchmark sources can be found in [Thedolite benchmarks](benchmarks).
-
-
-## Theodolite Execution Framework
-
-Theodolite aims to benchmark scalability of stream processing engines for real use cases. Microservices that apply stream processing techniques are usually deployed in elastic cloud environments. Hence, Theodolite's cloud-native benchmarking framework deploys its components in a cloud environment, orchestrated by Kubernetes. More information on how to execute scalability benchmarks can be found in [Thedolite execution framework](execution).
+## Theodolite Benchmarking Tool
+Theodolite aims to benchmark scalability of stream processing engines for real use cases. Microservices that apply stream processing techniques are usually deployed in elastic cloud environments. Hence, Theodolite's cloud-native benchmarking framework deploys its components in a cloud environment, orchestrated by Kubernetes. It is recommended to install Theodolite with the package manager Helm. The Theodolite Helm chart along with instructions how to install it can be found in the [`helm`](helm) directory.
## Theodolite Analysis Tools
-Theodolite's benchmarking method creates a *scalability graph* allowing to draw conclusions about the scalability of a stream processing engine or its deployment. A scalability graph shows how resource demand evolves with an increasing workload. Theodolite provides Jupyter notebooks for creating such scalability graphs based on benchmarking results from the execution framework. More information can be found in [Theodolite analysis tool](analysis).
+Theodolite's benchmarking method maps load intensities to the resource amounts that are required for processing them. A plot showing how resource demand evolves with an increasing load allows to draw conclusions about the scalability of a stream processing engine or its deployment. Theodolite provides Jupyter notebooks for creating such plots based on benchmarking results from the execution framework. More information can be found in [Theodolite analysis tool](analysis).
+
+## Theodolite Benchmarks
+Theodolite comes with 4 application benchmarks, which are based on typical use cases for stream processing within microservices. For each benchmark, a corresponding load generator is provided. Currently, this repository provides benchmark implementations for Apache Kafka Streams and Apache Flink. The benchmark sources can be found in [Thedolite benchmarks](theodolite-benchmarks).
## How to Cite
diff --git a/analysis/demand-metric-plot.ipynb b/analysis/demand-metric-plot.ipynb
index 90ef227dbf6a4566760329b615d5f59b4cc2bc25..71e08f0590f819a63b1bdd6bf13b57ac665f65bc 100644
--- a/analysis/demand-metric-plot.ipynb
+++ b/analysis/demand-metric-plot.ipynb
@@ -1,22 +1,22 @@
{
"cells": [
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"# Theodolite Analysis - Plotting the Demand Metric\n",
"\n",
"This notebook creates a plot, showing scalability as a function that maps load intensities to the resources required for processing them. It is able to combine multiple such plots in one figure, for example, to compare multiple systems or configurations.\n",
"\n",
"The notebook takes a CSV file for each plot mapping load intensities to minimum required resources, computed by the `demand-metric-plot.ipynb` notebook."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"First, we need to import some libraries, which are required for creating the plots."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -33,11 +33,11 @@
]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"We need to specify the directory, where the demand CSV files can be found, and a dictionary that maps a system description (e.g. its name) to the corresponding CSV file (prefix). To use Unicode narrow non-breaking spaces in the description format it as `u\"1000\\u202FmCPU\"`."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -53,11 +53,11 @@
]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"Now, we combie all systems described in `experiments`."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -71,11 +71,11 @@
]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"We might want to display the mappings before we plot it."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -87,11 +87,11 @@
]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"The following code creates a MatPlotLib figure showing the scalability plots for all specified systems. You might want to adjust its styling etc. according to your preferences. Make sure to also set a filename."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -149,27 +149,33 @@
}
],
"metadata": {
+ "file_extension": ".py",
+ "interpreter": {
+ "hash": "e9e076445e1891a25f59b525adcc71b09846b3f9cf034ce4147fc161b19af121"
+ },
+ "kernelspec": {
+ "display_name": "Python 3.8.10 64-bit ('.venv': venv)",
+ "name": "python3"
+ },
"language_info": {
- "name": "python",
"codemirror_mode": {
"name": "ipython",
"version": 3
},
- "version": "3.8.5-final"
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.8.10"
},
- "orig_nbformat": 2,
- "file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"npconvert_exporter": "python",
+ "orig_nbformat": 2,
"pygments_lexer": "ipython3",
- "version": 3,
- "kernelspec": {
- "name": "python37064bitvenvvenv6c432ee1239d4f3cb23f871068b0267d",
- "display_name": "Python 3.7.0 64-bit ('.venv': venv)",
- "language": "python"
- }
+ "version": 3
},
"nbformat": 4,
"nbformat_minor": 2
-}
\ No newline at end of file
+}
diff --git a/analysis/demand-metric.ipynb b/analysis/demand-metric.ipynb
index bcea129b7cb07465fa99f32b6f8b2b6115e8a0aa..fbf3ee02960a1e06457eef5dda96cb6d0a1a75ac 100644
--- a/analysis/demand-metric.ipynb
+++ b/analysis/demand-metric.ipynb
@@ -1,6 +1,8 @@
{
"cells": [
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"# Theodolite Analysis - Demand Metric\n",
"\n",
@@ -9,11 +11,11 @@
"Theodolite's *demand* metric is a function, mapping load intensities to the minimum required resources (e.g., instances) that are required to process this load. With this notebook, the *demand* metric function is approximated by a map of tested load intensities to their minimum required resources.\n",
"\n",
"The final output when running this notebook will be a CSV file, providig this mapping. It can be used to create nice plots of a system's scalability using the `demand-metric-plot.ipynb` notebook."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"In the following cell, we need to specifiy:\n",
"\n",
@@ -22,9 +24,7 @@
"* `max_lag_trend_slope`: The maximum tolerable increase in queued messages per second.\n",
"* `measurement_dir`: The directory where the measurement data files are to be found.\n",
"* `results_dir`: The directory where the computed demand CSV files are to be stored."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -40,11 +40,11 @@
]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"With the following call, we compute our demand mapping."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -58,11 +58,11 @@
]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"We might already want to plot a simple visualization here:"
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -74,11 +74,11 @@
]
},
{
+ "cell_type": "markdown",
+ "metadata": {},
"source": [
"Finally we store the results in a CSV file."
- ],
- "cell_type": "markdown",
- "metadata": {}
+ ]
},
{
"cell_type": "code",
@@ -93,27 +93,33 @@
}
],
"metadata": {
+ "file_extension": ".py",
+ "interpreter": {
+ "hash": "e9e076445e1891a25f59b525adcc71b09846b3f9cf034ce4147fc161b19af121"
+ },
+ "kernelspec": {
+ "display_name": "Python 3.8.10 64-bit ('.venv': venv)",
+ "name": "python3"
+ },
"language_info": {
- "name": "python",
"codemirror_mode": {
"name": "ipython",
"version": 3
},
- "version": "3.8.5-final"
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.8.10"
},
- "orig_nbformat": 2,
- "file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"npconvert_exporter": "python",
+ "orig_nbformat": 2,
"pygments_lexer": "ipython3",
- "version": 3,
- "kernelspec": {
- "name": "python37064bitvenvvenv6c432ee1239d4f3cb23f871068b0267d",
- "display_name": "Python 3.7.0 64-bit ('.venv': venv)",
- "language": "python"
- }
+ "version": 3
},
"nbformat": 4,
"nbformat_minor": 2
-}
\ No newline at end of file
+}
diff --git a/analysis/src/demand.py b/analysis/src/demand.py
index dfb20c05af8e9a134eedd2cdb584c961a82369f5..2178ab7c5dc5f7e4c04ebb58d4c14c9bf8b1aeff 100644
--- a/analysis/src/demand.py
+++ b/analysis/src/demand.py
@@ -1,59 +1,51 @@
import os
from datetime import datetime, timedelta, timezone
import pandas as pd
+from pandas.core.frame import DataFrame
from sklearn.linear_model import LinearRegression
def demand(exp_id, directory, threshold, warmup_sec):
raw_runs = []
- # Compute SL, i.e., lag trend, for each tested configuration
- filenames = [filename for filename in os.listdir(directory) if filename.startswith(f"exp{exp_id}") and filename.endswith("totallag.csv")]
+ # Compute SLI, i.e., lag trend, for each tested configuration
+ filenames = [filename for filename in os.listdir(directory) if filename.startswith(f"exp{exp_id}") and "lag-trend" in filename and filename.endswith(".csv")]
for filename in filenames:
- #print(filename)
run_params = filename[:-4].split("_")
- dim_value = run_params[2]
- instances = run_params[3]
+ dim_value = run_params[1]
+ instances = run_params[2]
df = pd.read_csv(os.path.join(directory, filename))
- #input = df.loc[df['topic'] == "input"]
input = df
- #print(input)
+
input['sec_start'] = input.loc[0:, 'timestamp'] - input.iloc[0]['timestamp']
- #print(input)
- #print(input.iloc[0, 'timestamp'])
+
regress = input.loc[input['sec_start'] >= warmup_sec] # Warm-Up
- #regress = input
- #input.plot(kind='line',x='timestamp',y='value',color='red')
- #plt.show()
+ X = regress.iloc[:, 1].values.reshape(-1, 1) # values converts it into a numpy array
+ Y = regress.iloc[:, 2].values.reshape(-1, 1) # -1 means that calculate the dimension of rows, but have 1 column
- X = regress.iloc[:, 2].values.reshape(-1, 1) # values converts it into a numpy array
- Y = regress.iloc[:, 3].values.reshape(-1, 1) # -1 means that calculate the dimension of rows, but have 1 column
linear_regressor = LinearRegression() # create object for the class
linear_regressor.fit(X, Y) # perform linear regression
Y_pred = linear_regressor.predict(X) # make predictions
trend_slope = linear_regressor.coef_[0][0]
- #print(linear_regressor.coef_)
row = {'load': int(dim_value), 'resources': int(instances), 'trend_slope': trend_slope}
- #print(row)
raw_runs.append(row)
runs = pd.DataFrame(raw_runs)
- # Set suitable = True if SLOs are met, i.e., lag trend is below threshold
- runs["suitable"] = runs.apply(lambda row: row['trend_slope'] < threshold, axis=1)
-
- # Sort results table (unsure if required)
- runs.columns = runs.columns.str.strip()
- runs.sort_values(by=["load", "resources"])
+ # Group by the load and resources to handle repetitions, and take from the reptitions the median
+ # for even reptitions, the mean of the two middle values is used
+ medians = runs.groupby(by=['load', 'resources'], as_index=False).median()
- # Filter only suitable configurations
- filtered = runs[runs.apply(lambda x: x['suitable'], axis=1)]
-
- # Compute demand per load intensity
- grouped = filtered.groupby(['load'])['resources'].min()
- demand_per_load = grouped.to_frame().reset_index()
+ # Set suitable = True if SLOs are met, i.e., lag trend slope is below threshold
+ medians["suitable"] = medians.apply(lambda row: row['trend_slope'] < threshold, axis=1)
+ suitable = medians[medians.apply(lambda x: x['suitable'], axis=1)]
+
+ # Compute minimal demand per load intensity
+ demand_per_load = suitable.groupby(by=['load'], as_index=False)['resources'].min()
+
return demand_per_load
+
diff --git a/codemeta.json b/codemeta.json
index 5696996592f63bf8ece23239d8204e0f25b9cce1..fd2fbe137fc4f8e854452998c62ee988829693fb 100644
--- a/codemeta.json
+++ b/codemeta.json
@@ -8,7 +8,7 @@
"dateModified": "2021-03-18",
"downloadUrl": "https://github.com/cau-se/theodolite/releases",
"name": "Theodolite",
- "version": "0.4.0",
+ "version": "0.5.0",
"description": "Theodolite is a framework for benchmarking the horizontal and vertical scalability of stream processing engines.",
"developmentStatus": "active",
"referencePublication": "https://doi.org/10.1016/j.bdr.2021.100209",
diff --git a/docs/README.md b/docs/README.md
index 4fd13bdfc157efe8b3491695bb83972f96a82c5d..eb0848d52ec4235c6325ba0a373ea2628e52a102 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -10,16 +10,20 @@ permalink: /
Theodolite is a framework for benchmarking the horizontal and vertical scalability of stream processing engines. It consists of three modules:
-## Theodolite Benchmarks
+## Theodolite Benchmarking Tool
-Theodolite contains 4 application benchmarks, which are based on typical use cases for stream processing within microservices. For each benchmark, a corresponding workload generator is provided. Currently, this repository provides benchmark implementations for Kafka Streams.
+Theodolite aims to benchmark scalability of stream processing engines for real use cases. Microservices that apply stream processing techniques are usually deployed in elastic cloud environments. Hence, Theodolite's cloud-native benchmarking framework deploys its components in a cloud environment, orchestrated by Kubernetes. It is recommended to install Theodolite with the package manager Helm. The Theodolite Helm chart along with instructions how to install it can be found in the [`helm`](helm) directory.
+## Theodolite Analysis Tools
-## Theodolite Execution Framework
+Theodolite's benchmarking method maps load intensities to the resource amounts that are required for processing them. A plot showing how resource demand evolves with an increasing load allows to draw conclusions about the scalability of a stream processing engine or its deployment. Theodolite provides Jupyter notebooks for creating such plots based on benchmarking results from the execution framework. More information can be found in [Theodolite analysis tool](analysis).
-Theodolite aims to benchmark scalability of stream processing engines for real use cases. Microservices that apply stream processing techniques are usually deployed in elastic cloud environments. Hence, Theodolite's cloud-native benchmarking framework deploys as components in a cloud environment, orchestrated by Kubernetes. More information on how to execute scalability benchmarks can be found in [Thedolite execution framework](execution).
+## Theodolite Benchmarks
+Theodolite comes with 4 application benchmarks, which are based on typical use cases for stream processing within microservices. For each benchmark, a corresponding load generator is provided. Currently, this repository provides benchmark implementations for Apache Kafka Streams and Apache Flink. The benchmark sources can be found in [Thedolite benchmarks](theodolite-benchmarks).
-## Theodolite Analysis Tools
+## How to Cite
+
+If you use Theodolite, please cite
-Theodolite's benchmarking method create a *scalability graph* allowing to draw conclusions about the scalability of a stream processing engine or its deployment. A scalability graph shows how resource demand evolves with an increasing workload. Theodolite provides Jupyter notebooks for creating such scalability graphs based on benchmarking results from the execution framework. More information can be found in [Theodolite analysis tool](analysis).
+> Sören Henning and Wilhelm Hasselbring. (2021). Theodolite: Scalability Benchmarking of Distributed Stream Processing Engines in Microservice Architectures. Big Data Research, Volume 25. DOI: [10.1016/j.bdr.2021.100209](https://doi.org/10.1016/j.bdr.2021.100209). arXiv:[2009.00304](https://arxiv.org/abs/2009.00304).
diff --git a/docs/index.yaml b/docs/index.yaml
index 087124d158794e1b48dfc880e26da2c91d78808f..635cf8e5fe879cd89927b1b7d87ae621187b3e94 100644
--- a/docs/index.yaml
+++ b/docs/index.yaml
@@ -1,6 +1,41 @@
apiVersion: v1
entries:
theodolite:
+ - apiVersion: v2
+ appVersion: 0.5.0
+ created: "2021-11-04T17:45:14.153231798+01:00"
+ dependencies:
+ - condition: grafana.enabled
+ name: grafana
+ repository: https://grafana.github.io/helm-charts
+ version: 6.0.0
+ - condition: kube-prometheus-stack.enabled
+ name: kube-prometheus-stack
+ repository: https://prometheus-community.github.io/helm-charts
+ version: 12.0.0
+ - condition: cp-helm-charts.enabled
+ name: cp-helm-charts
+ repository: https://soerenhenning.github.io/cp-helm-charts
+ version: 0.6.0
+ - condition: kafka-lag-exporter.enabled
+ name: kafka-lag-exporter
+ repository: https://lightbend.github.io/kafka-lag-exporter/repo/
+ version: 0.6.6
+ description: Theodolite is a framework for benchmarking the scalability stream
+ processing engines.
+ digest: 8a4f218e44341eb8fb09ddc58c6aaa0a14aded685f3423088c21fe0ffc112281
+ home: https://cau-se.github.io/theodolite
+ maintainers:
+ - email: soeren.henning@email.uni-kiel.de
+ name: Sören Henning
+ url: https://www.se.informatik.uni-kiel.de/en/team/soeren-henning-m-sc
+ name: theodolite
+ sources:
+ - https://github.com/cau-se/theodolite
+ type: application
+ urls:
+ - https://github.com/cau-se/theodolite/releases/download/v0.5.0/theodolite-0.5.0.tgz
+ version: 0.5.0
- apiVersion: v2
appVersion: 0.4.0
created: "2021-03-18T15:50:50.930902088+01:00"
@@ -36,4 +71,4 @@ entries:
urls:
- https://github.com/cau-se/theodolite/releases/download/v0.4.0/theodolite-0.4.0.tgz
version: 0.4.0
-generated: "2021-03-18T15:50:50.897801281+01:00"
+generated: "2021-11-04T17:45:14.120866992+01:00"
diff --git a/docs/release-process.md b/docs/release-process.md
index 981306b0762e43eacb29a434cc1e505593548fce..103d8d1ac65472459bcaad648f921240eaf508c8 100644
--- a/docs/release-process.md
+++ b/docs/release-process.md
@@ -18,8 +18,11 @@ again be merged into master.
3. Update all references to artifacts which are versioned. This includes:
- 1. Update all references to Theodolite Docker images to tag `v0.3.1`. These are the Kubernetes resource definitions in
-`execution`, the references to *latest* in `run_uc.py`, the Docker Compose files in `theodolite-benchmarks/docker-test` and the example `theodolite.yaml` job.
+ 1. Update all references to Theodolite Docker images to tag `v0.3.1`. These are:
+ 1. the default `helm/values.yaml` file,
+ 2. the example `execution/theodolite.yaml` job,
+ 3. the Kubernetes benchmark resources in `theodolite-benchmarks/definitions/**/resources` and
+ 2. the Docker Compose files in `theodolite-benchmarks/docker-test`.
2. Update both, the `version` and the `appVersion` fields, in the Helm `Charts.yaml` file to `0.3.1`.
diff --git a/execution/.gitignore b/execution/.gitignore
deleted file mode 100644
index bac9a5d1eeb12d9e40d38376904e8fb69c0e5231..0000000000000000000000000000000000000000
--- a/execution/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-exp_counter.txt
-results
diff --git a/helm/Chart.yaml b/helm/Chart.yaml
index b09b4022d6727029311815b3b2b1bfcf4b4d2bd1..0e56a156832ed6f9159f436ec63f825d132e8dd3 100644
--- a/helm/Chart.yaml
+++ b/helm/Chart.yaml
@@ -13,11 +13,11 @@ type: application
dependencies:
- name: grafana
- version: 6.0.0
+ version: 6.17.5
repository: https://grafana.github.io/helm-charts
condition: grafana.enabled
- name: kube-prometheus-stack
- version: 12.0.0
+ version: 20.0.1
repository: https://prometheus-community.github.io/helm-charts
condition: kube-prometheus-stack.enabled
- name: cp-helm-charts
@@ -25,10 +25,10 @@ dependencies:
repository: https://soerenhenning.github.io/cp-helm-charts
condition: cp-helm-charts.enabled
- name: kafka-lag-exporter
- version: 0.6.6
+ version: 0.6.7
repository: https://lightbend.github.io/kafka-lag-exporter/repo/
condition: kafka-lag-exporter.enabled
-version: 0.5.0-SNAPSHOT
+version: 0.6.0-SNAPSHOT
-appVersion: 0.5.0-SNAPSHOT
+appVersion: 0.6.0-SNAPSHOT
diff --git a/helm/README.md b/helm/README.md
index 40651d605a020c74fc75650c4709ca5a2dd41a50..fe5c15e6fd52122d52c016bff62b8a33e2a22018 100644
--- a/helm/README.md
+++ b/helm/README.md
@@ -2,55 +2,49 @@
## Installation
-Install the chart via:
+The Theodolite Helm chart with all its dependencies can be installed via:
```sh
helm dependencies update .
helm install theodolite .
```
-This chart installs requirements to execute benchmarks with Theodolite.
+Additionally, a PersistentVolumeClaim with the name `theodolite-pv-claim` needs to be created or the results volume can be disabled as done with the minimal configuration, described below.
-Dependencies and subcharts:
+## Customize Installation
-- Prometheus Operator
-- Prometheus
-- Grafana (incl. dashboard and data source configuration)
-- Kafka
-- Zookeeper
-- A Kafka client pod
+As usual, the installation with Helm can be configured by passing a values YAML file:
-## Test
-
-Test the installation:
-
-```sh
-helm test theodolite
+```
+helm install theodolite . -f <your-config.yaml>
```
-Our test files are located [here](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.
+We provide a minimal configuration, especially suited for development environments, with the `preconfigs/minimal.yaml`
+file.
-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.
+Per default, Helm installs the Theodolite CRDs used for the operator. If Theodolite will not be used as operator or if
+the CRDs are already installed, you can skip their installation by adding the flag `--skip-crds`.
-## Configuration
+## Test Installation
-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:
+Test the installation with:
```sh
-helm install theodolite . -f preconfigs/one-broker-values.yaml
+helm test theodolite
```
+Our test files are located [here](templates/tests). Many subcharts have their own tests, which are also executed.
+Please note: If a test fails, Helm will stop testing.
+
## Uninstall this Chart
-To uninstall/delete the `theodolite` deployment:
+The Theodolite Helm can easily be removed with:
```sh
helm uninstall theodolite
```
-This command does not remove the CRDs which are created by this chart. Remove them manually with:
+Helm does not remove any CRDs created by this chart. You can remove them manually with:
```sh
# CRDs from Theodolite
@@ -69,9 +63,20 @@ kubectl delete crd thanosrulers.monitoring.coreos.com
## Development
-**Hints**:
+### Dependencies
+
+The following 3rd party charts are used by Theodolite:
+
+- Kube Prometheus Stack (to install the Prometheus Operator, which is used to create a Prometheus instances)
+- Grafana (including a dashboard and a data source configuration)
+- Confluent Platform (for Kafka and Zookeeper)
+- Kafka Lag Exporter (used to collect monitoring data of the Kafka lag)
+
+### Hints
+
+#### Grafana
-- 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)
+Grafana ConfigMaps contain 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
diff --git a/helm/crds/benchmark.yaml b/helm/crds/benchmark.yaml
new file mode 120000
index 0000000000000000000000000000000000000000..fb100de7a1407462bfb6488a54b7f70014a58474
--- /dev/null
+++ b/helm/crds/benchmark.yaml
@@ -0,0 +1 @@
+./../../theodolite/crd/crd-benchmark.yaml
\ No newline at end of file
diff --git a/helm/crds/execution.yaml b/helm/crds/execution.yaml
new file mode 120000
index 0000000000000000000000000000000000000000..62d268c23c391cd7bbfbaffeaee8af1697dc446a
--- /dev/null
+++ b/helm/crds/execution.yaml
@@ -0,0 +1 @@
+./../../theodolite/crd/crd-execution.yaml
\ No newline at end of file
diff --git a/helm/preconfigs/minimal.yaml b/helm/preconfigs/minimal.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..b0828c2f424e8456933dc626a66a199cd60aa5da
--- /dev/null
+++ b/helm/preconfigs/minimal.yaml
@@ -0,0 +1,12 @@
+cp-helm-charts:
+ cp-zookeeper:
+ servers: 1
+
+ cp-kafka:
+ brokers: 1
+ configurationOverrides:
+ offsets.topic.replication.factor: "1"
+
+operator:
+ resultsVolume:
+ enabled: false
diff --git a/helm/preconfigs/one-broker-values.yaml b/helm/preconfigs/one-broker-values.yaml
deleted file mode 100644
index c53c1f1eb8bc7a17f192d70a6f10f8cacc09c98f..0000000000000000000000000000000000000000
--- a/helm/preconfigs/one-broker-values.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-cp-helm-charts:
- ## ------------------------------------------------------
- ## Zookeeper
- ## ------------------------------------------------------
- cp-zookeeper:
- servers: 1 # default: 3
-
- ## ------------------------------------------------------
- ## Kafka
- ## ------------------------------------------------------
- cp-kafka:
- brokers: 1 # default: 10
-
- configurationOverrides:
- offsets.topic.replication.factor: "1"
\ No newline at end of file
diff --git a/helm/templates/theodolite/crd-benchmark.yaml b/helm/templates/theodolite/crd-benchmark.yaml
deleted file mode 100644
index 084480e1f9e2ef827fb145cd823bbd2f68a20bac..0000000000000000000000000000000000000000
--- a/helm/templates/theodolite/crd-benchmark.yaml
+++ /dev/null
@@ -1,119 +0,0 @@
-{{- if .Values.operator.benchmarkCRD.create -}}
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- name: benchmarks.theodolite.com
-spec:
- group: theodolite.com
- names:
- kind: benchmark
- plural: benchmarks
- shortNames:
- - bench
- versions:
- - name: v1
- served: true
- storage: true
- schema:
- openAPIV3Schema:
- type: object
- required: ["spec"]
- properties:
- spec:
- type: object
- required: []
- properties:
- name:
- type: string
- appResource:
- type: array
- minItems: 1
- items:
- type: string
- loadGenResource:
- type: array
- minItems: 1
- items:
- type: string
- resourceTypes:
- type: array
- minItems: 1
- items:
- type: object
- properties:
- typeName:
- type: string
- patchers:
- type: array
- minItems: 1
- items:
- type: object
- properties:
- type:
- type: string
- default: ""
- resource:
- type: string
- default: ""
- properties:
- type: object
- additionalProperties: true
- x-kubernetes-map-type: "granular"
- default: {}
- loadTypes:
- type: array
- minItems: 1
- items:
- type: object
- properties:
- typeName:
- type: string
- patchers:
- type: array
- minItems: 1
- items:
- type: object
- properties:
- type:
- type: string
- default: ""
- resource:
- type: string
- default: ""
- properties:
- type: object
- additionalProperties: true
- x-kubernetes-map-type: "granular"
- default: {}
- kafkaConfig:
- type: object
- properties:
- bootstrapServer:
- type: string
- topics:
- type: array
- minItems: 1
- items:
- type: object
- required: []
- properties:
- name:
- type: string
- default: ""
- numPartitions:
- type: integer
- default: 0
- replicationFactor:
- type: integer
- default: 0
- removeOnly:
- type: boolean
- default: false
- additionalPrinterColumns:
- - name: Age
- type: date
- jsonPath: .metadata.creationTimestamp
- subresources:
- status: {}
- scope: Namespaced
-{{- end }}
diff --git a/helm/templates/theodolite/crd-execution.yaml b/helm/templates/theodolite/crd-execution.yaml
deleted file mode 100644
index 163835e9b37aca774983d4f019cc61d4bde06510..0000000000000000000000000000000000000000
--- a/helm/templates/theodolite/crd-execution.yaml
+++ /dev/null
@@ -1,133 +0,0 @@
-{{- if .Values.operator.executionCRD.create -}}
-apiVersion: apiextensions.k8s.io/v1
-kind: CustomResourceDefinition
-metadata:
- name: executions.theodolite.com
-spec:
- group: theodolite.com
- names:
- kind: execution
- plural: executions
- shortNames:
- - exec
- versions:
- - name: v1
- served: true
- storage: true
- schema:
- openAPIV3Schema:
- type: object
- required: ["spec"]
- properties:
- spec:
- type: object
- required: ["benchmark", "load", "resources", "slos", "execution", "configOverrides"]
- properties:
- name:
- type: string
- default: ""
- benchmark:
- type: string
- load: # definition of the load dimension
- type: object
- required: ["loadType", "loadValues"]
- properties:
- loadType:
- type: string
- loadValues:
- type: array
- items:
- type: integer
- resources: # definition of the resource dimension
- type: object
- required: ["resourceType", "resourceValues"]
- properties:
- resourceType:
- type: string
- resourceValues:
- type: array
- items:
- type: integer
- slos: # def of service level objectives
- type: array
- items:
- type: object
- required: ["sloType", "prometheusUrl", "offset"]
- properties:
- sloType:
- description: The type of the SLO. It must match 'lag trend'.
- type: string
- prometheusUrl:
- description: Connection string for Promehteus.
- type: string
- offset:
- description: Hours by which the start and end timestamp will be shifted (for different timezones).
- type: integer
- properties:
- description: (Optional) SLO specific additional arguments.
- type: object
- additionalProperties: true
- x-kubernetes-map-type: "granular"
- default: {}
- execution: # def execution config
- type: object
- required: ["strategy", "duration", "repetitions", "restrictions"]
- properties:
- strategy:
- type: string
- duration:
- type: integer
- repetitions:
- type: integer
- loadGenerationDelay:
- type: integer
- restrictions:
- type: array
- items:
- type: string
- configOverrides:
- type: array
- items:
- type: object
- properties:
- patcher:
- type: object
- properties:
- type:
- type: string
- default: ""
- resource:
- type: string
- default: ""
- properties:
- type: object
- additionalProperties: true
- x-kubernetes-map-type: "granular"
- default: {}
- value:
- type: string
- status:
- type: object
- properties:
- executionState:
- description: ""
- type: string
- executionDuration:
- description: "Duration of the execution in seconds"
- type: string
- additionalPrinterColumns:
- - name: STATUS
- type: string
- description: State of the execution
- jsonPath: .status.executionState
- - name: Duration
- type: string
- description: Duration of the execution
- jsonPath: .status.executionDuration
- - name: Age
- type: date
- jsonPath: .metadata.creationTimestamp
- subresources:
- status: {}
- scope: Namespaced
-{{- end }}
diff --git a/helm/templates/theodolite/random-scheduler/deployment.yaml b/helm/templates/theodolite/random-scheduler/deployment.yaml
index a1ea535d52d3dce971806dd638a90e9acb81c5d0..55b6e4ad5f8fafccc9623e69ef1df1fccf81ed39 100644
--- a/helm/templates/theodolite/random-scheduler/deployment.yaml
+++ b/helm/templates/theodolite/random-scheduler/deployment.yaml
@@ -22,8 +22,8 @@ spec:
serviceAccount: {{ include "theodolite.fullname" . }}-random-scheduler
containers:
- name: random-scheduler
- image: ghcr.io/cau-se/theodolite-random-scheduler:latest
- #imagePullPolicy: Always
+ image: "{{ .Values.randomScheduler.image }}:{{ .Values.randomScheduler.imageTag }}"
+ imagePullPolicy: "{{ .Values.randomScheduler.imagePullPolicy }}"
env:
- name: TARGET_NAMESPACE
value: {{ .Release.Namespace }}
diff --git a/helm/templates/theodolite/role-binding.yaml b/helm/templates/theodolite/role-binding.yaml
index 93d8c34e7bc544c3b0c231e986bc58c792cce38e..3b327bb246f9716be0939416db55fc1b2cc5dd70 100644
--- a/helm/templates/theodolite/role-binding.yaml
+++ b/helm/templates/theodolite/role-binding.yaml
@@ -1,5 +1,5 @@
{{- if .Values.rbac.create -}}
-apiVersion: rbac.authorization.k8s.io/v1beta1
+apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: {{ include "theodolite.fullname" . }}
diff --git a/helm/update-index.sh b/helm/update-index.sh
index 286724dd87718387df58ed993af417bf0fd4d8ec..66c55bb8b79e18e3d06d156cb1859f2a53078999 100755
--- a/helm/update-index.sh
+++ b/helm/update-index.sh
@@ -3,7 +3,7 @@
RELEASE_NAME=$1 # Supposed to be equal to tag, e.g., v0.3.0
RELEASE_PATH="https://github.com/cau-se/theodolite/releases/download"
-REPO_INDEX="../../docs/index.yaml"
+REPO_INDEX="../docs/index.yaml"
helm repo index . --url $RELEASE_PATH/$RELEASE_NAME --merge $REPO_INDEX && \
mv index.yaml $REPO_INDEX
\ No newline at end of file
diff --git a/helm/values.yaml b/helm/values.yaml
index 917ec5cdbda7541b56b366aff2412ccf7d856f3b..c51c82d0063cbe0ccdc4e058658c88a6711eaf1b 100644
--- a/helm/values.yaml
+++ b/helm/values.yaml
@@ -250,11 +250,6 @@ operator:
imageTag: latest
imagePullPolicy: Always
- executionCRD:
- create: true
- benchmarkCRD:
- create: true
-
sloChecker:
lagTrend:
enabled: true
@@ -281,6 +276,9 @@ rbac:
randomScheduler:
enabled: true
+ image: ghcr.io/cau-se/theodolite-random-scheduler
+ imageTag: latest
+ imagePullPolicy: Always
rbac:
create: true
serviceAccount:
diff --git a/theodolite-benchmarks/kstreams-commons/build.gradle b/theodolite-benchmarks/kstreams-commons/build.gradle
index e177aa5c4770c1a77fc21084a7766741fdb9bdec..c5a880acd4377056cc0b0f06b33a2d74c9f87c4e 100644
--- a/theodolite-benchmarks/kstreams-commons/build.gradle
+++ b/theodolite-benchmarks/kstreams-commons/build.gradle
@@ -7,6 +7,9 @@ repositories {
maven {
url "https://oss.sonatype.org/content/repositories/snapshots/"
}
+ maven {
+ url 'https://packages.confluent.io/maven/'
+ }
}
dependencies {
diff --git a/theodolite/crd/crd-benchmark.yaml b/theodolite/crd/crd-benchmark.yaml
index 9de29fc031e26b9e4e16517492740b0805fd4af9..7a861276a651af520ccec853b65cb57009a45cc5 100644
--- a/theodolite/crd/crd-benchmark.yaml
+++ b/theodolite/crd/crd-benchmark.yaml
@@ -118,7 +118,7 @@ spec:
minItems: 1
items:
type: object
- required: ["name", "numPartitions", "replicationFactor"]
+ required: ["name"]
properties:
name:
description: The name of the topic.
diff --git a/theodolite/src/main/kotlin/theodolite/evaluation/SloCheckerFactory.kt b/theodolite/src/main/kotlin/theodolite/evaluation/SloCheckerFactory.kt
index e1ee4f4d25a095435634ebbd8c6d51ba459490b1..64f9110cd931feef41dc65f88d6623e82f4e03a2 100644
--- a/theodolite/src/main/kotlin/theodolite/evaluation/SloCheckerFactory.kt
+++ b/theodolite/src/main/kotlin/theodolite/evaluation/SloCheckerFactory.kt
@@ -22,13 +22,13 @@ class SloCheckerFactory {
* - `warmup`: time from the beginning to skip in the analysis.
*
*
- * ### `lag trend percent`
+ * ### `lag trend ratio`
* Creates an [ExternalSloChecker] with defined parameters.
- * The required threshold is computed using a percentage and the load of the experiment.
+ * The required threshold is computed using a ratio and the load of the experiment.
*
* The properties map needs the following fields:
* - `externalSlopeURL`: Url to the concrete SLO checker service.
- * - `percent`: of the executed load that is accepted for the slope.
+ * - `ratio`: of the executed load that is accepted for the slope.
* - `warmup`: time from the beginning to skip in the analysis.
*
* @param sloType Type of the [SloChecker].
@@ -50,18 +50,16 @@ class SloCheckerFactory {
threshold = properties["threshold"]?.toInt() ?: throw IllegalArgumentException("threshold expected"),
warmup = properties["warmup"]?.toInt() ?: throw IllegalArgumentException("warmup expected")
)
- SloTypes.LAG_TREND_PERCENTAGE.value, SloTypes.DROPPED_RECORDS_PERCENTAGE.value -> {
- if (!properties["loadType"].equals("NumSensors")) {
- throw IllegalArgumentException("Percent Threshold is only allowed with load type NumSensors")
- }
- val thresholdPercent =
- properties["percent"]?.toDouble()
- ?: throw IllegalArgumentException("percent for threshold expected")
- if (thresholdPercent < 0.0 || thresholdPercent > 1.0) {
- throw IllegalArgumentException("Threshold percent need to be an Double in the range between 0.0 and 1.0 (inclusive)")
+
+ SloTypes.LAG_TREND_RATIO.value, SloTypes.DROPPED_RECORDS_RATIO.value -> {
+ val thresholdRatio =
+ properties["ratio"]?.toDouble()
+ ?: throw IllegalArgumentException("ratio for threshold expected")
+ if (thresholdRatio < 0.0) {
+ throw IllegalArgumentException("Threshold ratio needs to be an Double greater or equal 0.0")
}
// cast to int, as rounding is not really necessary
- val threshold = (load.get() * thresholdPercent).toInt()
+ val threshold = (load.get() * thresholdRatio).toInt()
ExternalSloChecker(
externalSlopeURL = properties["externalSloUrl"]
diff --git a/theodolite/src/main/kotlin/theodolite/evaluation/SloConfigHandler.kt b/theodolite/src/main/kotlin/theodolite/evaluation/SloConfigHandler.kt
index 27601878f59b5a30c9b6af0c649da326991c5e48..2328000e7e71aea116220ab10dfbba25407c0f49 100644
--- a/theodolite/src/main/kotlin/theodolite/evaluation/SloConfigHandler.kt
+++ b/theodolite/src/main/kotlin/theodolite/evaluation/SloConfigHandler.kt
@@ -8,8 +8,8 @@ class SloConfigHandler() {
companion object {
fun getQueryString(sloType: String): String {
return when (sloType.toLowerCase()) {
- SloTypes.LAG_TREND.value, SloTypes.LAG_TREND_PERCENTAGE.value -> "sum by(group)(kafka_consumergroup_group_lag >= 0)"
- SloTypes.DROPPED_RECORDS.value, SloTypes.DROPPED_RECORDS_PERCENTAGE.value -> "sum by(job) (kafka_streams_stream_task_metrics_dropped_records_total>=0)"
+ SloTypes.LAG_TREND.value, SloTypes.LAG_TREND_RATIO.value -> "sum by(group)(kafka_consumergroup_group_lag >= 0)"
+ SloTypes.DROPPED_RECORDS.value, SloTypes.DROPPED_RECORDS_RATIO.value -> "sum by(job) (kafka_streams_stream_task_metrics_dropped_records_total>=0)"
else -> throw InvalidPatcherConfigurationException("Could not find Prometheus query string for slo type $sloType")
}
}
diff --git a/theodolite/src/main/kotlin/theodolite/evaluation/SloTypes.kt b/theodolite/src/main/kotlin/theodolite/evaluation/SloTypes.kt
index 7a37c698e42b9dd6b863e7fd7a4c7c3df38fc374..ac9de35861b0bd9c012bfb0b8cfcb2e1aa5aed68 100644
--- a/theodolite/src/main/kotlin/theodolite/evaluation/SloTypes.kt
+++ b/theodolite/src/main/kotlin/theodolite/evaluation/SloTypes.kt
@@ -2,9 +2,9 @@ package theodolite.evaluation
enum class SloTypes(val value: String) {
LAG_TREND("lag trend"),
- LAG_TREND_PERCENTAGE("lag trend percentage"),
+ LAG_TREND_RATIO("lag trend ratio"),
DROPPED_RECORDS("dropped records"),
- DROPPED_RECORDS_PERCENTAGE("dropped records percentage")
+ DROPPED_RECORDS_RATIO("dropped records ratio")
}
\ No newline at end of file
diff --git a/theodolite/src/main/kotlin/theodolite/execution/TheodoliteExecutor.kt b/theodolite/src/main/kotlin/theodolite/execution/TheodoliteExecutor.kt
index 0368435fa8e2f6ac3b664e1d761bcf910ca010a0..6a9a850c32ade111d07765bac7fdf5f69b6a1ed5 100644
--- a/theodolite/src/main/kotlin/theodolite/execution/TheodoliteExecutor.kt
+++ b/theodolite/src/main/kotlin/theodolite/execution/TheodoliteExecutor.kt
@@ -55,9 +55,6 @@ class TheodoliteExecutor(
this.kubernetesBenchmark.loadTypes
)
- // Add load type to check if the percentage lag trend is applicable
- config.slos.forEach { it.properties["loadType"] = config.load.loadType }
-
executor =
BenchmarkExecutorImpl(
benchmark = kubernetesBenchmark,
@@ -118,10 +115,10 @@ class TheodoliteExecutor(
val ioHandler = IOHandler()
val resultsFolder = ioHandler.getResultFolderURL()
this.config.executionId = getAndIncrementExecutionID(resultsFolder + "expID.txt")
- ioHandler.writeToJSONFile(this.config, "$resultsFolder${this.config.executionId}-execution-configuration")
+ ioHandler.writeToJSONFile(this.config, "${resultsFolder}exp${this.config.executionId}-execution-configuration")
ioHandler.writeToJSONFile(
kubernetesBenchmark,
- "$resultsFolder${this.config.executionId}-benchmark-configuration"
+ "${resultsFolder}exp${this.config.executionId}-benchmark-configuration"
)
val config = buildConfig()
@@ -133,7 +130,7 @@ class TheodoliteExecutor(
}
ioHandler.writeToJSONFile(
config.compositeStrategy.benchmarkExecutor.results,
- "$resultsFolder${this.config.executionId}-result"
+ "${resultsFolder}exp${this.config.executionId}-result"
)
}