Files
library-charts/library/common/templates/lib/container/_volumeMounts.tpl
Kjeld Schouten-Lebbing 303df87c51 feat(common): readd TrueCharts specific features to refactor (#292)
**Description**
This PR re-adds TrueCharts specific portions back into the refactor done
by iX-Systems to the common-chart

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

Co-authored-by: Stavros kois <s.kois@outlook.com>
Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2023-01-23 00:37:30 +01:00

143 lines
6.6 KiB
Smarty

{{/* Volume Mounts included by the container. */}}
{{- define "ix.v1.common.container.volumeMounts" -}}
{{- $isMainContainer := .isMainContainer -}}
{{- $root := .root -}}
{{- $extraContainerVolMounts := .extraContainerVolMounts -}}
{{- if (mustHas $root.Values.controller.type (list "Job" "CronJob")) -}}
{{- $isMainContainer = true -}}
{{- end -}}
{{- if $isMainContainer -}}
{{- range $name, $item := $root.Values.persistence -}}
{{- if $item.enabled -}}
{{- if not $item.noMount -}}
{{- include "ix.v1.common.container.volumeMount" (dict "root" $root
"item" $item
"name" $name) | indent 0 -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{/* TODO: write tests when statefulset is ready */}}
{{- if eq $root.Values.controller.type "StatefulSet" -}}
{{- range $index, $vct := $root.Values.volumeClaimTemplates -}}
{{- include "ix.v1.common.container.volumeMount" (dict "root" $root
"item" $vct
"name" (toString $index)) | indent 0 -}}
{{- end -}}
{{- end -}}
{{- else if not $isMainContainer -}}
{{/* Create a list of volume names, so we can run checks against it */}}
{{- $volNames := list -}}
{{- range $name, $item := $root.Values.persistence -}}
{{- $volNames = mustAppend $volNames $name -}}
{{- end -}}
{{/* Create a list of extraContainerVolMounts names, so we can run checks against it */}}
{{- $extraContainerVolNames := list -}}
{{- range $index, $item := $extraContainerVolMounts -}}
{{- if $item.name -}}
{{- $extraContainerVolNames = mustAppend $extraContainerVolNames $item.name -}}
{{- end -}}
{{- end -}}
{{- range $index, $volMount := $extraContainerVolMounts -}}
{{- if hasKey $volMount "inherit" -}} {{/* If has Key "inherit" */}}
{{- if eq $volMount.inherit "all" -}} {{/* Inherit all volumeMounts */}}
{{- range $name, $item := $root.Values.persistence -}}
{{- if $item.enabled -}}
{{- include "ix.v1.common.container.volumeMount" (dict "root" $root
"item" $item
"name" $name) | indent 0 -}}
{{- if (mustHas $name $extraContainerVolNames) -}} {{/* Remove it from the volNames so it does not get re-added */}}
{{- $extraContainerVolNames = mustWithout $extraContainerVolNames $name -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- else if eq $volMount.inherit "skipNoMount" -}} {{/* Inherit all volumeMounts but skip the "noMount" volumeMounts */}}
{{- range $name, $item := $root.Values.persistence -}}
{{- if $item.enabled -}}
{{- if not $item.noMount -}}
{{- include "ix.v1.common.container.volumeMount" (dict "root" $root
"item" $item
"name" $name) | indent 0 -}}
{{- if (mustHas $name $extraContainerVolNames) -}} {{/* Remove it from the volNames so it does not get re-added */}}
{{- $extraContainerVolNames = mustWithout $extraContainerVolNames $name -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- else if eq $volMount.inherit "setPermissions" -}} {{/* Inherit all volumes with setPermissions enabled */}}
{{- range $name, $item := $root.Values.persistence -}}
{{- if $item.enabled -}}
{{- if $item.setPermissions -}}
{{- include "ix.v1.common.container.volumeMount" (dict "root" $root
"item" $item
"name" $name) | indent 0 -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- end -}}{{/* Here we can add other inherit cases */}}
{{- else -}}
{{- if not $volMount.name -}}
{{- fail "<name> is required in volumeMounts in init/system/install/upgrade/additional containers." -}}
{{- end -}}
{{- if mustHas $volMount.name $extraContainerVolNames -}}
{{- if not (mustHas $volMount.name $volNames) -}}
{{- fail (printf "You are trying to mount a volume that does not exist (%s). Please define the volume in <persistence>." $volMount.name) -}}
{{- end -}}
{{- $item := dict -}}
{{- $_ := set $item "mountPath" $volMount.mountPath -}}
{{- if hasKey $volMount "subPath" -}}
{{- $_ := set $item "subPath" $volMount.subPath -}}
{{- end -}}
{{- if hasKey $volMount "mountPropagation" -}}
{{- $_ := set $item "mountPropagation" $volMount.mountPropagation -}}
{{- end -}}
{{- if hasKey $volMount "readOnly" -}}
{{- $_ := set $item "readOnly" $volMount.readOnly -}}
{{- end -}}
{{- include "ix.v1.common.container.volumeMount" (dict "root" $root
"item" $item
"name" $volMount.name) | indent 0 -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- define "ix.v1.common.container.volumeMount" -}}
{{- $root := .root -}}
{{- $item := .item -}}
{{- $name := .name -}}
{{- if not $item.mountPath -}} {{/* Make sure that we have a mountPath */}}
{{- fail "<mountPath> must be defined, alternatively use the <noMount> flag." -}}
{{- end -}}
{{- $mountPath := (tpl $item.mountPath $root) -}}
{{- if not (hasPrefix "/" $mountPath) -}}
{{- fail (printf "Mount path (%s), must start with a forward slash -> / <-" $mountPath) -}}
{{- end }}
- name: {{ tpl $name $root }}
mountPath: {{ $mountPath }}
{{- with $item.subPath }}
subPath: {{ tpl . $root }}
{{- end -}}
{{- if (hasKey $item "readOnly") -}}
{{- if or (eq $item.readOnly true) (eq $item.readOnly false) }}
readOnly: {{ $item.readOnly }}
{{- else -}}
{{- fail (printf "<readOnly> cannot be empty on item (%s)" $name) -}}
{{- end -}}
{{- end -}}
{{- with $item.mountPropagation }}
mountPropagation: {{ tpl . $root }}
{{- end -}}
{{- end -}}