diff --git a/library/ix-dev/community/firefly-iii/Chart.lock b/library/ix-dev/community/firefly-iii/Chart.lock index 910f0a7fa2..f0acbd4636 100644 --- a/library/ix-dev/community/firefly-iii/Chart.lock +++ b/library/ix-dev/community/firefly-iii/Chart.lock @@ -1,6 +1,6 @@ dependencies: - name: common repository: file://../../../common - version: 1.2.2 -digest: sha256:fb077cb81f6acecd5c9e6adc22a18e156f780cd78f27198cdb47810f95364b56 -generated: "2023-11-09T15:39:48.205306548+02:00" + version: 1.2.3 +digest: sha256:e6ff49b06bf5d4d159e505ae6d153f36cd46170bb519caf90462cd5caebfd0fb +generated: "2023-11-15T19:55:44.573696179+02:00" diff --git a/library/ix-dev/community/firefly-iii/Chart.yaml b/library/ix-dev/community/firefly-iii/Chart.yaml index 730ab0baf2..d2a5900eb8 100644 --- a/library/ix-dev/community/firefly-iii/Chart.yaml +++ b/library/ix-dev/community/firefly-iii/Chart.yaml @@ -3,7 +3,7 @@ description: Firefly III is a personal finances manager annotations: title: Firefly III type: application -version: 1.0.12 +version: 1.1.0 apiVersion: v2 appVersion: 6.0.30 kubeVersion: '>=1.16.0-0' @@ -14,7 +14,7 @@ maintainers: dependencies: - name: common repository: file://../../../common - version: 1.2.2 + version: 1.2.3 home: https://www.firefly-iii.org/ icon: https://media.sys.truenas.net/apps/firefly-iii/icons/icon.png sources: diff --git a/library/ix-dev/community/firefly-iii/charts/common-1.2.2.tgz b/library/ix-dev/community/firefly-iii/charts/common-1.2.2.tgz deleted file mode 100644 index e5b170983a..0000000000 Binary files a/library/ix-dev/community/firefly-iii/charts/common-1.2.2.tgz and /dev/null differ diff --git a/library/ix-dev/community/firefly-iii/charts/common-1.2.3.tgz b/library/ix-dev/community/firefly-iii/charts/common-1.2.3.tgz new file mode 100644 index 0000000000..43d3079b05 Binary files /dev/null and b/library/ix-dev/community/firefly-iii/charts/common-1.2.3.tgz differ diff --git a/library/ix-dev/community/firefly-iii/ci/basic-values.yaml b/library/ix-dev/community/firefly-iii/ci/basic-values.yaml index 2f7fe58c05..09721dfeaf 100644 --- a/library/ix-dev/community/firefly-iii/ci/basic-values.yaml +++ b/library/ix-dev/community/firefly-iii/ci/basic-values.yaml @@ -4,11 +4,8 @@ fireflyNetwork: fireflyStorage: uploads: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/uploads + type: pvc pgData: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/pgData + type: pvc pgBackup: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/pgBackup + type: emptyDir diff --git a/library/ix-dev/community/firefly-iii/ci/importer-values.yaml b/library/ix-dev/community/firefly-iii/ci/importer-values.yaml index c367a2c2e4..ea175db1a9 100644 --- a/library/ix-dev/community/firefly-iii/ci/importer-values.yaml +++ b/library/ix-dev/community/firefly-iii/ci/importer-values.yaml @@ -8,11 +8,8 @@ fireflyNetwork: fireflyStorage: uploads: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/uploads + type: pvc pgData: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/pgData + type: pvc pgBackup: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/pgBackup + type: emptyDir diff --git a/library/ix-dev/community/firefly-iii/migrations/migrate b/library/ix-dev/community/firefly-iii/migrations/migrate new file mode 100755 index 0000000000..caea93011f --- /dev/null +++ b/library/ix-dev/community/firefly-iii/migrations/migrate @@ -0,0 +1,54 @@ +#!/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': + # Fixes an invalid key carried from values.yaml + storage.pop('hostPath', None) + + # 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') + + for key in delete_keys: + storage.pop(key, None) + + return storage + + +def migrate(values): + storage_key = 'fireflyStorage' + storages = ['uploads', 'pgData', 'pgBackup'] + + 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) + + 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/firefly-iii/questions.yaml b/library/ix-dev/community/firefly-iii/questions.yaml index 7f36ffbb06..2f4c5599a1 100644 --- a/library/ix-dev/community/firefly-iii/questions.yaml +++ b/library/ix-dev/community/firefly-iii/questions.yaml @@ -148,24 +148,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: uploads $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: "uploads" + - variable: aclEntries + label: ACL Configuration + schema: + type: dict + show_if: [["aclEnable", "=", true]] + attrs: [] + - variable: hostPathConfig + label: hostPathConfig 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: pgData label: Firefly III Postgres Data Storage description: The path to store Firefly III Postgres Data. @@ -187,24 +228,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: pgData + 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 + # Postgres 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: "pgData" + - variable: aclEntries + label: ACL Configuration + schema: + type: dict + show_if: [["aclEnable", "=", true]] + attrs: [] + - variable: hostPathConfig + label: hostPathConfig 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 + # Postgres 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]] + immutable: true + required: true - variable: pgBackup label: Firefly III Postgres Backup Storage description: The path to store Firefly III Postgres Backup. @@ -226,24 +315,217 @@ 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: pgBackup + 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 + # Postgres 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: "pgBackup" + - variable: aclEntries + label: ACL Configuration + schema: + type: dict + show_if: [["aclEnable", "=", true]] + attrs: [] + - variable: hostPathConfig + label: hostPathConfig 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 + # Postgres 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]] + immutable: true + required: true + + - variable: additionalStorages + label: Additional Storage + description: Additional storage for Firefly III. + schema: + type: list + default: [] + items: + - variable: storageEntry + label: Storage Entry + schema: + type: dict + attrs: + - variable: type + label: Type + description: | + ixVolume: Is dataset created automatically by the system.
+ Host Path: Is a path that already exists on the system.
+ SMB Share: Is a SMB share that is mounted to a persistent volume claim. + schema: + type: string + required: true + default: "ixVolume" + immutable: true + enum: + - value: "hostPath" + description: Host Path (Path that already exists on the system) + - value: "ixVolume" + 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: hostPathConfig + label: hostPathConfig + schema: + type: dict + show_if: [["type", "=", "hostPath"]] + 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: dict + show_if: [["type", "=", "ixVolume"]] + $ref: + - "normalize/ixVolume" + 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: dict + show_if: [["type", "=", "smb-pv-pvc"]] + 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: "" diff --git a/library/ix-dev/community/firefly-iii/templates/_persistence.tpl b/library/ix-dev/community/firefly-iii/templates/_persistence.tpl index 12b227887e..3d43ed4302 100644 --- a/library/ix-dev/community/firefly-iii/templates/_persistence.tpl +++ b/library/ix-dev/community/firefly-iii/templates/_persistence.tpl @@ -2,9 +2,8 @@ persistence: uploads: enabled: true - type: {{ .Values.fireflyStorage.uploads.type }} - datasetName: {{ .Values.fireflyStorage.uploads.datasetName | default "" }} - hostPath: {{ .Values.fireflyStorage.uploads.hostPath | default "" }} + {{- include "firefly.storage.ci.migration" (dict "storage" .Values.fireflyStorage.uploads) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.fireflyStorage.uploads) | nindent 4 }} targetSelector: firefly: firefly: @@ -20,8 +19,30 @@ persistence: firefly-importer: mountPath: /tmp + {{- range $idx, $storage := .Values.fireflyStorage.additionalStorages }} + {{ printf "firefly-%v:" (int $idx) }} + enabled: true + {{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }} + targetSelector: + firefly: + firefly: + mountPath: {{ $storage.mountPath }} + {{- end }} + + {{- include "firefly.storage.ci.migration" (dict "storage" .Values.fireflyStorage.pgData) }} + {{- include "firefly.storage.ci.migration" (dict "storage" .Values.fireflyStorage.pgBackup) }} {{- include "ix.v1.common.app.postgresPersistence" (dict "pgData" .Values.fireflyStorage.pgData "pgBackup" .Values.fireflyStorage.pgBackup ) | nindent 2 }} {{- end -}} + +{{/* TODO: Remove on the next version bump, eg 1.1.0+ */}} +{{- define "firefly.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/firefly-iii/values.yaml b/library/ix-dev/community/firefly-iii/values.yaml index 789e89ae6e..2d3964b85d 100644 --- a/library/ix-dev/community/firefly-iii/values.yaml +++ b/library/ix-dev/community/firefly-iii/values.yaml @@ -27,13 +27,17 @@ fireflyNetwork: fireflyStorage: uploads: type: ixVolume - datasetName: uploads + ixVolumeConfig: + datasetName: uploads pgData: type: ixVolume - hostPath: pgData + ixVolumeConfig: + datasetName: pgData pgBackup: type: ixVolume - hostPath: pgBackup + ixVolumeConfig: + datasetName: pgBackup + additionalStorages: [] notes: