From 33fac886ec019dee98511e9192071815f00a2c6b Mon Sep 17 00:00:00 2001 From: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Date: Thu, 4 Jan 2024 13:57:21 +0200 Subject: [PATCH] wordpress - migrate storage section (adds acl) (#1995) * update values * update template * bump version * update ui * add migration * dont wait backup dir to be consumed --- library/ix-dev/community/wordpress/Chart.yaml | 2 +- .../community/wordpress/ci/basic-values.yaml | 12 +- .../community/wordpress/ci/cron-values.yaml | 12 +- .../community/wordpress/migrations/migrate | 73 ++++ .../ix-dev/community/wordpress/questions.yaml | 358 +++++++++++++----- .../wordpress/templates/_persistence.tpl | 49 ++- .../ix-dev/community/wordpress/values.yaml | 9 +- 7 files changed, 386 insertions(+), 129 deletions(-) create mode 100755 library/ix-dev/community/wordpress/migrations/migrate diff --git a/library/ix-dev/community/wordpress/Chart.yaml b/library/ix-dev/community/wordpress/Chart.yaml index 628a2c0ec4..b85678ef14 100644 --- a/library/ix-dev/community/wordpress/Chart.yaml +++ b/library/ix-dev/community/wordpress/Chart.yaml @@ -3,7 +3,7 @@ description: Wordpress is a web content management system annotations: title: Wordpress type: application -version: 1.1.9 +version: 1.2.0 apiVersion: v2 appVersion: 6.4.2 kubeVersion: '>=1.16.0-0' diff --git a/library/ix-dev/community/wordpress/ci/basic-values.yaml b/library/ix-dev/community/wordpress/ci/basic-values.yaml index 25f5e4ec4c..d94c10bb33 100644 --- a/library/ix-dev/community/wordpress/ci/basic-values.yaml +++ b/library/ix-dev/community/wordpress/ci/basic-values.yaml @@ -1,10 +1,10 @@ wpStorage: data: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/data + type: pvc mariadbData: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/mariadbData + type: pvc mariadbBackup: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/mariadbBackup + type: emptyDir + emptyDirConfig: + medium: "" + size: "" diff --git a/library/ix-dev/community/wordpress/ci/cron-values.yaml b/library/ix-dev/community/wordpress/ci/cron-values.yaml index a595138e40..304f44de48 100644 --- a/library/ix-dev/community/wordpress/ci/cron-values.yaml +++ b/library/ix-dev/community/wordpress/ci/cron-values.yaml @@ -4,11 +4,11 @@ wpConfig: wpStorage: data: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/data + type: pvc mariadbData: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/mariadbData + type: pvc mariadbBackup: - type: hostPath - hostPath: /mnt/{{ .Release.Name }}/mariadbBackup + type: emptyDir + emptyDirConfig: + medium: "" + size: "" diff --git a/library/ix-dev/community/wordpress/migrations/migrate b/library/ix-dev/community/wordpress/migrations/migrate new file mode 100755 index 0000000000..e0f0bea2b0 --- /dev/null +++ b/library/ix-dev/community/wordpress/migrations/migrate @@ -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 = 'wpStorage' + storages = ['data', 'mariadbData', 'mariadbBackup'] + + 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/wordpress/questions.yaml b/library/ix-dev/community/wordpress/questions.yaml index 55653ba9ab..f10bac59c1 100644 --- a/library/ix-dev/community/wordpress/questions.yaml +++ b/library/ix-dev/community/wordpress/questions.yaml @@ -115,23 +115,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: 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: 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: mariadbData label: Wordpress MariaDB Data Storage description: The path to store Wordpress MariaDB Data. @@ -153,23 +194,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: mariadbData + 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 + # MariaDB 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: mariadbData + - 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 + # MariaDB 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]] + required: true + - variable: mariadbBackup label: Wordpress MariaDB Backup Storage description: The path to store Wordpress MariaDB Backup. @@ -191,23 +281,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: mariadbBackup + 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 + # MariaDB 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: mariadbBackup + - 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 + # MariaDB 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]] + required: true + - variable: additionalStorages label: Additional Storage description: Additional storage for Wordpress. @@ -238,74 +377,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 label: "" diff --git a/library/ix-dev/community/wordpress/templates/_persistence.tpl b/library/ix-dev/community/wordpress/templates/_persistence.tpl index 405d7af3f8..f02393809c 100644 --- a/library/ix-dev/community/wordpress/templates/_persistence.tpl +++ b/library/ix-dev/community/wordpress/templates/_persistence.tpl @@ -2,44 +2,33 @@ persistence: data: enabled: true - type: {{ .Values.wpStorage.data.type }} - datasetName: {{ .Values.wpStorage.data.datasetName | default "" }} - hostPath: {{ .Values.wpStorage.data.hostPath | default "" }} + {{- include "wp.storage.ci.migration" (dict "storage" .Values.wpStorage.data) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.wpStorage.data) | nindent 4 }} targetSelector: wordpress: wordpress: mountPath: /var/www/html + {{- if and (eq .Values.wpStorage.data.type "ixVolume") + (not (.Values.wpStorage.data.ixVolumeConfig | default dict).aclEnable) }} 01-permissions: mountPath: /mnt/directories/data + {{- end }} wordpress-cron: wordpress-cron: mountPath: /var/www/html {{- range $idx, $storage := .Values.wpStorage.additionalStorages }} {{ printf "wp-%v" (int $idx) }}: - {{- $size := "" -}} - {{- if $storage.size -}} - {{- $size = (printf "%vGi" $storage.size) -}} - {{- end }} 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 "wp.storage.ci.migration" (dict "storage" $storage) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }} targetSelector: wordpress: wordpress: mountPath: {{ $storage.mountPath }} + {{- if and (eq $storage.type "ixVolume") (not ($storage.ixVolumeConfig | default dict).aclEnable) }} 01-permissions: mountPath: /mnt/directories{{ $storage.mountPath }} + {{- end }} {{- end }} tmp: enabled: true @@ -57,9 +46,8 @@ persistence: mountPath: /var/run mariadbdata: enabled: true - type: {{ .Values.wpStorage.mariadbData.type }} - datasetName: {{ .Values.wpStorage.mariadbData.datasetName | default "" }} - hostPath: {{ .Values.wpStorage.mariadbData.hostPath | default "" }} + {{- include "wp.storage.ci.migration" (dict "storage" .Values.wpStorage.mariadbData) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.wpStorage.mariadbData) | nindent 4 }} targetSelector: # MariaDB pod mariadb: @@ -71,9 +59,8 @@ persistence: mountPath: /mnt/directories/mariadb_data mariadbbackup: enabled: true - type: {{ .Values.wpStorage.mariadbBackup.type }} - datasetName: {{ .Values.wpStorage.mariadbBackup.datasetName | default "" }} - hostPath: {{ .Values.wpStorage.mariadbBackup.hostPath | default "" }} + {{- include "wp.storage.ci.migration" (dict "storage" .Values.wpStorage.mariadbBackup) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" .Values.wpStorage.mariadbBackup) | nindent 4 }} targetSelector: # MariaDB backup pod mariadbbackup: @@ -84,3 +71,13 @@ persistence: permissions: mountPath: /mnt/directories/mariadb_backup {{- end -}} + +{{/* TODO: Remove on the next version bump, eg 1.2.0+ */}} +{{- define "wp.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/wordpress/values.yaml b/library/ix-dev/community/wordpress/values.yaml index 215ab82706..88b4f799af 100644 --- a/library/ix-dev/community/wordpress/values.yaml +++ b/library/ix-dev/community/wordpress/values.yaml @@ -19,11 +19,14 @@ wpNetwork: wpStorage: data: type: ixVolume - datasetName: data + ixVolumeConfig: + datasetName: data mariadbData: type: ixVolume - datasetName: mariadbData + ixVolumeConfig: + datasetName: mariadbData mariadbBackup: type: ixVolume - datasetName: mariadbBackup + ixVolumeConfig: + datasetName: mariadbBackup additionalStorages: []