From 05ef88f1716faab53e38b4131b4a9c79332eb73d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Vonheiden?= <bjoern.vonheiden@hotmail.de>
Date: Wed, 25 Aug 2021 17:10:09 +0200
Subject: [PATCH] add description to the slo properties in crd files
---
helm/templates/theodolite/crd-execution.yaml | 4 ++++
theodolite/crd/crd-execution.yaml | 19 ++++++++-----------
2 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/helm/templates/theodolite/crd-execution.yaml b/helm/templates/theodolite/crd-execution.yaml
index 3238ec517..163835e9b 100644
--- a/helm/templates/theodolite/crd-execution.yaml
+++ b/helm/templates/theodolite/crd-execution.yaml
@@ -55,12 +55,16 @@ spec:
required: ["sloType", "prometheusUrl", "offset"]
properties:
sloType:
+ description: The type of the SLO. It must match 'lag trend'.
type: string
prometheusUrl:
+ description: Connection string for Promehteus.
type: string
offset:
+ description: Hours by which the start and end timestamp will be shifted (for different timezones).
type: integer
properties:
+ description: (Optional) SLO specific additional arguments.
type: object
additionalProperties: true
x-kubernetes-map-type: "granular"
diff --git a/theodolite/crd/crd-execution.yaml b/theodolite/crd/crd-execution.yaml
index f0588ecf9..47d0306f5 100644
--- a/theodolite/crd/crd-execution.yaml
+++ b/theodolite/crd/crd-execution.yaml
@@ -60,26 +60,23 @@ spec:
type: array
items:
type: object
- required: ["sloType", "threshold", "prometheusUrl", "externalSloUrl", "offset", "warmup"]
+ required: ["sloType", "prometheusUrl", "offset"]
properties:
sloType:
description: The type of the SLO. It must match 'lag trend'.
type: string
- threshold:
- description: The threshold the SUT should meet for a sucessful experiment.
- type: integer
prometheusUrl:
description: Connection string for Promehteus.
type: string
- externalSloUrl:
- description: Connection string for a external slo analysis.
- type: string
offset:
description: Hours by which the start and end timestamp will be shifted (for different timezones).
type: integer
- warmup:
- description: Seconds of time that are ignored in the analysis.
- type: integer
+ properties:
+ description: (Optional) SLO specific additional arguments.
+ type: object
+ additionalProperties: true
+ x-kubernetes-map-type: "granular"
+ default: {}
execution: # def execution config
description: Defines the overall parameter for the execution.
type: object
@@ -152,4 +149,4 @@ spec:
jsonPath: .metadata.creationTimestamp
subresources:
status: {}
- scope: Namespaced
\ No newline at end of file
+ scope: Namespaced
--
GitLab