add parameters to template with default value

Author: ericogr

apis/v1/objecttemplate_types.go

@@ -35,10 +35,17 @@ type Object struct {
 	TemplateBody string   `json:"templateBody"`
 }
 
+// Parameter defines a single parameter
+type Parameter struct {
+	Name    string `json:"name"`
+	Default string `json:"default"`
+}
+
 // ObjectTemplateSpec defines the desired state of ObjectTemplate
 type ObjectTemplateSpec struct {
-	Description string   `json:"description,omitempty"`
-	Objects     []Object `json:"objects"`
+	Description string      `json:"description,omitempty"`
+	Parameters  []Parameter `json:"parameters"`
+	Objects     []Object    `json:"objects"`
 }
 
 // ObjectTemplateStatus defines the observed state of ObjectTemplate

apis/v1/zz_generated.deepcopy.go

@@ -76,8 +76,22 @@ spec:
                 - templateBody
                 type: object
               type: array
+            parameters:
+              items:
+                description: Parameter defines a single parameter
+                properties:
+                  default:
+                    type: string
+                  name:
+                    type: string
+                required:
+                - default
+                - name
+                type: object
+              type: array
           required:
           - objects
+          - parameters
           type: object
         status:
           description: ObjectTemplateStatus defines the observed state of ObjectTemplate

config/crd/bases/template.k8s.ericogr.com.br_objecttemplates.yaml

@@ -5,6 +5,11 @@ metadata:
   name: objecttemplate-configmap-test
 spec:
   description: ConfigMap test
+  parameters:
+  - name: name
+  - name: age
+  - name: country
+    default: myCountry
   objects:
   - kind: ConfigMap
     apiVersion: v1
@@ -19,4 +24,5 @@ spec:
     templateBody: |-
       data:
         name: '{{ .name }}'
-        age: '{{ .age }}'
+        age: '{{ .age }}'
+        country: '{{ .country }}'

config/samples/template.k8s.ericogr.com.br_v1_objecttemplate.yaml

@@ -28,9 +28,10 @@ type Common struct {
 }
 
 // UpdateObjectsByTemplate update object
-func (c *Common) UpdateObjectsByTemplate(ot otv1.ObjectTemplate, owners []metav1.OwnerReference, namespaceName string, values map[string]string) error {
+func (c *Common) UpdateObjectsByTemplate(ot otv1.ObjectTemplate, owners []metav1.OwnerReference, namespaceName string, paramsValues map[string]string) error {
 	for _, obj := range ot.Spec.Objects {
-		err := c.UpdateSingleObjectByTemplate(obj, owners, namespaceName, values)
+		normParams := c.normalizeParametersValues(ot.Spec.Parameters, paramsValues)
+		err := c.UpdateSingleObjectByTemplate(obj, owners, namespaceName, normParams)
 
 		if err != nil {
 			return err
@@ -40,6 +41,19 @@ func (c *Common) UpdateObjectsByTemplate(ot otv1.ObjectTemplate, owners []metav1
 	return nil
 }
 
+func (c *Common) normalizeParametersValues(templateParamsValues []otv1.Parameter, paramsValues map[string]string) (params map[string]string) {
+	params = map[string]string{}
+	for _, tp := range templateParamsValues {
+		if len(paramsValues[tp.Name]) > 0 {
+			params[tp.Name] = paramsValues[tp.Name]
+		} else {
+			params[tp.Name] = tp.Default
+		}
+	}
+
+	return params
+}
+
 // UpdateSingleObjectByTemplate update object
 func (c *Common) UpdateSingleObjectByTemplate(obj otv1.Object, owners []metav1.OwnerReference, namespaceName string, values map[string]string) error {
 	ctx := context.Background()

controllers/template/commons.go

@@ -52,6 +52,20 @@ var _ = Describe("ObjectTemplateParams controller (ConfigMap)", func() {
 				},
 				Spec: otv1.ObjectTemplateSpec{
 					Description: "namespace-template",
+					Parameters: []otv1.Parameter{
+						{
+							Name:    "lives",
+							Default: "1",
+						},
+						{
+							Name:    "properties_file",
+							Default: "",
+						},
+						{
+							Name:    "character_name",
+							Default: "maria",
+						},
+					},
 					Objects: []otv1.Object{
 						{
 							Kind: "ConfigMap",
@@ -69,6 +83,7 @@ var _ = Describe("ObjectTemplateParams controller (ConfigMap)", func() {
 							Name:       NewObjectName,
 							TemplateBody: `data:
   player_initial_lives: "{{ .lives }}"
+  player_name: "{{ .character_name }}"
   ui_properties_file_name: "{{ .properties_file }}"`,
 						},
 					},
@@ -117,6 +132,7 @@ var _ = Describe("ObjectTemplateParams controller (ConfigMap)", func() {
 				return err == nil
 			}, timeout, interval).Should(BeTrue())
 			Expect(configmap.Data["player_initial_lives"]).Should(BeIdenticalTo("3"))
+			Expect(configmap.Data["player_name"]).Should(BeIdenticalTo("maria"))
 			Expect(configmap.Data["ui_properties_file_name"]).Should(BeIdenticalTo("user-interface.properties"))
 			Expect(configmap.ObjectMeta.Annotations["annotation1"]).Should(BeIdenticalTo("value_annotation1"))
 			Expect(configmap.ObjectMeta.Annotations["annotation2"]).Should(BeIdenticalTo("value_annotation2"))

controllers/template/controller_map_test.go

@@ -52,6 +52,12 @@ var _ = Describe("ObjectTemplateParams controller (POD)", func() {
 				},
 				Spec: otv1.ObjectTemplateSpec{
 					Description: "namespace-template",
+					Parameters: []otv1.Parameter{
+						{
+							Name:    "imageName",
+							Default: "latest",
+						},
+					},
 					Objects: []otv1.Object{
 						{
 							Kind: "Pod",