diff --git a/charts/util/Chart.yaml b/charts/util/Chart.yaml index 731dafa..2bb0f35 100644 --- a/charts/util/Chart.yaml +++ b/charts/util/Chart.yaml @@ -2,5 +2,5 @@ apiVersion: v2 name: util description: Library chart providing helper functions for FNNDSC Helm charts type: library -version: 0.1.0 +version: 0.2.0 diff --git a/charts/util/templates/_deployment.tpl b/charts/util/templates/_deployment.tpl new file mode 100644 index 0000000..ff355f5 --- /dev/null +++ b/charts/util/templates/_deployment.tpl @@ -0,0 +1,38 @@ +{{- define "util.deploymentTpl" }} +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "util.fullname" . }} + namespace: {{ .Release.Namespace }} + labels: + {{- include "util.labels" . | nindent 4 }} + {{- with .Values.labels }} + {{- toYaml . | nindent 4 }} + {{- end }} + {{- with .Values.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "util.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "util.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + containers: + {{- include "util.container" (mustMerge (dict "containerName" (include "util.name" .) "portName" "http") .) | nindent 8 }} + {{- include "util.podSpec" . | nindent 6 }} +{{- end }} diff --git a/charts/util/templates/_helpers.tpl b/charts/util/templates/_helpers.tpl index c104740..e6ecfb2 100644 --- a/charts/util/templates/_helpers.tpl +++ b/charts/util/templates/_helpers.tpl @@ -1,25 +1,139 @@ -{{- /* -Helper function to use a value. If the value is unset, try looking up the previous value -from a secret. If the secret does not exist, generate a random value with a specified length. -*/ -}} -{{- define "util.valueOrLookupOrRandom" -}} -{{- if .value -}} - {{- .value | b64enc | quote -}} -{{- else -}} - {{- $length := .length | default 32 -}} - {{- $name := .name -}} - {{- if (not $name) -}} - {{- fail (printf "util.valueOrLookupOrRandom was not called with required parameter 'name'. Given parameters: %s" (keys .)) -}} - {{- end -}} - {{- with (lookup "v1" "Secret" .root.Release.Namespace .secret) -}} - {{- if (hasKey .data $name) -}} - {{- (index .data $name) | quote -}} - {{- else -}} - {{- randAlphaNum $length | b64enc | quote -}} - {{- end -}} - {{- else -}} - {{- randAlphaNum $length | b64enc | quote -}} - {{- end -}} +{{/* +Expand the name of the chart. +*/}} +{{- define "util.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- 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 "util.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "util.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "util.labels" -}} +helm.sh/chart: {{ include "util.chart" . }} +{{ include "util.selectorLabels" . }} +{{- with (default .Chart.AppVersion .appVersion) }} +app.kubernetes.io/version: {{ quote . }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "util.selectorLabels" -}} +app.kubernetes.io/name: {{ include "util.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + + +{{/* +Create the name of the service account to use +*/}} +{{- define "util.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "util.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{- define "util.image" -}} +{{ if .Values.image.registry }}{{ .Values.image.registry }}/{{ end }}{{ .Values.image.repository }}:{{ .Values.image.tag | default .appVersion | default .Chart.AppVersion }} {{- end -}} + +{{- define "util.podSpec" -}} +{{- with (concat (.Values.imagePullSecrets | default (list)) ((.Values.global).imagePullSecrets | default (list)) | mustUniq) }} +imagePullSecrets: +{{- toYaml . | nindent 8 }} +{{- end }} +{{- if (or .Values.serviceAccount.name .Values.serviceAccount.create) }} +serviceAccountName: {{ include "util.util.serviceAccountName" . }} +{{- end }} +{{- with (.Values.podSecurityContext | deepCopy | mustMergeOverwrite (deepCopy ((.Values.global).podSecurityContext | default (dict)))) }} +securityContext: +{{- toYaml . | nindent 8 }} +{{- end }} +{{- with .Values.nodeSelector }} +nodeSelector: +{{- toYaml . | nindent 8 }} +{{- end }} +{{- with .Values.affinity }} +affinity: +{{- toYaml . | nindent 8 }} +{{- end }} +{{- with .Values.tolerations }} +tolerations: +{{- toYaml . | nindent 8 }} +{{- end }} {{- end -}} +{{- define "util.container" -}} +- image: {{ include "util.image" . }} + {{- if .containerName }} + name: {{ .containerName }} + {{- end }} + {{- if .Values.image.pullPolicy }} + imagePullPolicy: {{ .Values.image.pullPolicy }} + {{- end }} + ports: + - containerPort: {{ .Values.containerPort | default .Values.service.port }} + {{- if .Values.hostPort }} + hostPort: {{ .Values.hostPort }} + {{- end }} + protocol: TCP + {{- if .portName }} + name: {{ .portName }} + {{- end }} + {{- if .Values.extraEnv }} + env: + {{- range $k, $v := .Values.extraEnv }} + - name: {{ $k }} + value: {{ $v | quote }} + {{- end }} + {{- end }} + {{- with .Values.securityContext }} + securityContext: + {{- toYaml . | nindent 4 }} + {{- end }} + {{- with .Values.resources }} + resources: + {{- toYaml . | nindent 4 }} + {{- end }} + {{- with .Values.livenessProbe }} + livenessProbe: + {{- toYaml . | nindent 4 }} + {{- end }} + {{- with .Values.readinessProbe }} + readinessProbe: + {{- toYaml . | nindent 4 }} + {{- end }} + {{- with .Values.startupProbe }} + startupProbe: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end -}} diff --git a/charts/util/templates/_hpa.tpl b/charts/util/templates/_hpa.tpl new file mode 100644 index 0000000..6742ec8 --- /dev/null +++ b/charts/util/templates/_hpa.tpl @@ -0,0 +1,35 @@ +{{- define "util.hpaTpl" }} +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "util.fullname" . }} + namespace: {{ .Release.Namespace }} + labels: + {{- include "util.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "util.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + target: + type: Utilization + averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} +{{- end }} diff --git a/charts/util/templates/_ingress.tpl b/charts/util/templates/_ingress.tpl new file mode 100644 index 0000000..a71dd6f --- /dev/null +++ b/charts/util/templates/_ingress.tpl @@ -0,0 +1,46 @@ +{{- define "util.ingressTpl" }} +{{- if .Values.ingress.enabled -}} +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: {{ include "util.fullname" . }} + namespace: {{ .Release.Namespace }} + labels: + {{- include "util.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- with .Values.ingress.className }} + ingressClassName: {{ . }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- with .pathType }} + pathType: {{ . }} + {{- end }} + backend: + service: + name: {{ include "util.fullname" $ }} + port: + number: {{ $.Values.service.port }} + {{- end }} + {{- end }} +{{- end }} +{{- end }} diff --git a/charts/util/templates/_knative.tpl b/charts/util/templates/_knative.tpl new file mode 100644 index 0000000..b97f315 --- /dev/null +++ b/charts/util/templates/_knative.tpl @@ -0,0 +1,34 @@ +{{- define "util.knativeServiceTpl" }} +apiVersion: serving.knative.dev/v1 +kind: Service +metadata: + name: {{ include "util.fullname" . }} + namespace: {{ .Release.Namespace }} + labels: + {{- include "util.labels" . | nindent 4 }} + {{- with .Values.labels }} + {{- toYaml . | nindent 4 }} + {{- end }} + {{- with .Values.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + template: + metadata: + {{- with .Values.revisionAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.podLabels }} + labels: + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- if .Values.containerConcurrency }} + containerConcurrency: {{ .Values.containerConcurrency }} + {{- end }} + containers: + {{- include "util.container" . | nindent 8 }} + {{- mustMerge (omit . "Values") (dict "Values" (omit .Values "startupProbe")) | include "util.podSpec" | nindent 6 }} +{{- end }} diff --git a/charts/util/templates/_knative_or_deployment.tpl b/charts/util/templates/_knative_or_deployment.tpl new file mode 100644 index 0000000..bcf9f86 --- /dev/null +++ b/charts/util/templates/_knative_or_deployment.tpl @@ -0,0 +1,24 @@ +{{- define "util.knativeOrDeployment" -}} +{{- include "util.serviceAccountTpl" . }} +{{- if (eq .Values.kind "Service") }} +{{- include "util.knativeServiceTpl" . }} +{{- else if (eq .Values.kind "Deployment") }} +{{- include "util.deploymentEverythingTpl" . }} +{{- else }} +{{- fail (printf "Unsupported kind: %s" .kind) }} +{{- end -}} +{{- end -}} + +{{- define "util.deploymentEverythingTpl" }} +{{- include "util.deploymentTpl" . }} +--- +{{- include "util.hpaTpl" . }} +--- +{{- include "util.ingressTpl" . }} +--- +{{- include "util.serviceTpl" . }} +--- +{{- include "util.testServiceConnectionTpl" . }} +--- +{{- include "util.openshiftRouteTpl" . }} +{{- end }} diff --git a/charts/util/templates/_route.tpl b/charts/util/templates/_route.tpl new file mode 100644 index 0000000..e5e3e21 --- /dev/null +++ b/charts/util/templates/_route.tpl @@ -0,0 +1,25 @@ +{{- define "util.openshiftRouteTpl" }} +{{- if .Values.route.enabled -}} +kind: Route +apiVersion: route.openshift.io/v1 +metadata: + name: {{ include "util.fullname" . }} + labels: + {{- include "util.labels" . | nindent 4 }} + {{- with .Values.route.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + to: + kind: Service + name: {{ include "util.fullname" . }} + {{- with .Values.route.tls }} + tls: + {{- toYaml . | nindent 4 }} + {{- end }} + port: + targetPort: http + host: {{ required ".Values.route.host is required." .Values.route.host }} +{{- end }} +{{- end }} diff --git a/charts/util/templates/_service.tpl b/charts/util/templates/_service.tpl new file mode 100644 index 0000000..eeb77e0 --- /dev/null +++ b/charts/util/templates/_service.tpl @@ -0,0 +1,24 @@ +{{- define "util.serviceTpl" }} +apiVersion: v1 +kind: Service +metadata: + name: {{ include "util.fullname" . }} + labels: + {{- include "util.labels" . | nindent 4 }} + {{- with .Values.service.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + {{- if .Values.service.nodePort }} + nodePort: {{ .Values.service.nodePort }} + {{- end }} + selector: + {{- include "util.selectorLabels" . | nindent 4 }} +{{- end }} diff --git a/charts/util/templates/_serviceaccount.tpl b/charts/util/templates/_serviceaccount.tpl new file mode 100644 index 0000000..4813e54 --- /dev/null +++ b/charts/util/templates/_serviceaccount.tpl @@ -0,0 +1,18 @@ +{{- define "util.serviceAccountTpl" }} +{{- if .Values.serviceAccount.create }} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "util.serviceAccountName" . }} + namespace: {{ .Release.Namespace }} + {{- with .labels }} + labels: + {{- .Value.serviceAccount.labels | deepCopy | default (dict) | mustMergeOverwrite (include "util.labels" . | fromYaml) | toYaml | nindent 4 }} + {{- end }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +automountServiceAccountToken: {{ .Values.serviceAccount.automount }} +{{- end }} +{{- end }} diff --git a/charts/util/templates/_test_connection.tpl b/charts/util/templates/_test_connection.tpl new file mode 100644 index 0000000..7aa9bd8 --- /dev/null +++ b/charts/util/templates/_test_connection.tpl @@ -0,0 +1,19 @@ +{{- define "util.testServiceConnectionTpl" }} +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "util.fullname" . }}-test-connection" + labels: + {{- include "util.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: quay.io/prometheus/busybox:latest + command: ['wget'] + args: + - --spider + - http://{{ include "util.fullname" . }}:{{ .Values.service.port }}{{ (.Values.test).path }} + restartPolicy: Never +{{- end }} diff --git a/charts/util/templates/_valueOrLookupOrRandom.tpl b/charts/util/templates/_valueOrLookupOrRandom.tpl new file mode 100644 index 0000000..19f7ea0 --- /dev/null +++ b/charts/util/templates/_valueOrLookupOrRandom.tpl @@ -0,0 +1,25 @@ +{{- /* +Helper function to use a value. If the value is unset, try looking up the previous value +from a secret. If the secret does not exist, generate a random value with a specified length. +*/ -}} +{{- define "util.valueOrLookupOrRandom" -}} +{{- if .value -}} + {{- .value | b64enc | quote -}} +{{- else -}} + {{- $length := .length | default 32 -}} + {{- $name := .name -}} + {{- if (not $name) -}} + {{- fail (printf "util.valueOrLookupOrRandom was not called with required parameter 'name'. Given parameters: %s" (keys .)) -}} + {{- end -}} + {{- with (lookup "v1" "Secret" .root.Release.Namespace .secret) -}} + {{- if (and .data (hasKey .data $name)) -}} + {{- (index .data $name) | quote -}} + {{- else -}} + {{- randAlphaNum $length | b64enc | quote -}} + {{- end -}} + {{- else -}} + {{- randAlphaNum $length | b64enc | quote -}} + {{- end -}} +{{- end -}} +{{- end -}} +