add spec to volumes to API

Author: odacremolbap

config/300-crdregistration.yaml

@@ -155,8 +155,8 @@ spec:
                       transformed into workload parameters.
                     properties:
                       addEnvs:
-                        description: AddEnvs contains configurations for parameters
-                          to be added to the workload not derived from the user instance.
+                        description: AddEnvs contains instructions to create environment
+                          variables at the workload not derived from the user instance.
                         items:
                           description: EnvVar represents an environment variable present
                             in a Container.
@@ -284,12 +284,12 @@ spec:
                             type: string
                         type: object
                       specToEnvs:
-                        description: SpecToEnvs contains instructions to modify parameters
-                          generation from the instance's spec.
+                        description: SpecToEnvs contains instructions to generate
+                          environment variables from the instance's spec.
                         items:
                           description: SpecToEnvsParameterConfiguration contains instructions
-                            to modify parameters generation for the controlled instance
-                            spec.
+                            to generate environment variables from the controlled
+                            instance spec.
                           properties:
                             path:
                               description: JSON simplified path for the parameter.
@@ -359,6 +359,54 @@ spec:
                           - 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.
+                              properties:
+                                key:
+                                  description: The key to select.
+                                  type: string
+                                name:
+                                  description: Object name
+                                  type: string
+                              required:
+                              - key
+                              - name
+                              type: object
+                          required:
+                          - path
+                          type: object
+                        type: array
                     type: object
                   statusConfiguration:
                     description: StatusConfiguration contains rules to populate a

docs/reference/registration.md

@@ -221,6 +221,23 @@ The default behavior is to create parameters from each spec element (arrays will
             name: resolveAddress
 ```
 
+### Generate Volumes From Spec
+
+Secrets and ConfigMaps can be mounted as a volume inside the workload. The registration needs a name for the volume, the file to mount inside the container and a reference to the Secret or ConfigMap.
+
+- [x] Function: resolve object to internal URL
+
+```yaml
+    parameterConfiguration:
+      specToVolumes:
+      - path: spec.userList
+        name: userfile
+        mountPath: /opt/user.lst
+        valueFromConfigMap:
+          name: spec.userList.name
+          key: spec.userList.key
+```
+
 ## Workload Status
 
 - [x] Use parameter value for status.

pkg/apis/common/v1alpha1/workload_types.go

@@ -37,15 +37,20 @@ type ParameterConfiguration struct {
 	// +optional
 	Global *GlobalParameterConfiguration `json:"global,omitempty"`
 
-	// AddEnvs contains configurations for parameters to be added to the workload
+	// AddEnvs contains instructions to create environment variables at the workload
 	// not derived from the user instance.
 	// +optional
 	AddEnvs []corev1.EnvVar `json:"addEnvs,omitempty"`
 
-	// SpecToEnvs contains instructions to modify parameters generation from
+	// SpecToEnvs contains instructions to generate environment variables from
 	// the instance's spec.
 	// +optional
 	SpecToEnvs []SpecToEnvParameterConfiguration `json:"specToEnvs,omitempty"`
+
+	// SpecToVolumes contains instructions to generate volumes and mounts from
+	// the instance's spec.
+	// +optional
+	SpecToVolumes []SpecToVolumeParameterConfiguration `json:"specToVolumes,omitempty"`
 }
 
 // GlobalParameterConfiguration defines configuration to be applied to all generated parameters.
@@ -63,7 +68,7 @@ func (gpc *GlobalParameterConfiguration) GetDefaultPrefix() string {
 	return *gpc.DefaultPrefix
 }
 
-// SpecToEnvsParameterConfiguration contains instructions to modify parameters generation for
+// SpecToEnvsParameterConfiguration contains instructions to generate environment variables from
 // the controlled instance spec.
 type SpecToEnvParameterConfiguration struct {
 	// JSON simplified path for the parameter.
@@ -74,6 +79,27 @@ type SpecToEnvParameterConfiguration struct {
 	Render *ParameterRenderConfiguration `json:"render,omitempty"`
 }
 
+// SpecToVolumeParameterConfiguration contains instructions to generate volumes
+// and volume mounts from the controlled instance spec.
+type SpecToVolumeParameterConfiguration struct {
+	// JSON simplified path for the parameter.
+	Path string `json:"path"`
+
+	// Name for the volume.
+	Name string `json:"name,omitempty"`
+
+	// Path where the file will be mounted.
+	MountPath string `json:"mountPath,omitempty"`
+
+	// ValueFromConfigMap is a reference to a ConfigMap.
+	// +optional
+	ValueFromConfigMap *ObjectReference `json:"valueFromConfigMap,omitempty"`
+
+	// ValueFromSecret is a reference to a Secret.
+	// +optional
+	ValueFromSecret *ObjectReference `json:"valueFromSecret,omitempty"`
+}
+
 // ParameterRenderConfiguration are the customization options for an specific
 // parameter generation.
 type ParameterRenderConfiguration struct {