From 5a923871cefce36d1ec1e222376a9228db0d2c54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de> Date: Fri, 7 Jan 2022 15:28:52 +0100 Subject: [PATCH] Remove old files --- docs/creating-a-benchmark-old.md | 36 ----------- docs/running-benchmarks-old.md | 107 ------------------------------- 2 files changed, 143 deletions(-) delete mode 100644 docs/creating-a-benchmark-old.md delete mode 100644 docs/running-benchmarks-old.md diff --git a/docs/creating-a-benchmark-old.md b/docs/creating-a-benchmark-old.md deleted file mode 100644 index 3664bebf8..000000000 --- a/docs/creating-a-benchmark-old.md +++ /dev/null @@ -1,36 +0,0 @@ -* Create a benchmark for operator mode -* Create a benchmark for standalone mode -* Deploy a benchmark - -## Creating a benchmark for operator mode - -### App and Workload Generator Resources - -### Load and Resource Types - -### Kafka Configuration - - -### Make benchmark Kubernetes resources accessible - -* A benchmark is defined by a set of Kubernetes resources, which are automatically deployed and scaled by Theodolite. -* To make these resources accessible by the Theodolite operator, we need to add them to a volume, already mounted by Theodolite. The easiest way to do this is by adding the resources to the ConfigMap `benchmark-resources-custom`, which is mounted by Theodolite with its default installation. - - - - - -## Creating a benchmark for standalone mode - -Creating a benchmark in standalone mode is similar to operator mode. However, -instead of defining a benchmark as `Benchmark` resource, it is defined as a -benchmark YAML file. Such a file deviates in the following points from a -`Benchmark` resource: - -* The fields `apiVersion`, `kind` and `metadata` should be removed. -* The benchmark's name (`metadata.name` in `Benchmark` resources) must be defined by the top-level field `name`. -* Everything that is defined in `spec` has to be moved to the top-level. - -**TODO: example** - -**TODO: Create a ConfigMap containing the benchmark YAML files as well as all Kubernetes resources for that benchmark + deploy** \ No newline at end of file diff --git a/docs/running-benchmarks-old.md b/docs/running-benchmarks-old.md deleted file mode 100644 index 9775c815f..000000000 --- a/docs/running-benchmarks-old.md +++ /dev/null @@ -1,107 +0,0 @@ -old - -# Running Scalability Benchmarks - -There are two options to run scalability benchmarks with Theodolite: - -1. The [Theodolite Operator](#running-benchmarks-with-the-theodolite-operator) is a long-running service in your cluster, which accepts submitted benchmarks and executes them. -2. In [standalone mode](#running-benchmarks-in-standalone-mode), Theodolite is started as a Kubernetes Job and only runs for the duration of one benchmark execution. - -While the operator is a bit more complex to install then the standalone mode, -it makes it way easier to manage benchmarks and their executions. In -particular, it allows to submit a set of experiments, which are then executed -automatically one after another. -**Therefore, running benchmarks with the operator is recommended.** - - -## Running Benchmarks with the Theodolite Operator - -The general process for running Theodolite benchmarks in operator mode is as follows: - -1. Create and deploy a new `Benchmark` resource or deploy one of the already existing ones. -2. Define your benchmark execution as an `Execution` resource and deploy it. - -### 1. Creating a benchmark - -Benchmarks are defined as resources of our custom resource definition -`Benchmark`. You can either create a new `Benchmark` for your custom benchmark -or system under test or deploy one of the existing benchmarks, which can be -found in [`theodolite-benchmarks/definitions`](https://github.com/cau-se/theodolite/tree/master/theodolite-benchmarks/definitions). - -Suppose your `Benchmark` resource is stored in `example-benchmark.yaml`, you -can deploy it by running: - -```sh -kubectl apply -f example-benchmark.yaml -``` - -To see the list of all deployed benchmarks run: - -```sh -kubectl get benchmarks -``` - -Additionally you need to make all your benchmark's Kubernetes resources available to the operator. - -**TODO benchmark resources** - -Once your benchmark is deployed, it is ready to be executed. - -### 2. Creating an execution - -To execute a benchmark, you need to describe this execution by creating an `Execution` resource. - -**TODO: details execution** - -Suppose your `Execution` resource is stored in `example-execution.yaml`, you -can deploy it by running: - -```sh -kubectl apply -f example-execution.yaml -``` - -To see the list of all deployed benchmarks run: - -```sh -kubectl get executions -``` - -The `STATUS` field will tell you whether a benchmark execution has been -started, finished or failed due to some error. The `DURATION` field tells you -for how long that execution is running (so far). Similar to a Kubernetes Job, -an `Execution` is not automatically deleted once it is finished. This makes it -easier to keep track of all the benchmark executions and to organize benchmark -results. - - -## Running Benchmarks in Standalone Mode - -The general process for running Theodolite benchmarks in standalone mode is as follows: - -1. Create a benchmark by writing a YAML file or select one of the already existing ones and create a ConfigMap from it. -2. Define your benchmark execution as a YAML file and create a ConfigMap from it. We provide a template for this. -3. Create a Theodolite Job from our template and mount your benchmark and benchmark execution with it. - -### 1. Creating a benchmark - -Creating a benchmark in standalone mode is similar to operator mode. However, -instead of defining a benchmark as `Benchmark` resource, it is defined as a -benchmark YAML file. Such a file deviates in the following points from a -`Benchmark` resource: - -* The fields `apiVersion`, `kind` and `metadata` should be removed. -* The benchmark's name (`metadata.name` in `Benchmark` resources) must be defined by the top-level field `name`. -* Everything that is defined in `spec` has to be moved to the top-level. - -**TODO: example** - -**TODO: Create a ConfigMap containing the benchmark YAML files as well as all Kubernetes resources for that benchmark + deploy** - -### 2. Creating an execution - -**TODO: see above** - - -### 3. Create a Theodolite Job - -**TODO example** \ No newline at end of file -- GitLab