feat(common): Release version 2.0.0-beta.1 (#173)

charts/library/common/templates/lib/controller/_enabled_containers.tpl

@@ -0,0 +1,24 @@
+{{/*
+Return the enabled containers for a controller.
+*/}}
+{{- define "bjw-s.common.lib.controller.enabledContainers" -}}
+  {{- $rootContext := .rootContext -}}
+  {{- $controllerObject := .controllerObject -}}
+
+  {{- $enabledContainers := dict -}}
+  {{- range $name, $container := $controllerObject.containers -}}
+    {{- if kindIs "map" $container -}}
+      {{- /* Enable container by default, but allow override */ -}}
+      {{- $containerEnabled := true -}}
+      {{- if hasKey $container "enabled" -}}
+        {{- $containerEnabled = $container.enabled -}}
+      {{- end -}}
+
+      {{- if $containerEnabled -}}
+        {{- $_ := set $enabledContainers $name . -}}
+      {{- end -}}
+    {{- end -}}
+  {{- end -}}
+
+  {{- $enabledContainers | toYaml -}}
+{{- end -}}

charts/library/common/templates/lib/controller/_mainContainer.tpl

@@ -1,58 +0,0 @@
-{{- /* The main container included in the controller */ -}}
-{{- define "bjw-s.common.lib.controller.mainContainer" -}}
-- name: {{ include "bjw-s.common.lib.chart.names.fullname" . }}
-  image: {{ include "bjw-s.common.lib.container.image" . }}
-  imagePullPolicy: {{ .Values.image.pullPolicy }}
-  {{- with .Values.command }}
-  command:
-    {{- if kindIs "string" . }}
-    - {{ . | quote }}
-    {{- else }}
-      {{ toYaml . | nindent 4 }}
-    {{- end }}
-  {{- end }}
-  {{- with .Values.args }}
-  args:
-    {{- if kindIs "string" . }}
-    - {{ . | quote }}
-    {{- else }}
-    {{ toYaml . | nindent 4 }}
-    {{- end }}
-  {{- end }}
-  {{- with .Values.securityContext }}
-  securityContext:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
-  {{- with .Values.lifecycle }}
-  lifecycle:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
-  {{- with .Values.termination.messagePath }}
-  terminationMessagePath: {{ . }}
-  {{- end }}
-  {{- with .Values.termination.messagePolicy }}
-  terminationMessagePolicy: {{ . }}
-  {{- end }}
-
-  {{- with .Values.env }}
-  env:
-    {{- get (fromYaml (include "bjw-s.common.lib.container.envVars" $)) "env" | toYaml | nindent 4 -}}
-  {{- end }}
-  {{- with .Values.envFrom }}
-  envFrom:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
-  {{- with (include "bjw-s.common.lib.container.ports" . | trim) }}
-  ports:
-    {{- nindent 4 . }}
-  {{- end }}
-  {{- with (include "bjw-s.common.lib.container.volumeMounts" . | trim) }}
-  volumeMounts:
-    {{- nindent 4 . }}
-  {{- end }}
-  {{- include "bjw-s.common.lib.container.probes" . | trim | nindent 2 }}
-  {{- with .Values.resources }}
-  resources:
-    {{- toYaml . | nindent 4 }}
-  {{- end }}
-{{- end -}}

charts/library/common/templates/lib/controller/_pod.tpl

@@ -1,114 +0,0 @@
-{{- /*
-The pod definition included in the controller.
-*/ -}}
-{{- define "bjw-s.common.lib.controller.pod" -}}
-  {{- with .Values.imagePullSecrets }}
-imagePullSecrets:
-    {{- toYaml . | nindent 2 }}
-  {{- end }}
-serviceAccountName: {{ include "bjw-s.common.lib.chart.names.serviceAccountName" . }}
-automountServiceAccountToken: {{ .Values.automountServiceAccountToken }}
-  {{- with .Values.podSecurityContext }}
-securityContext:
-    {{- toYaml . | nindent 2 }}
-  {{- end }}
-  {{- with .Values.priorityClassName }}
-priorityClassName: {{ . }}
-  {{- end }}
-  {{- with .Values.runtimeClassName }}
-runtimeClassName: {{ . }}
-  {{- end }}
-  {{- with .Values.schedulerName }}
-schedulerName: {{ . }}
-  {{- end }}
-  {{- with .Values.hostIPC }}
-hostIPC: {{ . }}
-  {{- end }}
-  {{- with .Values.hostNetwork }}
-hostNetwork: {{ . }}
-  {{- end }}
-  {{- with .Values.hostPID }}
-hostPID: {{ . }}
-  {{- end }}
-  {{- with .Values.hostname }}
-hostname: {{ . }}
-  {{- end }}
-  {{- if .Values.dnsPolicy }}
-dnsPolicy: {{ .Values.dnsPolicy }}
-  {{- else if .Values.hostNetwork }}
-dnsPolicy: ClusterFirstWithHostNet
-  {{- else }}
-dnsPolicy: ClusterFirst
-  {{- end }}
-  {{- with .Values.dnsConfig }}
-dnsConfig:
-    {{- toYaml . | nindent 2 }}
-  {{- end }}
-enableServiceLinks: {{ .Values.enableServiceLinks }}
-  {{- with .Values.termination.gracePeriodSeconds }}
-terminationGracePeriodSeconds: {{ . }}
-  {{- end }}
-  {{- if .Values.initContainers }}
-initContainers:
-    {{- $initContainers := list }}
-    {{- range $index, $key := (keys .Values.initContainers | uniq | sortAlpha) }}
-      {{- $container := get $.Values.initContainers $key }}
-      {{- if not $container.name -}}
-        {{- $_ := set $container "name" $key }}
-      {{- end }}
-      {{- if $container.env -}}
-        {{- $_ := set $ "ObjectValues" (dict "envVars" $container.env) -}}
-        {{- $newEnv := fromYaml (include "bjw-s.common.lib.container.envVars" $) -}}
-        {{- $_ := unset $.ObjectValues "envVars" -}}
-        {{- $_ := set $container "env" $newEnv.env }}
-      {{- end }}
-      {{- $initContainers = append $initContainers $container }}
-    {{- end }}
-    {{- tpl (toYaml $initContainers) $ | nindent 2 }}
-  {{- end }}
-containers:
-  {{- include "bjw-s.common.lib.controller.mainContainer" . | nindent 2 }}
-  {{- with (merge .Values.sidecars .Values.additionalContainers) }}
-    {{- $sidecarContainers := list }}
-    {{- range $name, $container := . }}
-      {{- if not $container.name -}}
-        {{- $_ := set $container "name" $name }}
-      {{- end }}
-      {{- if $container.env -}}
-        {{- $_ := set $ "ObjectValues" (dict "envVars" $container.env) -}}
-        {{- $newEnv := fromYaml (include "bjw-s.common.lib.container.envVars" $) -}}
-        {{- $_ := set $container "env" $newEnv.env }}
-        {{- $_ := unset $.ObjectValues "envVars" -}}
-      {{- end }}
-      {{- $sidecarContainers = append $sidecarContainers $container }}
-    {{- end }}
-    {{- tpl (toYaml $sidecarContainers) $ | nindent 2 }}
-  {{- end }}
-  {{- with (include "bjw-s.common.lib.controller.volumes" . | trim) }}
-volumes:
-    {{- nindent 2 . }}
-  {{- end }}
-  {{- with .Values.hostAliases }}
-hostAliases:
-    {{- toYaml . | nindent 2 }}
-  {{- end }}
-  {{- with .Values.nodeSelector }}
-nodeSelector:
-    {{- toYaml . | nindent 2 }}
-  {{- end }}
-  {{- with .Values.affinity }}
-affinity:
-    {{- toYaml . | nindent 2 }}
-  {{- end }}
-  {{- with .Values.topologySpreadConstraints }}
-topologySpreadConstraints:
-    {{- toYaml . | nindent 2 }}
-  {{- end }}
-  {{- with .Values.tolerations }}
-tolerations:
-    {{- toYaml . | nindent 2 }}
-  {{- end }}
-  {{- with .Values.controller.restartPolicy }}
-restartPolicy: {{ . }}
-  {{- end }}
-{{- end -}}

charts/library/common/templates/lib/controller/_validate.tpl

@@ -0,0 +1,18 @@
+{{/*
+Validate controller values
+*/}}
+{{- define "bjw-s.common.lib.controller.validate" -}}
+  {{- $rootContext := .rootContext -}}
+  {{- $controllerValues := .object -}}
+
+  {{- $allowedControllerTypes := list "deployment" "daemonset" "statefulset" "cronjob" -}}
+  {{- if not (has $controllerValues.type $allowedControllerTypes) -}}
+    {{- fail (printf "Not a valid controller.type (%s)" $controllerValues.type) -}}
+  {{- end -}}
+
+  {{- $enabledContainers := include "bjw-s.common.lib.controller.enabledContainers" (dict "rootContext" $rootContext "controllerObject" $controllerValues) | fromYaml }}
+  {{- /* Validate at least one container is enabled */ -}}
+  {{- if not $enabledContainers -}}
+    {{- fail (printf "No containers enabled for controller (%s)" $controllerValues.identifier) -}}
+  {{- end -}}
+{{- end -}}

charts/library/common/templates/lib/controller/_valuesToObject.tpl

@@ -0,0 +1,36 @@
+{{/*
+Convert controller values to an object
+*/}}
+{{- define "bjw-s.common.lib.controller.valuesToObject" -}}
+  {{- $rootContext := .rootContext -}}
+  {{- $identifier := .id -}}
+  {{- $objectValues := .values -}}
+
+  {{- /* Determine and inject the controller name */ -}}
+  {{- $objectName := (include "bjw-s.common.lib.chart.names.fullname" $rootContext) -}}
+
+  {{- if $objectValues.nameOverride -}}
+    {{- $objectName = printf "%s-%s" $objectName $objectValues.nameOverride -}}
+  {{- else -}}
+    {{- if ne $identifier "main" -}}
+      {{- $objectName = printf "%s-%s" $objectName $identifier -}}
+    {{- end -}}
+  {{- end -}}
+  {{- $_ := set $objectValues "name" $objectName -}}
+  {{- $_ := set $objectValues "identifier" $identifier -}}
+
+  {{- /* Set the default Pod options for the controller */ -}}
+  {{- range $index, $key := keys $rootContext.Values.defaultPodOptions -}}
+    {{- if not (hasKey $objectValues "pod") -}}
+      {{- $_ := set $objectValues "pod" dict -}}
+    {{- end -}}
+
+    {{- $defaultValue := get $rootContext.Values.defaultPodOptions $key -}}
+    {{- if not (hasKey $objectValues.pod $key) -}}
+      {{- $_ := set $objectValues.pod $key $defaultValue -}}
+    {{- end -}}
+  {{- end -}}
+
+  {{- /* Return the controller object */ -}}
+  {{- $objectValues | toYaml -}}
+{{- end -}}

charts/library/common/templates/lib/controller/_volumes.tpl

@@ -1,68 +0,0 @@
-{{/*
-Volumes included by the controller.
-*/}}
-{{- define "bjw-s.common.lib.controller.volumes" -}}
-{{- range $index, $persistence := .Values.persistence }}
-{{- if $persistence.enabled }}
-- name: {{ $index }}
-  {{- if eq (default "pvc" $persistence.type) "pvc" }}
-    {{- $pvcName := (include "bjw-s.common.lib.chart.names.fullname" $) -}}
-    {{- if $persistence.existingClaim }}
-      {{- /* Always prefer an existingClaim if that is set */}}
-      {{- $pvcName = $persistence.existingClaim -}}
-    {{- else -}}
-      {{- /* Otherwise refer to the PVC name */}}
-      {{- if $persistence.nameOverride -}}
-        {{- if not (eq $persistence.nameOverride "-") -}}
-          {{- $pvcName = (printf "%s-%s" (include "bjw-s.common.lib.chart.names.fullname" $) $persistence.nameOverride) -}}
-        {{- end -}}
-      {{- else -}}
-        {{- $pvcName = (printf "%s-%s" (include "bjw-s.common.lib.chart.names.fullname" $) $index) -}}
-      {{- end -}}
-    {{- end }}
-  persistentVolumeClaim:
-    claimName: {{ $pvcName }}
-  {{- else if or (eq $persistence.type "configMap") (eq $persistence.type "secret") }}
-    {{- $objectName := (required (printf "name not set for persistence item %s" $index) $persistence.name) }}
-    {{- $objectName = tpl $objectName $ }}
-    {{- if eq $persistence.type "configMap" }}
-  configMap:
-    name: {{ $objectName }}
-    {{- else }}
-  secret:
-    secretName: {{ $objectName }}
-    {{- end }}
-    {{- with $persistence.defaultMode }}
-    defaultMode: {{ . }}
-    {{- end }}
-    {{- with $persistence.items }}
-    items:
-      {{- toYaml . | nindent 6 }}
-    {{- end }}
-  {{- else if eq $persistence.type "emptyDir" }}
-    {{- $emptyDir := dict -}}
-    {{- with $persistence.medium -}}
-      {{- $_ := set $emptyDir "medium" . -}}
-    {{- end -}}
-    {{- with $persistence.sizeLimit -}}
-      {{- $_ := set $emptyDir "sizeLimit" . -}}
-    {{- end }}
-  emptyDir: {{- $emptyDir | toYaml | nindent 4 }}
-  {{- else if eq $persistence.type "hostPath" }}
-  hostPath:
-    path: {{ required "hostPath not set" $persistence.hostPath }}
-    {{- with $persistence.hostPathType }}
-    type: {{ . }}
-    {{- end }}
-  {{- else if eq $persistence.type "nfs" }}
-  nfs:
-    server: {{ required "server not set" $persistence.server }}
-    path: {{ required "path not set" $persistence.path }}
-  {{- else if eq $persistence.type "custom" }}
-    {{- toYaml $persistence.volumeSpec | nindent 2 }}
-  {{- else }}
-    {{- fail (printf "Not a valid persistence.type (%s)" $persistence.type) }}
-  {{- end }}
-{{- end }}
-{{- end }}
-{{- end }}