From d21299f957f604162942e2eeb8d0e8078e3cb044 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Henning?= <post@soeren-henning.de> Date: Wed, 3 Jun 2020 14:06:02 +0200 Subject: [PATCH] Provide some basic documentation in Readme --- README.md | 16 +++++++++++++++- analysis/README.md | 2 +- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a38aa360f..6ad1dd576 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,18 @@ > A theodolite is a precision optical instrument for measuring angles between designated visible points in the horizontal and vertical planes. -- <cite>[Wikipedia](https://en.wikipedia.org/wiki/Theodolite)</cite> -Theodolite is a framework for benchmarking the horizontal and vertical scalability of stream processing engines. +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 Kafka Streams. + + +## 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 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 Analysis Tools + +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). diff --git a/analysis/README.md b/analysis/README.md index 531842582..263b1db16 100644 --- a/analysis/README.md +++ b/analysis/README.md @@ -17,6 +17,6 @@ Python libraries, which can be installed via: pip install -r requirements.txt ``` - We have tested these +We have tested these notebooks with [Visual Studio Code](https://code.visualstudio.com/docs/python/jupyter-support), however, every other server should be fine as well. -- GitLab