use fromSpec as a rendering base

Author: odacremolbap

config/300-crdregistration.yaml

@@ -273,28 +273,21 @@ spec:
                           - name
                           type: object
                         type: array
-                      global:
-                        description: Global defines the configuration to be applied
-                          to all generated parameters.
-                        properties:
-                          defaultPrefix:
-                            description: DefaultPrefix to be appeneded to keys by
-                              all generated parameters. This configuration does not
-                              affect parameter keys explicitly set by users.
-                            type: string
-                        type: object
-                      specToEnvs:
-                        description: SpecToEnvs contains instructions to generate
-                          environment variables from the instance's spec.
+                      fromSpec:
+                        description: FromSpec contains instructions to generate workload
+                          items from the instance's spec.
                         items:
-                          description: SpecToEnvsParameterConfiguration contains instructions
-                            to generate environment variables from the controlled
-                            instance spec.
+                          description: FromSpecConfiguration contains instructions
+                            to generate rendering from the controlled instance spec.
                           properties:
                             path:
                               description: JSON simplified path for the parameter.
                               type: string
-                            render:
+                            skip:
+                              description: Skip sets whether the object should skip
+                                rendering as a workload item.
+                              type: boolean
+                            toEnv:
                               description: Render options for the parameter generation.
                               properties:
                                 defaultValue:
@@ -306,10 +299,6 @@ spec:
                                   description: Name is the name of the parameter to
                                     be created.
                                   type: string
-                                skip:
-                                  description: Skip sets whether the object should
-                                    skip rendering as a workload parameter.
-                                  type: boolean
                                 valueFromBuiltInFunc:
                                   description: ValueFromBuiltInFunc configures the
                                     field to be rendered acording to the chosen built-in
@@ -355,58 +344,58 @@ spec:
                                   - name
                                   type: object
                               type: object
-                          required:
-                          - path
-                          type: object
-                        type: array
-                      specToVolumes:
-                        description: SpecToVolumes contains instructions to generate
-                          volumes and mounts from the instance's spec.
-                        items:
-                          description: SpecToVolumeParameterConfiguration contains
-                            instructions to generate volumes and volume mounts from
-                            the controlled instance spec.
-                          properties:
-                            mountPath:
-                              description: Path where the file will be mounted.
-                              type: string
-                            name:
-                              description: Name for the volume.
-                              type: string
-                            path:
-                              description: JSON simplified path for the parameter.
-                              type: string
-                            valueFromConfigMap:
-                              description: ValueFromConfigMap is a reference to a
-                                ConfigMap.
-                              properties:
-                                key:
-                                  description: The key to select.
-                                  type: string
-                                name:
-                                  description: Object name
-                                  type: string
-                              required:
-                              - key
-                              - name
-                              type: object
-                            valueFromSecret:
-                              description: ValueFromSecret is a reference to a Secret.
+                            toVolume:
+                              description: Render options for the parameter generation.
                               properties:
-                                key:
-                                  description: The key to select.
+                                mountPath:
+                                  description: Path where the file will be mounted.
                                   type: string
                                 name:
-                                  description: Object name
+                                  description: Name for the volume.
                                   type: string
-                              required:
-                              - key
-                              - name
+                                valueFromConfigMap:
+                                  description: ValueFromConfigMap is a reference to
+                                    a ConfigMap.
+                                  properties:
+                                    key:
+                                      description: The key to select.
+                                      type: string
+                                    name:
+                                      description: Object name
+                                      type: string
+                                  required:
+                                  - key
+                                  - name
+                                  type: object
+                                valueFromSecret:
+                                  description: ValueFromSecret is a reference to a
+                                    Secret.
+                                  properties:
+                                    key:
+                                      description: The key to select.
+                                      type: string
+                                    name:
+                                      description: Object name
+                                      type: string
+                                  required:
+                                  - key
+                                  - name
+                                  type: object
                               type: object
                           required:
                           - path
                           type: object
                         type: array
+                      global:
+                        description: Global defines the configuration to be applied
+                          to all generated parameters.
+                        properties:
+                          defaultPrefix:
+                            description: DefaultPrefix to be appeneded to keys by
+                              all generated parameters. This configuration does not
+                              affect parameter keys explicitly set by users.
+                            type: string
+                        type: object
                     type: object
                   statusConfiguration:
                     description: StatusConfiguration contains rules to populate a

docs/reference/registration.md

@@ -158,10 +158,9 @@ The default behavior is to create parameters from each spec element (arrays will
 
 ```yaml
     parameterConfiguration:
-      specToEnvs:
+      fromSpec:
       - path: spec.bar
-        render:
-          skip: true
+        skip: true
 ```
 
 - [x] Change key for generated param. Can be combined.
@@ -231,11 +230,12 @@ Secrets and ConfigMaps can be mounted as a volume inside the workload. The regis
     parameterConfiguration:
       specToVolumes:
       - path: spec.userList
-        name: userfile
-        mountPath: /opt/user.lst
-        valueFromConfigMap:
-          name: spec.userList.name
-          key: spec.userList.key
+        render:
+          name: userfile
+          mountPath: /opt/user.lst
+          valueFromConfigMap:
+            name: spec.userList.name
+            key: spec.userList.key
 ```
 
 ## Workload Status

docs/tutorial.md

@@ -316,15 +316,14 @@ spec:
     fromImage:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
     parameterConfiguration:
-      specToEnvs:
+      fromSpec:
       # Skip variable2 from generating a parameter for the workload
       - path: spec.variable2
-        render:
-          skip: true
+        skip: true
 
 ```
 
-The `spec.workload.parameterConfiguration.specToEnvs[].render.skip` boolean indicates whether the environment variable for the element should be generated.
+The `spec.workload.parameterConfiguration.fromSpec[].skip` boolean indicates whether the environment variable for the element should be generated.
 
 Create the registration:
 
@@ -377,7 +376,7 @@ kubectl delete crdregistration kuard
 
 ### Parameter Renaming
 
-Most often expected environment variables at the container do not match Scoby's automatic rendering. All generated environment variables can be renamed using `spec.workload.parameterConfiguration.specToEnvs[].render.key`.
+Most often expected environment variables at the container do not match Scoby's automatic rendering. All generated environment variables can be renamed using `spec.workload.parameterConfiguration.fromSpec[].toEnv.name`.
 
 ```yaml
 apiVersion: scoby.triggermesh.io/v1alpha1
@@ -396,10 +395,10 @@ spec:
     fromImage:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
     parameterConfiguration:
-      specToEnvs:
+      fromSpec:
       # Rename variable2
       - path: spec.variable2
-        render:
+        toEnv:
           name: KUARD_VARIABLE_TWO
 ```
 
@@ -458,7 +457,7 @@ kubectl delete crdregistration kuard
 
 ### Parameter Default Value
 
-The value for an environment variable can be set to a default value using `spec.workload.parameterConfiguration.specToEnvs[].render.defaultValue`.
+The value for an environment variable can be set to a default value using `spec.workload.parameterConfiguration.fromSpec[].toEnv.defaultValue`.
 
 ```yaml
 apiVersion: scoby.triggermesh.io/v1alpha1
@@ -477,10 +476,10 @@ spec:
     fromImage:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
     parameterConfiguration:
-      specToEnvs:
+      fromSpec:
       # Override variable2 value
       - path: spec.variable2
-        render:
+        toEnv:
           defaultValue: new variable2 value
 ```
 
@@ -539,7 +538,7 @@ kubectl delete crdregistration kuard
 
 ### Parameter Value From Secret
 
-The value for an environment variable can reference a Secret through the `spec.workload.parameterConfiguration.specToEnvs[].render.valueFromSecret` customization option, that needs the `name` and `key` subelements to be set. In this example we will also be setting the variable name.
+The value for an environment variable can reference a Secret through the `spec.workload.parameterConfiguration.fromSpec[].toEnv.valueFromSecret` customization option, that needs the `name` and `key` subelements to be set. In this example we will also be setting the variable name.
 
 ```yaml
 apiVersion: scoby.triggermesh.io/v1alpha1
@@ -558,10 +557,10 @@ spec:
     fromImage:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
     parameterConfiguration:
-      specToEnvs:
+      fromSpec:
       # Reference a secret
       - path: spec.refToSecret
-        render:
+        toEnv:
           name: FOO_CREDENTIALS
           valueFromSecret:
             name: spec.refToSecret.secretName
@@ -634,7 +633,7 @@ kubectl delete secret kuard-secret
 
 ### Parameter Value From ConfigMap
 
-The value for an environment variable can reference a ConfigMap through the `spec.workload.parameterConfiguration.specToEnvs[].render.valueFromConfigMap` customization option, that needs the `name` and `key` subelements to be set.
+The value for an environment variable can reference a ConfigMap through the `spec.workload.parameterConfiguration.fromSpec[].toEnv.valueFromConfigMap` customization option, that needs the `name` and `key` subelements to be set.
 
 ```yaml
 apiVersion: scoby.triggermesh.io/v1alpha1
@@ -653,10 +652,10 @@ spec:
     fromImage:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
     parameterConfiguration:
-      specToEnvs:
+      fromSpec:
       # Reference a ConfigMap
       - path: spec.refToConfigMap
-        render:
+        toEnv:
           valueFromConfigMap:
             name: spec.refToConfigMap.configName
             key: spec.refToConfigMap.configKey
@@ -742,7 +741,7 @@ A destination duck type informs either an URI, a Kubernetes service, or a Kubern
     uri: <uri>
 ```
 
-Use the built-in function `spec.workload.parameterConfiguration.specToEnvs[].valueFromBuiltInFunc.resolveAddress` on the element that contains the Destination type. As an added feature this example also updates an status element with the resolved address.
+Use the built-in function `spec.workload.parameterConfiguration.fromSpec[].toEnv.valueFromBuiltInFunc.resolveAddress` on the element that contains the Destination type. As an added feature this example also updates an status element with the resolved address.
 
 ```yaml
 apiVersion: scoby.triggermesh.io/v1alpha1
@@ -761,10 +760,10 @@ spec:
     fromImage:
       repo: gcr.io/kuar-demo/kuard-amd64:blue
     parameterConfiguration:
-      specToEnvs:
+      fromSpec:
       # Resolve an address
       - path: spec.refToAddress
-        render:
+        toEnv:
           name: FOO_SINK
           valueFromBuiltInFunc:
             name: resolveAddress