From 490196e3430f45dce26945c9feee42becf02f722 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Mon, 30 May 2022 18:36:29 +0200
Subject: [PATCH] Revert CRD docs
---
docs/api-reference/crds.md | 910 +++++++++++++++++++------------------
1 file changed, 459 insertions(+), 451 deletions(-)
diff --git a/docs/api-reference/crds.md b/docs/api-reference/crds.md
index 2214691f2..c5cc7596f 100644
--- a/docs/api-reference/crds.md
+++ b/docs/api-reference/crds.md
@@ -1,3 +1,11 @@
+---
+title: Theodolite CRDs
+has_children: false
+parent: API Reference
+nav_order: 1
+---
+
+
# API Reference
Packages:
@@ -52,45 +60,18 @@ Resource Types:
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
<td>true</td>
</tr><tr>
- <td><b><a href="#benchmarkstatus">status</a></b></td>
+ <td><b><a href="#benchmarkspec">spec</a></b></td>
<td>object</td>
<td>
<br/>
</td>
- <td>false</td>
+ <td>true</td>
</tr><tr>
- <td><b><a href="#benchmarkspec">spec</a></b></td>
+ <td><b><a href="#benchmarkstatus">status</a></b></td>
<td>object</td>
<td>
<br/>
</td>
- <td>true</td>
- </tr></tbody>
-</table>
-
-
-### benchmark.status
-<sup><sup>[↩ Parent](#benchmark)</sup></sup>
-
-
-
-
-
-<table>
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- </thead>
- <tbody><tr>
- <td><b>resourceSetsState</b></td>
- <td>string</td>
- <td>
- The status of a Benchmark indicates whether all resources are available to start the benchmark or not.<br/>
- </td>
<td>false</td>
</tr></tbody>
</table>
@@ -113,6 +94,34 @@ Resource Types:
</tr>
</thead>
<tbody><tr>
+ <td><b><a href="#benchmarkspecloadgenerator">loadGenerator</a></b></td>
+ <td>object</td>
+ <td>
+ The loadGenResourceSets specifies all Kubernetes resources required to start the load generator. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b><a href="#benchmarkspecloadtypesindex">loadTypes</a></b></td>
+ <td>[]object</td>
+ <td>
+ A list of load types that can be scaled for this benchmark. For each load type the concrete values are defined in the execution object.<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b><a href="#benchmarkspecresourcetypesindex">resourceTypes</a></b></td>
+ <td>[]object</td>
+ <td>
+ A list of resource types that can be scaled for this `benchmark` resource. For each resource type the concrete values are defined in the `execution` object.<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b><a href="#benchmarkspecsut">sut</a></b></td>
+ <td>object</td>
+ <td>
+ The appResourceSets specifies all Kubernetes resources required to start the sut. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
<td><b><a href="#benchmarkspecinfrastructure">infrastructure</a></b></td>
<td>object</td>
<td>
@@ -146,44 +155,16 @@ Resource Types:
<i>Default</i>: false<br/>
</td>
<td>false</td>
- </tr><tr>
- <td><b><a href="#benchmarkspecloadgenerator">loadGenerator</a></b></td>
- <td>object</td>
- <td>
- The loadGenResourceSets specifies all Kubernetes resources required to start the load generator. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.<br/>
- </td>
- <td>true</td>
- </tr><tr>
- <td><b><a href="#benchmarkspecloadtypesindex">loadTypes</a></b></td>
- <td>[]object</td>
- <td>
- A list of load types that can be scaled for this benchmark. For each load type the concrete values are defined in the execution object.<br/>
- </td>
- <td>true</td>
- </tr><tr>
- <td><b><a href="#benchmarkspecresourcetypesindex">resourceTypes</a></b></td>
- <td>[]object</td>
- <td>
- A list of resource types that can be scaled for this `benchmark` resource. For each resource type the concrete values are defined in the `execution` object.<br/>
- </td>
- <td>true</td>
- </tr><tr>
- <td><b><a href="#benchmarkspecsut">sut</a></b></td>
- <td>object</td>
- <td>
- The appResourceSets specifies all Kubernetes resources required to start the sut. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.<br/>
- </td>
- <td>true</td>
</tr></tbody>
</table>
-### benchmark.spec.infrastructure
+### benchmark.spec.loadGenerator
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
-(Optional) A list of file names that reference Kubernetes resources that are deployed on the cluster to create the required infrastructure.
+The loadGenResourceSets specifies all Kubernetes resources required to start the load generator. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.
<table>
<thead>
@@ -195,25 +176,25 @@ Resource Types:
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecinfrastructureafteractionsindex">afterActions</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorafteractionsindex">afterActions</a></b></td>
<td>[]object</td>
<td>
- Infrastructure after actions are executed after the teardown of the infrastructure.<br/>
+ Load generator after actions are executed after the teardown of the load generator.<br/>
<br/>
<i>Default</i>: []<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindex">beforeActions</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindex">beforeActions</a></b></td>
<td>[]object</td>
<td>
- Infrastructure before actions are executed before the infrastructure is set up.<br/>
+ Load generator before actions are executed before the load generator is started.<br/>
<br/>
<i>Default</i>: []<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecinfrastructureresourcesindex">resources</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorresourcesindex">resources</a></b></td>
<td>[]object</td>
<td>
<br/>
@@ -225,8 +206,8 @@ Resource Types:
</table>
-### benchmark.spec.infrastructure.afterActions[index]
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
+### benchmark.spec.loadGenerator.afterActions[index]
+<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
@@ -242,14 +223,14 @@ Resource Types:
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecinfrastructureafteractionsindexexec">exec</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexexec">exec</a></b></td>
<td>object</td>
<td>
Specifies command to be executed.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecinfrastructureafteractionsindexselector">selector</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselector">selector</a></b></td>
<td>object</td>
<td>
The selector specifies which resource should be selected for the execution of the command.<br/>
@@ -259,8 +240,8 @@ Resource Types:
</table>
-### benchmark.spec.infrastructure.afterActions[index].exec
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindex)</sup></sup>
+### benchmark.spec.loadGenerator.afterActions[index].exec
+<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup>
@@ -293,8 +274,8 @@ Specifies command to be executed.
</table>
-### benchmark.spec.infrastructure.afterActions[index].selector
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindex)</sup></sup>
+### benchmark.spec.loadGenerator.afterActions[index].selector
+<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup>
@@ -319,7 +300,7 @@ The selector specifies which resource should be selected for the execution of th
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecinfrastructureafteractionsindexselectorpod">pod</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselectorpod">pod</a></b></td>
<td>object</td>
<td>
Specifies the pod.<br/>
@@ -329,8 +310,8 @@ The selector specifies which resource should be selected for the execution of th
</table>
-### benchmark.spec.infrastructure.afterActions[index].selector.pod
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindexselector)</sup></sup>
+### benchmark.spec.loadGenerator.afterActions[index].selector.pod
+<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindexselector)</sup></sup>
@@ -358,8 +339,8 @@ Specifies the pod.
</table>
-### benchmark.spec.infrastructure.beforeActions[index]
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
+### benchmark.spec.loadGenerator.beforeActions[index]
+<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
@@ -375,14 +356,14 @@ Specifies the pod.
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexexec">exec</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexexec">exec</a></b></td>
<td>object</td>
<td>
Specifies command to be executed.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexselector">selector</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselector">selector</a></b></td>
<td>object</td>
<td>
The selector specifies which resource should be selected for the execution of the command.<br/>
@@ -392,8 +373,8 @@ Specifies the pod.
</table>
-### benchmark.spec.infrastructure.beforeActions[index].exec
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindex)</sup></sup>
+### benchmark.spec.loadGenerator.beforeActions[index].exec
+<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup>
@@ -426,8 +407,8 @@ Specifies command to be executed.
</table>
-### benchmark.spec.infrastructure.beforeActions[index].selector
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindex)</sup></sup>
+### benchmark.spec.loadGenerator.beforeActions[index].selector
+<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup>
@@ -452,7 +433,7 @@ The selector specifies which resource should be selected for the execution of th
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexselectorpod">pod</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselectorpod">pod</a></b></td>
<td>object</td>
<td>
Specifies the pod.<br/>
@@ -462,8 +443,8 @@ The selector specifies which resource should be selected for the execution of th
</table>
-### benchmark.spec.infrastructure.beforeActions[index].selector.pod
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindexselector)</sup></sup>
+### benchmark.spec.loadGenerator.beforeActions[index].selector.pod
+<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindexselector)</sup></sup>
@@ -491,8 +472,8 @@ Specifies the pod.
</table>
-### benchmark.spec.infrastructure.resources[index]
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
+### benchmark.spec.loadGenerator.resources[index]
+<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
@@ -508,14 +489,14 @@ Specifies the pod.
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecinfrastructureresourcesindexconfigmap">configMap</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorresourcesindexconfigmap">configMap</a></b></td>
<td>object</td>
<td>
The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecinfrastructureresourcesindexfilesystem">fileSystem</a></b></td>
+ <td><b><a href="#benchmarkspecloadgeneratorresourcesindexfilesystem">fileSystem</a></b></td>
<td>object</td>
<td>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
@@ -525,8 +506,8 @@ Specifies the pod.
</table>
-### benchmark.spec.infrastructure.resources[index].configMap
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructureresourcesindex)</sup></sup>
+### benchmark.spec.loadGenerator.resources[index].configMap
+<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup>
@@ -559,8 +540,8 @@ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes conf
</table>
-### benchmark.spec.infrastructure.resources[index].fileSystem
-<sup><sup>[↩ Parent](#benchmarkspecinfrastructureresourcesindex)</sup></sup>
+### benchmark.spec.loadGenerator.resources[index].fileSystem
+<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup>
@@ -593,12 +574,12 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</table>
-### benchmark.spec.kafkaConfig
+### benchmark.spec.loadTypes[index]
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
-Contains the Kafka configuration.
+
<table>
<thead>
@@ -610,25 +591,25 @@ Contains the Kafka configuration.
</tr>
</thead>
<tbody><tr>
- <td><b>bootstrapServer</b></td>
- <td>string</td>
+ <td><b><a href="#benchmarkspecloadtypesindexpatchersindex">patchers</a></b></td>
+ <td>[]object</td>
<td>
- The bootstrap servers connection string.<br/>
+ List of patchers used to scale this resource type.<br/>
</td>
<td>true</td>
</tr><tr>
- <td><b><a href="#benchmarkspeckafkaconfigtopicsindex">topics</a></b></td>
- <td>[]object</td>
+ <td><b>typeName</b></td>
+ <td>string</td>
<td>
- List of topics to be created for each experiment. Alternative theodolite offers the possibility to remove certain topics after each experiment.<br/>
+ Name of the load type.<br/>
</td>
<td>true</td>
</tr></tbody>
</table>
-### benchmark.spec.kafkaConfig.topics[index]
-<sup><sup>[↩ Parent](#benchmarkspeckafkaconfig)</sup></sup>
+### benchmark.spec.loadTypes[index].patchers[index]
+<sup><sup>[↩ Parent](#benchmarkspecloadtypesindex)</sup></sup>
@@ -644,51 +625,42 @@ Contains the Kafka configuration.
</tr>
</thead>
<tbody><tr>
- <td><b>numPartitions</b></td>
- <td>integer</td>
+ <td><b>resource</b></td>
+ <td>string</td>
<td>
- The number of partitions of the topic.<br/>
+ Specifies the Kubernetes resource to be patched.<br/>
<br/>
- <i>Default</i>: 0<br/>
+ <i>Default</i>: <br/>
</td>
- <td>false</td>
+ <td>true</td>
</tr><tr>
- <td><b>removeOnly</b></td>
- <td>boolean</td>
+ <td><b>type</b></td>
+ <td>string</td>
<td>
- Determines if this topic should only be deleted after each experiement. For removeOnly topics the name can be a RegEx describing the topic.<br/>
+ Type of the Patcher.<br/>
<br/>
- <i>Default</i>: false<br/>
+ <i>Default</i>: <br/>
</td>
- <td>false</td>
+ <td>true</td>
</tr><tr>
- <td><b>replicationFactor</b></td>
- <td>integer</td>
+ <td><b>properties</b></td>
+ <td>map[string]string</td>
<td>
- The replication factor of the topic.<br/>
+ (Optional) Patcher specific additional arguments.<br/>
<br/>
- <i>Default</i>: 0<br/>
+ <i>Default</i>: map[]<br/>
</td>
<td>false</td>
- </tr><tr>
- <td><b>name</b></td>
- <td>string</td>
- <td>
- The name of the topic.<br/>
- <br/>
- <i>Default</i>: <br/>
- </td>
- <td>true</td>
</tr></tbody>
</table>
-### benchmark.spec.loadGenerator
+### benchmark.spec.resourceTypes[index]
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
-The loadGenResourceSets specifies all Kubernetes resources required to start the load generator. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.
+
<table>
<thead>
@@ -700,39 +672,26 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecloadgeneratorafteractionsindex">afterActions</a></b></td>
- <td>[]object</td>
- <td>
- Load generator after actions are executed after the teardown of the load generator.<br/>
- <br/>
- <i>Default</i>: []<br/>
- </td>
- <td>false</td>
- </tr><tr>
- <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindex">beforeActions</a></b></td>
+ <td><b><a href="#benchmarkspecresourcetypesindexpatchersindex">patchers</a></b></td>
<td>[]object</td>
<td>
- Load generator before actions are executed before the load generator is started.<br/>
- <br/>
- <i>Default</i>: []<br/>
+ List of patchers used to scale this resource type.<br/>
</td>
- <td>false</td>
+ <td>true</td>
</tr><tr>
- <td><b><a href="#benchmarkspecloadgeneratorresourcesindex">resources</a></b></td>
- <td>[]object</td>
+ <td><b>typeName</b></td>
+ <td>string</td>
<td>
- <br/>
- <br/>
- <i>Default</i>: []<br/>
+ Name of the resource type.<br/>
</td>
- <td>false</td>
+ <td>true</td>
</tr></tbody>
</table>
-### benchmark.spec.loadGenerator.afterActions[index]
-<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
-
+### benchmark.spec.resourceTypes[index].patchers[index]
+<sup><sup>[↩ Parent](#benchmarkspecresourcetypesindex)</sup></sup>
+
@@ -747,14 +706,108 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexexec">exec</a></b></td>
+ <td><b>resource</b></td>
+ <td>string</td>
+ <td>
+ Specifies the Kubernetes resource to be patched.<br/>
+ <br/>
+ <i>Default</i>: <br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b>type</b></td>
+ <td>string</td>
+ <td>
+ Type of the patcher.<br/>
+ <br/>
+ <i>Default</i>: <br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b>properties</b></td>
+ <td>map[string]string</td>
+ <td>
+ (Optional) Patcher specific additional arguments.<br/>
+ <br/>
+ <i>Default</i>: map[]<br/>
+ </td>
+ <td>false</td>
+ </tr></tbody>
+</table>
+
+
+### benchmark.spec.sut
+<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
+
+
+
+The appResourceSets specifies all Kubernetes resources required to start the sut. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.
+
+<table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ </thead>
+ <tbody><tr>
+ <td><b><a href="#benchmarkspecsutafteractionsindex">afterActions</a></b></td>
+ <td>[]object</td>
+ <td>
+ <br/>
+ <br/>
+ <i>Default</i>: []<br/>
+ </td>
+ <td>false</td>
+ </tr><tr>
+ <td><b><a href="#benchmarkspecsutbeforeactionsindex">beforeActions</a></b></td>
+ <td>[]object</td>
+ <td>
+ SUT before actions are executed before the SUT is started.<br/>
+ <br/>
+ <i>Default</i>: []<br/>
+ </td>
+ <td>false</td>
+ </tr><tr>
+ <td><b><a href="#benchmarkspecsutresourcesindex">resources</a></b></td>
+ <td>[]object</td>
+ <td>
+ <br/>
+ <br/>
+ <i>Default</i>: []<br/>
+ </td>
+ <td>false</td>
+ </tr></tbody>
+</table>
+
+
+### benchmark.spec.sut.afterActions[index]
+<sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
+
+
+
+
+
+<table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ </thead>
+ <tbody><tr>
+ <td><b><a href="#benchmarkspecsutafteractionsindexexec">exec</a></b></td>
<td>object</td>
<td>
Specifies command to be executed.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselector">selector</a></b></td>
+ <td><b><a href="#benchmarkspecsutafteractionsindexselector">selector</a></b></td>
<td>object</td>
<td>
The selector specifies which resource should be selected for the execution of the command.<br/>
@@ -764,8 +817,8 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the
</table>
-### benchmark.spec.loadGenerator.afterActions[index].exec
-<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup>
+### benchmark.spec.sut.afterActions[index].exec
+<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup>
@@ -798,8 +851,8 @@ Specifies command to be executed.
</table>
-### benchmark.spec.loadGenerator.afterActions[index].selector
-<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup>
+### benchmark.spec.sut.afterActions[index].selector
+<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup>
@@ -824,7 +877,7 @@ The selector specifies which resource should be selected for the execution of th
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselectorpod">pod</a></b></td>
+ <td><b><a href="#benchmarkspecsutafteractionsindexselectorpod">pod</a></b></td>
<td>object</td>
<td>
Specifies the pod.<br/>
@@ -834,8 +887,8 @@ The selector specifies which resource should be selected for the execution of th
</table>
-### benchmark.spec.loadGenerator.afterActions[index].selector.pod
-<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindexselector)</sup></sup>
+### benchmark.spec.sut.afterActions[index].selector.pod
+<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindexselector)</sup></sup>
@@ -863,8 +916,8 @@ Specifies the pod.
</table>
-### benchmark.spec.loadGenerator.beforeActions[index]
-<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
+### benchmark.spec.sut.beforeActions[index]
+<sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
@@ -880,14 +933,14 @@ Specifies the pod.
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexexec">exec</a></b></td>
+ <td><b><a href="#benchmarkspecsutbeforeactionsindexexec">exec</a></b></td>
<td>object</td>
<td>
Specifies command to be executed.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselector">selector</a></b></td>
+ <td><b><a href="#benchmarkspecsutbeforeactionsindexselector">selector</a></b></td>
<td>object</td>
<td>
The selector specifies which resource should be selected for the execution of the command.<br/>
@@ -897,8 +950,8 @@ Specifies the pod.
</table>
-### benchmark.spec.loadGenerator.beforeActions[index].exec
-<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup>
+### benchmark.spec.sut.beforeActions[index].exec
+<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup>
@@ -931,8 +984,8 @@ Specifies command to be executed.
</table>
-### benchmark.spec.loadGenerator.beforeActions[index].selector
-<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup>
+### benchmark.spec.sut.beforeActions[index].selector
+<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup>
@@ -957,7 +1010,7 @@ The selector specifies which resource should be selected for the execution of th
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselectorpod">pod</a></b></td>
+ <td><b><a href="#benchmarkspecsutbeforeactionsindexselectorpod">pod</a></b></td>
<td>object</td>
<td>
Specifies the pod.<br/>
@@ -967,8 +1020,8 @@ The selector specifies which resource should be selected for the execution of th
</table>
-### benchmark.spec.loadGenerator.beforeActions[index].selector.pod
-<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindexselector)</sup></sup>
+### benchmark.spec.sut.beforeActions[index].selector.pod
+<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindexselector)</sup></sup>
@@ -996,8 +1049,8 @@ Specifies the pod.
</table>
-### benchmark.spec.loadGenerator.resources[index]
-<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
+### benchmark.spec.sut.resources[index]
+<sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
@@ -1013,14 +1066,14 @@ Specifies the pod.
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecloadgeneratorresourcesindexconfigmap">configMap</a></b></td>
+ <td><b><a href="#benchmarkspecsutresourcesindexconfigmap">configMap</a></b></td>
<td>object</td>
<td>
The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecloadgeneratorresourcesindexfilesystem">fileSystem</a></b></td>
+ <td><b><a href="#benchmarkspecsutresourcesindexfilesystem">fileSystem</a></b></td>
<td>object</td>
<td>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
@@ -1030,8 +1083,8 @@ Specifies the pod.
</table>
-### benchmark.spec.loadGenerator.resources[index].configMap
-<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup>
+### benchmark.spec.sut.resources[index].configMap
+<sup><sup>[↩ Parent](#benchmarkspecsutresourcesindex)</sup></sup>
@@ -1064,8 +1117,8 @@ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes conf
</table>
-### benchmark.spec.loadGenerator.resources[index].fileSystem
-<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup>
+### benchmark.spec.sut.resources[index].fileSystem
+<sup><sup>[↩ Parent](#benchmarkspecsutresourcesindex)</sup></sup>
@@ -1098,12 +1151,12 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</table>
-### benchmark.spec.loadTypes[index]
+### benchmark.spec.infrastructure
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
-
+(Optional) A list of file names that reference Kubernetes resources that are deployed on the cluster to create the required infrastructure.
<table>
<thead>
@@ -1115,25 +1168,38 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecloadtypesindexpatchersindex">patchers</a></b></td>
+ <td><b><a href="#benchmarkspecinfrastructureafteractionsindex">afterActions</a></b></td>
<td>[]object</td>
<td>
- List of patchers used to scale this resource type.<br/>
+ Infrastructure after actions are executed after the teardown of the infrastructure.<br/>
+ <br/>
+ <i>Default</i>: []<br/>
</td>
- <td>true</td>
+ <td>false</td>
</tr><tr>
- <td><b>typeName</b></td>
- <td>string</td>
+ <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindex">beforeActions</a></b></td>
+ <td>[]object</td>
<td>
- Name of the load type.<br/>
+ Infrastructure before actions are executed before the infrastructure is set up.<br/>
+ <br/>
+ <i>Default</i>: []<br/>
</td>
- <td>true</td>
+ <td>false</td>
+ </tr><tr>
+ <td><b><a href="#benchmarkspecinfrastructureresourcesindex">resources</a></b></td>
+ <td>[]object</td>
+ <td>
+ <br/>
+ <br/>
+ <i>Default</i>: []<br/>
+ </td>
+ <td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.loadTypes[index].patchers[index]
-<sup><sup>[↩ Parent](#benchmarkspecloadtypesindex)</sup></sup>
+### benchmark.spec.infrastructure.afterActions[index]
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
@@ -1149,42 +1215,29 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr>
</thead>
<tbody><tr>
- <td><b>properties</b></td>
- <td>map[string]string</td>
+ <td><b><a href="#benchmarkspecinfrastructureafteractionsindexexec">exec</a></b></td>
+ <td>object</td>
<td>
- (Optional) Patcher specific additional arguments.<br/>
- <br/>
- <i>Default</i>: map[]<br/>
+ Specifies command to be executed.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b>resource</b></td>
- <td>string</td>
- <td>
- Specifies the Kubernetes resource to be patched.<br/>
- <br/>
- <i>Default</i>: <br/>
- </td>
- <td>true</td>
- </tr><tr>
- <td><b>type</b></td>
- <td>string</td>
+ <td><b><a href="#benchmarkspecinfrastructureafteractionsindexselector">selector</a></b></td>
+ <td>object</td>
<td>
- Type of the Patcher.<br/>
- <br/>
- <i>Default</i>: <br/>
+ The selector specifies which resource should be selected for the execution of the command.<br/>
</td>
- <td>true</td>
+ <td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.resourceTypes[index]
-<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
-
+### benchmark.spec.infrastructure.afterActions[index].exec
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindex)</sup></sup>
+Specifies command to be executed.
<table>
<thead>
@@ -1196,29 +1249,29 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecresourcetypesindexpatchersindex">patchers</a></b></td>
- <td>[]object</td>
+ <td><b>command</b></td>
+ <td>[]string</td>
<td>
- List of patchers used to scale this resource type.<br/>
+ The command to be executed as string array.<br/>
</td>
- <td>true</td>
+ <td>false</td>
</tr><tr>
- <td><b>typeName</b></td>
- <td>string</td>
+ <td><b>timeoutSeconds</b></td>
+ <td>integer</td>
<td>
- Name of the resource type.<br/>
+ Specifies the timeout (in seconds) for the specified command.<br/>
</td>
- <td>true</td>
+ <td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.resourceTypes[index].patchers[index]
-<sup><sup>[↩ Parent](#benchmarkspecresourcetypesindex)</sup></sup>
-
+### benchmark.spec.infrastructure.afterActions[index].selector
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindex)</sup></sup>
+The selector specifies which resource should be selected for the execution of the command.
<table>
<thead>
@@ -1230,42 +1283,31 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr>
</thead>
<tbody><tr>
- <td><b>properties</b></td>
- <td>map[string]string</td>
+ <td><b>container</b></td>
+ <td>string</td>
<td>
- (Optional) Patcher specific additional arguments.<br/>
+ Specifies the container.<br/>
<br/>
- <i>Default</i>: map[]<br/>
+ <i>Default</i>: <br/>
</td>
<td>false</td>
</tr><tr>
- <td><b>resource</b></td>
- <td>string</td>
+ <td><b><a href="#benchmarkspecinfrastructureafteractionsindexselectorpod">pod</a></b></td>
+ <td>object</td>
<td>
- Specifies the Kubernetes resource to be patched.<br/>
- <br/>
- <i>Default</i>: <br/>
- </td>
- <td>true</td>
- </tr><tr>
- <td><b>type</b></td>
- <td>string</td>
- <td>
- Type of the patcher.<br/>
- <br/>
- <i>Default</i>: <br/>
+ Specifies the pod.<br/>
</td>
- <td>true</td>
+ <td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.sut
-<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
+### benchmark.spec.infrastructure.afterActions[index].selector.pod
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindexselector)</sup></sup>
-The appResourceSets specifies all Kubernetes resources required to start the sut. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.
+Specifies the pod.
<table>
<thead>
@@ -1277,38 +1319,20 @@ The appResourceSets specifies all Kubernetes resources required to start the sut
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecsutafteractionsindex">afterActions</a></b></td>
- <td>[]object</td>
- <td>
- <br/>
- <br/>
- <i>Default</i>: []<br/>
- </td>
- <td>false</td>
- </tr><tr>
- <td><b><a href="#benchmarkspecsutbeforeactionsindex">beforeActions</a></b></td>
- <td>[]object</td>
- <td>
- SUT before actions are executed before the SUT is started.<br/>
- <br/>
- <i>Default</i>: []<br/>
- </td>
- <td>false</td>
- </tr><tr>
- <td><b><a href="#benchmarkspecsutresourcesindex">resources</a></b></td>
- <td>[]object</td>
+ <td><b>matchLabels</b></td>
+ <td>map[string]string</td>
<td>
+ The matchLabels of the desired pod.<br/>
<br/>
- <br/>
- <i>Default</i>: []<br/>
+ <i>Default</i>: map[]<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.sut.afterActions[index]
-<sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
+### benchmark.spec.infrastructure.beforeActions[index]
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
@@ -1324,14 +1348,14 @@ The appResourceSets specifies all Kubernetes resources required to start the sut
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecsutafteractionsindexexec">exec</a></b></td>
+ <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexexec">exec</a></b></td>
<td>object</td>
<td>
Specifies command to be executed.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecsutafteractionsindexselector">selector</a></b></td>
+ <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexselector">selector</a></b></td>
<td>object</td>
<td>
The selector specifies which resource should be selected for the execution of the command.<br/>
@@ -1341,8 +1365,8 @@ The appResourceSets specifies all Kubernetes resources required to start the sut
</table>
-### benchmark.spec.sut.afterActions[index].exec
-<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup>
+### benchmark.spec.infrastructure.beforeActions[index].exec
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindex)</sup></sup>
@@ -1375,8 +1399,8 @@ Specifies command to be executed.
</table>
-### benchmark.spec.sut.afterActions[index].selector
-<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup>
+### benchmark.spec.infrastructure.beforeActions[index].selector
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindex)</sup></sup>
@@ -1401,7 +1425,7 @@ The selector specifies which resource should be selected for the execution of th
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecsutafteractionsindexselectorpod">pod</a></b></td>
+ <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexselectorpod">pod</a></b></td>
<td>object</td>
<td>
Specifies the pod.<br/>
@@ -1411,8 +1435,8 @@ The selector specifies which resource should be selected for the execution of th
</table>
-### benchmark.spec.sut.afterActions[index].selector.pod
-<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindexselector)</sup></sup>
+### benchmark.spec.infrastructure.beforeActions[index].selector.pod
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindexselector)</sup></sup>
@@ -1440,8 +1464,8 @@ Specifies the pod.
</table>
-### benchmark.spec.sut.beforeActions[index]
-<sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
+### benchmark.spec.infrastructure.resources[index]
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
@@ -1457,29 +1481,29 @@ Specifies the pod.
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecsutbeforeactionsindexexec">exec</a></b></td>
+ <td><b><a href="#benchmarkspecinfrastructureresourcesindexconfigmap">configMap</a></b></td>
<td>object</td>
<td>
- Specifies command to be executed.<br/>
+ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecsutbeforeactionsindexselector">selector</a></b></td>
+ <td><b><a href="#benchmarkspecinfrastructureresourcesindexfilesystem">fileSystem</a></b></td>
<td>object</td>
<td>
- The selector specifies which resource should be selected for the execution of the command.<br/>
+ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.sut.beforeActions[index].exec
-<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup>
+### benchmark.spec.infrastructure.resources[index].configMap
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructureresourcesindex)</sup></sup>
-Specifies command to be executed.
+The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.
<table>
<thead>
@@ -1491,29 +1515,29 @@ Specifies command to be executed.
</tr>
</thead>
<tbody><tr>
- <td><b>command</b></td>
+ <td><b>files</b></td>
<td>[]string</td>
<td>
- The command to be executed as string array.<br/>
+ (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b>timeoutSeconds</b></td>
- <td>integer</td>
+ <td><b>name</b></td>
+ <td>string</td>
<td>
- Specifies the timeout (in seconds) for the specified command.<br/>
+ The name of the configMap<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.sut.beforeActions[index].selector
-<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup>
+### benchmark.spec.infrastructure.resources[index].fileSystem
+<sup><sup>[↩ Parent](#benchmarkspecinfrastructureresourcesindex)</sup></sup>
-The selector specifies which resource should be selected for the execution of the command.
+The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
<table>
<thead>
@@ -1525,31 +1549,29 @@ The selector specifies which resource should be selected for the execution of th
</tr>
</thead>
<tbody><tr>
- <td><b>container</b></td>
- <td>string</td>
+ <td><b>files</b></td>
+ <td>[]string</td>
<td>
- Specifies the container.<br/>
- <br/>
- <i>Default</i>: <br/>
+ (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b><a href="#benchmarkspecsutbeforeactionsindexselectorpod">pod</a></b></td>
- <td>object</td>
+ <td><b>path</b></td>
+ <td>string</td>
<td>
- Specifies the pod.<br/>
+ The path to the folder which contains the Kubernetes manifests files.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.sut.beforeActions[index].selector.pod
-<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindexselector)</sup></sup>
+### benchmark.spec.kafkaConfig
+<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
-Specifies the pod.
+Contains the Kafka configuration.
<table>
<thead>
@@ -1561,20 +1583,25 @@ Specifies the pod.
</tr>
</thead>
<tbody><tr>
- <td><b>matchLabels</b></td>
- <td>map[string]string</td>
+ <td><b>bootstrapServer</b></td>
+ <td>string</td>
<td>
- The matchLabels of the desired pod.<br/>
- <br/>
- <i>Default</i>: map[]<br/>
+ The bootstrap servers connection string.<br/>
</td>
- <td>false</td>
+ <td>true</td>
+ </tr><tr>
+ <td><b><a href="#benchmarkspeckafkaconfigtopicsindex">topics</a></b></td>
+ <td>[]object</td>
+ <td>
+ List of topics to be created for each experiment. Alternative theodolite offers the possibility to remove certain topics after each experiment.<br/>
+ </td>
+ <td>true</td>
</tr></tbody>
</table>
-### benchmark.spec.sut.resources[index]
-<sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
+### benchmark.spec.kafkaConfig.topics[index]
+<sup><sup>[↩ Parent](#benchmarkspeckafkaconfig)</sup></sup>
@@ -1590,63 +1617,51 @@ Specifies the pod.
</tr>
</thead>
<tbody><tr>
- <td><b><a href="#benchmarkspecsutresourcesindexconfigmap">configMap</a></b></td>
- <td>object</td>
+ <td><b>name</b></td>
+ <td>string</td>
<td>
- The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/>
+ The name of the topic.<br/>
+ <br/>
+ <i>Default</i>: <br/>
</td>
- <td>false</td>
+ <td>true</td>
</tr><tr>
- <td><b><a href="#benchmarkspecsutresourcesindexfilesystem">fileSystem</a></b></td>
- <td>object</td>
+ <td><b>numPartitions</b></td>
+ <td>integer</td>
<td>
- The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
+ The number of partitions of the topic.<br/>
+ <br/>
+ <i>Default</i>: 0<br/>
</td>
<td>false</td>
- </tr></tbody>
-</table>
-
-
-### benchmark.spec.sut.resources[index].configMap
-<sup><sup>[↩ Parent](#benchmarkspecsutresourcesindex)</sup></sup>
-
-
-
-The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.
-
-<table>
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- </thead>
- <tbody><tr>
- <td><b>files</b></td>
- <td>[]string</td>
+ </tr><tr>
+ <td><b>removeOnly</b></td>
+ <td>boolean</td>
<td>
- (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
+ Determines if this topic should only be deleted after each experiement. For removeOnly topics the name can be a RegEx describing the topic.<br/>
+ <br/>
+ <i>Default</i>: false<br/>
</td>
<td>false</td>
</tr><tr>
- <td><b>name</b></td>
- <td>string</td>
+ <td><b>replicationFactor</b></td>
+ <td>integer</td>
<td>
- The name of the configMap<br/>
+ The replication factor of the topic.<br/>
+ <br/>
+ <i>Default</i>: 0<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
-### benchmark.spec.sut.resources[index].fileSystem
-<sup><sup>[↩ Parent](#benchmarkspecsutresourcesindex)</sup></sup>
+### benchmark.status
+<sup><sup>[↩ Parent](#benchmark)</sup></sup>
+
-The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
<table>
<thead>
@@ -1658,17 +1673,10 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr>
</thead>
<tbody><tr>
- <td><b>files</b></td>
- <td>[]string</td>
- <td>
- (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
- </td>
- <td>false</td>
- </tr><tr>
- <td><b>path</b></td>
+ <td><b>resourceSetsState</b></td>
<td>string</td>
<td>
- The path to the folder which contains the Kubernetes manifests files.<br/>
+ The status of a Benchmark indicates whether all resources are available to start the benchmark or not.<br/>
</td>
<td>false</td>
</tr></tbody>
@@ -1710,13 +1718,6 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
<td>object</td>
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
<td>true</td>
- </tr><tr>
- <td><b><a href="#executionstatus">status</a></b></td>
- <td>object</td>
- <td>
- <br/>
- </td>
- <td>false</td>
</tr><tr>
<td><b><a href="#executionspec">spec</a></b></td>
<td>object</td>
@@ -1724,58 +1725,13 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
<br/>
</td>
<td>true</td>
- </tr></tbody>
-</table>
-
-
-### execution.status
-<sup><sup>[↩ Parent](#execution)</sup></sup>
-
-
-
-
-
-<table>
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- </thead>
- <tbody><tr>
- <td><b>completionTime</b></td>
- <td>string</td>
- <td>
- Time when this execution was stopped<br/>
- <br/>
- <i>Format</i>: date-time<br/>
- </td>
- <td>false</td>
</tr><tr>
- <td><b>executionDuration</b></td>
- <td>string</td>
- <td>
- Duration of the execution<br/>
- </td>
- <td>false</td>
- </tr><tr>
- <td><b>executionState</b></td>
- <td>string</td>
+ <td><b><a href="#executionstatus">status</a></b></td>
+ <td>object</td>
<td>
<br/>
</td>
<td>false</td>
- </tr><tr>
- <td><b>startTime</b></td>
- <td>string</td>
- <td>
- Time this execution started<br/>
- <br/>
- <i>Format</i>: date-time<br/>
- </td>
- <td>false</td>
</tr></tbody>
</table>
@@ -1797,15 +1753,6 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr>
</thead>
<tbody><tr>
- <td><b>name</b></td>
- <td>string</td>
- <td>
- This field exists only for technical reasons and should not be set by the user. The value of the field will be overwritten.<br/>
- <br/>
- <i>Default</i>: <br/>
- </td>
- <td>false</td>
- </tr><tr>
<td><b>benchmark</b></td>
<td>string</td>
<td>
@@ -1847,6 +1794,15 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
List of resource values for the specified resource type.<br/>
</td>
<td>true</td>
+ </tr><tr>
+ <td><b>name</b></td>
+ <td>string</td>
+ <td>
+ This field exists only for technical reasons and should not be set by the user. The value of the field will be overwritten.<br/>
+ <br/>
+ <i>Default</i>: <br/>
+ </td>
+ <td>false</td>
</tr></tbody>
</table>
@@ -1902,15 +1858,6 @@ Patcher used to patch a resource
</tr>
</thead>
<tbody><tr>
- <td><b>properties</b></td>
- <td>map[string]string</td>
- <td>
- (Optional) Patcher specific additional arguments.<br/>
- <br/>
- <i>Default</i>: map[]<br/>
- </td>
- <td>false</td>
- </tr><tr>
<td><b>resource</b></td>
<td>string</td>
<td>
@@ -1928,6 +1875,15 @@ Patcher used to patch a resource
<i>Default</i>: <br/>
</td>
<td>true</td>
+ </tr><tr>
+ <td><b>properties</b></td>
+ <td>map[string]string</td>
+ <td>
+ (Optional) Patcher specific additional arguments.<br/>
+ <br/>
+ <i>Default</i>: map[]<br/>
+ </td>
+ <td>false</td>
</tr></tbody>
</table>
@@ -1949,13 +1905,6 @@ Defines the overall parameter for the execution.
</tr>
</thead>
<tbody><tr>
- <td><b>loadGenerationDelay</b></td>
- <td>integer</td>
- <td>
- Seconds to wait between the start of the SUT and the load generator.<br/>
- </td>
- <td>false</td>
- </tr><tr>
<td><b>duration</b></td>
<td>integer</td>
<td>
@@ -1983,6 +1932,13 @@ Defines the overall parameter for the execution.
Defines the used strategy for the execution, either 'LinearSearch' or 'BinarySearch'<br/>
</td>
<td>true</td>
+ </tr><tr>
+ <td><b>loadGenerationDelay</b></td>
+ <td>integer</td>
+ <td>
+ Seconds to wait between the start of the SUT and the load generator.<br/>
+ </td>
+ <td>false</td>
</tr></tbody>
</table>
@@ -2072,15 +2028,6 @@ Specifies the scaling resource that is benchmarked.
</tr>
</thead>
<tbody><tr>
- <td><b>properties</b></td>
- <td>map[string]string</td>
- <td>
- (Optional) SLO specific additional arguments.<br/>
- <br/>
- <i>Default</i>: map[]<br/>
- </td>
- <td>false</td>
- </tr><tr>
<td><b>offset</b></td>
<td>integer</td>
<td>
@@ -2101,5 +2048,66 @@ Specifies the scaling resource that is benchmarked.
The type of the SLO. It must match 'lag trend'.<br/>
</td>
<td>true</td>
+ </tr><tr>
+ <td><b>properties</b></td>
+ <td>map[string]string</td>
+ <td>
+ (Optional) SLO specific additional arguments.<br/>
+ <br/>
+ <i>Default</i>: map[]<br/>
+ </td>
+ <td>false</td>
+ </tr></tbody>
+</table>
+
+
+### execution.status
+<sup><sup>[↩ Parent](#execution)</sup></sup>
+
+
+
+
+
+<table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ </thead>
+ <tbody><tr>
+ <td><b>completionTime</b></td>
+ <td>string</td>
+ <td>
+ Time when this execution was stopped<br/>
+ <br/>
+ <i>Format</i>: date-time<br/>
+ </td>
+ <td>false</td>
+ </tr><tr>
+ <td><b>executionDuration</b></td>
+ <td>string</td>
+ <td>
+ Duration of the execution<br/>
+ </td>
+ <td>false</td>
+ </tr><tr>
+ <td><b>executionState</b></td>
+ <td>string</td>
+ <td>
+ <br/>
+ </td>
+ <td>false</td>
+ </tr><tr>
+ <td><b>startTime</b></td>
+ <td>string</td>
+ <td>
+ Time this execution started<br/>
+ <br/>
+ <i>Format</i>: date-time<br/>
+ </td>
+ <td>false</td>
</tr></tbody>
</table>
\ No newline at end of file
--
GitLab