jellyfin - migrate storage section (#1811)

* use pvc in ci

* jellyfin - migrate storage section

* bump and ci migration

* emptydir mig ci

* make emptyDir size int

* regen common

* cleanup

* not an f string

* update label
This commit is contained in:
Stavros Kois
2023-12-03 16:01:26 +02:00
committed by GitHub
parent 81dec3d2fc
commit e2829640e8
13 changed files with 429 additions and 198 deletions

View File

@@ -2,7 +2,7 @@ apiVersion: v2
name: common
description: A library chart for iX Official Catalog
type: library
version: 1.2.3
version: 1.2.4
appVersion: v1
annotations:
title: Common Library Chart

View File

@@ -17,6 +17,7 @@
{{- $domain := "" -}}
{{- $username := "" -}}
{{- $password := "" -}}
{{- $medium := "" -}}
{{- if $storage.readOnly -}}
{{- $readOnly = true -}}
@@ -58,6 +59,21 @@
{{- if $storage.smbConfig.size -}}
{{- $size = (printf "%vGi" $storage.smbConfig.size) -}}
{{- end -}}
{{- end -}}
{{/* emptyDir */}}
{{- if eq $storage.type "emptyDir" -}}
{{- if not $storage.emptyDirConfig -}}
{{- fail (printf "Storage Shim - Expected non-empty [emptyDirConfig]") -}}
{{- end -}}
{{- if $storage.emptyDirConfig.medium -}}
{{- $medium = $storage.emptyDirConfig.medium -}}
{{- end -}}
{{- if $storage.emptyDirConfig.size -}}
{{- $size = (printf "%vGi" $storage.emptyDirConfig.size) -}}
{{- end -}}
{{- end }}
type: {{ $storage.type }}
@@ -65,6 +81,7 @@ size: {{ $size }}
hostPath: {{ $hostPath }}
datasetName: {{ $datasetName }}
readOnly: {{ $readOnly }}
medium: {{ $medium }}
server: {{ $server }}
share: {{ $share }}
domain: {{ $domain }}

View File

@@ -1,6 +1,6 @@
dependencies:
- name: common
repository: file://../../../common
version: 1.2.3
digest: sha256:e6ff49b06bf5d4d159e505ae6d153f36cd46170bb519caf90462cd5caebfd0fb
generated: "2023-11-22T22:27:23.591400891+02:00"
version: 1.2.4
digest: sha256:47ebfd41bc2ac33ab6989e7bd4d1d3aea662365fffa8b525a24cc56a2a35c174
generated: "2023-11-29T16:38:16.689416389+02:00"

View File

@@ -4,7 +4,7 @@ description: Jellyfin is a Free Software Media System that puts you in control o
annotations:
title: Jellyfin
type: application
version: 1.1.5
version: 1.2.0
apiVersion: v2
appVersion: 10.8.13
kubeVersion: '>=1.16.0-0'
@@ -15,7 +15,7 @@ maintainers:
dependencies:
- name: common
repository: file://../../../common
version: 1.2.3
version: 1.2.4
home: https://jellyfin.org/
icon: https://media.sys.truenas.net/apps/jellyfin/icons/icon.svg
sources:

View File

@@ -7,15 +7,14 @@ jellyfinRunAs:
jellyfinStorage:
config:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/config
type: pvc
cache:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/cache
type: pvc
transcodes:
type: emptyDir
medium: Memory
size: 1Gi
emptyDirConfig:
medium: Memory
size: 1
# Make sure installation don't fail when 0 GPU are assigned
jellyfinGPU:

View File

@@ -3,20 +3,17 @@ jellyfinNetwork:
jellyfinStorage:
config:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/config
type: pvc
cache:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/cache
type: pvc
transcodes:
type: emptyDir
medium: ''
size: ''
emptyDirConfig:
medium: ""
size:
additionalStorages:
- type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/movies
- type: pvc
mountPath: /movies
- type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/series
- type: pvc
mountPath: /series

View File

@@ -3,11 +3,8 @@ jellyfinNetwork:
jellyfinStorage:
config:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/config
type: pvc
cache:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/cache
type: pvc
transcodes:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/transcodes
type: pvc

View File

@@ -4,17 +4,82 @@ import os
import sys
def storage_migrate(storage):
delete_keys = []
if storage['type'] == 'hostPath':
# Check if the key exists, if not we have already migrated
if not storage.get('hostPath'):
return storage
storage['hostPathConfig'] = {'hostPath': storage['hostPath']}
delete_keys.append('hostPath')
elif storage['type'] == 'ixVolume':
# Check if the key exists, if not we have already migrated
if not storage.get('datasetName'):
return storage
storage['ixVolumeConfig'] = {'datasetName': storage['datasetName']}
delete_keys.append('datasetName')
# Clean up for some older versions.
if storage.get('hostPath'):
delete_keys.append('hostPath')
elif storage['type'] == 'emptyDir':
# Check if the key exists, if not we have already migrated
if not 'medium' in storage.keys():
return storage
if storage['size'] and (not storage['size'].endswith('Gi')):
raise Exception('In order to proceed with the update, ' \
'please change the size for the storage using ' \
'"emptyDir" in the format xGi. eg. "2Gi"')
storage['emptyDirConfig'] = {
'medium': storage['medium'],
'size': int(storage['size'].replace('Gi', '')) if storage['size'] else None,
}
delete_keys.extend(['medium', 'size'])
elif storage['type'] == 'smb-pv-pvc':
# Check if the key exists, if not we have already migrated
if not storage.get('server'):
return storage
storage['smbConfig'] = {
'server': storage['server'],
'share': storage['share'],
'domain': storage['domain'],
'username': storage['username'],
'password': storage['password'],
'size': storage['size'],
}
delete_keys.extend(['server', 'share', 'domain', 'username', 'password', 'size'])
for key in delete_keys:
storage.pop(key, None)
return storage
def migrate(values):
storageKey = 'jellyfinStorage'
storage_key = 'jellyfinStorage'
storages = ['config', 'cache', 'transcodes']
for storage in storages:
check_val = values.get(storageKey, {}).get(storage, {})
if not isinstance(check_val, dict) or not check_val or check_val.get('type', 'hostPath') == 'hostPath':
continue
check_val = values.get(storage_key, {}).get(storage, {})
if not isinstance(check_val, dict) or not check_val:
raise Exception(f'Storage section {storage} is malformed')
values[storageKey][storage] = {key: value for key, value in check_val.items() if key != 'hostPath'}
values[storage_key][storage] = storage_migrate(check_val)
additionalStorages = values.get(storage_key, {}).get('additionalStorages', [])
for idx, storage in enumerate(additionalStorages):
if not isinstance(storage, dict) or not storage:
raise Exception(f'Item {idx} in additionalStorages is malformed')
values[storage_key]['additionalStorages'][idx] = storage_migrate(storage)
return values

View File

@@ -131,24 +131,64 @@ questions:
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: string
type: dict
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: "config"
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "config"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: hostPathConfig
label: Host Path Configuration
schema:
type: hostpath
type: dict
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: cache
label: Jellyfin Cache Storage
description: The path to store Jellyfin Cache.
@@ -170,24 +210,64 @@ questions:
description: Host Path (Path that already exists on the system)
- value: "ixVolume"
description: ixVolume (Dataset created automatically by the system)
- variable: datasetName
label: Dataset Name
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: string
type: dict
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: "cache"
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "cache"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: hostPathConfig
label: Host Path Configuration
schema:
type: hostpath
type: dict
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: transcodes
label: Jellyfin Transcodes Storage
description: The path to store Jellyfin Transcodes.
@@ -212,47 +292,92 @@ questions:
description: ixVolume (Dataset created automatically by the system)
- value: "emptyDir"
description: emptyDir (Temporary directory created on the disk or in memory)
- variable: datasetName
label: Dataset Name
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: string
type: dict
show_if: [["type", "=", "ixVolume"]]
required: true
hidden: true
immutable: true
default: "transcodes"
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
hidden: true
default: "transcodes"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: emptyDirConfig
label: emptyDir Configuration
schema:
type: hostpath
type: dict
show_if: [["type", "=", "emptyDir"]]
attrs:
- variable: medium
label: emptyDir Medium
description: |
Disk: Creates a temporary directory on the disk.</br>
Memory: Creates a temporary directory in memory.
schema:
type: string
default: ""
enum:
- value: ""
description: Disk (Temporary directory created on the disk)
- value: "Memory"
description: Memory (Temporary directory created in memory)
- variable: size
label: emptyDir Size Limit (in Gi)
description: |
The maximum size (in Gi) of the temporary directory.</br>
For example: 2
schema:
type: int
"null": true
default: 2
- variable: hostPathConfig
label: Host Path Configuration
schema:
type: dict
show_if: [["type", "=", "hostPath"]]
immutable: true
required: true
- variable: medium
label: emptyDir Medium
description: |
Disk: Creates a temporary directory on the disk.</br>
Memory: Creates a temporary directory in memory.
schema:
type: string
show_if: [["type", "=", "emptyDir"]]
default: ""
enum:
- value: ""
description: Disk (Temporary directory created on the disk)
- value: "Memory"
description: Memory (Temporary directory created in memory)
- variable: size
label: emptyDir Size Limit
description: |
The maximum size of the temporary directory.</br>
For example: 2Gi
schema:
type: string
show_if: [["type", "=", "emptyDir"]]
default: "2Gi"
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: additionalStorages
label: Additional Storage
@@ -284,74 +409,120 @@ questions:
description: ixVolume (Dataset created automatically by the system)
- value: "smb-pv-pvc"
description: SMB Share (Mounts a persistent volume claim to a SMB share)
- variable: readOnly
label: Read Only
description: Mount the volume as read only.
schema:
type: boolean
default: false
- variable: mountPath
label: Mount Path
description: The path inside the container to mount the storage.
schema:
type: path
required: true
- variable: hostPath
label: Host Path
description: The host path to use for storage.
- variable: hostPathConfig
label: Host Path Configuration
schema:
type: hostpath
type: dict
show_if: [["type", "=", "hostPath"]]
required: true
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: acl
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
$ref:
- "normalize/acl"
- variable: hostPath
label: Host Path
description: The host path to use for storage.
schema:
type: hostpath
show_if: [["aclEnable", "=", false]]
immutable: true
required: true
- variable: ixVolumeConfig
label: ixVolume Configuration
description: The configuration for the ixVolume dataset.
schema:
type: string
type: dict
show_if: [["type", "=", "ixVolume"]]
required: true
immutable: true
default: "storage_entry"
$ref:
- "normalize/ixVolume"
- variable: server
label: Server
description: The server for the SMB share.
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
default: false
- variable: datasetName
label: Dataset Name
description: The name of the dataset to use for storage.
schema:
type: string
required: true
immutable: true
default: "storage_entry"
- variable: aclEntries
label: ACL Configuration
schema:
type: dict
show_if: [["aclEnable", "=", true]]
attrs: []
- variable: smbConfig
label: SMB Share Configuration
description: The configuration for the SMB Share.
schema:
type: string
type: dict
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
- variable: share
label: Share
description: The share name for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
- variable: domain
label: Domain (Optional)
description: The domain for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
- variable: username
label: Username
description: The username for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
- variable: password
label: Password
description: The password for the SMB share.
schema:
type: string
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
private: true
- variable: size
label: Size (in Gi)
description: The size of the volume quota.
schema:
type: int
show_if: [["type", "=", "smb-pv-pvc"]]
required: true
min: 1
default: 1
attrs:
- variable: server
label: Server
description: The server for the SMB share.
schema:
type: string
required: true
- variable: share
label: Share
description: The share name for the SMB share.
schema:
type: string
required: true
- variable: domain
label: Domain (Optional)
description: The domain for the SMB share.
schema:
type: string
- variable: username
label: Username
description: The username for the SMB share.
schema:
type: string
required: true
- variable: password
label: Password
description: The password for the SMB share.
schema:
type: string
required: true
private: true
- variable: size
label: Size (in Gi)
description: The size of the volume quota.
schema:
type: int
required: true
min: 1
default: 1
- variable: resources
group: Resources Configuration

View File

@@ -41,12 +41,6 @@ workload:
type: http
port: 8096
path: /health
initContainers:
{{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions"
"UID" .Values.jellyfinRunAs.user
"GID" .Values.jellyfinRunAs.group
"mode" "check"
"type" "init") | nindent 8 }}
{{/* Service */}}
service:
@@ -68,42 +62,28 @@ service:
persistence:
config:
enabled: true
type: {{ .Values.jellyfinStorage.config.type }}
datasetName: {{ .Values.jellyfinStorage.config.datasetName | default "" }}
hostPath: {{ .Values.jellyfinStorage.config.hostPath | default "" }}
{{- include "jellyfin.storage.ci.migration" (dict "storage" .Values.jellyfinStorage.config) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.jellyfinStorage.config) | nindent 4 }}
targetSelector:
jellyfin:
jellyfin:
mountPath: /config
01-permissions:
mountPath: /mnt/directories/config
cache:
enabled: true
type: {{ .Values.jellyfinStorage.cache.type }}
datasetName: {{ .Values.jellyfinStorage.cache.datasetName | default "" }}
hostPath: {{ .Values.jellyfinStorage.cache.hostPath | default "" }}
{{- include "jellyfin.storage.ci.migration" (dict "storage" .Values.jellyfinStorage.cache) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.jellyfinStorage.cache) | nindent 4 }}
targetSelector:
jellyfin:
jellyfin:
mountPath: /cache
01-permissions:
mountPath: /mnt/directories/cache
transcode:
enabled: true
type: {{ .Values.jellyfinStorage.transcodes.type }}
datasetName: {{ .Values.jellyfinStorage.transcodes.datasetName | default "" }}
hostPath: {{ .Values.jellyfinStorage.transcodes.hostPath | default "" }}
medium: {{ .Values.jellyfinStorage.transcodes.medium | default "" }}
{{/* Size of the emptyDir */}}
size: {{ .Values.jellyfinStorage.transcodes.size | default "" }}
{{- include "jellyfin.storage.ci.migration" (dict "storage" .Values.jellyfinStorage.transcodes) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.jellyfinStorage.transcodes) | nindent 4 }}
targetSelector:
jellyfin:
jellyfin:
mountPath: /config/transcodes
{{ if ne .Values.jellyfinStorage.transcodes.type "emptyDir" }}
01-permissions:
mountPath: /mnt/directories/transcodes
{{ end }}
tmp:
enabled: true
type: emptyDir
@@ -112,32 +92,16 @@ persistence:
jellyfin:
mountPath: /tmp
{{- range $idx, $storage := .Values.jellyfinStorage.additionalStorages }}
{{ printf "jellyfin-%v" (int $idx) }}:
{{- $size := "" -}}
{{- if $storage.size -}}
{{- $size = (printf "%vGi" $storage.size) -}}
{{- end }}
{{ printf "jellyfin-%v:" (int $idx) }}
enabled: true
type: {{ $storage.type }}
datasetName: {{ $storage.datasetName | default "" }}
hostPath: {{ $storage.hostPath | default "" }}
server: {{ $storage.server | default "" }}
share: {{ $storage.share | default "" }}
domain: {{ $storage.domain | default "" }}
username: {{ $storage.username | default "" }}
password: {{ $storage.password | default "" }}
size: {{ $size }}
{{- if eq $storage.type "smb-pv-pvc" }}
mountOptions:
- key: noperm
{{- end }}
{{- include "jellyfin.storage.ci.migration" (dict "storage" $storage) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }}
targetSelector:
jellyfin:
jellyfin:
mountPath: {{ $storage.mountPath }}
01-permissions:
mountPath: /mnt/directories{{ $storage.mountPath }}
{{- end }}
{{ with .Values.jellyfinGPU }}
scaleGPU:
{{ range $key, $value := . }}
@@ -149,3 +113,19 @@ scaleGPU:
{{ end }}
{{ end }}
{{- end -}}
{{/* TODO: Remove on the next version bump, eg 1.2.0+ */}}
{{- define "jellyfin.storage.ci.migration" -}}
{{- $storage := .storage -}}
{{- if $storage.hostPath -}}
{{- $_ := set $storage "hostPathConfig" dict -}}
{{- $_ := set $storage.hostPathConfig "hostPath" $storage.hostPath -}}
{{- end -}}
{{- if (hasKey $storage "medium") -}}
{{- $_ := set $storage "emptyDirConfig" dict -}}
{{- $_ := set $storage.emptyDirConfig "medium" $storage.medium -}}
{{- $_ := set $storage.emptyDirConfig "size" 1 -}}
{{- end -}}
{{- end -}}

View File

@@ -11,23 +11,28 @@ resources:
jellyfinConfig:
publishedServerUrl: ''
additionalEnvs: []
jellyfinGPU: {}
jellyfinNetwork:
webPort: 30013
hostNetwork: false
jellyfinRunAs:
user: 568
group: 568
jellyfinStorage:
config:
type: ixVolume
datasetName: config
ixVolumeConfig:
datasetName: config
cache:
type: ixVolume
datasetName: cache
ixVolumeConfig:
datasetName: cache
transcodes:
type: ixVolume
datasetName: transcodes
medium: ''
size: ''
ixVolumeConfig:
datasetName: transcodes
additionalStorages: []