diff --git a/README.md b/README.md index f2673f4b9ed0c46987963f8b455e19def802db79..86d72b5c32dfdd243e27904c76f3afb474d10c1f 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,14 @@ Theodolite is a framework for benchmarking the horizontal and vertical scalabili ## 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 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](theodolite-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 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 Kubernetes package manager Helm, more information on how to instal Theodoolite can be found in [Theodolite Helm Chart](helm). + +For the execution of an benchmark, a `benchmark`and an `execution` must be definined, examples can be found [here](./theodolite/examples). More information can be found at [docs](docs). ## Theodolite Analysis Tools diff --git a/docs/README.md b/docs/README.md index 4fd13bdfc157efe8b3491695bb83972f96a82c5d..fb04991022f7683d096439ff734ccd02518f12f5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,12 +12,14 @@ Theodolite is a framework for benchmarking the horizontal and vertical scalabili ## 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 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](theodolite-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 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 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. It is recommended to install theodolite with Kubernetes package manager Helm, more information on how to instal Theodoolite can be found in [Theodolite Helm Chart](helm). + +For the execution of an benchmark, a `benchmark`and an `execution` must be definined, examples can be found [here](./theodolite/examples) ## Theodolite Analysis Tools