diff --git a/library/ix-dev/community/readarr/Chart.yaml b/library/ix-dev/community/readarr/Chart.yaml index ca3925974e..be551f8b17 100644 --- a/library/ix-dev/community/readarr/Chart.yaml +++ b/library/ix-dev/community/readarr/Chart.yaml @@ -4,7 +4,7 @@ description: Readarr is an ebook and audiobook collection manager for Usenet and annotations: title: Readarr type: application -version: 1.1.5 +version: 1.2.0 apiVersion: v2 appVersion: 0.3.11.2319 kubeVersion: '>=1.16.0-0' diff --git a/library/ix-dev/community/readarr/README.md b/library/ix-dev/community/readarr/README.md index 5cc2f44111..58a6a0bf67 100644 --- a/library/ix-dev/community/readarr/README.md +++ b/library/ix-dev/community/readarr/README.md @@ -1,8 +1,3 @@ # Readarr [Readarr](https://github.com/Readarr/Readarr) is an ebook and audiobook collection manager for Usenet and BitTorrent users. - -> When application is installed, a container will be launched with **root** privileges. -> This is required in order to apply the correct permissions to the `Readarr` directories. -> Afterward, the `Readarr` container will run as a **non**-root user (Default: `568`). -> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user. diff --git a/library/ix-dev/community/readarr/app-readme.md b/library/ix-dev/community/readarr/app-readme.md index 5cc2f44111..58a6a0bf67 100644 --- a/library/ix-dev/community/readarr/app-readme.md +++ b/library/ix-dev/community/readarr/app-readme.md @@ -1,8 +1,3 @@ # Readarr [Readarr](https://github.com/Readarr/Readarr) is an ebook and audiobook collection manager for Usenet and BitTorrent users. - -> When application is installed, a container will be launched with **root** privileges. -> This is required in order to apply the correct permissions to the `Readarr` directories. -> Afterward, the `Readarr` container will run as a **non**-root user (Default: `568`). -> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user. diff --git a/library/ix-dev/community/readarr/ci/basic-values.yaml b/library/ix-dev/community/readarr/ci/basic-values.yaml index d7a56366e6..eb31464f45 100644 --- a/library/ix-dev/community/readarr/ci/basic-values.yaml +++ b/library/ix-dev/community/readarr/ci/basic-values.yaml @@ -7,5 +7,4 @@ readarrRunAs: readarrStorage: config: - type: hostPath - hostPath: /mnt/{{ .Release.Namespace }}/config + type: pvc diff --git a/library/ix-dev/community/readarr/ci/extra-values.yaml b/library/ix-dev/community/readarr/ci/extra-values.yaml index cd011c60cb..dc6a4992a3 100644 --- a/library/ix-dev/community/readarr/ci/extra-values.yaml +++ b/library/ix-dev/community/readarr/ci/extra-values.yaml @@ -10,12 +10,9 @@ readarrNetwork: readarrStorage: config: - type: hostPath - hostPath: /mnt/{{ .Release.Namespace }}/config + type: pvc additionalStorages: - - type: hostPath - hostPath: /mnt/{{ .Release.Namespace }}/pop_music + - type: pvc mountPath: /pop_music - - type: hostPath - hostPath: /mnt/{{ .Release.Namespace }}/country_music + - type: pvc mountPath: /country_music diff --git a/library/ix-dev/community/readarr/ci/hostNet-values.yaml b/library/ix-dev/community/readarr/ci/hostNet-values.yaml index d05f6099bc..a8e6f9247f 100644 --- a/library/ix-dev/community/readarr/ci/hostNet-values.yaml +++ b/library/ix-dev/community/readarr/ci/hostNet-values.yaml @@ -4,5 +4,4 @@ readarrNetwork: readarrStorage: config: - type: hostPath - hostPath: /mnt/{{ .Release.Namespace }}/config + type: pvc diff --git a/library/ix-dev/community/readarr/migrations/migrate b/library/ix-dev/community/readarr/migrations/migrate new file mode 100755 index 0000000000..2c702b2963 --- /dev/null +++ b/library/ix-dev/community/readarr/migrations/migrate @@ -0,0 +1,77 @@ +#!/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') + + # Clean up for some older versions. + if storage.get('hostPath'): + delete_keys.append('hostPath') + + 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 = 'readarrStorage' + 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())))) diff --git a/library/ix-dev/community/readarr/questions.yaml b/library/ix-dev/community/readarr/questions.yaml index cc738b818d..fdac3bbdd2 100644 --- a/library/ix-dev/community/readarr/questions.yaml +++ b/library/ix-dev/community/readarr/questions.yaml @@ -130,24 +130,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]] + required: true + - variable: additionalStorages label: Additional Storage description: Additional storage for Readarr. @@ -178,74 +218,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 diff --git a/library/ix-dev/community/readarr/templates/_persistence.tpl b/library/ix-dev/community/readarr/templates/_persistence.tpl index 83fcecdc57..740a8e95dc 100644 --- a/library/ix-dev/community/readarr/templates/_persistence.tpl +++ b/library/ix-dev/community/readarr/templates/_persistence.tpl @@ -2,15 +2,16 @@ persistence: config: enabled: true - type: {{ .Values.readarrStorage.config.type }} - datasetName: {{ .Values.readarrStorage.config.datasetName | default "" }} - hostPath: {{ .Values.readarrStorage.config.hostPath | default "" }} + {{- include "readarr.storage.ci.migration" (dict "storage" .Values.readarrStorage.config) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.readarrStorage.config) | nindent 4 }} targetSelector: readarr: readarr: mountPath: /config + {{- if eq .Values.readarrStorage.config.type "ixVolume" }} 01-permissions: mountPath: /mnt/directories/config + {{- end }} tmp: enabled: true type: emptyDir @@ -19,30 +20,27 @@ persistence: readarr: mountPath: /tmp {{- range $idx, $storage := .Values.readarrStorage.additionalStorages }} - {{ printf "readarr-%v" (int $idx) }}: - {{- $size := "" -}} - {{- if $storage.size -}} - {{- $size = (printf "%vGi" $storage.size) -}} - {{- end }} + {{ printf "readarr-%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 "readarr.storage.ci.migration" (dict "storage" $storage) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }} targetSelector: readarr: readarr: mountPath: {{ $storage.mountPath }} + {{- if eq $storage.type "ixVolume" }} 01-permissions: mountPath: /mnt/directories{{ $storage.mountPath }} + {{- end }} {{- end }} {{- end -}} + +{{/* TODO: Remove on the next version bump, eg 1.2.0+ */}} +{{- define "readarr.storage.ci.migration" -}} + {{- $storage := .storage -}} + + {{- if $storage.hostPath -}} + {{- $_ := set $storage "hostPathConfig" dict -}} + {{- $_ := set $storage.hostPathConfig "hostPath" $storage.hostPath -}} + {{- end -}} +{{- end -}} diff --git a/library/ix-dev/community/readarr/templates/_readarr.tpl b/library/ix-dev/community/readarr/templates/_readarr.tpl index 9088a03642..379f8e2c00 100644 --- a/library/ix-dev/community/readarr/templates/_readarr.tpl +++ b/library/ix-dev/community/readarr/templates/_readarr.tpl @@ -45,5 +45,5 @@ workload: "UID" .Values.readarrRunAs.user "GID" .Values.readarrRunAs.group "mode" "check" - "type" "init") | nindent 8 }} + "type" "install") | nindent 8 }} {{- end -}} diff --git a/library/ix-dev/community/readarr/values.yaml b/library/ix-dev/community/readarr/values.yaml index dfe7107a29..d91750206c 100644 --- a/library/ix-dev/community/readarr/values.yaml +++ b/library/ix-dev/community/readarr/values.yaml @@ -20,5 +20,6 @@ readarrRunAs: readarrStorage: config: type: ixVolume - datasetName: config + ixVolumeConfig: + datasetName: config additionalStorages: []