From cf85c47be886eb99c8219859a1e6df248691ba0a Mon Sep 17 00:00:00 2001
From: Marcel Becker <stu117960@mail.uni-kiel.de>
Date: Tue, 1 Mar 2022 13:02:11 +0100
Subject: [PATCH] Updated CRD API reference page
---
docs/api-reference/crds.md | 103 +++++++++++++++++++++++++++++++------
1 file changed, 87 insertions(+), 16 deletions(-)
diff --git a/docs/api-reference/crds.md b/docs/api-reference/crds.md
index fb3f02ac9..6bcd35d09 100644
--- a/docs/api-reference/crds.md
+++ b/docs/api-reference/crds.md
@@ -114,6 +114,13 @@ Resource Types:
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="#benchmarkspecslosindex">slos</a></b></td>
+ <td>[]object</td>
+ <td>
+ List of resource values for the specified resource type.<br/>
+ </td>
+ <td>true</td>
</tr><tr>
<td><b><a href="#benchmarkspecsut">sut</a></b></td>
<td>object</td>
@@ -727,6 +734,63 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</table>
+### benchmark.spec.slos[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>name</b></td>
+ <td>string</td>
+ <td>
+ The name of the SLO.<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b>offset</b></td>
+ <td>integer</td>
+ <td>
+ Hours by which the start and end timestamp will be shifted (for different timezones).<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b>prometheusUrl</b></td>
+ <td>string</td>
+ <td>
+ Connection string for Promehteus.<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
+ <td><b>sloType</b></td>
+ <td>string</td>
+ <td>
+ 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>
+
+
### benchmark.spec.sut
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
@@ -1778,13 +1842,6 @@ Contains the Kafka configuration.
Specifies the scaling resource that is benchmarked.<br/>
</td>
<td>true</td>
- </tr><tr>
- <td><b><a href="#executionspecslosindex">slos</a></b></td>
- <td>[]object</td>
- <td>
- List of resource values for the specified resource type.<br/>
- </td>
- <td>true</td>
</tr><tr>
<td><b>name</b></td>
<td>string</td>
@@ -1794,6 +1851,13 @@ Contains the Kafka configuration.
<i>Default</i>: <br/>
</td>
<td>false</td>
+ </tr><tr>
+ <td><b><a href="#executionspecslosindex">slos</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>
@@ -2019,26 +2083,26 @@ Specifies the scaling resource that is benchmarked.
</tr>
</thead>
<tbody><tr>
+ <td><b>name</b></td>
+ <td>string</td>
+ <td>
+ The name of the SLO. It must match a SLO specified in the Benchmark.<br/>
+ </td>
+ <td>true</td>
+ </tr><tr>
<td><b>offset</b></td>
<td>integer</td>
<td>
Hours by which the start and end timestamp will be shifted (for different timezones).<br/>
</td>
- <td>true</td>
+ <td>false</td>
</tr><tr>
<td><b>prometheusUrl</b></td>
<td>string</td>
<td>
Connection string for Promehteus.<br/>
</td>
- <td>true</td>
- </tr><tr>
- <td><b>sloType</b></td>
- <td>string</td>
- <td>
- The type of the SLO. It must match 'lag trend'.<br/>
- </td>
- <td>true</td>
+ <td>false</td>
</tr><tr>
<td><b>properties</b></td>
<td>map[string]string</td>
@@ -2048,6 +2112,13 @@ Specifies the scaling resource that is benchmarked.
<i>Default</i>: map[]<br/>
</td>
<td>false</td>
+ </tr><tr>
+ <td><b>sloType</b></td>
+ <td>string</td>
+ <td>
+ The type of the SLO. It must match 'lag trend'.<br/>
+ </td>
+ <td>false</td>
</tr></tbody>
</table>
--
GitLab