feat(cf-common): upd initContainer tpl (#32)

Author: mikhail-klimko

charts/cf-common-test/README.md

@@ -31,7 +31,7 @@ Codefresh library chart - test chart - not for deployment!
 | global | object | `{}` |  |
 | hpa | object | `{}` |  |
 | ingress | object | `{}` |  |
-| initContainers | list | `[]` |  |
+| initContainers | object | `{}` |  |
 | nodeSelector | object | `{}` |  |
 | pdb | object | `{}` |  |
 | podSecurityContext | object | `{}` |  |

charts/cf-common-test/tests/deployment/spec_test.yaml

@@ -69,19 +69,69 @@ tests:
       - values.yaml
     set:
       initContainers:
-      - name: init-myservice
-        image: busybox:1.28
-        command: ['sh', '-c', "sleep 60"]
+        sleep:
+          enabled: true
+          image:
+            registry: docker.io
+            repository: bitnami/bitnami-shell
+            tag: latest
+            pullPolicy: IfNotPresent
+          command: ['sh', '-c', "sleep 60"]
     asserts:
       - lengthEqual:
           path: spec.template.spec.initContainers
           count: 1
       - contains:
           path: spec.template.spec.initContainers
           content:
-            name: init-myservice
-            image: busybox:1.28
+            name: sleep
+            image: docker.io/bitnami/bitnami-shell:latest
             command: ['sh', '-c', "sleep 60"]
+            imagePullPolicy: IfNotPresent
+
+  - it: Test deployment's initContainer is disabled
+    values:
+      - values.yaml
+    set:
+      initContainers:
+        sleep:
+          enabled: false
+          image:
+            registry: docker.io
+            repository: bitnami/bitnami-shell
+            tag: latest
+            pullPolicy: IfNotPresent
+          command: ['sh', '-c', "sleep 60"]
+    asserts:
+      - isNull:
+          path: spec.template.spec.initContainers
+
+  - it: Test deployment's initContainer with global.imageRegistry
+    values:
+      - values.yaml
+    set:
+      global:
+        imageRegistry: myregistry.io
+      initContainers:
+        sleep:
+          enabled: true
+          image:
+            registry: docker.io
+            repository: bitnami/bitnami-shell
+            tag: latest
+            pullPolicy: IfNotPresent
+          command: ['sh', '-c', "sleep 60"]
+    asserts:
+      - lengthEqual:
+          path: spec.template.spec.initContainers
+          count: 1
+      - contains:
+          path: spec.template.spec.initContainers
+          content:
+            name: sleep
+            image: myregistry.io/bitnami/bitnami-shell:latest
+            command: ['sh', '-c', "sleep 60"]
+            imagePullPolicy: IfNotPresent
 
   - it: Test deployments nodeSelector
     values:

charts/cf-common-test/values.yaml

@@ -31,7 +31,7 @@ tolerations: []
 
 affinity: {}
 
-initContainers: []
+initContainers: {}
 
 additionalContainers: []
 

charts/cf-common/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: v0.0.0
 description: Codefresh library chart
 name: cf-common
-version: 0.3.0
+version: 0.4.0
 type: library
 keywords:
   - codefresh

charts/cf-common/README.md

@@ -2,7 +2,7 @@
 
 Codefresh library chart
 
-![Version: 0.3.0](https://img.shields.io/badge/Version-0.3.0-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
+![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
 
 ## Installing the Chart
 
@@ -18,7 +18,7 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
 # Chart.yaml
 dependencies:
 - name: cf-common
-  version: 0.3.0
+  version: 0.4.0
   repository: https://chartmuseum.codefresh.io/cf-common
 ```
 
@@ -122,7 +122,7 @@ dependencies:
 | ingress.main.ingressClassName | string | `nil` | Set the ingressClass that is used for the ingress. |
 | ingress.main.labels | object | `{}` | Add additional labels for ingress. |
 | ingress.main.tls | list | `[]` | Configure TLS for the ingress. Both secretName and hosts can process a Helm template. |
-| initContainers | list | `[]` | Array of init containers to add |
+| initContainers | object | `{}` | Map of init containers to add Follows the same values structure as in `.Values.containes` The map key (e.g. `sleep`) will be used for the container name. |
 | nodeSelector | object | `{}` | Set node selection constrains |
 | pdb | object | See below | Configure Pod Disruption Budget |
 | pdb.enabled | bool | `false` | Enable PDB |

charts/cf-common/templates/classic/_helpers.tpl

@@ -2,10 +2,10 @@
 Calculate RabbitMQ URI (for On-Prem)
 Must me called from chart root context.
 Usage:
-{{ include "cf-common-0.3.0.classic.calculateRabbitMqUri" . }}
+{{ include "cf-common-0.4.0.classic.calculateRabbitMqUri" . }}
 */}}
 
-{{- define "cf-common-0.3.0.classic.calculateRabbitMqUri" }}
+{{- define "cf-common-0.4.0.classic.calculateRabbitMqUri" }}
 
 {{- $rabbitmqProtocol := .Values.global.rabbitmqProtocol | default "amqp" -}}
 {{- $rabbitmqUsername := .Values.global.rabbitmqUsername -}}
@@ -23,9 +23,9 @@ coalesce here for backward compatibility
 {{/*
 Calculate Mongo Uri (for On-Prem)
 Usage:
-{{ include "cf.common-0.3.0.classic.calculateMongoUri" (dict "dbName" $.Values.global.pipelineManagerService "mongoURI" $.Values.global.mongoURI) }}
+{{ include "cf.common-0.4.0.classic.calculateMongoUri" (dict "dbName" $.Values.global.pipelineManagerService "mongoURI" $.Values.global.mongoURI) }}
 */}}
-{{- define "cf-common-0.3.0.classic.calculateMongoUri" -}}
+{{- define "cf-common-0.4.0.classic.calculateMongoUri" -}}
   {{- if contains "?" .mongoURI -}}
     {{- $mongoURI :=  (splitList "?" .mongoURI) -}}
     {{- printf "%s%s?%s" (first $mongoURI) .dbName (last $mongoURI) }}

charts/cf-common/templates/common/_annotations.tpl

@@ -2,19 +2,19 @@
 Render checksum annotation
 Must be called from chart root context.
 Usage:
-annotations: {{ include "cf-common-0.3.0.annotations.podAnnotations" . | nindent }}
+annotations: {{ include "cf-common-0.4.0.annotations.podAnnotations" . | nindent }}
 */}}
-{{- define "cf-common-0.3.0.annotations.podAnnotations" -}}
+{{- define "cf-common-0.4.0.annotations.podAnnotations" -}}
 
 {{- if .Values.podAnnotations -}}
-  {{- include "cf-common-0.3.0.tplrender" (dict "Values" .Values.podAnnotations "context" $) | nindent 0 }}
+  {{- include "cf-common-0.4.0.tplrender" (dict "Values" .Values.podAnnotations "context" $) | nindent 0 }}
 {{- end -}}
 
 {{- $configMapFound := dict -}}
 {{- range $configMapIndex, $configMapItem := .Values.configMaps -}}
 
   {{- if $configMapItem.enabled -}}
-    {{- $_ := set $configMapFound $configMapIndex ( include "cf-common-0.3.0.tplrender" (dict "Values" $configMapItem.data "context" $) | sha256sum) -}}
+    {{- $_ := set $configMapFound $configMapIndex ( include "cf-common-0.4.0.tplrender" (dict "Values" $configMapItem.data "context" $) | sha256sum) -}}
   {{- end -}}
 
   {{- if $configMapFound -}}
@@ -27,7 +27,7 @@ annotations: {{ include "cf-common-0.3.0.annotations.podAnnotations" . | nindent
 {{- range $secretIndex, $secretItem := .Values.secrets -}}
 
   {{- if $secretItem.enabled -}}
-    {{- $_ := set $secretFound $secretIndex ( include "cf-common-0.3.0.tplrender" (dict "Values" $secretItem.stringData "context" $) | sha256sum) -}}
+    {{- $_ := set $secretFound $secretIndex ( include "cf-common-0.4.0.tplrender" (dict "Values" $secretItem.stringData "context" $) | sha256sum) -}}
   {{- end -}}
 
   {{- if $secretFound -}}

charts/cf-common/templates/common/_labels.tpl

@@ -1,28 +1,28 @@
 {{/*
 Kubernetes standard labels
 */}}
-{{- define "cf-common-0.3.0.labels.standard" -}}
-app.kubernetes.io/name: {{ include "cf-common-0.3.0.names.name" . }}
-helm.sh/chart: {{ include "cf-common-0.3.0.names.chart" . }}
+{{- define "cf-common-0.4.0.labels.standard" -}}
+app.kubernetes.io/name: {{ include "cf-common-0.4.0.names.name" . }}
+helm.sh/chart: {{ include "cf-common-0.4.0.names.chart" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 app.kubernetes.io/managed-by: {{ .Release.Service }}
 {{- end -}}
 
 {{/*
 Labels to use on deploy.spec.selector.matchLabels and svc.spec.selector
 */}}
-{{- define "cf-common-0.3.0.labels.matchLabels" -}}
-app.kubernetes.io/name: {{ include "cf-common-0.3.0.names.name" . }}
+{{- define "cf-common-0.4.0.labels.matchLabels" -}}
+app.kubernetes.io/name: {{ include "cf-common-0.4.0.names.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end -}}
 
 
 {{/*
 Extra labels
 Usage:
-{{ include "cf-common-0.3.0.labels.extraLabels" ( dict "Values" .Values.path.to.the.labels "context" $) }}
+{{ include "cf-common-0.4.0.labels.extraLabels" ( dict "Values" .Values.path.to.the.labels "context" $) }}
 */}}
-{{- define "cf-common-0.3.0.labels.extraLabels" -}}
+{{- define "cf-common-0.4.0.labels.extraLabels" -}}
   {{- if not (kindIs "map" .Values) -}}
   {{- fail "ERROR: labels block must be a map" -}}
   {{- end -}}
@@ -34,9 +34,9 @@ Usage:
 {{/*
 Annotations
 Usage:
-{{ include "cf-common-0.3.0.annotations" ( dict "Values" .Values.path.to.the.annotations "context" $) }}
+{{ include "cf-common-0.4.0.annotations" ( dict "Values" .Values.path.to.the.annotations "context" $) }}
 */}}
-{{- define "cf-common-0.3.0.annotations" -}}
+{{- define "cf-common-0.4.0.annotations" -}}
   {{- if not (kindIs "map" .Values) -}}
   {{- fail "ERROR: annotations block must be a map" -}}
   {{- end -}}

charts/cf-common/templates/common/_names.tpl

@@ -1,14 +1,14 @@
 {{/*
 Expand the name of the chart.
 */}}
-{{- define "cf-common-0.3.0.names.name" -}}
+{{- define "cf-common-0.4.0.names.name" -}}
 {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
 {{/*
 Create chart name and version as used by the chart label.
 */}}
-{{- define "cf-common-0.3.0.names.chart" -}}
+{{- define "cf-common-0.4.0.names.chart" -}}
 {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
 {{- end -}}
 
@@ -17,7 +17,7 @@ Create a default fully qualified app name.
 We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
 If release name contains chart name it will be used as a full name.
 */}}
-{{- define "cf-common-0.3.0.names.fullname" -}}
+{{- define "cf-common-0.4.0.names.fullname" -}}
 {{- if .Values.fullnameOverride -}}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
 {{- else -}}
@@ -33,10 +33,10 @@ If release name contains chart name it will be used as a full name.
 {{/*
 ServiceAccount Name
 */}}
-{{- define "cf-common-0.3.0.names.serviceAccountName" -}}
+{{- define "cf-common-0.4.0.names.serviceAccountName" -}}
   {{- if .Values.serviceAccount -}}
     {{- if .Values.serviceAccount.enabled -}}
-      {{- .Values.serviceAccount.nameOverride | default (include "cf-common-0.3.0.names.fullname" .)  -}}
+      {{- .Values.serviceAccount.nameOverride | default (include "cf-common-0.4.0.names.fullname" .)  -}}
     {{- else -}}
       {{- print "default" -}}
     {{- end -}}

charts/cf-common/templates/common/_tpl.tpl

@@ -1,9 +1,9 @@
 {{/*
 Renders a value that contains template.
 Usage:
-{{ include "cf-common-0.3.0.tplrender" ( dict "Values" .Values.path.to.the.Value "context" $) }}
+{{ include "cf-common-0.4.0.tplrender" ( dict "Values" .Values.path.to.the.Value "context" $) }}
 */}}
-{{- define "cf-common-0.3.0.tplrender" -}}
+{{- define "cf-common-0.4.0.tplrender" -}}
   {{- $tpl := .Values -}}
   {{- if not (typeIs "string" $tpl) -}}
     {{- $tpl = toYaml $tpl -}}