Skip to content

Commit

Permalink
Kavita - migrates storage section (adds acl) (#1913)
Browse files Browse the repository at this point in the history
* bump version

* update values

* update templates

* update ui

* add migration
  • Loading branch information
stavros-k authored Dec 20, 2023
1 parent a1667da commit f4d1cf3
Show file tree
Hide file tree
Showing 9 changed files with 246 additions and 97 deletions.
2 changes: 1 addition & 1 deletion library/ix-dev/community/kavita/Chart.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ dependencies:
repository: file://../../../common
version: 1.2.5
digest: sha256:39d574b4c1141e20a63afd62dffdde37efe60a89e00e38111b35a53b34103bb1
generated: "2023-12-19T17:27:36.516747616+02:00"
generated: "2023-12-19T18:30:36.238049067+02:00"
2 changes: 1 addition & 1 deletion library/ix-dev/community/kavita/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: Kavita is a fast, feature rich, cross platform reading server.
annotations:
title: Kavita
type: application
version: 1.1.7
version: 1.2.0
apiVersion: v2
appVersion: 0.7.11
kubeVersion: '>=1.16.0-0'
Expand Down
Binary file modified library/ix-dev/community/kavita/charts/common-1.2.5.tgz
Binary file not shown.
3 changes: 1 addition & 2 deletions library/ix-dev/community/kavita/ci/basic-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ kavitaNetwork:

kavitaStorage:
config:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/config
type: pvc
9 changes: 3 additions & 6 deletions library/ix-dev/community/kavita/ci/extra-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,9 @@ kavitaNetwork:

kavitaStorage:
config:
type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/config
type: pvc
additionalStorages:
- type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/manga
- type: pvc
mountPath: /manga
- type: hostPath
hostPath: /mnt/{{ .Release.Namespace }}/comic
- type: pvc
mountPath: /comic
73 changes: 73 additions & 0 deletions library/ix-dev/community/kavita/migrations/migrate
Original file line number Diff line number Diff line change
@@ -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 = 'kavitaStorage'
storages = ['config']

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()))))
215 changes: 150 additions & 65 deletions library/ix-dev/community/kavita/questions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -101,23 +101,63 @@ 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: additionalStorages
label: Additional Storage
Expand Down Expand Up @@ -149,74 +189,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
group: Resources Configuration
Expand Down
Loading

0 comments on commit f4d1cf3

Please sign in to comment.