Skip to content
Snippets Groups Projects
Commit cf85c47b authored by Marcel Samir Becker's avatar Marcel Samir Becker
Browse files

Updated CRD API reference page

parent 05296646
No related branches found
No related tags found
1 merge request!251Move definition of SLOs to Benchmark
...@@ -114,6 +114,13 @@ Resource Types: ...@@ -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/> 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>
<td>true</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> </tr><tr>
<td><b><a href="#benchmarkspecsut">sut</a></b></td> <td><b><a href="#benchmarkspecsut">sut</a></b></td>
<td>object</td> <td>object</td>
...@@ -727,6 +734,63 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem. ...@@ -727,6 +734,63 @@ The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
</table> </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 ### benchmark.spec.sut
<sup><sup>[↩ Parent](#benchmarkspec)</sup></sup> <sup><sup>[↩ Parent](#benchmarkspec)</sup></sup>
...@@ -1778,13 +1842,6 @@ Contains the Kafka configuration. ...@@ -1778,13 +1842,6 @@ Contains the Kafka configuration.
Specifies the scaling resource that is benchmarked.<br/> Specifies the scaling resource that is benchmarked.<br/>
</td> </td>
<td>true</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> </tr><tr>
<td><b>name</b></td> <td><b>name</b></td>
<td>string</td> <td>string</td>
...@@ -1794,6 +1851,13 @@ Contains the Kafka configuration. ...@@ -1794,6 +1851,13 @@ Contains the Kafka configuration.
<i>Default</i>: <br/> <i>Default</i>: <br/>
</td> </td>
<td>false</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> </tr></tbody>
</table> </table>
...@@ -2019,26 +2083,26 @@ Specifies the scaling resource that is benchmarked. ...@@ -2019,26 +2083,26 @@ Specifies the scaling resource that is benchmarked.
</tr> </tr>
</thead> </thead>
<tbody><tr> <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><b>offset</b></td>
<td>integer</td> <td>integer</td>
<td> <td>
Hours by which the start and end timestamp will be shifted (for different timezones).<br/> Hours by which the start and end timestamp will be shifted (for different timezones).<br/>
</td> </td>
<td>true</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>prometheusUrl</b></td> <td><b>prometheusUrl</b></td>
<td>string</td> <td>string</td>
<td> <td>
Connection string for Promehteus.<br/> Connection string for Promehteus.<br/>
</td> </td>
<td>true</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>true</td>
</tr><tr> </tr><tr>
<td><b>properties</b></td> <td><b>properties</b></td>
<td>map[string]string</td> <td>map[string]string</td>
...@@ -2048,6 +2112,13 @@ Specifies the scaling resource that is benchmarked. ...@@ -2048,6 +2112,13 @@ Specifies the scaling resource that is benchmarked.
<i>Default</i>: map[]<br/> <i>Default</i>: map[]<br/>
</td> </td>
<td>false</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> </tr></tbody>
</table> </table>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment