feat(common): add support for pod affinity and set default affinity

charts/library/common-test/Chart.yaml

@@ -7,7 +7,7 @@ apiVersion: v2
 appVersion: unknown
 dependencies:
   - name: common
-    version: ~26.0.0
+    version: ~26.1.0
     repository: file://../common/
     condition: ""
     alias: ""

charts/library/common/Chart.yaml

@@ -48,4 +48,4 @@ sources:
   - https://hub.docker.com/_/
   - https://hub.docker.com/r/mikefarah/yq
 type: library
-version: 26.0.1
+version: 26.1.0

charts/library/common/templates/lib/metadata/_podLabels.tpl

@@ -23,4 +23,5 @@
     {{- fail "PodLabels - Template used in a place that is not designed to be used" -}}
   {{- end }}
 pod.lifecycle: {{ $label }}
+{{include "tc.v1.common.lib.metadata.volumeLabels" (dict "rootCtx" $rootCtx "objectData" $objectData)}}
 {{- end -}}

charts/library/common/templates/lib/metadata/_volumeLabels.tpl

@@ -0,0 +1,66 @@
+{{/* Labels that are added to podSpec */}}
+{{/* Call this template:
+{{ include "tc.v1.common.lib.metadata.volumeLabels" $ }}
+*/}}
+{{- define "tc.v1.common.lib.metadata.volumeLabels" -}}
+
+  {{- $rootCtx := .rootCtx -}}
+  {{- $objectData := .objectData -}}
+  {{- $pvcNames := "" -}}
+
+  {{- range $name, $persistenceValues := $rootCtx.Values.persistence -}}
+    {{- $enabled := (include "tc.v1.common.lib.util.enabled" (dict
+                  "rootCtx" $rootCtx "objectData" $persistenceValues
+                  "name" $name "caller" "Volumes"
+                  "key" "persistence")) -}}
+    {{- if (eq $enabled "true") -}}
+      {{- $persistence := (mustDeepCopy $persistenceValues) -}}
+      {{- $_ := set $persistence "shortName" $name -}}
+
+      {{- $selected := false -}}
+
+      {{/* If set to true, define volume */}}
+      {{- if $persistence.targetSelectAll -}}
+        {{- $selected = true -}}
+
+      {{/* If the pod is the autopermission */}}
+      {{- else if eq $objectData.shortName "autopermissions" -}}
+        {{- if $persistence.autoPermissions -}}
+          {{- if $persistence.autoPermissions.enabled -}}
+            {{- $selected = true -}}
+          {{- end -}}
+        {{- end -}}
+
+      {{/* If targetSelector is set, check if pod is selected */}}
+      {{- else if $persistence.targetSelector -}}
+        {{- if not (kindIs "map" $persistence.targetSelector) -}}
+          {{- fail (printf "Persistence - Expected [targetSelector] to be [dict], but got [%s]" (kindOf $persistence.targetSelector)) -}}
+        {{- end -}}
+
+        {{- if (mustHas $objectData.shortName (keys $persistence.targetSelector)) -}}
+          {{- $selected = true -}}
+        {{- end -}}
+
+      {{/* If no targetSelector is set or targetSelectAll, check if pod is primary */}}
+      {{- else if $objectData.primary -}}
+        {{- $selected = true -}}
+      {{- end -}}
+
+      {{/* If pod selected */}}
+      {{- if $selected -}}
+        {{/* Define the volume based on type */}}
+        {{- $type := ($persistence.type | default $rootCtx.Values.global.fallbackDefaults.persistenceType) -}}
+
+        {{- if eq "pvc" $type }}
+           {{- if $pvcNames -}}
+             {{ $pvcNames = ( printf "%s+%s" $pvcNames $name ) }}
+           {{- else -}}
+             {{ $pvcNames = $name }}
+           {{- end -}}
+        {{ end -}}
+      {{- end -}}
+
+    {{- end -}}
+  {{- end -}}
+"truecharts.org/pvc": {{ $pvcNames }}
+{{- end -}}

charts/library/common/templates/lib/pod/_affinity.tpl

@@ -0,0 +1,42 @@
+{{/* Returns pod affinity  */}}
+{{/* Call this template:
+{{ include "tc.v1.common.lib.pod.affinity" (dict "rootCtx" $ "objectData" $objectData) }}
+rootCtx: The root context of the chart.
+objectData: The object data to be used to render the Pod.
+*/}}
+{{- define "tc.v1.common.lib.pod.affinity" -}}
+  {{- $rootCtx := .rootCtx -}}
+  {{- $objectData := .objectData -}}
+
+  {{- $affinity := list -}}
+
+  {{/* Initialize from the "global" option */}}
+  {{- with $rootCtx.Values.podOptions.affinity -}}
+    {{- $affinity = . -}}
+  {{- end -}}
+
+  {{/* Override with pods option */}}
+  {{- with $objectData.podSpec.affinity -}}
+    {{- $affinity = . -}}
+  {{- end -}}
+
+  {{- $validTypes := (list "Deployment" "StatefulSet") -}}
+   {{/* TODO: We need to merge default with user input */}}
+  {{- $pvcLabels := (include "tc.v1.common.lib.metadata.volumeLabels" (dict "rootCtx" $rootCtx "objectData" $objectData)) -}}
+  {{- if and (mustHas $objectData.type $validTypes) $pvcLabels $rootCtx.Values.podOptions.defaultAffinity }}
+  podAffinity:
+    requiredDuringSchedulingIgnoredDuringExecution:
+      - labelSelector:
+          matchExpressions:
+            - key: app
+              operator: In
+              values:
+                - {{ $pvcLabels }}
+        topologyKey: "kubernetes.io/hostname"
+  {{- else -}}
+  {{- with $affinity -}} {{/* TODO: Template this, so we can add some validation around easy to make mistakes. Low Prio */}}
+    {{- . | toYaml | nindent 0 }}
+  {{- end -}}
+  {{- end -}}
+
+{{- end -}}

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

@@ -30,6 +30,10 @@ priorityClassName: {{ . }}
 nodeSelector:
     {{- . | nindent 2 }}
   {{- end -}}
+  {{- with (include "tc.v1.common.lib.pod.affinity" (dict "rootCtx" $rootCtx "objectData" $objectData) | trim) }}
+affinity:
+    {{- . | nindent 2 }}
+  {{- end -}}
   {{- with (include "tc.v1.common.lib.pod.topologySpreadConstraints" (dict "rootCtx" $rootCtx "objectData" $objectData) | trim) }}
 topologySpreadConstraints:
     {{- . | nindent 2 }}

charts/library/common/values.yaml

@@ -150,6 +150,7 @@ podOptions:
     kubernetes.io/arch: "amd64"
   # -- Used to enforce a good spread for Deployments and StatefulSets by default
   defaultSpread: true
+  defaultAffinity: true
   topologySpreadConstraints: []
   tolerations: []
   schedulerName: ""