From aaac90fbff3951ce2887635d709a51f5f931a9b5 Mon Sep 17 00:00:00 2001 From: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Date: Sun, 24 Dec 2023 23:08:01 +0200 Subject: [PATCH] Cloudflared - migrate storage section (#1939) * update ui * add migration * update values * update templates * bumpv ersion * whops --- .../ix-dev/community/cloudflared/Chart.yaml | 2 +- .../cloudflared/ci/hostNet-values.yaml | 3 +- .../community/cloudflared/migrations/migrate | 65 ++++++++ .../community/cloudflared/questions.yaml | 153 +++++++++++------- .../cloudflared/templates/_cloudflared.tpl | 6 + .../cloudflared/templates/_persistance.tpl | 35 ++-- 6 files changed, 189 insertions(+), 75 deletions(-) create mode 100755 library/ix-dev/community/cloudflared/migrations/migrate diff --git a/library/ix-dev/community/cloudflared/Chart.yaml b/library/ix-dev/community/cloudflared/Chart.yaml index c51fdf71a9..1a67855023 100644 --- a/library/ix-dev/community/cloudflared/Chart.yaml +++ b/library/ix-dev/community/cloudflared/Chart.yaml @@ -3,7 +3,7 @@ description: Cloudflared is a client for Cloudflare Tunnel, a daemon that expose annotations: title: Cloudflared type: application -version: 1.1.6 +version: 1.2.0 apiVersion: v2 appVersion: 2023.10.0 kubeVersion: '>=1.16.0-0' diff --git a/library/ix-dev/community/cloudflared/ci/hostNet-values.yaml b/library/ix-dev/community/cloudflared/ci/hostNet-values.yaml index 27f6102b88..8af70132f1 100644 --- a/library/ix-dev/community/cloudflared/ci/hostNet-values.yaml +++ b/library/ix-dev/community/cloudflared/ci/hostNet-values.yaml @@ -3,8 +3,7 @@ cloudflaredNetwork: cloudflaredStorage: additionalStorages: - - type: hostPath - hostPath: /mnt/{{ .Release.Namespace }}/data1 + - type: pvc mountPath: /data1 cloudflaredConfig: diff --git a/library/ix-dev/community/cloudflared/migrations/migrate b/library/ix-dev/community/cloudflared/migrations/migrate new file mode 100755 index 0000000000..eadaba7f5e --- /dev/null +++ b/library/ix-dev/community/cloudflared/migrations/migrate @@ -0,0 +1,65 @@ +#!/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 = 'cloudflaredStorage' + + 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/cloudflared/questions.yaml b/library/ix-dev/community/cloudflared/questions.yaml index 9f18318cbd..d8b08a2078 100644 --- a/library/ix-dev/community/cloudflared/questions.yaml +++ b/library/ix-dev/community/cloudflared/questions.yaml @@ -138,74 +138,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/cloudflared/templates/_cloudflared.tpl b/library/ix-dev/community/cloudflared/templates/_cloudflared.tpl index a03966630b..7db6178472 100644 --- a/library/ix-dev/community/cloudflared/templates/_cloudflared.tpl +++ b/library/ix-dev/community/cloudflared/templates/_cloudflared.tpl @@ -52,4 +52,10 @@ workload: enabled: false startup: enabled: false + initContainers: + {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions" + "UID" .Values.cloudflaredRunAs.user + "GID" .Values.cloudflaredRunAs.group + "mode" "check" + "type" "install") | nindent 8 }} {{- end -}} diff --git a/library/ix-dev/community/cloudflared/templates/_persistance.tpl b/library/ix-dev/community/cloudflared/templates/_persistance.tpl index 7fa83eb5b3..f3d1efd74a 100644 --- a/library/ix-dev/community/cloudflared/templates/_persistance.tpl +++ b/library/ix-dev/community/cloudflared/templates/_persistance.tpl @@ -1,28 +1,27 @@ {{- define "cloudflared.persistence" -}} persistence: {{- range $idx, $storage := .Values.cloudflaredStorage.additionalStorages }} - {{ printf "cloudflared-%v" (int $idx) }}: - {{- $size := "" -}} - {{- if $storage.size -}} - {{- $size = (printf "%vGi" $storage.size) -}} - {{- end }} + {{ printf "cloudflared-%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 "cloudflared.storage.ci.migration" (dict "storage" $storage) }} + {{- include "ix.v1.common.app.storageOptions" (dict "storage" $storage) | nindent 4 }} targetSelector: cloudflared: cloudflared: mountPath: {{ $storage.mountPath }} + {{- if and (eq $storage.type "ixVolume") (not ($storage.ixVolumeConfig | default dict).aclEnable) }} + 01-permissions: + mountPath: /mnt/directories{{ $storage.mountPath }} + {{- end }} {{- end }} {{- end -}} + +{{/* TODO: Remove on the next version bump, eg 1.2.0+ */}} +{{- define "cloudflared.storage.ci.migration" -}} + {{- $storage := .storage -}} + + {{- if $storage.hostPath -}} + {{- $_ := set $storage "hostPathConfig" dict -}} + {{- $_ := set $storage.hostPathConfig "hostPath" $storage.hostPath -}} + {{- end -}} +{{- end -}}