From 7d652ce3be13deae27aeb4f122a0ecbf913ec391 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Henning?= <soeren.henning@email.uni-kiel.de>
Date: Fri, 15 Jul 2022 18:36:24 +0200
Subject: [PATCH] Update CRD docs
---
docs/api-reference/crds.md | 182 +++++++++++++++++++------------------
1 file changed, 92 insertions(+), 90 deletions(-)
diff --git a/docs/api-reference/crds.md b/docs/api-reference/crds.md
index 9a42d0b5d..6a0562651 100644
--- a/docs/api-reference/crds.md
+++ b/docs/api-reference/crds.md
@@ -2285,13 +2285,6 @@ Contains the Kafka configuration.
The name of the benchmark this execution is referring to.<br/>
</td>
<td>true</td>
- </tr><tr>
- <td><b><a href="#executionspecconfigoverridesindex">configOverrides</a></b></td>
- <td>[]object</td>
- <td>
- List of patchers that are used to override existing configurations.<br/>
- </td>
- <td>true</td>
</tr><tr>
<td><b><a href="#executionspecexecution">execution</a></b></td>
<td>object</td>
@@ -2300,7 +2293,7 @@ Contains the Kafka configuration.
</td>
<td>true</td>
</tr><tr>
- <td><b><a href="#executionspecloads">loads</a></b></td>
+ <td><b><a href="#executionspecload">load</a></b></td>
<td>object</td>
<td>
Specifies the load values that are benchmarked.<br/>
@@ -2314,100 +2307,28 @@ Contains the Kafka configuration.
</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><tr>
- <td><b><a href="#executionspecslosindex">slos</a></b></td>
+ <td><b><a href="#executionspecconfigoverridesindex">configOverrides</a></b></td>
<td>[]object</td>
<td>
- List of SLOs with their properties, which differ from the benchmark definition.<br/>
- </td>
- <td>false</td>
- </tr></tbody>
-</table>
-
-
-### execution.spec.configOverrides[index]
-<sup><sup>[↩ Parent](#executionspec)</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="#executionspecconfigoverridesindexpatcher">patcher</a></b></td>
- <td>object</td>
- <td>
- Patcher used to patch a resource<br/>
- </td>
- <td>false</td>
- </tr><tr>
- <td><b>value</b></td>
- <td>string</td>
- <td>
+ List of patchers that are used to override existing configurations.<br/>
<br/>
+ <i>Default</i>: []<br/>
</td>
<td>false</td>
- </tr></tbody>
-</table>
-
-
-### execution.spec.configOverrides[index].patcher
-<sup><sup>[↩ Parent](#executionspecconfigoverridesindex)</sup></sup>
-
-
-
-Patcher used to patch a resource
-
-<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><b>name</b></td>
<td>string</td>
<td>
- Type of the Patcher.<br/>
+ 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>true</td>
+ <td>false</td>
</tr><tr>
- <td><b>properties</b></td>
- <td>map[string]string</td>
+ <td><b><a href="#executionspecslosindex">slos</a></b></td>
+ <td>[]object</td>
<td>
- (Optional) Patcher specific additional arguments.<br/>
- <br/>
- <i>Default</i>: map[]<br/>
+ List of SLOs with their properties, which differ from the benchmark definition.<br/>
</td>
<td>false</td>
</tr></tbody>
@@ -2517,7 +2438,7 @@ Defines the used strategy for the execution, either 'LinearSearch', 'BinarySearc
</table>
-### execution.spec.loads
+### execution.spec.load
<sup><sup>[↩ Parent](#executionspec)</sup></sup>
@@ -2585,6 +2506,87 @@ Specifies the scaling resource that is benchmarked.
</table>
+### execution.spec.configOverrides[index]
+<sup><sup>[↩ Parent](#executionspec)</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="#executionspecconfigoverridesindexpatcher">patcher</a></b></td>
+ <td>object</td>
+ <td>
+ Patcher used to patch a resource<br/>
+ </td>
+ <td>false</td>
+ </tr><tr>
+ <td><b>value</b></td>
+ <td>string</td>
+ <td>
+ <br/>
+ </td>
+ <td>false</td>
+ </tr></tbody>
+</table>
+
+
+### execution.spec.configOverrides[index].patcher
+<sup><sup>[↩ Parent](#executionspecconfigoverridesindex)</sup></sup>
+
+
+
+Patcher used to patch a resource
+
+<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>
+
+
### execution.spec.slos[index]
<sup><sup>[↩ Parent](#executionspec)</sup></sup>
--
GitLab