diff --git a/library/ix-dev/community/odoo/Chart.lock b/library/ix-dev/community/odoo/Chart.lock index 6e4f09c579..8c4f99b5ae 100644 --- a/library/ix-dev/community/odoo/Chart.lock +++ b/library/ix-dev/community/odoo/Chart.lock @@ -1,6 +1,6 @@ dependencies: - name: common repository: file://../../../common - version: 1.2.2 -digest: sha256:fb077cb81f6acecd5c9e6adc22a18e156f780cd78f27198cdb47810f95364b56 -generated: "2023-11-09T15:42:20.921603595+02:00" + version: 1.2.3 +digest: sha256:e6ff49b06bf5d4d159e505ae6d153f36cd46170bb519caf90462cd5caebfd0fb +generated: "2023-11-15T18:40:05.852239091+02:00" diff --git a/library/ix-dev/community/odoo/Chart.yaml b/library/ix-dev/community/odoo/Chart.yaml index 4e3edb06b2..5fa297e1d1 100644 --- a/library/ix-dev/community/odoo/Chart.yaml +++ b/library/ix-dev/community/odoo/Chart.yaml @@ -3,7 +3,7 @@ description: Odoo is a suite of web based open source business apps. annotations: title: Odoo type: application -version: 1.0.4 +version: 1.1.0 apiVersion: v2 appVersion: '16.0' 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.odoo.com/ icon: https://media.sys.truenas.net/apps/odoo/icons/icon.png sources: diff --git a/library/ix-dev/community/odoo/README.md b/library/ix-dev/community/odoo/README.md index e0c8e7edd0..a80fed1100 100644 --- a/library/ix-dev/community/odoo/README.md +++ b/library/ix-dev/community/odoo/README.md @@ -3,10 +3,9 @@ [Odoo](https://odoo.com) is a suite of web based open source business apps. > When application is installed, a container will be launched with **root** privileges. -> This is required in order to apply the correct permissions to the `odoo` directories. -> Afterward, the `odoo` container will run as a **non**-root user (`101`). -> Same applies to the `postgres` container. This will run afterwards as a **non**-root user (`999`). +> This is required in order to apply the correct permissions to the `postgres` directories. +> Afterwards `postgres` will run afterwards as a **non**-root user (`999`). > On each upgrade, a container will be launched with **root** privileges in order to apply the correct > permissions to the `postgres` **backups** directory. Container that performs the backup will run as a **non**-root user (`999`) afterwards. > Keep in mind the permissions on the backup directory will be changed to `999:999` on **every** update. -> But will only be changed once for the `odoo` and `postgres` data directories. +> But will only be changed once for the `postgres` data directories. diff --git a/library/ix-dev/community/odoo/app-readme.md b/library/ix-dev/community/odoo/app-readme.md index e0c8e7edd0..a80fed1100 100644 --- a/library/ix-dev/community/odoo/app-readme.md +++ b/library/ix-dev/community/odoo/app-readme.md @@ -3,10 +3,9 @@ [Odoo](https://odoo.com) is a suite of web based open source business apps. > When application is installed, a container will be launched with **root** privileges. -> This is required in order to apply the correct permissions to the `odoo` directories. -> Afterward, the `odoo` container will run as a **non**-root user (`101`). -> Same applies to the `postgres` container. This will run afterwards as a **non**-root user (`999`). +> This is required in order to apply the correct permissions to the `postgres` directories. +> Afterwards `postgres` will run afterwards as a **non**-root user (`999`). > On each upgrade, a container will be launched with **root** privileges in order to apply the correct > permissions to the `postgres` **backups** directory. Container that performs the backup will run as a **non**-root user (`999`) afterwards. > Keep in mind the permissions on the backup directory will be changed to `999:999` on **every** update. -> But will only be changed once for the `odoo` and `postgres` data directories. +> But will only be changed once for the `postgres` data directories. diff --git a/library/ix-dev/community/odoo/charts/common-1.2.2.tgz b/library/ix-dev/community/odoo/charts/common-1.2.2.tgz deleted file mode 100644 index 209fa89453..0000000000 Binary files a/library/ix-dev/community/odoo/charts/common-1.2.2.tgz and /dev/null differ diff --git a/library/ix-dev/community/odoo/charts/common-1.2.3.tgz b/library/ix-dev/community/odoo/charts/common-1.2.3.tgz new file mode 100644 index 0000000000..d1d4036f5c Binary files /dev/null and b/library/ix-dev/community/odoo/charts/common-1.2.3.tgz differ diff --git a/library/ix-dev/community/odoo/ci/basic-values.yaml b/library/ix-dev/community/odoo/ci/basic-values.yaml index 44c171ce34..b8237e4249 100644 --- a/library/ix-dev/community/odoo/ci/basic-values.yaml +++ b/library/ix-dev/community/odoo/ci/basic-values.yaml @@ -3,14 +3,10 @@ odooNetwork: odooStorage: data: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/data + type: pvc addons: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/addons + 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/odoo/ci/extra-values.yaml b/library/ix-dev/community/odoo/ci/extra-values.yaml index c1259b052f..b9b03c3dca 100644 --- a/library/ix-dev/community/odoo/ci/extra-values.yaml +++ b/library/ix-dev/community/odoo/ci/extra-values.yaml @@ -10,14 +10,10 @@ odooConfig: odooStorage: data: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/data + type: pvc addons: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/addons + 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/odoo/migrations/migrate b/library/ix-dev/community/odoo/migrations/migrate new file mode 100755 index 0000000000..ceb9dcafe1 --- /dev/null +++ b/library/ix-dev/community/odoo/migrations/migrate @@ -0,0 +1,51 @@ +#!/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') + + for key in delete_keys: + storage.pop(key, None) + + return storage + + +def migrate(values): + storage_key = 'odooStorage' + storages = ['data', 'addons', '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/odoo/questions.yaml b/library/ix-dev/community/odoo/questions.yaml index 003545fb64..879009f692 100644 --- a/library/ix-dev/community/odoo/questions.yaml +++ b/library/ix-dev/community/odoo/questions.yaml @@ -124,24 +124,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: data $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: "data" + - 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: addons label: Odoo Addons Storage description: The path to store Odoo addons storage. @@ -163,24 +204,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: addons $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: "addons" + - 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: Odoo Postgres Data Storage description: The path to store Odoo Postgres Data. @@ -202,24 +284,73 @@ 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: Odoo Postgres Backup Storage description: The path to store Odoo Postgres Backup. @@ -241,24 +372,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 Odoo. + 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/odoo/templates/_odoo.tpl b/library/ix-dev/community/odoo/templates/_odoo.tpl index 1086ad69bc..9e9a5f76d5 100644 --- a/library/ix-dev/community/odoo/templates/_odoo.tpl +++ b/library/ix-dev/community/odoo/templates/_odoo.tpl @@ -40,14 +40,10 @@ workload: path: /web/health port: {{ .Values.odooNetwork.webPort }} initContainers: - {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions" - "UID" 101 - "GID" 101 - "type" "install") | nindent 8 }} - {{- include "ix.v1.common.app.postgresWait" (dict "name" "02-postgres-wait" + {{- include "ix.v1.common.app.postgresWait" (dict "name" "01-postgres-wait" "secretName" "postgres-creds") | nindent 8 }} {{- if .Release.IsInstall }} {{/* If we use type: install it will run before the postgres wait and fail */}} - 03-db-init: + 02-db-init: enabled: true type: init imageSelector: image diff --git a/library/ix-dev/community/odoo/templates/_persistence.tpl b/library/ix-dev/community/odoo/templates/_persistence.tpl index eeea0e552e..1fcc1933b2 100644 --- a/library/ix-dev/community/odoo/templates/_persistence.tpl +++ b/library/ix-dev/community/odoo/templates/_persistence.tpl @@ -2,29 +2,23 @@ persistence: data: enabled: true - type: {{ .Values.odooStorage.data.type }} - datasetName: {{ .Values.odooStorage.data.datasetName | default "" }} - hostPath: {{ .Values.odooStorage.data.hostPath | default "" }} + {{- include "odoo.storage.ci.migration" (dict "storage" .Values.odooStorage.data) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.odooStorage.data) | nindent 4 }} targetSelector: odoo: odoo: mountPath: /var/lib/odoo - 01-permissions: - mountPath: /mnt/directories/odoo_data - 03-db-init: + 02-db-init: mountPath: /var/lib/odoo addons: enabled: true - type: {{ .Values.odooStorage.addons.type }} - datasetName: {{ .Values.odooStorage.addons.datasetName | default "" }} - hostPath: {{ .Values.odooStorage.addons.hostPath | default "" }} + {{- include "odoo.storage.ci.migration" (dict "storage" .Values.odooStorage.addons) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.odooStorage.addons) | nindent 4 }} targetSelector: odoo: odoo: mountPath: /mnt/extra-addons - 01-permissions: - mountPath: /mnt/directories/odoo_addons - 03-db-init: + 02-db-init: mountPath: /mnt/extra-addons tmp: enabled: true @@ -33,7 +27,7 @@ persistence: odoo: odoo: mountPath: /tmp - 03-db-init: + 02-db-init: mountPath: /tmp config: @@ -46,13 +40,36 @@ persistence: mountPath: /etc/odoo/odoo.conf readOnly: true subPath: odoo.conf - 03-db-init: + 02-db-init: mountPath: /etc/odoo/odoo.conf readOnly: true subPath: odoo.conf + {{- range $idx, $storage := .Values.odooStorage.additionalStorages }} + {{ printf "odoo-%v:" (int $idx) }} + enabled: true + {{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }} + targetSelector: + odoo: + odoo: + mountPath: {{ $storage.mountPath }} + {{- end }} + + {{- include "odoo.storage.ci.migration" (dict "storage" .Values.odooStorage.pgData) }} + {{- include "odoo.storage.ci.migration" (dict "storage" .Values.odooStorage.pgBackup) }} {{- include "ix.v1.common.app.postgresPersistence" (dict "pgData" .Values.odooStorage.pgData "pgBackup" .Values.odooStorage.pgBackup ) | nindent 2 }} {{- end -}} + + +{{/* TODO: Remove on the next version bump, eg 1.1.0+ */}} +{{- define "odoo.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/odoo/values.yaml b/library/ix-dev/community/odoo/values.yaml index 405f1937b0..94df63a11b 100644 --- a/library/ix-dev/community/odoo/values.yaml +++ b/library/ix-dev/community/odoo/values.yaml @@ -19,16 +19,21 @@ odooNetwork: odooStorage: data: type: ixVolume - datasetName: data + ixVolumeConfig: + datasetName: data addons: type: ixVolume - datasetName: addons + ixVolumeConfig: + datasetName: addons pgData: type: ixVolume - datasetName: pgData + ixVolumeConfig: + datasetName: pgData pgBackup: type: ixVolume - datasetName: pgBackup + ixVolumeConfig: + datasetName: pgBackup + additionalStorages: [] notes: custom: |