diff --git a/docs/development/app development/storage.md b/docs/development/app development/storage.md index f188a1704f6..02d27e4c0ac 100644 --- a/docs/development/app development/storage.md +++ b/docs/development/app development/storage.md @@ -35,35 +35,44 @@ Preventing the user to disable them, ensures that users don't (by mistake) remov schema: type: boolean default: true - hidden: true + hidden: false - variable: storageClass label: "Type of Storage" - description: " Warning: Anything other than Internal will break rollback!" + description: " Warning: Anything other than SCALE-ZFS will break rollback!" schema: type: string - default: "" - enum: - - value: "" - description: "Internal" + default: "SCALE-ZFS" - variable: mountPath label: "mountPath" description: "Path inside the container the storage is mounted" schema: type: string - default: "/data" + default: "/config" hidden: true - variable: emptyDir - label: "Mount a ramdisk instead of actual storage" + label: "EmptyDir Volume" schema: type: dict - hidden: true + hidden: false attrs: - variable: enabled - label: "Enable emptyDir" + label: "Use emptyDir volume" schema: type: boolean default: false - hidden: true + hidden: false + show_subquestions_if: true + subquestions: + - variable: medium + label: "EmptyDir Medium" + schema: + type: string + default: "" + enum: + - value: "" + description: "Default" + - value: "Memory" + description: "Memory" - variable: accessMode label: "Access Mode (Advanced)" description: "Allow or disallow multiple PVC's writhing to the same PVC" @@ -127,16 +136,29 @@ It should always be included in any App, to give users the option to customise t required: true editable: true - variable: emptyDir - label: "Mount a ramdisk instead of actual storage" + label: "EmptyDir Volume" schema: - hidden: true + type: dict + hidden: false attrs: - variable: enabled - label: Enable emptyDir + label: "Use emptyDir volume" schema: type: boolean default: false - hidden: true + hidden: false + show_subquestions_if: true + subquestions: + - variable: medium + label: "EmptyDir Medium" + schema: + type: string + default: "" + enum: + - value: "" + description: "Default" + - value: "Memory" + description: "Memory" - variable: mountPath label: "Mount Path" description: "Path to mount inside the pod" @@ -153,6 +175,7 @@ It should always be included in any App, to give users the option to customise t hidden: true - variable: hostPath label: "Host Path" + description: "Path on the host to mount inside the container, ignored when emptyDir is enabled" schema: type: hostpath required: true diff --git a/docs/manual/Migration Guides/index.md b/docs/manual/Migration Guides/index.md index c9a4cf5eb7c..4bee7456932 100644 --- a/docs/manual/Migration Guides/index.md +++ b/docs/manual/Migration Guides/index.md @@ -31,3 +31,10 @@ Be also aware that we do not have common 2.0 based installs available in the ver In cases you upgrade to a common 4.0 based app, reinstall is currently required. Please be aware: Installing will nuke your data! However: Common 3.0 based Apps are still available to be installed using the version dropdown + +##### Common 4.0 -> common 5.0 based Apps + +Common 5.0.0 is actually a rather small update: It just allows using a ramdisk when using emptyDir on hostPathMount. +It is however still a breaking change. + +To update, we advice removing all(!) entries from hostPathMounts/customStorage and readd them after the update