Skip to content
Snippets Groups Projects
Commit e8d61606 authored by Benedikt Wetzel's avatar Benedikt Wetzel
Browse files

fix merge and generate new crd docs

parent df90bdff
Branches
Tags
1 merge request!261Wait until the resources of the predecessor resourceSet are ready
Pipeline #7298 failed
Stage: build
Stage: test
Stage: check
Show whitespace changes
Inline Side-by-side
docs/api-reference/crds.md
+ 458
− 456
View file @ e8d61606
---
title: Theodolite CRDs
has_children: false
parent: API Reference
nav_order: 1
---
# API Reference # API Reference
Packages: Packages:
...@@ -60,18 +52,45 @@ Resource Types: ...@@ -60,18 +52,45 @@ Resource Types:
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td> <td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
<td>true</td> <td>true</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspec">spec</a></b></td> <td><b><a href="#benchmarkstatus">status</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
<br/> <br/>
</td> </td>
<td>true</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkstatus">status</a></b></td> <td><b><a href="#benchmarkspec">spec</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
<br/> <br/>
</td> </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> <td>false</td>
</tr></tbody> </tr></tbody>
</table> </table>
...@@ -94,6 +113,41 @@ Resource Types: ...@@ -94,6 +113,41 @@ Resource Types:
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecinfrastructure">infrastructure</a></b></td>
<td>object</td>
<td>
(Optional) A list of file names that reference Kubernetes resources that are deployed on the cluster to create the required infrastructure.<br/>
<br/>
<i>Default</i>: map[]<br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspeckafkaconfig">kafkaConfig</a></b></td>
<td>object</td>
<td>
Contains the Kafka configuration.<br/>
</td>
<td>false</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><tr>
<td><b>rolloutMode</b></td>
<td>enum</td>
<td>
<br/>
<br/>
<i>Enum</i>: no-waiting, default<br/>
<i>Default</i>: default<br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspecloadgenerator">loadGenerator</a></b></td> <td><b><a href="#benchmarkspecloadgenerator">loadGenerator</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
...@@ -121,41 +175,16 @@ Resource Types: ...@@ -121,41 +175,16 @@ Resource Types:
The appResourceSets specifies all Kubernetes resources required to start the sut. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.<br/> 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>
<td>true</td> <td>true</td>
</tr><tr>
<td><b><a href="#benchmarkspecinfrastructure">infrastructure</a></b></td>
<td>object</td>
<td>
(Optional) A list of file names that reference Kubernetes resources that are deployed on the cluster to create the required infrastructure.<br/>
<br/>
<i>Default</i>: map[]<br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspeckafkaconfig">kafkaConfig</a></b></td>
<td>object</td>
<td>
Contains the Kafka configuration.<br/>
</td>
<td>false</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> </tr></tbody>
</table> </table>
### benchmark.spec.loadGenerator ### benchmark.spec.infrastructure
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup> <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. (Optional) A list of file names that reference Kubernetes resources that are deployed on the cluster to create the required infrastructure.
<table> <table>
<thead> <thead>
...@@ -167,25 +196,25 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the ...@@ -167,25 +196,25 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecloadgeneratorafteractionsindex">afterActions</a></b></td> <td><b><a href="#benchmarkspecinfrastructureafteractionsindex">afterActions</a></b></td>
<td>[]object</td> <td>[]object</td>
<td> <td>
Load generator after actions are executed after the teardown of the load generator.<br/> Infrastructure after actions are executed after the teardown of the infrastructure.<br/>
<br/> <br/>
<i>Default</i>: []<br/> <i>Default</i>: []<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindex">beforeActions</a></b></td> <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindex">beforeActions</a></b></td>
<td>[]object</td> <td>[]object</td>
<td> <td>
Load generator before actions are executed before the load generator is started.<br/> Infrastructure before actions are executed before the infrastructure is set up.<br/>
<br/> <br/>
<i>Default</i>: []<br/> <i>Default</i>: []<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorresourcesindex">resources</a></b></td> <td><b><a href="#benchmarkspecinfrastructureresourcesindex">resources</a></b></td>
<td>[]object</td> <td>[]object</td>
<td> <td>
<br/> <br/>
...@@ -197,8 +226,8 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the ...@@ -197,8 +226,8 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the
</table> </table>
### benchmark.spec.loadGenerator.afterActions[index] ### benchmark.spec.infrastructure.afterActions[index]
<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
...@@ -214,14 +243,14 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the ...@@ -214,14 +243,14 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecloadgeneratorafteractionsindexexec">exec</a></b></td> <td><b><a href="#benchmarkspecinfrastructureafteractionsindexexec">exec</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies command to be executed.<br/> Specifies command to be executed.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselector">selector</a></b></td> <td><b><a href="#benchmarkspecinfrastructureafteractionsindexselector">selector</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The selector specifies which resource should be selected for the execution of the command.<br/> The selector specifies which resource should be selected for the execution of the command.<br/>
...@@ -231,8 +260,8 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the ...@@ -231,8 +260,8 @@ The loadGenResourceSets specifies all Kubernetes resources required to start the
</table> </table>
### benchmark.spec.loadGenerator.afterActions[index].exec ### benchmark.spec.infrastructure.afterActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindex)</sup></sup>
...@@ -265,8 +294,8 @@ Specifies command to be executed. ...@@ -265,8 +294,8 @@ Specifies command to be executed.
</table> </table>
### benchmark.spec.loadGenerator.afterActions[index].selector ### benchmark.spec.infrastructure.afterActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindex)</sup></sup>
...@@ -291,7 +320,7 @@ The selector specifies which resource should be selected for the execution of th ...@@ -291,7 +320,7 @@ The selector specifies which resource should be selected for the execution of th
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselectorpod">pod</a></b></td> <td><b><a href="#benchmarkspecinfrastructureafteractionsindexselectorpod">pod</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies the pod.<br/> Specifies the pod.<br/>
...@@ -301,8 +330,8 @@ The selector specifies which resource should be selected for the execution of th ...@@ -301,8 +330,8 @@ The selector specifies which resource should be selected for the execution of th
</table> </table>
### benchmark.spec.loadGenerator.afterActions[index].selector.pod ### benchmark.spec.infrastructure.afterActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindexselector)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindexselector)</sup></sup>
...@@ -330,8 +359,8 @@ Specifies the pod. ...@@ -330,8 +359,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.loadGenerator.beforeActions[index] ### benchmark.spec.infrastructure.beforeActions[index]
<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
...@@ -347,14 +376,14 @@ Specifies the pod. ...@@ -347,14 +376,14 @@ Specifies the pod.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexexec">exec</a></b></td> <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexexec">exec</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies command to be executed.<br/> Specifies command to be executed.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselector">selector</a></b></td> <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexselector">selector</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The selector specifies which resource should be selected for the execution of the command.<br/> The selector specifies which resource should be selected for the execution of the command.<br/>
...@@ -364,8 +393,8 @@ Specifies the pod. ...@@ -364,8 +393,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.loadGenerator.beforeActions[index].exec ### benchmark.spec.infrastructure.beforeActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindex)</sup></sup>
...@@ -398,8 +427,8 @@ Specifies command to be executed. ...@@ -398,8 +427,8 @@ Specifies command to be executed.
</table> </table>
### benchmark.spec.loadGenerator.beforeActions[index].selector ### benchmark.spec.infrastructure.beforeActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindex)</sup></sup>
...@@ -424,7 +453,7 @@ The selector specifies which resource should be selected for the execution of th ...@@ -424,7 +453,7 @@ The selector specifies which resource should be selected for the execution of th
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselectorpod">pod</a></b></td> <td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexselectorpod">pod</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies the pod.<br/> Specifies the pod.<br/>
...@@ -434,8 +463,8 @@ The selector specifies which resource should be selected for the execution of th ...@@ -434,8 +463,8 @@ The selector specifies which resource should be selected for the execution of th
</table> </table>
### benchmark.spec.loadGenerator.beforeActions[index].selector.pod ### benchmark.spec.infrastructure.beforeActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindexselector)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindexselector)</sup></sup>
...@@ -463,8 +492,8 @@ Specifies the pod. ...@@ -463,8 +492,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.loadGenerator.resources[index] ### benchmark.spec.infrastructure.resources[index]
<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup>
...@@ -480,14 +509,14 @@ Specifies the pod. ...@@ -480,14 +509,14 @@ Specifies the pod.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecloadgeneratorresourcesindexconfigmap">configMap</a></b></td> <td><b><a href="#benchmarkspecinfrastructureresourcesindexconfigmap">configMap</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/> The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorresourcesindexfilesystem">fileSystem</a></b></td> <td><b><a href="#benchmarkspecinfrastructureresourcesindexfilesystem">fileSystem</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/> The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
...@@ -497,8 +526,8 @@ Specifies the pod. ...@@ -497,8 +526,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.loadGenerator.resources[index].configMap ### benchmark.spec.infrastructure.resources[index].configMap
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructureresourcesindex)</sup></sup>
...@@ -531,8 +560,8 @@ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes conf ...@@ -531,8 +560,8 @@ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes conf
</table> </table>
### benchmark.spec.loadGenerator.resources[index].fileSystem ### benchmark.spec.infrastructure.resources[index].fileSystem
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecinfrastructureresourcesindex)</sup></sup>
...@@ -565,12 +594,12 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -565,12 +594,12 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</table> </table>
### benchmark.spec.loadTypes[index] ### benchmark.spec.kafkaConfig
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
Contains the Kafka configuration.
<table> <table>
<thead> <thead>
...@@ -582,25 +611,25 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -582,25 +611,25 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecloadtypesindexpatchersindex">patchers</a></b></td> <td><b>bootstrapServer</b></td>
<td>[]object</td> <td>string</td>
<td> <td>
List of patchers used to scale this resource type.<br/> The bootstrap servers connection string.<br/>
</td> </td>
<td>true</td> <td>true</td>
</tr><tr> </tr><tr>
<td><b>typeName</b></td> <td><b><a href="#benchmarkspeckafkaconfigtopicsindex">topics</a></b></td>
<td>string</td> <td>[]object</td>
<td> <td>
Name of the load type.<br/> List of topics to be created for each experiment. Alternative theodolite offers the possibility to remove certain topics after each experiment.<br/>
</td> </td>
<td>true</td> <td>true</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.loadTypes[index].patchers[index] ### benchmark.spec.kafkaConfig.topics[index]
<sup><sup>[↩ Parent](#benchmarkspecloadtypesindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspeckafkaconfig)</sup></sup>
...@@ -616,42 +645,51 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -616,42 +645,51 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>resource</b></td> <td><b>numPartitions</b></td>
<td>string</td> <td>integer</td>
<td> <td>
Specifies the Kubernetes resource to be patched.<br/> The number of partitions of the topic.<br/>
<br/> <br/>
<i>Default</i>: <br/> <i>Default</i>: 0<br/>
</td> </td>
<td>true</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>type</b></td> <td><b>removeOnly</b></td>
<td>string</td> <td>boolean</td>
<td> <td>
Type of the Patcher.<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/> <br/>
<i>Default</i>: <br/> <i>Default</i>: false<br/>
</td> </td>
<td>true</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>properties</b></td> <td><b>replicationFactor</b></td>
<td>map[string]string</td> <td>integer</td>
<td> <td>
(Optional) Patcher specific additional arguments.<br/> The replication factor of the topic.<br/>
<br/> <br/>
<i>Default</i>: map[]<br/> <i>Default</i>: 0<br/>
</td> </td>
<td>false</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> </tr></tbody>
</table> </table>
### benchmark.spec.resourceTypes[index] ### benchmark.spec.loadGenerator
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup> <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> <table>
<thead> <thead>
...@@ -663,119 +701,38 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -663,119 +701,38 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecresourcetypesindexpatchersindex">patchers</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorafteractionsindex">afterActions</a></b></td>
<td>[]object</td> <td>[]object</td>
<td> <td>
List of patchers used to scale this resource type.<br/> Load generator after actions are executed after the teardown of the load generator.<br/>
<br/>
<i>Default</i>: []<br/>
</td> </td>
<td>true</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>typeName</b></td> <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindex">beforeActions</a></b></td>
<td>string</td> <td>[]object</td>
<td> <td>
Name of the resource type.<br/> Load generator before actions are executed before the load generator is started.<br/>
<br/>
<i>Default</i>: []<br/>
</td> </td>
<td>true</td> <td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorresourcesindex">resources</a></b></td>
<td>[]object</td>
<td>
<br/>
<br/>
<i>Default</i>: []<br/>
</td>
<td>false</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.resourceTypes[index].patchers[index] ### benchmark.spec.loadGenerator.afterActions[index]
<sup><sup>[↩ Parent](#benchmarkspecresourcetypesindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><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>
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>
...@@ -791,14 +748,14 @@ The appResourceSets specifies all Kubernetes resources required to start the sut ...@@ -791,14 +748,14 @@ The appResourceSets specifies all Kubernetes resources required to start the sut
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecsutafteractionsindexexec">exec</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexexec">exec</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies command to be executed.<br/> Specifies command to be executed.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecsutafteractionsindexselector">selector</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselector">selector</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The selector specifies which resource should be selected for the execution of the command.<br/> The selector specifies which resource should be selected for the execution of the command.<br/>
...@@ -808,8 +765,8 @@ The appResourceSets specifies all Kubernetes resources required to start the sut ...@@ -808,8 +765,8 @@ The appResourceSets specifies all Kubernetes resources required to start the sut
</table> </table>
### benchmark.spec.sut.afterActions[index].exec ### benchmark.spec.loadGenerator.afterActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup>
...@@ -842,8 +799,8 @@ Specifies command to be executed. ...@@ -842,8 +799,8 @@ Specifies command to be executed.
</table> </table>
### benchmark.spec.sut.afterActions[index].selector ### benchmark.spec.loadGenerator.afterActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup>
...@@ -868,7 +825,7 @@ The selector specifies which resource should be selected for the execution of th ...@@ -868,7 +825,7 @@ The selector specifies which resource should be selected for the execution of th
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecsutafteractionsindexselectorpod">pod</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselectorpod">pod</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies the pod.<br/> Specifies the pod.<br/>
...@@ -878,8 +835,8 @@ The selector specifies which resource should be selected for the execution of th ...@@ -878,8 +835,8 @@ The selector specifies which resource should be selected for the execution of th
</table> </table>
### benchmark.spec.sut.afterActions[index].selector.pod ### benchmark.spec.loadGenerator.afterActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindexselector)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindexselector)</sup></sup>
...@@ -907,8 +864,8 @@ Specifies the pod. ...@@ -907,8 +864,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.sut.beforeActions[index] ### benchmark.spec.loadGenerator.beforeActions[index]
<sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
...@@ -924,14 +881,14 @@ Specifies the pod. ...@@ -924,14 +881,14 @@ Specifies the pod.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecsutbeforeactionsindexexec">exec</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexexec">exec</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies command to be executed.<br/> Specifies command to be executed.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecsutbeforeactionsindexselector">selector</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselector">selector</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The selector specifies which resource should be selected for the execution of the command.<br/> The selector specifies which resource should be selected for the execution of the command.<br/>
...@@ -941,8 +898,8 @@ Specifies the pod. ...@@ -941,8 +898,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.sut.beforeActions[index].exec ### benchmark.spec.loadGenerator.beforeActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup>
...@@ -975,8 +932,8 @@ Specifies command to be executed. ...@@ -975,8 +932,8 @@ Specifies command to be executed.
</table> </table>
### benchmark.spec.sut.beforeActions[index].selector ### benchmark.spec.loadGenerator.beforeActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup>
...@@ -1001,7 +958,7 @@ The selector specifies which resource should be selected for the execution of th ...@@ -1001,7 +958,7 @@ The selector specifies which resource should be selected for the execution of th
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecsutbeforeactionsindexselectorpod">pod</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselectorpod">pod</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies the pod.<br/> Specifies the pod.<br/>
...@@ -1011,8 +968,8 @@ The selector specifies which resource should be selected for the execution of th ...@@ -1011,8 +968,8 @@ The selector specifies which resource should be selected for the execution of th
</table> </table>
### benchmark.spec.sut.beforeActions[index].selector.pod ### benchmark.spec.loadGenerator.beforeActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindexselector)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindexselector)</sup></sup>
...@@ -1040,8 +997,8 @@ Specifies the pod. ...@@ -1040,8 +997,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.sut.resources[index] ### benchmark.spec.loadGenerator.resources[index]
<sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
...@@ -1057,14 +1014,14 @@ Specifies the pod. ...@@ -1057,14 +1014,14 @@ Specifies the pod.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecsutresourcesindexconfigmap">configMap</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorresourcesindexconfigmap">configMap</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/> The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecsutresourcesindexfilesystem">fileSystem</a></b></td> <td><b><a href="#benchmarkspecloadgeneratorresourcesindexfilesystem">fileSystem</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/> The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
...@@ -1074,8 +1031,8 @@ Specifies the pod. ...@@ -1074,8 +1031,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.sut.resources[index].configMap ### benchmark.spec.loadGenerator.resources[index].configMap
<sup><sup>[↩ Parent](#benchmarkspecsutresourcesindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup>
...@@ -1108,8 +1065,8 @@ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes conf ...@@ -1108,8 +1065,8 @@ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes conf
</table> </table>
### benchmark.spec.sut.resources[index].fileSystem ### benchmark.spec.loadGenerator.resources[index].fileSystem
<sup><sup>[↩ Parent](#benchmarkspecsutresourcesindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup>
...@@ -1142,12 +1099,12 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -1142,12 +1099,12 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</table> </table>
### benchmark.spec.infrastructure ### benchmark.spec.loadTypes[index]
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup> <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> <table>
<thead> <thead>
...@@ -1159,38 +1116,25 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -1159,38 +1116,25 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecinfrastructureafteractionsindex">afterActions</a></b></td> <td><b><a href="#benchmarkspecloadtypesindexpatchersindex">patchers</a></b></td>
<td>[]object</td>
<td>
Infrastructure after actions are executed after the teardown of the infrastructure.<br/>
<br/>
<i>Default</i>: []<br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspecinfrastructurebeforeactionsindex">beforeActions</a></b></td>
<td>[]object</td> <td>[]object</td>
<td> <td>
Infrastructure before actions are executed before the infrastructure is set up.<br/> List of patchers used to scale this resource type.<br/>
<br/>
<i>Default</i>: []<br/>
</td> </td>
<td>false</td> <td>true</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecinfrastructureresourcesindex">resources</a></b></td> <td><b>typeName</b></td>
<td>[]object</td> <td>string</td>
<td> <td>
<br/> Name of the load type.<br/>
<br/>
<i>Default</i>: []<br/>
</td> </td>
<td>false</td> <td>true</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.infrastructure.afterActions[index] ### benchmark.spec.loadTypes[index].patchers[index]
<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecloadtypesindex)</sup></sup>
...@@ -1206,29 +1150,42 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -1206,29 +1150,42 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecinfrastructureafteractionsindexexec">exec</a></b></td> <td><b>properties</b></td>
<td>object</td> <td>map[string]string</td>
<td> <td>
Specifies command to be executed.<br/> (Optional) Patcher specific additional arguments.<br/>
<br/>
<i>Default</i>: map[]<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecinfrastructureafteractionsindexselector">selector</a></b></td> <td><b>resource</b></td>
<td>object</td> <td>string</td>
<td> <td>
The selector specifies which resource should be selected for the execution of the command.<br/> Specifies the Kubernetes resource to be patched.<br/>
<br/>
<i>Default</i>: <br/>
</td> </td>
<td>false</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></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.infrastructure.afterActions[index].exec ### benchmark.spec.resourceTypes[index]
<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
Specifies command to be executed.
<table> <table>
<thead> <thead>
...@@ -1240,29 +1197,29 @@ Specifies command to be executed. ...@@ -1240,29 +1197,29 @@ Specifies command to be executed.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>command</b></td> <td><b><a href="#benchmarkspecresourcetypesindexpatchersindex">patchers</a></b></td>
<td>[]string</td> <td>[]object</td>
<td> <td>
The command to be executed as string array.<br/> List of patchers used to scale this resource type.<br/>
</td> </td>
<td>false</td> <td>true</td>
</tr><tr> </tr><tr>
<td><b>timeoutSeconds</b></td> <td><b>typeName</b></td>
<td>integer</td> <td>string</td>
<td> <td>
Specifies the timeout (in seconds) for the specified command.<br/> Name of the resource type.<br/>
</td> </td>
<td>false</td> <td>true</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.infrastructure.afterActions[index].selector ### benchmark.spec.resourceTypes[index].patchers[index]
<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecresourcetypesindex)</sup></sup>
The selector specifies which resource should be selected for the execution of the command.
<table> <table>
<thead> <thead>
...@@ -1274,31 +1231,42 @@ The selector specifies which resource should be selected for the execution of th ...@@ -1274,31 +1231,42 @@ The selector specifies which resource should be selected for the execution of th
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>container</b></td> <td><b>properties</b></td>
<td>string</td> <td>map[string]string</td>
<td> <td>
Specifies the container.<br/> (Optional) Patcher specific additional arguments.<br/>
<br/> <br/>
<i>Default</i>: <br/> <i>Default</i>: map[]<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecinfrastructureafteractionsindexselectorpod">pod</a></b></td> <td><b>resource</b></td>
<td>object</td> <td>string</td>
<td> <td>
Specifies the pod.<br/> Specifies the Kubernetes resource to be patched.<br/>
</td> <br/>
<td>false</td> <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></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.infrastructure.afterActions[index].selector.pod ### benchmark.spec.sut
<sup><sup>[↩ Parent](#benchmarkspecinfrastructureafteractionsindexselector)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
Specifies the pod. The appResourceSets specifies all Kubernetes resources required to start the sut. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.
<table> <table>
<thead> <thead>
...@@ -1310,20 +1278,38 @@ Specifies the pod. ...@@ -1310,20 +1278,38 @@ Specifies the pod.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>matchLabels</b></td> <td><b><a href="#benchmarkspecsutafteractionsindex">afterActions</a></b></td>
<td>map[string]string</td> <td>[]object</td>
<td> <td>
The matchLabels of the desired pod.<br/>
<br/> <br/>
<i>Default</i>: map[]<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>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.infrastructure.beforeActions[index] ### benchmark.spec.sut.afterActions[index]
<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
...@@ -1339,14 +1325,14 @@ Specifies the pod. ...@@ -1339,14 +1325,14 @@ Specifies the pod.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexexec">exec</a></b></td> <td><b><a href="#benchmarkspecsutafteractionsindexexec">exec</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies command to be executed.<br/> Specifies command to be executed.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexselector">selector</a></b></td> <td><b><a href="#benchmarkspecsutafteractionsindexselector">selector</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The selector specifies which resource should be selected for the execution of the command.<br/> The selector specifies which resource should be selected for the execution of the command.<br/>
...@@ -1356,8 +1342,8 @@ Specifies the pod. ...@@ -1356,8 +1342,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.infrastructure.beforeActions[index].exec ### benchmark.spec.sut.afterActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup>
...@@ -1390,8 +1376,8 @@ Specifies command to be executed. ...@@ -1390,8 +1376,8 @@ Specifies command to be executed.
</table> </table>
### benchmark.spec.infrastructure.beforeActions[index].selector ### benchmark.spec.sut.afterActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup>
...@@ -1416,7 +1402,7 @@ The selector specifies which resource should be selected for the execution of th ...@@ -1416,7 +1402,7 @@ The selector specifies which resource should be selected for the execution of th
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecinfrastructurebeforeactionsindexselectorpod">pod</a></b></td> <td><b><a href="#benchmarkspecsutafteractionsindexselectorpod">pod</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
Specifies the pod.<br/> Specifies the pod.<br/>
...@@ -1426,8 +1412,8 @@ The selector specifies which resource should be selected for the execution of th ...@@ -1426,8 +1412,8 @@ The selector specifies which resource should be selected for the execution of th
</table> </table>
### benchmark.spec.infrastructure.beforeActions[index].selector.pod ### benchmark.spec.sut.afterActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspecinfrastructurebeforeactionsindexselector)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindexselector)</sup></sup>
...@@ -1455,8 +1441,8 @@ Specifies the pod. ...@@ -1455,8 +1441,8 @@ Specifies the pod.
</table> </table>
### benchmark.spec.infrastructure.resources[index] ### benchmark.spec.sut.beforeActions[index]
<sup><sup>[↩ Parent](#benchmarkspecinfrastructure)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
...@@ -1472,29 +1458,29 @@ Specifies the pod. ...@@ -1472,29 +1458,29 @@ Specifies the pod.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b><a href="#benchmarkspecinfrastructureresourcesindexconfigmap">configMap</a></b></td> <td><b><a href="#benchmarkspecsutbeforeactionsindexexec">exec</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/> Specifies command to be executed.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b><a href="#benchmarkspecinfrastructureresourcesindexfilesystem">fileSystem</a></b></td> <td><b><a href="#benchmarkspecsutbeforeactionsindexselector">selector</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/> The selector specifies which resource should be selected for the execution of the command.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.infrastructure.resources[index].configMap ### benchmark.spec.sut.beforeActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecinfrastructureresourcesindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup>
The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap. Specifies command to be executed.
<table> <table>
<thead> <thead>
...@@ -1506,29 +1492,29 @@ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes conf ...@@ -1506,29 +1492,29 @@ The configMap resourceSet loads the Kubernetes manifests from an Kubernetes conf
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>files</b></td> <td><b>command</b></td>
<td>[]string</td> <td>[]string</td>
<td> <td>
(Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/> The command to be executed as string array.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>name</b></td> <td><b>timeoutSeconds</b></td>
<td>string</td> <td>integer</td>
<td> <td>
The name of the configMap<br/> Specifies the timeout (in seconds) for the specified command.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.infrastructure.resources[index].fileSystem ### benchmark.spec.sut.beforeActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecinfrastructureresourcesindex)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. The selector specifies which resource should be selected for the execution of the command.
<table> <table>
<thead> <thead>
...@@ -1540,29 +1526,31 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -1540,29 +1526,31 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>files</b></td> <td><b>container</b></td>
<td>[]string</td> <td>string</td>
<td> <td>
(Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/> Specifies the container.<br/>
<br/>
<i>Default</i>: <br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>path</b></td> <td><b><a href="#benchmarkspecsutbeforeactionsindexselectorpod">pod</a></b></td>
<td>string</td> <td>object</td>
<td> <td>
The path to the folder which contains the Kubernetes manifests files.<br/> Specifies the pod.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.kafkaConfig ### benchmark.spec.sut.beforeActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindexselector)</sup></sup>
Contains the Kafka configuration. Specifies the pod.
<table> <table>
<thead> <thead>
...@@ -1574,25 +1562,20 @@ Contains the Kafka configuration. ...@@ -1574,25 +1562,20 @@ Contains the Kafka configuration.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>bootstrapServer</b></td> <td><b>matchLabels</b></td>
<td>string</td> <td>map[string]string</td>
<td>
The bootstrap servers connection string.<br/>
</td>
<td>true</td>
</tr><tr>
<td><b><a href="#benchmarkspeckafkaconfigtopicsindex">topics</a></b></td>
<td>[]object</td>
<td> <td>
List of topics to be created for each experiment. Alternative theodolite offers the possibility to remove certain topics after each experiment.<br/> The matchLabels of the desired pod.<br/>
<br/>
<i>Default</i>: map[]<br/>
</td> </td>
<td>true</td> <td>false</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.spec.kafkaConfig.topics[index] ### benchmark.spec.sut.resources[index]
<sup><sup>[↩ Parent](#benchmarkspeckafkaconfig)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsut)</sup></sup>
...@@ -1608,51 +1591,63 @@ Contains the Kafka configuration. ...@@ -1608,51 +1591,63 @@ Contains the Kafka configuration.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>name</b></td> <td><b><a href="#benchmarkspecsutresourcesindexconfigmap">configMap</a></b></td>
<td>string</td> <td>object</td>
<td> <td>
The name of the topic.<br/> The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.<br/>
<br/>
<i>Default</i>: <br/>
</td> </td>
<td>true</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>numPartitions</b></td> <td><b><a href="#benchmarkspecsutresourcesindexfilesystem">fileSystem</a></b></td>
<td>integer</td> <td>object</td>
<td> <td>
The number of partitions of the topic.<br/> The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
<br/>
<i>Default</i>: 0<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr></tbody>
<td><b>removeOnly</b></td> </table>
<td>boolean</td>
### 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>
<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/> (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
<br/>
<i>Default</i>: false<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>replicationFactor</b></td> <td><b>name</b></td>
<td>integer</td> <td>string</td>
<td> <td>
The replication factor of the topic.<br/> The name of the configMap<br/>
<br/>
<i>Default</i>: 0<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
</table> </table>
### benchmark.status ### benchmark.spec.sut.resources[index].fileSystem
<sup><sup>[↩ Parent](#benchmark)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspecsutresourcesindex)</sup></sup>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
<table> <table>
<thead> <thead>
...@@ -1664,10 +1659,17 @@ Contains the Kafka configuration. ...@@ -1664,10 +1659,17 @@ Contains the Kafka configuration.
</tr> </tr>
</thead> </thead>
<tbody><tr> <tbody><tr>
<td><b>resourceSetsState</b></td> <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>string</td> <td>string</td>
<td> <td>
The status of a Benchmark indicates whether all resources are available to start the benchmark or not.<br/> The path to the folder which contains the Kubernetes manifests files.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
...@@ -1709,6 +1711,13 @@ Contains the Kafka configuration. ...@@ -1709,6 +1711,13 @@ Contains the Kafka configuration.
<td>object</td> <td>object</td>
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td> <td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
<td>true</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> </tr><tr>
<td><b><a href="#executionspec">spec</a></b></td> <td><b><a href="#executionspec">spec</a></b></td>
<td>object</td> <td>object</td>
...@@ -1716,13 +1725,58 @@ Contains the Kafka configuration. ...@@ -1716,13 +1725,58 @@ Contains the Kafka configuration.
<br/> <br/>
</td> </td>
<td>true</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> </tr><tr>
<td><b><a href="#executionstatus">status</a></b></td> <td><b>executionDuration</b></td>
<td>object</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> <td>
<br/> <br/>
</td> </td>
<td>false</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> </tr></tbody>
</table> </table>
...@@ -1744,6 +1798,15 @@ Contains the Kafka configuration. ...@@ -1744,6 +1798,15 @@ Contains the Kafka configuration.
</tr> </tr>
</thead> </thead>
<tbody><tr> <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><b>benchmark</b></td>
<td>string</td> <td>string</td>
<td> <td>
...@@ -1785,15 +1848,6 @@ Contains the Kafka configuration. ...@@ -1785,15 +1848,6 @@ Contains the Kafka configuration.
List of resource values for the specified resource type.<br/> List of resource values for the specified resource type.<br/>
</td> </td>
<td>true</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> </tr></tbody>
</table> </table>
...@@ -1849,6 +1903,15 @@ Patcher used to patch a resource ...@@ -1849,6 +1903,15 @@ Patcher used to patch a resource
</tr> </tr>
</thead> </thead>
<tbody><tr> <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><b>resource</b></td>
<td>string</td> <td>string</td>
<td> <td>
...@@ -1866,15 +1929,6 @@ Patcher used to patch a resource ...@@ -1866,15 +1929,6 @@ Patcher used to patch a resource
<i>Default</i>: <br/> <i>Default</i>: <br/>
</td> </td>
<td>true</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> </tr></tbody>
</table> </table>
...@@ -1896,6 +1950,13 @@ Defines the overall parameter for the execution. ...@@ -1896,6 +1950,13 @@ Defines the overall parameter for the execution.
</tr> </tr>
</thead> </thead>
<tbody><tr> <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><b>duration</b></td>
<td>integer</td> <td>integer</td>
<td> <td>
...@@ -1923,13 +1984,6 @@ Defines the overall parameter for the execution. ...@@ -1923,13 +1984,6 @@ Defines the overall parameter for the execution.
Defines the used strategy for the execution, either 'LinearSearch' or 'BinarySearch'<br/> Defines the used strategy for the execution, either 'LinearSearch' or 'BinarySearch'<br/>
</td> </td>
<td>true</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> </tr></tbody>
</table> </table>
...@@ -2019,6 +2073,15 @@ Specifies the scaling resource that is benchmarked. ...@@ -2019,6 +2073,15 @@ Specifies the scaling resource that is benchmarked.
</tr> </tr>
</thead> </thead>
<tbody><tr> <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><b>offset</b></td>
<td>integer</td> <td>integer</td>
<td> <td>
...@@ -2039,66 +2102,5 @@ Specifies the scaling resource that is benchmarked. ...@@ -2039,66 +2102,5 @@ Specifies the scaling resource that is benchmarked.
The type of the SLO. It must match 'lag trend'.<br/> The type of the SLO. It must match 'lag trend'.<br/>
</td> </td>
<td>true</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> </tr></tbody>
</table> </table>
\ No newline at end of file
theodolite/src/main/kotlin/theodolite/benchmark/RolloutManager.kt
+ 2
− 3
View file @ e8d61606
package theodolite.benchmark package theodolite.benchmark
import io.fabric8.kubernetes.api.model.KubernetesResource import io.fabric8.kubernetes.api.model.HasMetadata
import io.fabric8.kubernetes.api.model.apps.DaemonSet import io.fabric8.kubernetes.api.model.apps.DaemonSet
import io.fabric8.kubernetes.api.model.apps.Deployment import io.fabric8.kubernetes.api.model.apps.Deployment
import io.fabric8.kubernetes.api.model.apps.ReplicaSet import io.fabric8.kubernetes.api.model.apps.ReplicaSet
...@@ -13,8 +13,7 @@ private var SLEEP_TIME_MS = 500L ...@@ -13,8 +13,7 @@ private var SLEEP_TIME_MS = 500L
class RolloutManager(private val rolloutMode: RolloutMode, private val client: NamespacedKubernetesClient) { class RolloutManager(private val rolloutMode: RolloutMode, private val client: NamespacedKubernetesClient) {
fun rollout(resources: List<KubernetesResource>) { fun rollout(resources: List<HasMetadata>) {
println("MODE IS: ${rolloutMode.value}")
resources resources
.forEach { K8sManager(client).deploy(it) } .forEach { K8sManager(client).deploy(it) }
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment