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

Add descriptions for the resourceSets to the benchmark crd

parent 171e6a2d
No related branches found
No related tags found
1 merge request!171Introduce ResourceSets to make loading of resource files more flexible
This commit is part of merge request !171. Comments created here will be created in the context of that merge request.
Hide whitespace changes
Inline Side-by-side
docs/crd-docu.md
+ 19
− 19
View file @ e7cb5b94
...@@ -89,7 +89,7 @@ Resource Types: ...@@ -89,7 +89,7 @@ Resource Types:
<td><b><a href="#benchmarkspecappresourcesetsindex">appResourceSets</a></b></td> <td><b><a href="#benchmarkspecappresourcesetsindex">appResourceSets</a></b></td>
<td>[]object</td> <td>[]object</td>
<td> <td>
<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> </tr><tr>
...@@ -103,7 +103,7 @@ Resource Types: ...@@ -103,7 +103,7 @@ Resource Types:
<td><b><a href="#benchmarkspecloadgenresourcesetsindex">loadGenResourceSets</a></b></td> <td><b><a href="#benchmarkspecloadgenresourcesetsindex">loadGenResourceSets</a></b></td>
<td>[]object</td> <td>[]object</td>
<td> <td>
<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> </tr><tr>
...@@ -144,14 +144,14 @@ Resource Types: ...@@ -144,14 +144,14 @@ Resource Types:
<td><b><a href="#benchmarkspecappresourcesetsindexconfigmap">configMap</a></b></td> <td><b><a href="#benchmarkspecappresourcesetsindexconfigmap">configMap</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
<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="#benchmarkspecappresourcesetsindexfilesystem">fileSystem</a></b></td> <td><b><a href="#benchmarkspecappresourcesetsindexfilesystem">fileSystem</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
<br/> The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
...@@ -163,7 +163,7 @@ Resource Types: ...@@ -163,7 +163,7 @@ Resource Types:
The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.
<table> <table>
<thead> <thead>
...@@ -178,14 +178,14 @@ Resource Types: ...@@ -178,14 +178,14 @@ Resource Types:
<td><b>files</b></td> <td><b>files</b></td>
<td>[]string</td> <td>[]string</td>
<td> <td>
<br/> (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>name</b></td> <td><b>name</b></td>
<td>string</td> <td>string</td>
<td> <td>
<br/> The name of the configMap<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
...@@ -197,7 +197,7 @@ Resource Types: ...@@ -197,7 +197,7 @@ Resource Types:
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
<table> <table>
<thead> <thead>
...@@ -212,14 +212,14 @@ Resource Types: ...@@ -212,14 +212,14 @@ Resource Types:
<td><b>files</b></td> <td><b>files</b></td>
<td>[]string</td> <td>[]string</td>
<td> <td>
<br/> (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>path</b></td> <td><b>path</b></td>
<td>string</td> <td>string</td>
<td> <td>
<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>
...@@ -336,14 +336,14 @@ Contains the Kafka configuration. ...@@ -336,14 +336,14 @@ Contains the Kafka configuration.
<td><b><a href="#benchmarkspecloadgenresourcesetsindexconfigmap">configMap</a></b></td> <td><b><a href="#benchmarkspecloadgenresourcesetsindexconfigmap">configMap</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
<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="#benchmarkspecloadgenresourcesetsindexfilesystem">fileSystem</a></b></td> <td><b><a href="#benchmarkspecloadgenresourcesetsindexfilesystem">fileSystem</a></b></td>
<td>object</td> <td>object</td>
<td> <td>
<br/> The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
...@@ -355,7 +355,7 @@ Contains the Kafka configuration. ...@@ -355,7 +355,7 @@ Contains the Kafka configuration.
The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.
<table> <table>
<thead> <thead>
...@@ -370,14 +370,14 @@ Contains the Kafka configuration. ...@@ -370,14 +370,14 @@ Contains the Kafka configuration.
<td><b>files</b></td> <td><b>files</b></td>
<td>[]string</td> <td>[]string</td>
<td> <td>
<br/> (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>name</b></td> <td><b>name</b></td>
<td>string</td> <td>string</td>
<td> <td>
<br/> The name of the configMap<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr></tbody> </tr></tbody>
...@@ -389,7 +389,7 @@ Contains the Kafka configuration. ...@@ -389,7 +389,7 @@ Contains the Kafka configuration.
The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
<table> <table>
<thead> <thead>
...@@ -404,14 +404,14 @@ Contains the Kafka configuration. ...@@ -404,14 +404,14 @@ Contains the Kafka configuration.
<td><b>files</b></td> <td><b>files</b></td>
<td>[]string</td> <td>[]string</td>
<td> <td>
<br/> (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.<br/>
</td> </td>
<td>false</td> <td>false</td>
</tr><tr> </tr><tr>
<td><b>path</b></td> <td><b>path</b></td>
<td>string</td> <td>string</td>
<td> <td>
<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>
...@@ -935,7 +935,7 @@ Specifies the scaling resource that is benchmarked. ...@@ -935,7 +935,7 @@ Specifies the scaling resource that is benchmarked.
<td><b>resourceValues</b></td> <td><b>resourceValues</b></td>
<td>[]integer</td> <td>[]integer</td>
<td> <td>
<br/> List of resource values for the specified resource type.<br/>
</td> </td>
<td>true</td> <td>true</td>
</tr></tbody> </tr></tbody>
......
theodolite/crd/crd-benchmark.yaml
+ 14
− 0
View file @ e7cb5b94
...@@ -124,6 +124,7 @@ spec: ...@@ -124,6 +124,7 @@ spec:
type: boolean type: boolean
default: false default: false
appResourceSets: appResourceSets:
description: The appResourceSets specifies all Kubernetes resources required to start the sut. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.
type: array type: array
items: items:
type: object type: object
...@@ -132,24 +133,31 @@ spec: ...@@ -132,24 +133,31 @@ spec:
- required: [fileSystem] - required: [fileSystem]
properties: properties:
configMap: configMap:
description: The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.
type: object type: object
properties: properties:
name: name:
description: The name of the configMap
type: string type: string
files: files:
description: (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.
type: array type: array
items: items:
type: string type: string
fileSystem: fileSystem:
description: The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
type: object type: object
properties: properties:
path: path:
description: The path to the folder which contains the Kubernetes manifests files.
type: string type: string
files: files:
description: (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.
type: array type: array
items: items:
type: string type: string
loadGenResourceSets: loadGenResourceSets:
description: The appResourceSets specifies all Kubernetes resources required to start the sut. A resourceSet can be either a configMap resourceSet or a fileSystem resourceSet.
type: array type: array
items: items:
type: object type: object
...@@ -158,20 +166,26 @@ spec: ...@@ -158,20 +166,26 @@ spec:
- required: [fileSystem] - required: [fileSystem]
properties: properties:
configMap: configMap:
description: The configMap resourceSet loads the Kubernetes manifests from an Kubernetes configMap.
type: object type: object
properties: properties:
name: name:
description: The name of the configMap
type: string type: string
files: files:
description: (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.
type: array type: array
items: items:
type: string type: string
fileSystem: fileSystem:
description: The fileSystem resourceSet loads the Kubernetes manifests from the filesystem.
type: object type: object
properties: properties:
path: path:
description: The path to the folder which contains the Kubernetes manifests files.
type: string type: string
files: files:
description: (Optional) Specifies which files from the configMap should be loaded. If this field is not set, all files are loaded.
type: array type: array
items: items:
type: string type: string
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment