Merge pull request #49 from truenas/NAS-110066

Properly quote environment variables

library/common/2104.0.0/.helmignore

+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

library/common/2104.0.0/Chart.yaml

+apiVersion: v2
+name: common
+description: A library chart for iX Official Catalog
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: library
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 2104.0.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+appVersion: v1

library/common/2104.0.0/README.md

+# Library Chart for iX Official Catalog iX Chart
+
+**WARNING: THIS CHART IS NOT MEANT TO BE INSTALLED DIRECTLY**
+
+This is a [Helm Library Chart](https://helm.sh/docs/topics/library_charts/#helm). It's purpose is for grouping common logic between the k8s@home charts. 
+
+Since a lot of charts follow the same pattern this library was built to reduce maintenance cost between the charts that use it and try achieve a goal of being DRY.
+
+## Introduction
+
+This chart provides common template helpers which can be used to develop new charts using [Helm](https://helm.sh) package manager.

library/common/2104.0.0/templates/_serviceaccount.tpl

+{{/*
+Common service account
+*/}}
+{{- define "common.serviceaccount" -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "common.names.serviceAccountName" . | quote }}
+  namespace: {{ .Release.Namespace | quote }}
+  labels: {{- include "common.labels.selectorLabels" . | nindent 4 -}}
+{{- end -}}

library/common/2104.0.0/templates/classes/_service.tpl

+{{/*
+This template serves as a blueprint for all Service objects that are created
+within the common library.
+*/}}
+{{- define "common.classes.service" -}}
+{{- $values := .commonService -}}
+{{- $serviceName := include "common.names.fullname" . -}}
+{{- if hasKey $values "nameSuffix" -}}
+  {{- $serviceName = (printf "%v-%v" $serviceName $values.nameSuffix) -}}
+{{ end -}}
+{{- $svcType := $values.type | default "" -}}
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ $serviceName }}
+  labels:
+    {{- include "common.labels" . | nindent 4 }}
+  {{- if $values.labels }}
+    {{ toYaml $values.labels | nindent 4 }}
+  {{- end }}
+  {{- if $values.annotations }}
+    {{- with $values.annotations }}
+  annotations:
+    {{ toYaml . | nindent 4 }}
+    {{- end }}
+   {{- end }}
+spec:
+  {{- if (or (eq $svcType "ClusterIP") (empty $svcType)) }}
+  type: ClusterIP
+  {{- if $values.clusterIP }}
+  clusterIP: {{ $values.clusterIP }}
+  {{end}}
+  {{- else if eq $svcType "NodePort" }}
+  type: {{ $svcType }}
+  {{- else }}
+  {{- fail "Only ClusterIP and NodePort services are supported in common chart" }}
+  {{- end }}
+  {{- include "common.classes.service.ports" (dict "svcType" $svcType "values" $values ) | trim | nindent 2 }}
+  selector:
+    {{- include "common.labels.selectorLabels" . | nindent 4 }}
+{{- end }}

library/common/2104.0.0/templates/classes/_service_ports.tpl

+{{/*
+Render all the ports and additionalPorts for a Service object.
+*/}}
+{{- define "common.classes.service.ports" -}}
+  {{- $values := .values -}}
+  {{- $ports := $values.ports -}}
+  {{- if $ports -}}
+  ports:
+  {{- range $_ := $ports }}
+  - port: {{ .port }}
+    targetPort: {{ .targetPort | default "http" }}
+    protocol: {{ .protocol | default "TCP" }}
+    name: {{ .name | default "http" }}
+    {{- if (and (eq $.svcType "NodePort") (not (empty .nodePort))) }}
+    nodePort: {{ .nodePort }}
+    {{ end }}
+  {{- end -}}
+  {{- end -}}
+{{- end }}

library/common/2104.0.0/templates/lib/chart/_annotations.tpl

+{{/*
+Common workload annotations
+*/}}
+{{- define "common.annotations" -}}
+rollme: {{ randAlphaNum 5 | quote }}
+{{- end -}}

library/common/2104.0.0/templates/lib/chart/_capabilities.tpl

+{{/*
+Return the appropriate apiVersion for DaemonSet objects.
+*/}}
+{{- define "common.capabilities.daemonset.apiVersion" -}}
+{{- print "apps/v1" -}}
+{{- end -}}
+
+{{/*
+Return the appropriate apiVersion for Deployment objects.
+*/}}
+{{- define "common.capabilities.deployment.apiVersion" -}}
+{{- print "apps/v1" -}}
+{{- end -}}
+
+{{/*
+Return the appropriate apiVersion for StatefulSet objects.
+*/}}
+{{- define "common.capabilities.statefulset.apiVersion" -}}
+{{- print "apps/v1" -}}
+{{- end -}}
+
+{{/*
+Return the appropriate apiVersion for StatefulSet objects.
+*/}}
+{{- define "common.capabilities.cronjob.apiVersion" -}}
+{{- print "batch/v1beta1" -}}
+{{- end -}}

library/common/2104.0.0/templates/lib/chart/_labels.tpl

+{{/*
+Common labels shared across objects.
+*/}}
+{{- define "common.labels" -}}
+helm.sh/chart: {{ include "common.names.chart" . }}
+{{ include "common.labels.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels shared across objects.
+*/}}
+{{- define "common.labels.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "common.names.name" . }}
+app.kubernetes.io/instance: {{ include "common.names.releaseName" . }}
+{{ if hasKey .Values "extraSelectorLabels" }}
+{{ range $selector := .Values.extraSelectorLabels }}
+{{ printf "%s: %s" $selector.key $selector.value }}
+{{ end }}
+{{ end }}
+{{- end }}

library/common/2104.0.0/templates/lib/chart/_names.tpl

+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "common.names.name" -}}
+{{- $values := (.common | default dict) -}}
+{{- $name := (default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-") }}
+{{- if hasKey $values "nameSuffix" -}}
+  {{- $name = (printf "%v-%v" $name $values.nameSuffix) -}}
+{{ end -}}
+{{- print $name -}}
+{{- end }}
+
+{{/*
+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 "common.names.fullname" -}}
+{{- $values := (.common | default dict) -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- $name = (.Release.Name | trunc 63 | trimSuffix "-") }}
+{{- else }}
+{{- $name = (printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-") }}
+{{- end }}
+{{- if hasKey $values "nameSuffix" -}}
+  {{- $name = (printf "%v-%v" $name $values.nameSuffix) -}}
+{{ end -}}
+{{- print $name -}}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "common.names.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Determine service account name for deployment or statefulset.
+*/}}
+{{- define "common.names.serviceAccountName" -}}
+{{- if .Values.serviceAccountNameOverride }}
+{{- .Values.serviceAccountNameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-service-account" (include "common.names.releaseName" .) | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+
+
+{{/*
+Determine release name
+This will add a suffix to the release name if nameSuffix is set
+*/}}
+{{- define "common.names.releaseName" -}}
+{{- $values := (.common | default dict) -}}
+{{- if hasKey $values "nameSuffix" -}}
+  {{- printf "%v-%v" .Release.Name $values.nameSuffix -}}
+{{- else -}}
+  {{- print .Release.Name -}}
+{{ end -}}
+{{- end -}}

library/common/2104.0.0/templates/lib/containers/_environment.tpl

+{{/*
+Render environment variable
+*/}}
+{{- define "common.containers.environmentVariable" -}}
+{{- $envVariable := . -}}
+{{- include "common.schema.validateKeys" (dict "values" $envVariable "checkKeys" (list "name")) -}}
+{{- if $envVariable.valueFromSecret -}}
+{{- include "common.schema.validateKeys" (dict "values" $envVariable "checkKeys" (list "secretName" "secretKey")) -}}
+- name: {{ $envVariable.name | quote }}
+  valueFrom:
+    secretKeyRef:
+      name: {{ $envVariable.secretName | quote }}
+      key: {{ $envVariable.secretKey | quote }}
+{{- else -}}
+{{- include "common.schema.validateKeys" (dict "values" $envVariable "checkKeys" (list "value")) -}}
+- name: {{ $envVariable.name | quote }}
+  value: {{ $envVariable.value | quote }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Render environment variables
+*/}}
+{{- define "common.containers.environmentVariables" -}}
+{{- $values := . -}}
+{{- include "common.schema.validateKeys" (dict "values" $values "checkKeys" (list "environmentVariables")) -}}
+{{- range $envVariable := $values.environmentVariables -}}
+{{- include "common.containers.environmentVariable" $envVariable | nindent 0 -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Render environment variables if present
+*/}}
+{{- define "common.containers.allEnvironmentVariables" -}}
+{{- $values := . -}}
+{{- include "common.schema.validateKeys" (dict "values" $values "checkKeys" (list "environmentVariables")) -}}
+{{- if $values.environmentVariables -}}
+env: {{- include "common.containers.environmentVariables" $values | nindent 2 -}}
+{{- end -}}
+{{- end -}}

library/common/2104.0.0/templates/lib/containers/_image.tpl

+{{/*
+Retrieve image configuration for container
+*/}}
+{{- define "common.containers.imageConfig" -}}
+{{- $values := . -}}
+{{- include "common.schema.validateKeys" (dict "values" $values "checkKeys" (list "repository" "tag" "pullPolicy")) -}}
+image: "{{ $values.repository }}:{{ $values.tag }}"
+imagePullPolicy: {{ $values.pullPolicy }}
+{{- end -}}

library/common/2104.0.0/templates/lib/containers/_resource.tpl

+{{/*
+Retrieve GPU Configuration
+*/}}
+{{- define "common.containers.gpuConfiguration" -}}
+{{- $values := . -}}
+{{ if $values.gpuConfiguration }}
+resources:
+  limits: {{- toYaml $values.gpuConfiguration | nindent 4 }}
+{{ end }}
+{{- end -}}

library/common/2104.0.0/templates/lib/deployments/_utils.tpl

+{{/*
+Retrieve deployment metadata
+*/}}
+{{- define "common.deployment.metadata" -}}
+metadata:
+  name: {{ template "common.names.fullname" . }}
+  labels: {{ include "common.labels.selectorLabels" . | nindent 4 }}
+{{- end -}}
+
+
+{{/*
+Retrieve replicas/strategy/selector
+*/}}
+{{- define "common.deployment.common_spec" -}}
+replicas: {{ (default 1 .Values.replicas) }}
+strategy:
+  type: {{ (default "Recreate" .Values.updateStrategy ) }}
+selector:
+  matchLabels: {{ include "common.labels.selectorLabels" . | nindent 4 }}
+{{- end -}}
+
+
+{{/*
+Retrieve deployment pod's metadata
+*/}}
+{{- define "common.deployment.pod.metadata" -}}
+metadata:
+  name: {{ template "common.names.fullname" . }}
+  labels: {{ include "common.labels.selectorLabels" . | nindent 4 }}
+  annotations: {{ include "common.annotations" . | nindent 4 }}
+{{- end -}}
+
+
+{{/*
+Retrieve common deployment configuration
+*/}}
+{{- define "common.deployment.common_config" -}}
+apiVersion: {{ template "common.capabilities.deployment.apiVersion" . }}
+kind: Deployment
+{{ include "common.deployment.metadata" . | nindent 0 }}
+{{- end -}}

library/common/2104.0.0/templates/lib/networking/_dns.tpl

+{{/*
+DNS Configuration
+*/}}
+{{- define "common.networking.dnsConfiguration" }}
+dnsPolicy: {{ .Values.dnsPolicy }}
+{{- if .Values.dnsConfig }}
+dnsConfig:
+  {{- toYaml .Values.dnsConfig | nindent 2 }}
+{{- end }}
+{{- end }}

library/common/2104.0.0/templates/lib/resources/_certs.tpl

+{{/*
+Retrieve true/false if certificate is available in ixCertificates
+*/}}
+{{- define "common.resources.cert_present" -}}
+{{- $values := . -}}
+{{- include "common.schema.validateKeys" (dict "values" . "checkKeys" (list "commonCertOptions")) -}}
+{{- hasKey $values.Values.ixCertificates ($values.commonCertOptions.certKeyName | toString) -}}
+{{- end -}}
+
+
+{{/*
+Retrieve certificate from variable name
+*/}}
+{{- define "common.resources.cert" -}}
+{{- $values := . -}}
+{{- include "common.schema.validateKeys" (dict "values" . "checkKeys" (list "commonCertOptions")) -}}
+{{- $certKey := ($values.commonCertOptions.certKeyName | toString) -}}
+{{- if hasKey $values.Values.ixCertificates $certKey -}}
+{{- $cert := get $values.Values.ixCertificates $certKey -}}
+{{- if $values.commonCertOptions.publicKey -}}
+{{ $cert.certificate }}
+{{- else -}}
+{{ $cert.privatekey }}
+{{- end -}}
+{{- end -}}
+{{- end -}}

library/common/2104.0.0/templates/lib/schema/_utils.tpl

+{{/*
+Checks if a list of keys are present in a dictionary
+*/}}
+{{- define "common.schema.validateKeys" -}}
+{{- $values := . -}}
+{{- if and (hasKey $values "values") (hasKey $values "checkKeys") -}}
+{{- $missingKeys := list -}}
+{{- range $values.checkKeys -}}
+{{- if eq (hasKey $values.values . ) false -}}
+{{- $missingKeys = mustAppend $missingKeys . -}}
+{{- end -}}
+{{- end -}}
+{{- if $missingKeys -}}
+{{- fail (printf "Missing %s from dictionary" ($missingKeys | join ", ")) -}}
+{{- end -}}
+{{- else -}}
+{{- fail "A dictionary and list of keys to check must be provided" -}}
+{{- end -}}
+{{- end -}}

library/common/2104.0.0/templates/lib/storage/_appStorage.tpl

+{{/*
+Define appVolumeMounts for container
+*/}}
+{{- define "common.storage.configureAppVolumeMountsInContainer" -}}
+{{- include "common.schema.validateKeys" (dict "values" . "checkKeys" (list "appVolumeMounts")) -}}
+{{- $appVolumeMounts := .appVolumeMounts -}}
+{{- if $appVolumeMounts -}}
+{{ range $name, $avm := $appVolumeMounts }}
+{{- if (default true $avm.enabled) -}}
+{{ if $avm.containerNameOverride }}
+{{ $name = $avm.containerNameOverride }}
+{{ end }}
+- name: {{ $name }}
+  mountPath: {{ $avm.mountPath }}
+  {{ if $avm.subPath }}
+  subPath: {{ $avm.subPath }}
+  {{ end }}
+{{- end -}}
+{{ end }}
+{{- end -}}
+{{- end -}}
+
+
+{{/*
+Define hostPath for appVolumes
+*/}}
+{{- define "common.storage.configureAppVolumes" -}}
+{{- include "common.schema.validateKeys" (dict "values" . "checkKeys" (list "appVolumeMounts")) -}}
+{{- $values := . -}}
+{{- if $values.appVolumeMounts -}}
+{{- range $name, $av := $values.appVolumeMounts -}}
+{{ if (default true $av.enabled) }}
+- name: {{ $name }}
+  {{ if or $av.emptyDir $.emptyDirVolumes }}
+  emptyDir: {}
+  {{- else -}}
+  hostPath:
+    {{ if $av.hostPathEnabled }}
+    path: {{ required "hostPath not set" $av.hostPath }}
+    {{ else }}
+    {{- include "common.schema.validateKeys" (dict "values" $values "checkKeys" (list "ixVolumes")) -}}
+    {{- include "common.schema.validateKeys" (dict "values" $av "checkKeys" (list "datasetName")) -}}
+    {{- $volDict := dict "datasetName" $av.datasetName "ixVolumes" $values.ixVolumes -}}
+    path: {{ include "common.storage.retrieveHostPathFromiXVolume" $volDict }}
+    {{ end }}
+  {{ end }}
+{{ end }}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+
+{{/*
+Get all volumes configuration
+*/}}
+{{- define "common.storage.allAppVolumes" -}}
+{{- $appVolumeMounts := .appVolumeMounts -}}
+{{- if $appVolumeMounts -}}
+volumes: {{- include "common.storage.configureAppVolumes" . | nindent 2 -}}
+{{- end -}}
+{{- end -}}
+
+
+{{/*
+Get all container volume moutns configuration
+*/}}
+{{- define "common.storage.allContainerVolumeMounts" -}}
+{{- $appVolumeMounts := .appVolumeMounts -}}
+{{- if $appVolumeMounts -}}
+volumeMounts: {{- include "common.storage.configureAppVolumeMountsInContainer" . | nindent 2 -}}
+{{- end -}}
+{{- end -}}

library/common/2104.0.0/templates/lib/storage/_ixvolumes.tpl

+{{/*
+Retrieve host path from ix volumes based on dataset name
+*/}}
+{{- define "common.storage.retrieveHostPathFromiXVolume" -}}
+{{- range $index, $hostPathConfiguration := $.ixVolumes }}
+{{- $dsName := base $hostPathConfiguration.hostPath -}}
+{{- if eq $.datasetName $dsName -}}
+{{- $hostPathConfiguration.hostPath -}}
+{{- end -}}
+{{- end }}
+{{- end -}}

test/ipfs/1.0.2/Chart.yaml

@@ -14,5 +14,5 @@ sources:
 upstream_version: 0.8.0-rc1
 dependencies:
   - name: common
-    repository: file://../../../library/common/2101.0.0
-    version: 2101.0.0
+    repository: file://../../../library/common/2104.0.0
+    version: 2104.0.0

test/ipfs/1.0.2/requirements.lock

 dependencies:
 - name: common
-  repository: file://../../../library/common/2101.0.0
-  version: 2101.0.0
-digest: sha256:6ab46f958de11ae6a24d8f7e18417aa9852a8d968d5b0cc94ffa4700449931d6
-generated: "2021-02-04T01:15:55.312886+05:00"
+  repository: file://../../../library/common/2104.0.0
+  version: 2104.0.0
+digest: sha256:f0aa221073aafcc5e1602c2a9acb1a508ce72f6847c33dd4a9f9fe10017d5009
+generated: "2021-04-08T16:09:30.006044+05:00"

test/ix-chart/2102.1.0/Chart.lock

 dependencies:
 - name: common
-  repository: file://../../../library/common/2101.0.0
-  version: 2101.0.0
-digest: sha256:6ab46f958de11ae6a24d8f7e18417aa9852a8d968d5b0cc94ffa4700449931d6
-generated: "2021-02-04T01:15:55.365517+05:00"
+  repository: file://../../../library/common/2104.0.0
+  version: 2104.0.0
+digest: sha256:f0aa221073aafcc5e1602c2a9acb1a508ce72f6847c33dd4a9f9fe10017d5009
+generated: "2021-04-08T16:09:30.065733+05:00"

test/ix-chart/2102.1.0/Chart.yaml

@@ -23,6 +23,6 @@ version: 2102.1.0
 appVersion: v1
 dependencies:
   - name: common
-    repository: file://../../../library/common/2101.0.0
-    version: 2101.0.0
+    repository: file://../../../library/common/2104.0.0
+    version: 2104.0.0
 

test/minio/1.2.1/Chart.yaml

@@ -15,5 +15,5 @@ sources:
 upstream_version: 8.0.5
 dependencies:
   - name: common
-    repository: file://../../../library/common/2101.0.0
-    version: 2101.0.0
+    repository: file://../../../library/common/2104.0.0
+    version: 2104.0.0

test/minio/1.2.1/requirements.lock

 dependencies:
 - name: common
-  repository: file://../../../library/common/2101.0.0
-  version: 2101.0.0
-digest: sha256:6ab46f958de11ae6a24d8f7e18417aa9852a8d968d5b0cc94ffa4700449931d6
-generated: "2021-02-04T01:15:55.416388+05:00"
+  repository: file://../../../library/common/2104.0.0
+  version: 2104.0.0
+digest: sha256:f0aa221073aafcc5e1602c2a9acb1a508ce72f6847c33dd4a9f9fe10017d5009
+generated: "2021-04-08T16:09:30.123288+05:00"

test/nextcloud/1.2.1/Chart.lock

 dependencies:
 - name: common
-  repository: file://../../../library/common/2101.0.0
-  version: 2101.0.0
-digest: sha256:6ab46f958de11ae6a24d8f7e18417aa9852a8d968d5b0cc94ffa4700449931d6
-generated: "2021-02-04T01:15:55.262077+05:00"
+  repository: file://../../../library/common/2104.0.0
+  version: 2104.0.0
+digest: sha256:f0aa221073aafcc5e1602c2a9acb1a508ce72f6847c33dd4a9f9fe10017d5009
+generated: "2021-04-08T16:09:29.942145+05:00"

test/nextcloud/1.2.1/Chart.yaml

@@ -17,6 +17,6 @@ sources:
 upstream_version: 2.3.2
 dependencies:
   - name: common
-    repository: file://../../../library/common/2101.0.0
-    version: 2101.0.0
+    repository: file://../../../library/common/2104.0.0
+    version: 2104.0.0
 

test/plex/1.3.0/Chart.lock

 dependencies:
 - name: common
-  repository: file://../../../library/common/2101.0.0
-  version: 2101.0.0
-digest: sha256:6ab46f958de11ae6a24d8f7e18417aa9852a8d968d5b0cc94ffa4700449931d6
-generated: "2021-02-04T01:15:55.470042+05:00"
+  repository: file://../../../library/common/2104.0.0
+  version: 2104.0.0
+digest: sha256:f0aa221073aafcc5e1602c2a9acb1a508ce72f6847c33dd4a9f9fe10017d5009
+generated: "2021-04-08T16:09:30.181685+05:00"

test/plex/1.3.0/Chart.yaml

@@ -13,6 +13,6 @@ sources:
 upstream_version: 2.1.0
 dependencies:
   - name: common
-    repository: file://../../../library/common/2101.0.0
-    version: 2101.0.0
+    repository: file://../../../library/common/2104.0.0
+    version: 2104.0.0