github/charts
4
0
Fork 0
mirror of https://github.com/truenas/charts.git synced 2024-04-21 15:21:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

device vol type

Browse Source
This commit is contained in:
Stavros kois
2023-02-11 17:05:07 +02:00
parent 6baaed12ac
commit ccbe4446e0
9 changed files with 191 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
library/common-test/tests/persistence/validation_test.yaml
+1 -1
View File
@@ -40,7 +40,7 @@ tests:
type: not-a-type
asserts:
- failedTemplate:
errorMessage: Persistence - Expected <type> to be one of [pvc, emptyDir, nfs, hostPath, ixVolume, secret, configmap], but got [not-a-type]
errorMessage: Persistence - Expected <type> to be one of [pvc, emptyDir, nfs, hostPath, ixVolume, secret, configmap, device], but got [not-a-type]
- it: should fail without storageClassName in ixChartContext
set:
library/common-test/tests/pod/volume_device_test.yaml
+110
View File
@@ -0,0 +1,110 @@
suite: pod device volume test
templates:
- common.yaml
tests:
- it: should pass with device volume
set:
workload:
workload-name1:
enabled: true
primary: true
type: Deployment
podSpec: {}
persistence:
dev-vol:
enabled: true
type: device
hostPath: /dev/something
asserts:
- documentIndex: &deploymentDoc 0
isKind:
of: Deployment
- documentIndex: *deploymentDoc
contains:
path: spec.template.spec.volumes
content:
name: dev-vol
hostPath:
path: /dev/something
- it: should pass with device volume and type
set:
some_path: /dev/something
some_type: BlockDevice
workload:
workload-name1:
enabled: true
primary: true
type: Deployment
podSpec: {}
persistence:
dev-vol:
enabled: true
type: device
hostPath: "{{ .Values.some_path }}"
hostPathType: "{{ .Values.some_type }}"
asserts:
- documentIndex: *deploymentDoc
isKind:
of: Deployment
- documentIndex: *deploymentDoc
contains:
path: spec.template.spec.volumes
content:
name: dev-vol
hostPath:
path: /dev/something
type: BlockDevice
# Failures
- it: should fail without hostPath
set:
workload:
some-workload:
enabled: true
primary: true
type: Deployment
podSpec: {}
persistence:
volume1:
enabled: true
type: device
hostPath: ""
asserts:
- failedTemplate:
errorMessage: Persistence - Expected non-empty <hostPath> on <device> type
- it: should fail with relative hostPath
set:
workload:
some-workload:
enabled: true
primary: true
type: Deployment
podSpec: {}
persistence:
volume1:
enabled: true
type: device
hostPath: some-path
asserts:
- failedTemplate:
errorMessage: Persistence - Expected <hostPath> to start with a forward slash [/] on <device> type
- it: should fail with invalid hostPathType
set:
workload:
some-workload:
enabled: true
primary: true
type: Deployment
podSpec: {}
persistence:
volume1:
enabled: true
type: device
hostPath: /some-path
hostPathType: invalid
asserts:
- failedTemplate:
errorMessage: Persistence - Expected <hostPathType> to be one of [DirectoryOrCreate, Directory, FileOrCreate, File, Socket, CharDevice, BlockDevice], but got [invalid]
library/common/1.0.0/docs/persistence/README.md
+13 -12
View File
@@ -1,17 +1,17 @@
# Persistence
| Key | Type | Required | Helm Template | Default | Description |
| :----------------------------------------------------------------------------- | :-------: | :------: | :-----------: | :-----------------------: | :---------------------------------------------------------------------------------- |
| persistence | `dict` | ❌ | ❌ | `{}` | Define the persistence as dicts |
| persistence.[volume-name] | `dict` | ✅ | ❌ | `{}` | Holds persistence definition |
| persistence.[volume-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the persistence |
| persistence.[volume-name].type | `string` | ❌ | ❌ | `pvc` | Define the persistence type (pvc, ixVolume, nfs, hostPath, configmap, secret) |
| persistence.[volume-name].targetSelectAll | `boolean` | ❌ | ❌ | `false` | Define wether to define this volume to all workloads and mount it on all containers |
| persistence.[volume-name].targetSelector | `dict` | ❌ | ❌ | `{}` | Define a dict with pod and containers to mount |
| persistence.[volume-name].mountPath | `string` | ❌ | ✅ | `""` | Default mountPath for all container |
| persistence.[volume-name].targetSelector.[pod-name] | `dict` | ❌ | ❌ | `{}` | Define a dict named after the pod to define the volume |
| persistence.[volume-name].targetSelector.[pod-name].[container-name] | `dict` | ❌ | ❌ | `{}` | Define a dict named after the container to mount the volume |
| persistence.[volume-name].targetSelector.[pod-name].[container-name].mountPath | `string` | ❌ | ✅ | `[volume-name].mountPath` | Define the mountPath for the container |
| Key | Type | Required | Helm Template | Default | Description |
| :----------------------------------------------------------------------------- | :-------: | :------: | :-----------: | :-----------------------: | :------------------------------------------------------------------------------------ |
| persistence | `dict` | ❌ | ❌ | `{}` | Define the persistence as dicts |
| persistence.[volume-name] | `dict` | ✅ | ❌ | `{}` | Holds persistence definition |
| persistence.[volume-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the persistence |
| persistence.[volume-name].type | `string` | ❌ | ❌ | `pvc` | Define the persistence type (pvc, ixVolume, nfs, hostPath, configmap, secret, device) |
| persistence.[volume-name].targetSelectAll | `boolean` | ❌ | ❌ | `false` | Define wether to define this volume to all workloads and mount it on all containers |
| persistence.[volume-name].targetSelector | `dict` | ❌ | ❌ | `{}` | Define a dict with pod and containers to mount |
| persistence.[volume-name].mountPath | `string` | ❌ | ✅ | `""` | Default mountPath for all container |
| persistence.[volume-name].targetSelector.[pod-name] | `dict` | ❌ | ❌ | `{}` | Define a dict named after the pod to define the volume |
| persistence.[volume-name].targetSelector.[pod-name].[container-name] | `dict` | ❌ | ❌ | `{}` | Define a dict named after the container to mount the volume |
| persistence.[volume-name].targetSelector.[pod-name].[container-name].mountPath | `string` | ❌ | ✅ | `[volume-name].mountPath` | Define the mountPath for the container |
> When `targetSelectAll` is `true`, it will define the volume to all pods (`targetSelector` is ignored in this case)
> When `targetSelector` is defined, referencing pod(s) it will define the volume to those pod(s)
@@ -38,6 +38,7 @@ Naming scheme:
- [emptyDir](emptyDir.md)
- [ixVolume](ixVolume.md)
- [hostPath](hostPath.md)
- [device](device.md)
- [secret](secret.md)
- [pvc](pvc.md)
- [nfs](nfs.md)
library/common/1.0.0/docs/persistence/device.md
+28
View File
@@ -0,0 +1,28 @@
# Device
| Key | Type | Required | Helm Template | Default | Description |
| :------------------------------------- | :------: | :------: | :-----------: | :-----: | :---------------------- |
| persistence.[volume-name].hostPath | `string` | ✅ | ✅ | `""` | Define the hostPath |
| persistence.[volume-name].hostPathType | `string` | ❌ | ✅ | `""` | Define the hostPathType |
> `device` type is pretty much the same as `hostPath`. The only difference is that if a `device` type is defined.
> We can take additional actions, like setting supplementalGroups to the container assigned, so it can utilize the device.
---
Notes:
View common `keys` of `persistence` in [persistence Documentation](README.md).
---
Examples:
```yaml
persistence:
dev-vol:
enabled: true
type: device
hostPath: /path/to/host
hostPathType: BlockDevice
```
library/common/1.0.0/templates/lib/pod/_volumes.tpl
+2
View File
@@ -51,6 +51,8 @@ objectData: The object data to be used to render the Pod.
{{- include "ix.v1.common.lib.pod.volume.emptyDir" (dict "rootCtx" $rootCtx "objectData" $persistence) | trim | nindent 0 -}}
{{- else if eq "nfs" $type -}}
{{- include "ix.v1.common.lib.pod.volume.nfs" (dict "rootCtx" $rootCtx "objectData" $persistence) | trim | nindent 0 -}}
{{- else if eq "device" $type -}}
{{- include "ix.v1.common.lib.pod.volume.device" (dict "rootCtx" $rootCtx "objectData" $persistence) | trim | nindent 0 -}}
{{- end -}}
{{- end -}}
library/common/1.0.0/templates/lib/pod/volumes/_device.tpl
+35
View File
@@ -0,0 +1,35 @@
{{/* Returns device (hostPath) Volume */}}
{{/* Call this template:
{{ include "ix.v1.common.lib.pod.volume.device" (dict "rootCtx" $ "objectData" $objectData) }}
rootCtx: The root context of the template. It is used to access the global context.
objectData: The object data to be used to render the volume.
*/}}
{{- define "ix.v1.common.lib.pod.volume.device" -}}
{{- $rootCtx := .rootCtx -}}
{{- $objectData := .objectData -}}
{{- $hostPathType := "" -}}
{{- if $objectData.hostPathType -}}
{{- $hostPathType = tpl $objectData.hostPathType $rootCtx -}}
{{- end -}}
{{- if not $objectData.hostPath -}}
{{- fail "Persistence - Expected non-empty <hostPath> on <device> type" -}}
{{- end -}}
{{- $hostPath := tpl $objectData.hostPath $rootCtx -}}
{{- if not (hasPrefix "/" $hostPath) -}}
{{- fail "Persistence - Expected <hostPath> to start with a forward slash [/] on <device> type" -}}
{{- end -}}
{{- $types := (list "DirectoryOrCreate" "Directory" "FileOrCreate" "File" "Socket" "CharDevice" "BlockDevice") -}}
{{- if and $hostPathType (not (mustHas $hostPathType $types)) -}}
{{- fail (printf "Persistence - Expected <hostPathType> to be one of [%s], but got [%s]" (join ", " $types) $hostPathType) -}}
{{- end }}
- name: {{ $objectData.shortName }}
hostPath:
path: {{ $hostPath }}
{{- with $hostPathType }}
type: {{ $hostPathType }}
{{- end -}}
{{- end -}}
library/common/1.0.0/templates/lib/storage/_validation.tpl
+1 -1
View File
@@ -10,7 +10,7 @@ objectData:
{{- $rootCtx := .rootCtx -}}
{{- $objectData := .objectData -}}
{{- $types := (list "pvc" "emptyDir" "nfs" "hostPath" "ixVolume" "secret" "configmap") -}}
{{- $types := (list "pvc" "emptyDir" "nfs" "hostPath" "ixVolume" "secret" "configmap" "device") -}}
{{- if not (mustHas $objectData.type $types) -}}
{{- fail (printf "Persistence - Expected <type> to be one of [%s], but got [%s]" (join ", " $types) $objectData.type) -}}
{{- end -}}
library/common/1.0.0/templates/spawner/_service.tpl
+1 -1
View File
@@ -22,8 +22,8 @@
{{/* Perform validations */}}
{{- include "ix.v1.common.lib.chart.names.validation" (dict "name" $objectName) -}}
{{- include "ix.v1.common.lib.service.validation" (dict "rootCtx" $ "objectData" $objectData) -}}
{{- include "ix.v1.common.lib.metadata.validation" (dict "objectData" $objectData "caller" "Service") -}}
{{- include "ix.v1.common.lib.service.validation" (dict "rootCtx" $ "objectData" $objectData) -}}
{{/* Set the name of the service account */}}
{{- $_ := set $objectData "name" $objectName -}}
library/common/1.0.0/values.yaml
-25
View File
@@ -299,7 +299,6 @@ scaleGPU:
pod-name:
- container-name
# -- SCALE Certificate
scaleCertificate:
# -- Certificate name
@@ -322,27 +321,3 @@ scaleCertificate:
container-name:
certPath: ""
keyPath: ""
# -- Device
device:
# -- Device name
device-name:
# -- Enables the device
enabled: false
# -- Device host path
hostPath: /host/device/path
# -- Options that apply to all volumeMounts
# Can be overruled per volumeMount under targetSelector
mountPath: /shared
readOnly: False
subPath: ""
mountPropagation: ""
# Where to define the volume and mount the volume
# targetSelector: all
targetSelector:
pod-name:
container-name:
mountPath: /shared
readOnly: False
subPath: ""
mountPropagation: ""