feat(common): Release 2.0.0-beta.2 (#176)

charts/library/common/Chart.yaml

@@ -3,7 +3,7 @@ apiVersion: v2
 name: common
 description: Function library for Helm charts
 type: library
-version: 2.0.0-beta.1
+version: 2.0.0-beta.2
 kubeVersion: ">=1.22.0-0"
 keywords:
   - common
@@ -17,3 +17,10 @@ annotations:
   artifacthub.io/changes: |-
     - kind: changed
       description: Many things :P
+    - kind: removed
+      description: |-
+        **BREAKING CHANGE** Removed support for add-ons. These can be configured through other means nowadays.
+    - kind: added
+      description: Added support for ordering (init)Containers within a controller.
+    - kind: added
+      description: Added support for creating Network Policies.

charts/library/common/README.md

@@ -1,6 +1,6 @@
 # common
 
-![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
+![Version: 2.0.0-beta.2](https://img.shields.io/badge/Version-2.0.0--beta.2-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
 
 Function library for Helm charts
 
@@ -29,7 +29,7 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
 # Chart.yaml
 dependencies:
 - name: common
-  version: 2.0.0
+  version: 2.0.0-beta.2
   repository: https://bjw-s.github.io/helm-charts/
 ```
 
@@ -64,6 +64,7 @@ N/A
 | controllers.main.containers.main.image.tag | string | `nil` | image tag |
 | controllers.main.containers.main.lifecycle | object | `{}` | Configure the lifecycle for the container |
 | controllers.main.containers.main.nameOverride | string | `nil` | Override the container name |
+| controllers.main.containers.main.order | int | 99 | Override the default container order Containers get sorted alphanumerically by the `<order>-<identifier>` combination. |
 | controllers.main.containers.main.probes | object | See below | [[ref]](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) |
 | controllers.main.containers.main.probes.liveness | object | See below | Liveness probe configuration |
 | controllers.main.containers.main.probes.liveness.custom | bool | `false` | Set this to `true` if you wish to specify your own livenessProbe |
@@ -93,7 +94,7 @@ N/A
 | controllers.main.cronjob.successfulJobsHistory | int | `1` | The number of succesful Jobs to keep |
 | controllers.main.cronjob.ttlSecondsAfterFinished | string | `nil` | If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. |
 | controllers.main.enabled | bool | `true` | enable the controller. |
-| controllers.main.initContainers | object | `{}` | Specify any initContainers here as dictionary items. Each initContainer should have its own key. The dictionary item key will determine the order. Helm templates can be used. |
+| controllers.main.initContainers | object | `{}` | Specify any initContainers here as dictionary items. Each initContainer should have its own key initContainers get sorted alphanumerically by the `<order>-<identifier>` combination. |
 | controllers.main.labels | object | `{}` | Set labels on the deployment/statefulset/daemonset/cronjob |
 | controllers.main.replicas | int | `1` | Number of desired pods. When using a HorizontalPodAutoscaler, set this to `null`. |
 | controllers.main.revisionHistoryLimit | int | `3` | ReplicaSet revision history limit |

charts/library/common/templates/classes/_networkpolicy.tpl

@@ -0,0 +1,49 @@
+{{/*
+This template serves as a blueprint for all networkPolicy objects that are created
+within the common library.
+*/}}
+{{- define "bjw-s.common.class.networkpolicy" -}}
+  {{- $rootContext := .rootContext -}}
+  {{- $networkPolicyObject := .object -}}
+
+  {{- $labels := merge
+    ($networkPolicyObject.labels | default dict)
+    (include "bjw-s.common.lib.metadata.allLabels" $rootContext | fromYaml)
+  -}}
+  {{- $annotations := merge
+    ($networkPolicyObject.annotations | default dict)
+    (include "bjw-s.common.lib.metadata.globalAnnotations" $rootContext | fromYaml)
+  -}}
+  {{- $podSelector := dict -}}
+  {{- if (hasKey $networkPolicyObject "podSelector") -}}
+    {{- $podSelector = $networkPolicyObject.podSelector -}}
+  {{- else -}}
+    {{- $podSelector = dict "matchLabels" (merge
+      ($networkPolicyObject.extraSelectorLabels | default dict)
+      (dict "app.kubernetes.io/component" $networkPolicyObject.controller)
+      (include "bjw-s.common.lib.metadata.selectorLabels" $rootContext | fromYaml)
+    ) -}}
+  {{- end -}}
+---
+apiVersion: networking.k8s.io/v1
+kind: NetworkPolicy
+metadata:
+  name: {{ $networkPolicyObject.name }}
+  {{- with $labels }}
+  labels: {{- toYaml . | nindent 4 -}}
+  {{- end }}
+  {{- with $annotations }}
+  annotations: {{- toYaml . | nindent 4 -}}
+  {{- end }}
+spec:
+  podSelector: {{- toYaml $podSelector | nindent 4 }}
+  {{- with $networkPolicyObject.policyTypes }}
+  policyTypes: {{- toYaml . | nindent 4 -}}
+  {{- end }}
+  {{- with $networkPolicyObject.rules.ingress }}
+  ingress: {{- tpl (toYaml .) $rootContext | nindent 4 -}}
+  {{- end }}
+  {{- with $networkPolicyObject.rules.egress }}
+  egress: {{- tpl (toYaml .) $rootContext | nindent 4 -}}
+  {{- end }}
+{{- end -}}

charts/library/common/templates/lib/container/_volumemounts_old.tpl

@@ -1,58 +0,0 @@
-  {{- /* TODO: Remove this file */ -}}
-
-{{/* Volumes included by the controller */}}
-{{- define "bjw-s.common.lib.container.volumeMounts" -}}
-  {{- range $persistenceIndex, $persistenceItem := .Values.persistence }}
-    {{- if $persistenceItem.enabled -}}
-      {{- if kindIs "slice" $persistenceItem.subPath -}}
-        {{- if $persistenceItem.mountPath -}}
-          {{- fail (printf "Cannot use persistence.mountPath with a subPath list (%s)" $persistenceIndex) }}
-        {{- end -}}
-        {{- range $subPathIndex, $subPathItem := $persistenceItem.subPath }}
-- name: {{ $persistenceIndex }}
-  subPath: {{ required "subPaths as a list of maps require a path field" $subPathItem.path }}
-  mountPath: {{ required "subPaths as a list of maps require an explicit mountPath field" $subPathItem.mountPath }}
-          {{- with $subPathItem.readOnly }}
-  readOnly: {{ . }}
-          {{- end }}
-          {{- with $subPathItem.mountPropagation }}
-  mountPropagation: {{ . }}
-          {{- end }}
-        {{- end -}}
-      {{- else -}}
-        {{/* Set the default mountPath to /<name_of_the_peristence_item> */}}
-        {{- $mountPath := (printf "/%v" $persistenceIndex) -}}
-        {{- if eq "hostPath" (default "pvc" $persistenceItem.type) -}}
-          {{- $mountPath = $persistenceItem.hostPath -}}
-        {{- end -}}
-        {{/* Use the specified mountPath if provided */}}
-        {{- with $persistenceItem.mountPath -}}
-          {{- $mountPath = . -}}
-        {{- end }}
-        {{- if ne $mountPath "-" }}
-- name: {{ $persistenceIndex }}
-  mountPath: {{ $mountPath }}
-          {{- with $persistenceItem.subPath }}
-  subPath: {{ . }}
-          {{- end }}
-          {{- with $persistenceItem.readOnly }}
-  readOnly: {{ . }}
-          {{- end }}
-          {{- with $persistenceItem.mountPropagation }}
-  mountPropagation: {{ . }}
-          {{- end }}
-        {{- end }}
-      {{- end -}}
-    {{- end -}}
-  {{- end }}
-
-  {{- if eq .Values.controller.type "statefulset" }}
-    {{- range $index, $vct := .Values.volumeClaimTemplates }}
-- mountPath: {{ $vct.mountPath }}
-  name: {{ $vct.name }}
-      {{- if $vct.subPath }}
-  subPath: {{ $vct.subPath }}
-      {{- end }}
-    {{- end }}
-  {{- end }}
-{{- end -}}

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

@@ -15,7 +15,7 @@ Return the enabled containers for a controller.
       {{- end -}}
 
       {{- if $containerEnabled -}}
-        {{- $_ := set $enabledContainers $name . -}}
+        {{- $_ := set $enabledContainers $name $container -}}
       {{- end -}}
     {{- end -}}
   {{- end -}}

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

@@ -0,0 +1,22 @@
+{{/*
+Validate networkPolicy values
+*/}}
+{{- define "bjw-s.common.lib.networkpolicy.validate" -}}
+  {{- $rootContext := .rootContext -}}
+  {{- $networkpolicyObject := .object -}}
+
+  {{- if and (not (hasKey $networkpolicyObject "podSelector")) (empty (get $networkpolicyObject "controller")) -}}
+    {{- fail (printf "controller reference or podSelector is required for NetworkPolicy. (NetworkPolicy %s)" $networkpolicyObject.identifier) -}}
+  {{- end -}}
+
+  {{- if empty (get $networkpolicyObject "policyTypes") -}}
+    {{- fail (printf "policyTypes is required for NetworkPolicy. (NetworkPolicy %s)" $networkpolicyObject.identifier) -}}
+  {{- end -}}
+
+  {{- $allowedpolicyTypes := list "Ingress" "Egress" -}}
+  {{- range $networkpolicyObject.policyTypes -}}
+    {{- if not (has . $allowedpolicyTypes) -}}
+      {{- fail (printf "Not a valid policyType for NetworkPolicy. (NetworkPolicy %s, value %s)" $networkpolicyObject.identifier .) -}}
+    {{- end -}}
+  {{- end -}}
+{{- end -}}

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

@@ -0,0 +1,24 @@
+{{/*
+Convert networkPolicy values to an object
+*/}}
+{{- define "bjw-s.common.lib.networkpolicy.valuesToObject" -}}
+  {{- $rootContext := .rootContext -}}
+  {{- $identifier := .id -}}
+  {{- $objectValues := .values -}}
+
+  {{- /* Determine and inject the networkPolicy 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 -}}
+
+  {{- /* Return the networkPolicy object */ -}}
+  {{- $objectValues | toYaml -}}
+{{- end -}}

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

@@ -19,7 +19,7 @@ runtimeClassName: {{ . | trim }}
 schedulerName: {{ . | trim }}
   {{- end -}}
   {{- with ($controllerObject.pod.securityContext) }}
-securityContext: {{ . | trim | nindent 2 }}
+securityContext: {{ . | toYaml | nindent 2 }}
   {{- end -}}
   {{- with ($controllerObject.pod.hostname) }}
 hostname: {{ . | trim }}
@@ -29,13 +29,13 @@ hostNetwork: {{ $controllerObject.pod.hostNetwork }}
 hostPID: {{ $controllerObject.pod.hostPID }}
 dnsPolicy: {{ include "bjw-s.common.lib.pod.field.dnsPolicy" (dict "ctx" $ctx) | trim }}
   {{- with $controllerObject.pod.dnsConfig }}
-dnsConfig: {{ . | trim | nindent 2 }}
+dnsConfig: {{ . | toYaml | nindent 2 }}
   {{- end -}}
   {{- with $controllerObject.pod.hostAliases }}
-hostAliases: {{ . | trim | nindent 2 }}
+hostAliases: {{ . | toYaml | nindent 2 }}
   {{- end -}}
   {{- with $controllerObject.pod.imagePullSecrets }}
-imagePullSecrets: {{ . | trim | nindent 2 }}
+imagePullSecrets: {{ . | toYaml | nindent 2 }}
   {{- end -}}
   {{- with $controllerObject.pod.terminationGracePeriodSeconds }}
 terminationGracePeriodSeconds: {{ . | trim }}
@@ -44,16 +44,16 @@ terminationGracePeriodSeconds: {{ . | trim }}
 restartPolicy: {{ . | trim }}
   {{- end -}}
   {{- with $controllerObject.pod.nodeSelector }}
-nodeSelector: {{ . | trim | nindent 2 }}
+nodeSelector: {{ . | toYaml | nindent 2 }}
   {{- end -}}
   {{- with $controllerObject.pod.affinity }}
-affinity: {{ . | trim | nindent 2 }}
+affinity: {{ . | toYaml | nindent 2 }}
   {{- end -}}
   {{- with $controllerObject.pod.topologySpreadConstraints }}
-topologySpreadConstraints: {{ . | trim | nindent 2 }}
+topologySpreadConstraints: {{ . | toYaml | nindent 2 }}
   {{- end -}}
   {{- with $controllerObject.pod.tolerations }}
-tolerations: {{ . | trim | nindent 2 }}
+tolerations: {{ . | toYaml | nindent 2 }}
   {{- end }}
   {{- with (include "bjw-s.common.lib.pod.field.initContainers" (dict "ctx" $ctx) | trim) }}
 initContainers: {{ . | nindent 2 }}

charts/library/common/templates/lib/pod/fields/_containers.tpl

@@ -6,6 +6,7 @@ Returns the value for containers
   {{- $controllerObject := .ctx.controllerObject -}}
 
   {{- /* Default to empty list */ -}}
+  {{- $orderedContainers := dict -}}
   {{- $containers := list -}}
 
   {{- /* Fetch configured containers for this controller */ -}}
@@ -19,7 +20,13 @@ Returns the value for containers
 
     {{- /* Generate the Container spec */ -}}
     {{- $renderedContainer := include "bjw-s.common.lib.container.spec" (dict "rootContext" $rootContext "controllerObject" $controllerObject "containerObject" $containerObject) | fromYaml -}}
-    {{- $containers = append $containers $renderedContainer -}}
+
+    {{- $containerOrder := (dig "order" 99 $containerValues) -}}
+    {{- $_ := set $orderedContainers (printf "%v-%s" $containerOrder $key) $renderedContainer -}}
+  {{- end -}}
+
+  {{- range $key, $containerValues := $orderedContainers -}}
+    {{- $containers = append $containers $containerValues -}}
   {{- end -}}
 
   {{- if not (empty $containers) -}}

charts/library/common/templates/lib/pod/fields/_initContainers.tpl

@@ -6,19 +6,34 @@ Returns the value for initContainers
   {{- $controllerObject := .ctx.controllerObject -}}
 
   {{- /* Default to empty list */ -}}
+  {{- $orderedContainers := dict -}}
   {{- $containers := list -}}
 
   {{- /* Fetch configured containers for this controller */ -}}
   {{- range $key, $containerValues := $controllerObject.initContainers -}}
-    {{- /* Create object from the container values */ -}}
-    {{- $containerObject := (include "bjw-s.common.lib.container.valuesToObject" (dict "rootContext" $ "id" $key "values" $containerValues)) | fromYaml -}}
+    {{- /* Enable container by default, but allow override */ -}}
+    {{- $containerEnabled := true -}}
+    {{- if hasKey $containerValues "enabled" -}}
+      {{- $containerEnabled = $containerValues.enabled -}}
+    {{- end -}}
 
-    {{- /* Perform validations on the Container before rendering */ -}}
-    {{- include "bjw-s.common.lib.container.validate" (dict "rootContext" $ "object" $containerObject) -}}
+    {{- if $containerEnabled -}}
+      {{- /* Create object from the container values */ -}}
+      {{- $containerObject := (include "bjw-s.common.lib.container.valuesToObject" (dict "rootContext" $ "id" $key "values" $containerValues)) | fromYaml -}}
 
-    {{- /* Generate the Container spec */ -}}
-    {{- $renderedContainer := include "bjw-s.common.lib.container.spec" (dict "rootContext" $rootContext "containerObject" $containerObject) | fromYaml -}}
-    {{- $containers = append $containers $renderedContainer -}}
+      {{- /* Perform validations on the Container before rendering */ -}}
+      {{- include "bjw-s.common.lib.container.validate" (dict "rootContext" $ "object" $containerObject) -}}
+
+      {{- /* Generate the Container spec */ -}}
+      {{- $renderedContainer := include "bjw-s.common.lib.container.spec" (dict "rootContext" $rootContext "containerObject" $containerObject) | fromYaml -}}
+
+      {{- $containerOrder := (dig "order" 99 $containerValues) -}}
+      {{- $_ := set $orderedContainers (printf "%v-%s" $containerOrder $key) $renderedContainer -}}
+    {{- end -}}
+  {{- end -}}
+
+  {{- range $key, $containerValues := $orderedContainers -}}
+    {{- $containers = append $containers $containerValues -}}
   {{- end -}}
 
   {{- if not (empty $containers) -}}

charts/library/common/templates/loader/_generate.tpl

@@ -12,4 +12,5 @@ Secondary entrypoint and primary loader for the common chart
   {{- include "bjw-s.common.render.routes" . | nindent 0 -}}
   {{- include "bjw-s.common.render.configMaps" . | nindent 0 -}}
   {{- include "bjw-s.common.render.secrets" . | nindent 0 -}}
+  {{- include "bjw-s.common.render.networkpolicies" . | nindent 0 -}}
 {{- end -}}

charts/library/common/templates/render/_networkpolicies.tpl

@@ -0,0 +1,26 @@
+{{/*
+Renders the networkPolicy objects required by the chart.
+*/}}
+{{- define "bjw-s.common.render.networkpolicies" -}}
+  {{- /* Generate named networkPolicy as required */ -}}
+  {{- range $key, $networkPolicy := .Values.networkpolicies }}
+    {{- /* Enable networkPolicy by default, but allow override */ -}}
+    {{- $networkPolicyEnabled := true -}}
+    {{- if hasKey $networkPolicy "enabled" -}}
+      {{- $networkPolicyEnabled = $networkPolicy.enabled -}}
+    {{- end -}}
+
+    {{- if $networkPolicyEnabled -}}
+      {{- $networkPolicyValues := (mustDeepCopy $networkPolicy) -}}
+
+      {{- /* Create object from the raw networkPolicy values */ -}}
+      {{- $networkPolicyObject := (include "bjw-s.common.lib.networkpolicy.valuesToObject" (dict "rootContext" $ "id" $key "values" $networkPolicyValues)) | fromYaml -}}
+
+      {{- /* Perform validations on the networkPolicy before rendering */ -}}
+      {{- include "bjw-s.common.lib.networkpolicy.validate" (dict "rootContext" $ "object" $networkPolicyObject) -}}
+
+      {{/* Include the networkPolicy class */}}
+      {{- include "bjw-s.common.class.networkpolicy" (dict "rootContext" $ "object" $networkPolicyObject) | nindent 0 -}}
+    {{- end -}}
+  {{- end -}}
+{{- end -}}

charts/library/common/values.yaml

@@ -176,6 +176,11 @@ controllers:
         # -- Override the container name
         nameOverride:
 
+        # -- Override the default container order
+        # Containers get sorted alphanumerically by the `<order>-<identifier>` combination.
+        # @default -- 99
+        order: 1
+
         image:
           # -- image repository
           repository:
@@ -309,8 +314,8 @@ controllers:
         terminationMessagePolicy:
 
     # -- Specify any initContainers here as dictionary items.
-    # Each initContainer should have its own key. The dictionary item key will determine the order.
-    # Helm templates can be used.
+    # Each initContainer should have its own key
+    # initContainers get sorted alphanumerically by the `<order>-<identifier>` combination.
     initContainers: {}
 
 serviceAccount:
@@ -626,3 +631,32 @@ persistence:
     #         readOnly: false
     #         subPath: config.yaml
     advancedMounts: {}
+
+# -- Configure the networkPolicies for the chart here.
+# Additional networkPolicies can be added by adding a dictionary key similar to the 'main' networkPolicy.
+# @default -- See below
+networkpolicies:
+  main:
+    # -- Enables or disables the networkPolicy item. Defaults to true
+    enabled: false
+
+    # -- Configure which controller this networkPolicy should target
+    controller: main
+
+    # -- Define a custom podSelector for the networkPolicy. This takes precedence over targeting a controller.
+    # podSelector: {}
+
+    # -- The policyTypes for this networkPolicy
+    policyTypes:
+      - Ingress
+      - Egress
+
+    # -- The rulesets for this networkPolicy
+    # [[ref]](https://kubernetes.io/docs/concepts/services-networking/network-policies/#networkpolicy-resource)
+    rules:
+      # -- The ingress rules for this networkPolicy. Allows all ingress traffic by default.
+      ingress:
+        - {}
+      # -- The egress rules for this networkPolicy. Allows all egress traffic by default.
+      egress:
+        - {}