Newer
Older
---
title: Theodolite CRDs
has_children: false
parent: API Reference
nav_order: 1
---
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# API Reference
Packages:
- [theodolite.com/v1](#theodolitecomv1)
# theodolite.com/v1
Resource Types:
- [benchmark](#benchmark)
- [execution](#execution)
## benchmark
<sup><sup>[↩ Parent](#theodolitecomv1 )</sup></sup>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>apiVersion</b></td>
<td>string</td>
<td>theodolite.com/v1</td>
<td>true</td>
</tr>
<tr>
<td><b>kind</b></td>
<td>string</td>
<td>benchmark</td>
<td>true</td>
</tr>
<tr>
<td><b><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#objectmeta-v1-meta">metadata</a></b></td>
<td>object</td>
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
<td>true</td>
<td><b><a href="#benchmarkspec">spec</a></b></td>
<td>object</td>
<td>
<br/>
</td>
<td><b><a href="#benchmarkstatus">status</a></b></td>
<td>object</td>
<td>
<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec
<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>
Benedikt Wetzel
committed
<td><b><a href="#benchmarkspecloadgenerator">loadGenerator</a></b></td>
<td>object</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>
Benedikt Wetzel
committed
<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>
<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>
<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>
</table>
Benedikt Wetzel
committed
### benchmark.spec.loadGenerator
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
Benedikt Wetzel
committed
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>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b><a href="#benchmarkspecloadgeneratorafteractionsindex">afterActions</a></b></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>
Load generator before actions are executed before the load generator is started.<br/>
<br/>
<i>Default</i>: []<br/>
</td>
<td>false</td>
</tr><tr>
Benedikt Wetzel
committed
<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>
</table>
### benchmark.spec.loadGenerator.afterActions[index]
<sup><sup>[↩ Parent](#benchmarkspecloadgenerator)</sup></sup>
Benedikt Wetzel
committed
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b><a href="#benchmarkspecloadgeneratorafteractionsindexexec">exec</a></b></td>
<td>object</td>
<td>
</td>
<td>false</td>
</tr><tr>
<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/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.loadGenerator.afterActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td>[]string</td>
<td>
</td>
<td>false</td>
</tr><tr>
Specifies the timeout (in seconds) for the specified command.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.loadGenerator.afterActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindex)</sup></sup>
The selector specifies which resource should be selected for the execution of the command.
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
Specifies the container.<br/>
<br/>
<i>Default</i>: <br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorafteractionsindexselectorpod">pod</a></b></td>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.loadGenerator.afterActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorafteractionsindexselector)</sup></sup>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>matchLabels</b></td>
<td>map[string]string</td>
The matchLabels of the desired pod.<br/>
<br/>
<i>Default</i>: map[]<br/>
</tr></tbody>
</table>
### benchmark.spec.loadGenerator.beforeActions[index]
<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><a href="#benchmarkspecloadgeneratorbeforeactionsindexexec">exec</a></b></td>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselector">selector</a></b></td>
The selector specifies which resource should be selected for the execution of the command.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.loadGenerator.beforeActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup>
Specifies command to be executed.
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>command</b></td>
<td>[]string</td>
<td>
The command to be executed as string array.<br/>
</td>
<td>false</td>
</tr><tr>
<td>integer</td>
<td>
Specifies the timeout (in seconds) for the specified command.<br/>
</td>
<td>false</td>
### benchmark.spec.loadGenerator.beforeActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindex)</sup></sup>
The selector specifies which resource should be selected for the execution of the command.
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>container</b></td>
<td>string</td>
<td>
<br/>
<i>Default</i>: <br/>
</td>
<td><b><a href="#benchmarkspecloadgeneratorbeforeactionsindexselectorpod">pod</a></b></td>
<td>object</td>
<td>
Specifies the pod.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.loadGenerator.beforeActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorbeforeactionsindexselector)</sup></sup>
Benedikt Wetzel
committed
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>matchLabels</b></td>
<td>map[string]string</td>
Benedikt Wetzel
committed
<td>
Benedikt Wetzel
committed
<br/>
Benedikt Wetzel
committed
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.loadGenerator.resources[index]
<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>
Benedikt Wetzel
committed
<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>
Benedikt Wetzel
committed
<td><b><a href="#benchmarkspecloadgeneratorresourcesindexfilesystem">fileSystem</a></b></td>
<td>object</td>
<td>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
Benedikt Wetzel
committed
### benchmark.spec.loadGenerator.resources[index].configMap
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</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>
(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>name</b></td>
<td>string</td>
<td>
The name of the configMap<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
Benedikt Wetzel
committed
### benchmark.spec.loadGenerator.resources[index].fileSystem
<sup><sup>[↩ Parent](#benchmarkspecloadgeneratorresourcesindex)</sup></sup>
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
<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>
(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>
The path to the folder which contains the Kubernetes manifests files.<br/>
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.loadTypes[index]
<sup><sup>[↩ Parent](#benchmarkspec)</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="#benchmarkspecloadtypesindexpatchersindex">patchers</a></b></td>
<td>[]object</td>
<td>
List of patchers used to scale this resource type.<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>typeName</b></td>
<td>string</td>
<td>
Name of the load type.<br/>
</td>
<td>true</td>
</tr></tbody>
</table>
### benchmark.spec.loadTypes[index].patchers[index]
<sup><sup>[↩ Parent](#benchmarkspecloadtypesindex)</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>
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
</tr></tbody>
</table>
### benchmark.spec.resourceTypes[index]
<sup><sup>[↩ Parent](#benchmarkspec)</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="#benchmarkspecresourcetypesindexpatchersindex">patchers</a></b></td>
<td>[]object</td>
<td>
List of patchers used to scale this resource type.<br/>
</td>
<td>true</td>
</tr><tr>
<td><b>typeName</b></td>
<td>string</td>
<td>
Name of the resource type.<br/>
</td>
<td>true</td>
</tr></tbody>
</table>
### benchmark.spec.resourceTypes[index].patchers[index]
<sup><sup>[↩ Parent](#benchmarkspecresourcetypesindex)</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>
Benedikt Wetzel
committed
### benchmark.spec.sut
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
Benedikt Wetzel
committed
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>
<td><b><a href="#benchmarkspecsutbeforeactionsindex">beforeActions</a></b></td>
SUT before actions are executed before the SUT is started.<br/>
Benedikt Wetzel
committed
<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]
Benedikt Wetzel
committed
<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><b><a href="#benchmarkspecsutafteractionsindexselector">selector</a></b></td>
The selector specifies which resource should be selected for the execution of the command.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.sut.afterActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>command</b></td>
<td>[]string</td>
<td>
The command to be executed as string array.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>timeoutSeconds</b></td>
<td>integer</td>
<td>
Specifies the timeout (in seconds) for the specified command.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.sut.afterActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindex)</sup></sup>
The selector specifies which resource should be selected for the execution of the command.
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>container</b></td>
<td>string</td>
<td>
Specifies the container.<br/>
<br/>
<i>Default</i>: <br/>
</td>
<td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspecsutafteractionsindexselectorpod">pod</a></b></td>
<td>object</td>
<td>
Specifies the pod.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.sut.afterActions[index].selector.pod
<sup><sup>[↩ Parent](#benchmarkspecsutafteractionsindexselector)</sup></sup>
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
Specifies the pod.
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>matchLabels</b></td>
<td>map[string]string</td>
<td>
The matchLabels of the desired pod.<br/>
<br/>
<i>Default</i>: map[]<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.sut.beforeActions[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="#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="#benchmarkspecsutbeforeactionsindexselector">selector</a></b></td>
<td>object</td>
<td>
The selector specifies which resource should be selected for the execution of the command.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.sut.beforeActions[index].exec
<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup>
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
Specifies command to be executed.
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>command</b></td>
<td>[]string</td>
<td>
The command to be executed as string array.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>timeoutSeconds</b></td>
<td>integer</td>
<td>
Specifies the timeout (in seconds) for the specified command.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>
### benchmark.spec.sut.beforeActions[index].selector
<sup><sup>[↩ Parent](#benchmarkspecsutbeforeactionsindex)</sup></sup>
The selector specifies which resource should be selected for the execution of the command.
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody><tr>
<td><b>container</b></td>
<td>string</td>
<td>
Specifies the container.<br/>
<br/>
<i>Default</i>: <br/>