truenas/chart
1
0
Fork 0
mirror of https://github.com/truenas/charts.git synced 2026-06-14 22:25:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Piwigo - migrate storage section (adds acl) (#1999)

Browse Source
This commit is contained in:
Stavros Kois
2024-01-05 14:42:47 +02:00
committed by GitHub
parent aeb7f5af36
commit f066c7f61b
6 changed files with 432 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
library/ix-dev/community/piwigo/Chart.yaml
View File

@@ -4,7 +4,7 @@ description: Piwigo is a photo gallery software for the web that comes with powe
annotations:
title: Piwigo
type: application
version: 1.1.8
version: 1.2.0
apiVersion: v2
appVersion: 14.1.0
kubeVersion: '>=1.16.0-0'

15
library/ix-dev/community/piwigo/ci/basic-values.yaml
View File

@@ -13,14 +13,13 @@ piwiID:
piwiStorage:
config:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/config
type: pvc
gallery:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/gallery
type: pvc
mariadbData:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/mariadbData
type: pvc
mariadbBackup:
type: hostPath
hostPath: /mnt/{{ .Release.Name }}/mariadbBackup
type: emptyDir
emptyDirConfig:
medium: ""
size: ""

73
library/ix-dev/community/piwigo/migrations/migrate Executable file
View File

@@ -0,0 +1,73 @@
#!/usr/bin/python3
import json
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')
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):
storage_key = 'piwiStorage'
storages = ['config', 'gallery', 'mariadbData', 'mariadbBackup']
for storage in storages:
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[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
if __name__ == '__main__':
if len(sys.argv) != 2:
exit(1)
if os.path.exists(sys.argv[1]):
with open(sys.argv[1], 'r') as f:
print(json.dumps(migrate(json.loads(f.read()))))

421
library/ix-dev/community/piwigo/questions.yaml
View File

@@ -302,23 +302,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"]]
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]]
required: true
- variable: gallery
label: Piwigo Gallery Storage
description: The path to store Piwigo gallery.
@@ -340,23 +381,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: gallery
$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: "gallery"
- 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"]]
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]]
required: true
- variable: mariadbData
label: Piwigo MariaDB Data Storage
description: The path to store Piwigo MariaDB Data.
@@ -378,23 +460,72 @@ 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
show_if: [["type", "=", "ixVolume"]]
required: true
type: dict
# Nothing to show for the user
hidden: true
immutable: true
default: mariadbData
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
# MariaDB does a CHMOD at startup
# Which fails with ACL
hidden: true
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: mariadbData
- 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"]]
required: true
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
# MariaDB does a CHMOD at startup
# Which fails with ACL
hidden: true
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]]
required: true
- variable: mariadbBackup
label: Piwigo MariaDB Backup Storage
description: The path to store Piwigo MariaDB Backup.
@@ -416,23 +547,72 @@ 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
show_if: [["type", "=", "ixVolume"]]
required: true
type: dict
# Nothing to show for the user
hidden: true
immutable: true
default: mariadbBackup
show_if: [["type", "=", "ixVolume"]]
$ref:
- "normalize/ixVolume"
- variable: hostPath
label: Host Path
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
# MariaDB does a CHMOD at startup
# Which fails with ACL
hidden: true
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: mariadbBackup
- 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"]]
required: true
attrs:
- variable: aclEnable
label: Enable ACL
description: Enable ACL for the dataset.
schema:
type: boolean
# MariaDB does a CHMOD at startup
# Which fails with ACL
hidden: true
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]]
required: true
- variable: additionalStorages
label: Additional Storage
description: Additional storage for Piwigo.
@@ -463,74 +643,119 @@ 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]]
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
label: ""

49
library/ix-dev/community/piwigo/templates/_persistance.tpl
View File

@@ -2,18 +2,16 @@
persistence:
config:
enabled: true
type: {{ .Values.piwiStorage.config.type }}
datasetName: {{ .Values.piwiStorage.config.datasetName | default "" }}
hostPath: {{ .Values.piwiStorage.config.hostPath | default "" }}
{{- include "piwi.storage.ci.migration" (dict "storage" .Values.piwiStorage.config) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.piwiStorage.config) | nindent 4 }}
targetSelector:
piwigo:
piwigo:
mountPath: /config
gallery:
enabled: true
type: {{ .Values.piwiStorage.gallery.type }}
datasetName: {{ .Values.piwiStorage.gallery.datasetName | default "" }}
hostPath: {{ .Values.piwiStorage.gallery.hostPath | default "" }}
{{- include "piwi.storage.ci.migration" (dict "storage" .Values.piwiStorage.gallery) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.piwiStorage.gallery) | nindent 4 }}
targetSelector:
piwigo:
piwigo:
@@ -27,24 +25,9 @@ persistence:
mountPath: /tmp
{{- range $idx, $storage := .Values.piwiStorage.additionalStorages }}
{{ printf "piwi-%v" (int $idx) }}:
{{- $size := "" -}}
{{- if $storage.size -}}
{{- $size = (printf "%vGi" $storage.size) -}}
{{- end }}
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 "piwi.storage.ci.migration" (dict "storage" $storage) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }}
targetSelector:
piwigo:
piwigo:
@@ -53,9 +36,8 @@ persistence:
mariadbdata:
enabled: true
type: {{ .Values.piwiStorage.mariadbData.type }}
datasetName: {{ .Values.piwiStorage.mariadbData.datasetName | default "" }}
hostPath: {{ .Values.piwiStorage.mariadbData.hostPath | default "" }}
{{- include "piwi.storage.ci.migration" (dict "storage" .Values.piwiStorage.mariadbData) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.piwiStorage.mariadbData) | nindent 4 }}
targetSelector:
# MariaDB pod
mariadb:
@@ -67,9 +49,8 @@ persistence:
mountPath: /mnt/directories/mariadb_data
mariadbbackup:
enabled: true
type: {{ .Values.piwiStorage.mariadbBackup.type }}
datasetName: {{ .Values.piwiStorage.mariadbBackup.datasetName | default "" }}
hostPath: {{ .Values.piwiStorage.mariadbBackup.hostPath | default "" }}
{{- include "piwi.storage.ci.migration" (dict "storage" .Values.piwiStorage.mariadbBackup) }}
{{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.piwiStorage.mariadbBackup) | nindent 4 }}
targetSelector:
# MariaDB backup pod
mariadbbackup:
@@ -80,3 +61,13 @@ persistence:
permissions:
mountPath: /mnt/directories/mariadb_backup
{{- end -}}
{{/* TODO: Remove on the next version bump, eg 1.2.0+ */}}
{{- define "piwi.storage.ci.migration" -}}
{{- $storage := .storage -}}
{{- if $storage.hostPath -}}
{{- $_ := set $storage "hostPathConfig" dict -}}
{{- $_ := set $storage.hostPathConfig "hostPath" $storage.hostPath -}}
{{- end -}}
{{- end -}}

12
library/ix-dev/community/piwigo/values.yaml
View File

@@ -25,14 +25,18 @@ piwiID:
piwiStorage:
config:
type: ixVolume
datasetName: config
ixVolumeConfig:
datasetName: config
gallery:
type: ixVolume
datasetName: gallery
ixVolumeConfig:
datasetName: gallery
mariadbData:
type: ixVolume
datasetName: mariadbData
ixVolumeConfig:
datasetName: mariadbData
mariadbBackup:
type: ixVolume
datasetName: mariadbBackup
ixVolumeConfig:
datasetName: mariadbBackup
additionalStorages: []