feat: introduce readiness and liveness probe feature

RealAnna · bacherfl · RealAnna · commit c4a0299b5358 · 2023-02-16T20:21:47.000+01:00
Signed-off-by: RealAnna <anna.reale@dynatrace.com> feat: introduce readiness and liveness probe feature Signed-off-by: RealAnna <anna.reale@dynatrace.com> feat: added tests Signed-off-by: RealAnna <anna.reale@dynatrace.com> feat: introduce readiness and liveness probe feature Signed-off-by: RealAnna <anna.reale@dynatrace.com> feat: added fix Signed-off-by: RealAnna <anna.reale@dynatrace.com> feat: added fix Signed-off-by: RealAnna <anna.reale@dynatrace.com> feat: added fix Signed-off-by: RealAnna <anna.reale@dynatrace.com> feat: added fix Signed-off-by: RealAnna <anna.reale@dynatrace.com> feat: introduce readiness and liveness probe feature (#3) * feat: introduce readiness and liveness probe feature feat: introduce readiness and liveness probe feature Signed-off-by: realanna <anna.reale@dynatrace.com> * Update pkg/processor/probes/probes.go Co-authored-by: Florian Bacher <florian.bacher@dynatrace.com> Signed-off-by: realanna <anna.reale@dynatrace.com> --------- Signed-off-by: realanna <anna.reale@dynatrace.com> Co-authored-by: Florian Bacher <florian.bacher@dynatrace.com>
diff --git a/cmd/helmify/flags.go b/cmd/helmify/flags.go
@@ -37,6 +37,7 @@ func ReadFlags() config.Config {
 	flag.BoolVar(&result.VeryVerbose, "vv", false, "Enable very verbose output. Same as verbose but with DEBUG. Example: helmify -vv")
 	flag.BoolVar(&crd, "crd-dir", false, "Enable crd install into 'crds' directory.\nWarning: CRDs placed in 'crds' directory will not be templated by Helm.\nSee https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#some-caveats-and-explanations\nExample: helmify -crd-dir")
 	flag.BoolVar(&result.ImagePullSecrets, "image-pull-secrets", false, "Allows the user to use existing secrets as imagePullSecrets in values.yaml")
+	flag.BoolVar(&result.Probes, "probes", true, "Allows the user to customize liveness and readiness probes")
 
 	flag.Parse()
 	if h || help {
diff --git a/examples/operator/templates/_helpers.tpl b/examples/operator/templates/_helpers.tpl
@@ -60,3 +60,17 @@ Create the name of the service account to use
 {{- default "default" .Values.serviceAccount.name }}
 {{- end }}
 {{- end }}
+
+{{/*
+Renders a value that contains template.
+Usage:
+{{ include "tplvalues.render" ( dict "value" .Values.path.to.the.Value "context" $) }}
+*/}}
+{{- define "tplvalues.render" -}}
+    {{- if typeIs "string" .value }}
+        {{- tpl .value .context }}
+    {{- else }}
+        {{- tpl (.value | toYaml) .context }}
+    {{- end }}
+{{- end -}}
+
diff --git a/examples/operator/templates/deployment.yaml b/examples/operator/templates/deployment.yaml
@@ -53,28 +53,15 @@ spec:
               key: VAR1
               name: {{ include "operator.fullname" . }}-secret-vars
         - name: VAR2
-          value: {{ .Values.controllerManager.manager.var2 }}
+          value: {{ .Values.controllerManager.manager.env.var2 }}
         - name: VAR3_MY_ENV
-          value: {{ .Values.controllerManager.manager.var3MyEnv }}
+          value: {{ .Values.controllerManager.manager.env.var3MyEnv }}
         - name: KUBERNETES_CLUSTER_DOMAIN
           value: {{ .Values.kubernetesClusterDomain }}
         image: {{ .Values.controllerManager.manager.image.repository }}:{{ .Values.controllerManager.manager.image.tag
           | default .Chart.AppVersion }}
-        livenessProbe:
-          httpGet:
-            path: /healthz
-            port: 8081
-          initialDelaySeconds: 15
-          periodSeconds: 20
         name: manager
-        readinessProbe:
-          httpGet:
-            path: /readyz
-            port: 8081
-          initialDelaySeconds: 5
-          periodSeconds: 10
-        resources: {{- toYaml .Values.controllerManager.manager.resources | nindent 10
-          }}
+        resources: {{- toYaml .Values.controllerManager.manager.resources | nindent 10 }}
         securityContext:
           allowPrivilegeEscalation: false
         volumeMounts:
@@ -83,6 +70,26 @@ spec:
           subPath: controller_manager_config.yaml
         - mountPath: /my.ca
           name: secret-volume
+        {{- if .Values.controllerManager.manager.livenessProbe }}
+        livenessProbe: {{- include "tplvalues.render" (dict "value" .Values.controllerManager.manager.livenessProbe "context" $) | nindent 10 }}
+         {{- else }}
+        livenessProbe:
+         httpGet:
+           path: /healthz
+           port: 8081
+         initialDelaySeconds: 15
+         periodSeconds: 20
+        {{- end }}
+        {{- if .Values.controllerManager.manager.readinessProbe }}
+        readinessProbe: {{- include "tplvalues.render" (dict "value" .Values.controllerManager.manager.readinessProbe "context" $) | nindent 10 }}
+         {{- else }}
+        readinessProbe:
+         httpGet:
+           path: /readyz
+           port: 8081
+         initialDelaySeconds: 5
+         periodSeconds: 10
+        {{- end }}
       imagePullSecrets:
       - name: {{ include "operator.fullname" . }}-secret-registry-credentials
       securityContext:
diff --git a/examples/operator/values.yaml b/examples/operator/values.yaml
@@ -10,6 +10,18 @@ controllerManager:
     image:
       repository: controller
       tag: latest
+    livenessProbe:
+      httpGet:
+        path: /healthz
+        port: 8081
+      initialDelaySeconds: 15
+      periodSeconds: 20
+    readinessProbe:
+      httpGet:
+        path: /readyz
+        port: 8081
+      initialDelaySeconds: 5
+      periodSeconds: 10
     resources:
       limits:
         cpu: 100m
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -23,6 +23,8 @@ type Config struct {
 	Crd bool
 	// ImagePullSecrets flag
 	ImagePullSecrets bool
+	// Probes flag if true the probes will be parametrised
+	Probes bool
 }
 
 func (c *Config) Validate() error {
diff --git a/pkg/helm/init.go b/pkg/helm/init.go
@@ -99,6 +99,20 @@ Create the name of the service account to use
 {{- default "default" .Values.serviceAccount.name }}
 {{- end }}
 {{- end }}
+
+{{/*
+Renders a value that contains template.
+Usage:
+{{ include "tplvalues.render" ( dict "value" .Values.path.to.the.Value "context" $) }}
+*/}}
+{{- define "tplvalues.render" -}}
+    {{- if typeIs "string" .value }}
+        {{- tpl .value .context }}
+    {{- else }}
+        {{- tpl (.value | toYaml) .context }}
+    {{- end }}
+{{- end -}}
+
 `
 
 const defaultChartfile = `apiVersion: v2
diff --git a/pkg/helmify/model.go b/pkg/helmify/model.go
@@ -1,9 +1,10 @@
 package helmify
 
 import (
-	"github.com/arttor/helmify/pkg/config"
 	"io"
 
+	"github.com/arttor/helmify/pkg/config"
+
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 )
 
diff --git a/pkg/metadata/metadata.go b/pkg/metadata/metadata.go
@@ -2,9 +2,10 @@ package metadata
 
 import (
 	"fmt"
-	"github.com/arttor/helmify/pkg/config"
 	"strings"
 
+	"github.com/arttor/helmify/pkg/config"
+
 	"github.com/arttor/helmify/pkg/helmify"
 	"github.com/sirupsen/logrus"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
diff --git a/pkg/processor/deployment/deployment.go b/pkg/processor/deployment/deployment.go
@@ -7,10 +7,10 @@ import (
 	"text/template"
 
 	"github.com/arttor/helmify/pkg/cluster"
+	"github.com/arttor/helmify/pkg/helmify"
 	"github.com/arttor/helmify/pkg/processor"
 	"github.com/arttor/helmify/pkg/processor/imagePullSecrets"
-
-	"github.com/arttor/helmify/pkg/helmify"
+	"github.com/arttor/helmify/pkg/processor/probes"
 	yamlformat "github.com/arttor/helmify/pkg/yaml"
 	"github.com/iancoleman/strcase"
 	"github.com/pkg/errors"
@@ -47,7 +47,7 @@ const selectorTempl = `%[1]s
 {{- include "%[2]s.selectorLabels" . | nindent 6 }}
 %[3]s`
 
-const envValue = "{{ .Values.%[1]s.%[2]s.%[3]s }}"
+const envValue = "{{ .Values.%[1]s.%[2]s.%[3]s.%[4]s }}"
 
 // New creates processor for k8s Deployment resource.
 func New() helmify.Processor {
@@ -139,19 +139,20 @@ func (d deployment) Process(appMeta helmify.AppMetadata, obj *unstructured.Unstr
 	if err != nil {
 		return true, nil, err
 	}
+
 	for i := range containers {
 		containerName := strcase.ToLowerCamel((containers[i].(map[string]interface{})["name"]).(string))
 		res, exists, err := unstructured.NestedMap(values, nameCamel, containerName, "resources")
 		if err != nil {
 			return true, nil, err
 		}
-		if !exists || len(res) == 0 {
-			continue
-		}
-		err = unstructured.SetNestedField(containers[i].(map[string]interface{}), fmt.Sprintf(`{{- toYaml .Values.%s.%s.resources | nindent 10 }}`, nameCamel, containerName), "resources")
-		if err != nil {
-			return true, nil, err
+		if exists && len(res) > 0 {
+			err = unstructured.SetNestedField(containers[i].(map[string]interface{}), fmt.Sprintf(`{{- toYaml .Values.%s.%s.resources | nindent 10 }}`, nameCamel, containerName), "resources")
+			if err != nil {
+				return true, nil, err
+			}
 		}
+
 	}
 	err = unstructured.SetNestedSlice(specMap, containers, "containers")
 	if err != nil {
@@ -162,12 +163,21 @@ func (d deployment) Process(appMeta helmify.AppMetadata, obj *unstructured.Unstr
 		imagePullSecrets.ProcessSpecMap(specMap, &values)
 	}
 
+	if appMeta.Config().Probes {
+		err = probes.ProcessSpecMap(nameCamel, specMap, &values)
+		if err != nil {
+			return true, nil, err
+		}
+	}
+
 	spec, err := yamlformat.Marshal(specMap, 6)
 	if err != nil {
 		return true, nil, err
 	}
-	spec = strings.ReplaceAll(spec, "'", "")
 
+	spec = strings.ReplaceAll(spec, "'", "")
+	spec = strings.ReplaceAll(spec, "|\n        ", "")
+	spec = strings.ReplaceAll(spec, "|-\n        ", "")
 	return true, &result{
 		values: values,
 		data: struct {
@@ -208,6 +218,7 @@ func processPodSpec(name string, appMeta helmify.AppMetadata, pod *corev1.PodSpe
 	values := helmify.Values{}
 	for i, c := range pod.Containers {
 		processed, err := processPodContainer(name, appMeta, c, &values)
+
 		if err != nil {
 			return nil, err
 		}
@@ -260,13 +271,16 @@ func processPodContainer(name string, appMeta helmify.AppMetadata, c corev1.Cont
 		if e.ConfigMapRef != nil {
 			e.ConfigMapRef.Name = appMeta.TemplatedName(e.ConfigMapRef.Name)
 		}
+
 	}
+
 	c.Env = append(c.Env, corev1.EnvVar{
 		Name:  cluster.DomainEnv,
 		Value: fmt.Sprintf("{{ .Values.%s }}", cluster.DomainKey),
 	})
 	for k, v := range c.Resources.Requests {
 		err = unstructured.SetNestedField(*values, v.ToUnstructured(), name, containerName, "resources", "requests", k.String())
+
 		if err != nil {
 			return c, errors.Wrap(err, "unable to set container resources value")
 		}
@@ -277,7 +291,8 @@ func processPodContainer(name string, appMeta helmify.AppMetadata, c corev1.Cont
 			return c, errors.Wrap(err, "unable to set container resources value")
 		}
 	}
-	return c, nil
+
+	return c, err
 }
 
 func processEnv(name string, appMeta helmify.AppMetadata, c corev1.Container, values *helmify.Values) (corev1.Container, error) {
@@ -293,7 +308,7 @@ func processEnv(name string, appMeta helmify.AppMetadata, c corev1.Container, va
 			if err != nil {
 				return c, errors.Wrap(err, "unable to set deployment value field")
 			}
-			c.Env[i].Value = fmt.Sprintf(envValue, name, containerName, strcase.ToLowerCamel(strings.ToLower(c.Env[i].Name)))
+			c.Env[i].Value = fmt.Sprintf(envValue, name, containerName, "env", strcase.ToLowerCamel(strings.ToLower(c.Env[i].Name)))
 		}
 	}
 	return c, nil
diff --git a/pkg/processor/probes/probes.go b/pkg/processor/probes/probes.go
@@ -0,0 +1,97 @@
+package probes
+
+import (
+	"fmt"
+
+	"github.com/arttor/helmify/pkg/helmify"
+	yamlformat "github.com/arttor/helmify/pkg/yaml"
+	"github.com/iancoleman/strcase"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"sigs.k8s.io/yaml"
+)
+
+const livenessProbe = "livenessProbe"
+const readinessProbe = "readinessProbe"
+
+const livenessProbeTemplate = "{{- if .Values.%[1]s.%[2]s.livenessProbe }}\n" +
+	"livenessProbe: {{- include \"tplvalues.render\" (dict \"value\" .Values.%[1]s.%[2]s.livenessProbe \"context\" $) | nindent 10 }}\n" +
+	" {{- else }}\n" +
+	"livenessProbe:\n%[3]s" +
+	"\n{{- end }}"
+
+const readinessProbeTemplate = "\n{{- if .Values.%[1]s.%[2]s.readinessProbe }}\n" +
+	"readinessProbe: {{- include \"tplvalues.render\" (dict \"value\" .Values.%[1]s.%[2]s.readinessProbe \"context\" $) | nindent 10 }}\n" +
+	" {{- else }}\n" +
+	"readinessProbe:\n%[3]s" +
+	"\n{{- end }}"
+
+// ProcessSpecMap adds 'probes' to the Containers in specMap, if they are defined
+func ProcessSpecMap(name string, specMap map[string]interface{}, values *helmify.Values) error {
+
+	cs, _, err := unstructured.NestedSlice(specMap, "containers")
+	if err != nil {
+		return err
+	}
+
+	strContainers := make([]interface{}, len(cs))
+	for i, c := range cs {
+		castedContainer := c.(map[string]interface{})
+		strContainers[i], err = setProbesTemplates(name, castedContainer, values)
+		if err != nil {
+			return err
+		}
+	}
+
+	return unstructured.SetNestedSlice(specMap, strContainers, "containers")
+
+}
+
+func setProbesTemplates(name string, castedContainer map[string]interface{}, values *helmify.Values) (string, error) {
+
+	var ready, live string
+	var err error
+	if _, defined := castedContainer[livenessProbe]; defined {
+		live, err = setProbe(name, castedContainer, values, livenessProbe)
+		if err != nil {
+			return "", err
+		}
+		delete(castedContainer, livenessProbe)
+	}
+	if _, defined := castedContainer[readinessProbe]; defined {
+		ready, err = setProbe(name, castedContainer, values, readinessProbe)
+		if err != nil {
+			return "", err
+		}
+		delete(castedContainer, readinessProbe)
+	}
+	return setMap(name, castedContainer, live, ready)
+
+}
+
+func setMap(name string, castedContainer map[string]interface{}, live string, ready string) (string, error) {
+	containerName := strcase.ToLowerCamel(castedContainer["name"].(string))
+	content, err := yaml.Marshal(castedContainer)
+
+	if err != nil {
+		return "", err
+	}
+	strContainer := string(content)
+	if live != "" {
+		strContainer = strContainer + fmt.Sprintf(livenessProbeTemplate, name, containerName, live)
+	}
+	if ready != "" {
+		strContainer = strContainer + fmt.Sprintf(readinessProbeTemplate, name, containerName, ready)
+	}
+	return strContainer, nil
+}
+
+func setProbe(name string, castedContainer map[string]interface{}, values *helmify.Values, probe string) (string, error) {
+	containerName := strcase.ToLowerCamel(castedContainer["name"].(string))
+	live, err := yamlformat.Marshal(castedContainer[probe], 1)
+	if err != nil {
+		return "", err
+	}
+
+	return live, unstructured.SetNestedField(*values, castedContainer[probe], name, containerName, probe)
+
+}
diff --git a/pkg/processor/probes/probes_test.go b/pkg/processor/probes/probes_test.go

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@ type Config struct {`
`23`	`23`	`Crd bool`
`24`	`24`	`// ImagePullSecrets flag`
`25`	`25`	`ImagePullSecrets bool`
	`26`	`+ // Probes flag if true the probes will be parametrised`
	`27`	`+ Probes bool`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`func (c *Config) Validate() error {`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,10 @@`
`1`	`1`	`package helmify`
`2`	`2`
`3`	`3`	`import (`
`4`		`- "github.com/arttor/helmify/pkg/config"`
`5`	`4`	`"io"`
`6`	`5`
	`6`	`+ "github.com/arttor/helmify/pkg/config"`
	`7`	`+`
`7`	`8`	`"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"`
`8`	`9`	`)`
`9`	`10`