From 24dd5cf00310f989bfeccdbfadd4d97da446cca4 Mon Sep 17 00:00:00 2001 From: sonicaj Date: Sun, 3 Dec 2023 20:03:28 +0000 Subject: [PATCH] Publish new changes in catalog --- community/qbittorrent/1.1.4/README.md | 7 - community/qbittorrent/1.1.4/app-readme.md | 7 - .../qbittorrent/1.1.4/migrations/migrate | 29 -- .../qbittorrent/{1.1.4 => 1.2.0}/Chart.lock | 0 .../qbittorrent/{1.1.4 => 1.2.0}/Chart.yaml | 2 +- community/qbittorrent/1.2.0/README.md | 3 + community/qbittorrent/1.2.0/app-readme.md | 3 + .../{1.1.4 => 1.2.0}/charts/common-1.2.3.tgz | Bin .../{1.1.4 => 1.2.0}/ci/basic-values.yaml | 0 .../{1.1.4 => 1.2.0}/ci/extra-values.yaml | 0 .../{1.1.4 => 1.2.0}/ci/hostNet-values.yaml | 0 .../{1.1.4 => 1.2.0}/ix_values.yaml | 13 +- .../{1.1.4 => 1.2.0}/metadata.yaml | 0 .../qbittorrent/1.2.0/migrations/migrate | 77 +++++ .../{1.1.4 => 1.2.0}/questions.yaml | 284 +++++++++++++----- .../{1.1.4 => 1.2.0}/templates/NOTES.txt | 0 .../templates/_configuration.tpl | 0 .../{1.1.4 => 1.2.0}/templates/_portal.tpl | 0 .../templates/_qbittorrent.tpl | 53 ++-- .../{1.1.4 => 1.2.0}/templates/common.yaml | 0 20 files changed, 315 insertions(+), 163 deletions(-) delete mode 100644 community/qbittorrent/1.1.4/README.md delete mode 100644 community/qbittorrent/1.1.4/app-readme.md delete mode 100755 community/qbittorrent/1.1.4/migrations/migrate rename community/qbittorrent/{1.1.4 => 1.2.0}/Chart.lock (100%) rename community/qbittorrent/{1.1.4 => 1.2.0}/Chart.yaml (98%) create mode 100644 community/qbittorrent/1.2.0/README.md create mode 100644 community/qbittorrent/1.2.0/app-readme.md rename community/qbittorrent/{1.1.4 => 1.2.0}/charts/common-1.2.3.tgz (100%) rename community/qbittorrent/{1.1.4 => 1.2.0}/ci/basic-values.yaml (100%) rename community/qbittorrent/{1.1.4 => 1.2.0}/ci/extra-values.yaml (100%) rename community/qbittorrent/{1.1.4 => 1.2.0}/ci/hostNet-values.yaml (100%) rename community/qbittorrent/{1.1.4 => 1.2.0}/ix_values.yaml (70%) rename community/qbittorrent/{1.1.4 => 1.2.0}/metadata.yaml (100%) create mode 100755 community/qbittorrent/1.2.0/migrations/migrate rename community/qbittorrent/{1.1.4 => 1.2.0}/questions.yaml (53%) rename community/qbittorrent/{1.1.4 => 1.2.0}/templates/NOTES.txt (100%) rename community/qbittorrent/{1.1.4 => 1.2.0}/templates/_configuration.tpl (100%) rename community/qbittorrent/{1.1.4 => 1.2.0}/templates/_portal.tpl (100%) rename community/qbittorrent/{1.1.4 => 1.2.0}/templates/_qbittorrent.tpl (59%) rename community/qbittorrent/{1.1.4 => 1.2.0}/templates/common.yaml (100%) diff --git a/community/qbittorrent/1.1.4/README.md b/community/qbittorrent/1.1.4/README.md deleted file mode 100644 index a5cbcbd098..0000000000 --- a/community/qbittorrent/1.1.4/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# qBittorrent - -The [qBittorrent](https://www.qbittorrent.org/) project aims to provide an open-source software alternative to µTorrent. - -> When application is installed, a container will be launched with **root** privileges. -> This is required in order to apply the correct permissions to the qBittorrent directories. -> Afterward, the `qBittorrent` container will run as a **non**-root user (Default: `568`). diff --git a/community/qbittorrent/1.1.4/app-readme.md b/community/qbittorrent/1.1.4/app-readme.md deleted file mode 100644 index a5cbcbd098..0000000000 --- a/community/qbittorrent/1.1.4/app-readme.md +++ /dev/null @@ -1,7 +0,0 @@ -# qBittorrent - -The [qBittorrent](https://www.qbittorrent.org/) project aims to provide an open-source software alternative to µTorrent. - -> When application is installed, a container will be launched with **root** privileges. -> This is required in order to apply the correct permissions to the qBittorrent directories. -> Afterward, the `qBittorrent` container will run as a **non**-root user (Default: `568`). diff --git a/community/qbittorrent/1.1.4/migrations/migrate b/community/qbittorrent/1.1.4/migrations/migrate deleted file mode 100755 index 7b8becda5d..0000000000 --- a/community/qbittorrent/1.1.4/migrations/migrate +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/bin/python3 -import json -import os -import sys - - -def migrate(values): - storageKey = 'qbitStorage' - storages = ['downloads', 'config'] - - - 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 - - values[storageKey][storage] = {key: value for key, value in check_val.items() if key != 'hostPath'} - - - 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/community/qbittorrent/1.1.4/Chart.lock b/community/qbittorrent/1.2.0/Chart.lock similarity index 100% rename from community/qbittorrent/1.1.4/Chart.lock rename to community/qbittorrent/1.2.0/Chart.lock diff --git a/community/qbittorrent/1.1.4/Chart.yaml b/community/qbittorrent/1.2.0/Chart.yaml similarity index 98% rename from community/qbittorrent/1.1.4/Chart.yaml rename to community/qbittorrent/1.2.0/Chart.yaml index 228222ed00..4c6fdc5a11 100644 --- a/community/qbittorrent/1.1.4/Chart.yaml +++ b/community/qbittorrent/1.2.0/Chart.yaml @@ -4,7 +4,7 @@ description: The qBittorrent project aims to provide an open-source software alt annotations: title: qBittorrent type: application -version: 1.1.4 +version: 1.2.0 apiVersion: v2 appVersion: 4.6.2 kubeVersion: '>=1.16.0-0' diff --git a/community/qbittorrent/1.2.0/README.md b/community/qbittorrent/1.2.0/README.md new file mode 100644 index 0000000000..3552b02a3f --- /dev/null +++ b/community/qbittorrent/1.2.0/README.md @@ -0,0 +1,3 @@ +# qBittorrent + +The [qBittorrent](https://www.qbittorrent.org/) project aims to provide an open-source software alternative to µTorrent. diff --git a/community/qbittorrent/1.2.0/app-readme.md b/community/qbittorrent/1.2.0/app-readme.md new file mode 100644 index 0000000000..3552b02a3f --- /dev/null +++ b/community/qbittorrent/1.2.0/app-readme.md @@ -0,0 +1,3 @@ +# qBittorrent + +The [qBittorrent](https://www.qbittorrent.org/) project aims to provide an open-source software alternative to µTorrent. diff --git a/community/qbittorrent/1.1.4/charts/common-1.2.3.tgz b/community/qbittorrent/1.2.0/charts/common-1.2.3.tgz similarity index 100% rename from community/qbittorrent/1.1.4/charts/common-1.2.3.tgz rename to community/qbittorrent/1.2.0/charts/common-1.2.3.tgz diff --git a/community/qbittorrent/1.1.4/ci/basic-values.yaml b/community/qbittorrent/1.2.0/ci/basic-values.yaml similarity index 100% rename from community/qbittorrent/1.1.4/ci/basic-values.yaml rename to community/qbittorrent/1.2.0/ci/basic-values.yaml diff --git a/community/qbittorrent/1.1.4/ci/extra-values.yaml b/community/qbittorrent/1.2.0/ci/extra-values.yaml similarity index 100% rename from community/qbittorrent/1.1.4/ci/extra-values.yaml rename to community/qbittorrent/1.2.0/ci/extra-values.yaml diff --git a/community/qbittorrent/1.1.4/ci/hostNet-values.yaml b/community/qbittorrent/1.2.0/ci/hostNet-values.yaml similarity index 100% rename from community/qbittorrent/1.1.4/ci/hostNet-values.yaml rename to community/qbittorrent/1.2.0/ci/hostNet-values.yaml diff --git a/community/qbittorrent/1.1.4/ix_values.yaml b/community/qbittorrent/1.2.0/ix_values.yaml similarity index 70% rename from community/qbittorrent/1.1.4/ix_values.yaml rename to community/qbittorrent/1.2.0/ix_values.yaml index 0ab9dd867a..3a7a3f297b 100644 --- a/community/qbittorrent/1.1.4/ix_values.yaml +++ b/community/qbittorrent/1.2.0/ix_values.yaml @@ -10,24 +10,27 @@ resources: qbitConfig: additionalEnvs: [] + qbitNetwork: webPort: 30024 btPort: 50413 hostNetwork: false + qbitRunAs: user: 568 group: 568 + qbitStorage: downloads: type: ixVolume - datasetName: downloads + ixVolumeConfig: + datasetName: downloads config: type: ixVolume - datasetName: config + ixVolumeConfig: + datasetName: config additionalStorages: [] notes: custom: | - Default credentials: - - username: admin - - password: adminadmin + Default credentials are auto-generated and printed on the logs. diff --git a/community/qbittorrent/1.1.4/metadata.yaml b/community/qbittorrent/1.2.0/metadata.yaml similarity index 100% rename from community/qbittorrent/1.1.4/metadata.yaml rename to community/qbittorrent/1.2.0/metadata.yaml diff --git a/community/qbittorrent/1.2.0/migrations/migrate b/community/qbittorrent/1.2.0/migrations/migrate new file mode 100755 index 0000000000..f3984fe15e --- /dev/null +++ b/community/qbittorrent/1.2.0/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 = 'qbitStorage' + storages = ['downloads', '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/community/qbittorrent/1.1.4/questions.yaml b/community/qbittorrent/1.2.0/questions.yaml similarity index 53% rename from community/qbittorrent/1.1.4/questions.yaml rename to community/qbittorrent/1.2.0/questions.yaml index 7f2f4b30ad..a9711a5b22 100644 --- a/community/qbittorrent/1.1.4/questions.yaml +++ b/community/qbittorrent/1.2.0/questions.yaml @@ -132,24 +132,65 @@ 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: downloads $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: "downloads" + - 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: config label: qBittorrent Config Storage description: The path to store qBittorrent Configuration. @@ -171,24 +212,65 @@ 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: additionalStorages label: Additional Storage description: qBittorrent additional storage @@ -219,74 +301,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 label: Resources Configuration diff --git a/community/qbittorrent/1.1.4/templates/NOTES.txt b/community/qbittorrent/1.2.0/templates/NOTES.txt similarity index 100% rename from community/qbittorrent/1.1.4/templates/NOTES.txt rename to community/qbittorrent/1.2.0/templates/NOTES.txt diff --git a/community/qbittorrent/1.1.4/templates/_configuration.tpl b/community/qbittorrent/1.2.0/templates/_configuration.tpl similarity index 100% rename from community/qbittorrent/1.1.4/templates/_configuration.tpl rename to community/qbittorrent/1.2.0/templates/_configuration.tpl diff --git a/community/qbittorrent/1.1.4/templates/_portal.tpl b/community/qbittorrent/1.2.0/templates/_portal.tpl similarity index 100% rename from community/qbittorrent/1.1.4/templates/_portal.tpl rename to community/qbittorrent/1.2.0/templates/_portal.tpl diff --git a/community/qbittorrent/1.1.4/templates/_qbittorrent.tpl b/community/qbittorrent/1.2.0/templates/_qbittorrent.tpl similarity index 59% rename from community/qbittorrent/1.1.4/templates/_qbittorrent.tpl rename to community/qbittorrent/1.2.0/templates/_qbittorrent.tpl index 59d19b2f60..b017bed3d2 100644 --- a/community/qbittorrent/1.1.4/templates/_qbittorrent.tpl +++ b/community/qbittorrent/1.2.0/templates/_qbittorrent.tpl @@ -40,12 +40,6 @@ workload: type: http port: "{{ .Values.qbitNetwork.webPort }}" path: / - initContainers: - {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions" - "UID" .Values.qbitRunAs.user - "GID" .Values.qbitRunAs.group - "mode" "check" - "type" "init") | nindent 8 }} {{/* Service */}} service: @@ -84,51 +78,38 @@ service: persistence: config: enabled: true - type: {{ .Values.qbitStorage.config.type }} - datasetName: {{ .Values.qbitStorage.config.datasetName | default "" }} - hostPath: {{ .Values.qbitStorage.config.hostPath | default "" }} + {{- include "qbit.storage.ci.migration" (dict "storage" .Values.qbitStorage.config) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.qbitStorage.config) | nindent 4 }} targetSelector: qbittorrent: qbittorrent: mountPath: /config - 01-permissions: - mountPath: /mnt/directories/config downloads: enabled: true - type: {{ .Values.qbitStorage.downloads.type }} - datasetName: {{ .Values.qbitStorage.downloads.datasetName | default "" }} - hostPath: {{ .Values.qbitStorage.downloads.hostPath | default "" }} + {{- include "qbit.storage.ci.migration" (dict "storage" .Values.qbitStorage.downloads) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.qbitStorage.downloads) | nindent 4 }} targetSelector: qbittorrent: qbittorrent: mountPath: /downloads - 01-permissions: - mountPath: /mnt/directories/downloads {{- range $idx, $storage := .Values.qbitStorage.additionalStorages }} - {{ printf "qbittorrent-%v" (int $idx) }}: - {{- $size := "" -}} - {{- if $storage.size -}} - {{- $size = (printf "%vGi" $storage.size) -}} - {{- end }} + {{ printf "qbittorrent-%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 "qbit.storage.ci.migration" (dict "storage" $storage) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }} targetSelector: qbittorrent: qbittorrent: mountPath: {{ $storage.mountPath }} - 01-permissions: - mountPath: /mnt/directories/{{ printf "qbittorrent-%v" (int $idx) }} {{- end }} {{- end -}} + +{{/* TODO: Remove on the next version bump, eg 1.2.0+ */}} +{{- define "qbit.storage.ci.migration" -}} + {{- $storage := .storage -}} + + {{- if $storage.hostPath -}} + {{- $_ := set $storage "hostPathConfig" dict -}} + {{- $_ := set $storage.hostPathConfig "hostPath" $storage.hostPath -}} + {{- end -}} +{{- end -}} diff --git a/community/qbittorrent/1.1.4/templates/common.yaml b/community/qbittorrent/1.2.0/templates/common.yaml similarity index 100% rename from community/qbittorrent/1.1.4/templates/common.yaml rename to community/qbittorrent/1.2.0/templates/common.yaml