From 6700b69df4ae5e01065ed0981956e371c1623514 Mon Sep 17 00:00:00 2001
From: "stu126940@mail.uni-kiel.de" <stu126940@mail.uni-kiel.de>
Date: Mon, 22 Nov 2021 15:43:34 +0100
Subject: [PATCH] Add description to crds and update docs
---
docs/crd-docu.md | 34 +++++++++++++++++++++++++++++++
theodolite/crd/crd-benchmark.yaml | 4 ++--
2 files changed, 36 insertions(+), 2 deletions(-)
diff --git a/docs/crd-docu.md b/docs/crd-docu.md
index 4002f9b0e..bb41474ce 100644
--- a/docs/crd-docu.md
+++ b/docs/crd-docu.md
@@ -51,6 +51,13 @@ Resource Types:
<td>object</td>
<td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
<td>true</td>
+ </tr><tr>
+ <td><b><a href="#benchmarkstatus">status</a></b></td>
+ <td>object</td>
+ <td>
+ <br/>
+ </td>
+ <td>false</td>
</tr><tr>
<td><b><a href="#benchmarkspec">spec</a></b></td>
<td>object</td>
@@ -62,6 +69,33 @@ Resource Types:
</table>
+### benchmark.status
+<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>
+ <td><b>resourceSets</b></td>
+ <td>string</td>
+ <td>
+ The status of a Benchmark indicates whether all resources are available to start the benchmark or not.<br/>
+ </td>
+ <td>false</td>
+ </tr></tbody>
+</table>
+
+
### benchmark.spec
<sup><sup>[↩ Parent](#benchmark)</sup></sup>
diff --git a/theodolite/crd/crd-benchmark.yaml b/theodolite/crd/crd-benchmark.yaml
index 1fa085a1a..d3c271665 100644
--- a/theodolite/crd/crd-benchmark.yaml
+++ b/theodolite/crd/crd-benchmark.yaml
@@ -193,7 +193,7 @@ spec:
type: object
properties:
resourceSets:
- description: The status of a Benchmark indicates whether all resources are available to start the benchmark or not.
+ description: The status of a Benchmark indicates whether all resources are available to start the benchmark or not.
type: string
additionalPrinterColumns:
- name: Age
@@ -201,7 +201,7 @@ spec:
jsonPath: .metadata.creationTimestamp
- name: ResourceSets
type: string
- description: todo
+ description: The status of a Benchmark indicates whether all resources are available to start the benchmark or not.
jsonPath: .status.resourceSets
subresources:
status: {}
--
GitLab