Skip to content
Snippets Groups Projects
Commit cbc7987a authored by Sören Henning's avatar Sören Henning
Browse files

Minor docs fixes

parent 2b48d30d
No related branches found
No related tags found
No related merge requests found
Pipeline #6103 passed
...@@ -108,6 +108,9 @@ Suppose the resources needed by your benchmark are defined as YAML files, locate ...@@ -108,6 +108,9 @@ Suppose the resources needed by your benchmark are defined as YAML files, locate
Benchmarks need to specify at least one supported load and resource type for which scalability can be benchmarked. Benchmarks need to specify at least one supported load and resource type for which scalability can be benchmarked.
Load and resource types are described by a name (used for reference from an Execution) and a list of patchers. Load and resource types are described by a name (used for reference from an Execution) and a list of patchers.
Patchers can be seen as functions, which take a value as input and modify a Kubernetes resource in a patcher-specific way. Examples of patchers are the *ReplicaPatcher*, which modifies the replica specification of a deployment, or the *EnvVarPatcher*, which modifies an environment variable.
See the [patcher API reference](api-reference/patchers) for an overview of available patchers.
If a benchmark is [executed by an Execution](running-benchmarks), these patchers are used to configure SUT and load generator according to the [load and resource values](creating-an-execution) set in the Execution. If a benchmark is [executed by an Execution](running-benchmarks), these patchers are used to configure SUT and load generator according to the [load and resource values](creating-an-execution) set in the Execution.
## Kafka Configuration ## Kafka Configuration
...@@ -116,6 +119,12 @@ Theodolite allows to automatically create and remove Kafka topics for each SLO e ...@@ -116,6 +119,12 @@ Theodolite allows to automatically create and remove Kafka topics for each SLO e
Use the `removeOnly: True` property for topics which are created automatically by the SUT. Use the `removeOnly: True` property for topics which are created automatically by the SUT.
For those topics, also wildcards are allowed in the topic name. For those topics, also wildcards are allowed in the topic name.
If no Kafka topics should be created, simply set:
```yaml
kafkaConfig: []
```
<!-- Further information: API Reference --> <!-- Further information: API Reference -->
<!-- Further information: How to deploy --> <!-- Further information: How to deploy -->
...@@ -143,7 +143,7 @@ The easiest way to use them is at MyBinder: ...@@ -143,7 +143,7 @@ The easiest way to use them is at MyBinder:
Alternatively, you can also [run these notebook locally](https://github.com/cau-se/theodolite/tree/master/analysis), for example, with Docker or Visual Studio Code. Alternatively, you can also [run these notebook locally](https://github.com/cau-se/theodolite/tree/master/analysis), for example, with Docker or Visual Studio Code.
The notebooks allow to compute a scalability function using its *demand* metric and to visualize multiple such functions in plots: The notebooks allow to compute a scalability function using Theodolite's *demand* metric and to visualize multiple such functions in plots:
### Computing the *demand* metric with `demand-metric.ipynb` (optional) ### Computing the *demand* metric with `demand-metric.ipynb` (optional)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment