Introduce ResourceSets to make loading of resource files more flexible

This MR introduces so called ResourceSets that allow loading Kubernetes manifests either via ConfigMap or from the file system.

Closes #240 (closed)

helm/templates/theodolite/crd-benchmark.yaml

@@ -21,94 +21,156 @@ spec:
         properties:
           spec:
             type: object
-            required: []
+            required: ["appResourceSets", "loadGenResourceSets", "resourceTypes", "loadTypes", "kafkaConfig"]
             properties:
               name:
+                description: This field exists only for technical reasons and should not be set by the user. The value of the field will be overwritten.
                 type: string
-              appResource:
-                type: array
-                minItems: 1
-                items:
-                  type: string
-              loadGenResource:
-                type: array
-                minItems: 1
-                items:
-                  type: string
               resourceTypes:
+                description: 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.
                 type: array
                 minItems: 1
                 items:
                   type: object
+                  required: ["typeName", "patchers"]
                   properties:
                     typeName:
+                      description: Name of the resource type.
                       type: string
                     patchers:
+                      description: List of patchers used to scale this resource type.
+                      examples: test test test
                       type: array
                       minItems: 1
                       items:
                         type: object
+                        required: ["type", "resource"]
                         properties:
                           type:
+                            description: Type of the patcher.
                             type: string
                             default: ""
                           resource:
+                            description: Specifies the Kubernetes resource to be patched.
                             type: string
                             default: ""
                           properties:
+                            description: (Optional) Patcher specific additional arguments.
                             type: object
                             additionalProperties: true
                             x-kubernetes-map-type: "granular"
                             default: {}
               loadTypes:
+                description: A list of load types that can be scaled for this benchmark. For each load type the concrete values are defined in the execution object.
                 type: array
                 minItems: 1
                 items:
                   type: object
+                  required: ["typeName","patchers"]
                   properties:
                     typeName:
+                      description: Name of the load type.
                       type: string
                     patchers:
+                      description: List of patchers used to scale this resource type.
                       type: array
                       minItems: 1
                       items:
                         type: object
+                        required: ["type", "resource"]
                         properties:
                           type:
+                            description: Type of the Patcher.
                             type: string
                             default: ""
                           resource:
+                            description: Specifies the Kubernetes resource to be patched.
                             type: string
                             default: ""
                           properties:
+                            description: (Optional) Patcher specific additional arguments.
                             type: object
                             additionalProperties: true
                             x-kubernetes-map-type: "granular"
                             default: {}
               kafkaConfig:
+                description: Contains the Kafka configuration.
                 type: object
+                required: ["bootstrapServer", "topics"]
                 properties:
                   bootstrapServer:
+                    description: The bootstrap servers connection string.
                     type: string
                   topics:
+                    description: List of topics to be created for each experiment. Alternative theodolite offers the possibility to remove certain topics after each experiment.
                     type: array
                     minItems: 1
                     items:
                       type: object
-                      required: []
+                      required: ["name"]
                       properties:
                         name:
+                          description: The name of the topic.
                           type: string
                           default: ""
                         numPartitions:
+                          description: The number of partitions of the topic.
                           type: integer
                           default: 0
                         replicationFactor:
+                          description: The replication factor of the topic.
                           type: integer
                           default: 0
                         removeOnly:
+                          description: Determines if this topic should only be deleted after each experiement. For removeOnly topics the name can be a RegEx describing the topic.
                           type: boolean
                           default: false
+              appResourceSets:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    ConfigMapResourceSet:
+                      type: object
+                      properties:
+                        configmap:
+                          type: string
+                        files:
+                          type: array
+                          items:
+                            type: string
+                    FileSystemResourceSet:
+                      type: object
+                      properties:
+                        path:
+                          type: string
+                        files:
+                          type: array
+                          items:
+                            type: string
+              loadGenResourceSets:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    ConfigMapResourceSet:
+                      type: object
+                      properties:
+                        configmap:
+                          type: string
+                        files:
+                          type: array
+                          items:
+                            type: string
+                    FileSystemResourceSet:
+                      type: object
+                      properties:
+                        path:
+                          type: string
+                        files:
+                          type: array
+                          items:
+                            type: string
     additionalPrinterColumns:
     - name: Age
       type: date