eb48f8a4e1
* Create docs for Integrated Persistent Storage * add a clear note about possibly moving to PVC's in the (near) future. * Adapt developer docs to reflect new storage system * Move Apps fixed-storage to new Storage system
151 lines
5.2 KiB
Markdown
151 lines
5.2 KiB
Markdown
# Storage
|
|
|
|
This article serves as a development extention to the storage article available [here](https://wiki.truecharts.org/general/storage/)
|
|
|
|
##### Storage and Common-Chart
|
|
|
|
For all these storage solutions we require the commonchart to be added to the App.
|
|
The Common-Chart handles both the connection/addition of storage to the container and spinning up special k8s jobs to fix the permissions if requested for the Custom storage.
|
|
|
|
|
|
### Integrated Persistent Storage
|
|
|
|
When adding an App, there are almost always certain folders that are required for solid Apps performance. For example config files that should be persistent across restarts.
|
|
|
|
For these storages we can easily add fixes values in the UI, these settings can not be disabled or removed and would, by default and preferably, be limited to the "internal" storage class
|
|
Preventing the user to disable them, ensures that users don't (by mistake) remove the storage.
|
|
|
|
#####
|
|
|
|
```
|
|
- variable: persistence
|
|
label: "Integrated Persistent Storage"
|
|
description: "Websocket Service"
|
|
group: "Storage"
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: data
|
|
label: "App Config Storage"
|
|
description: "Stores the Application Configuration."
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enable the storage"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: true
|
|
- variable: storageClass
|
|
label: "Type of Storage"
|
|
description: " Warning: Anything other than Internal will break rollback!"
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
enum:
|
|
- value: ""
|
|
description: "Internal"
|
|
- variable: mountPath
|
|
label: "mountPath"
|
|
description: "Path inside the container the storage is mounted"
|
|
schema:
|
|
type: string
|
|
default: "/data"
|
|
hidden: true
|
|
- variable: emptyDir
|
|
label: "Mount a ramdisk instead of actual storage"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
hidden: true
|
|
- variable: accessMode
|
|
label: "Access Mode (Advanced)"
|
|
description: "Allow or disallow multiple PVC's writhing to the same PVC"
|
|
schema:
|
|
type: string
|
|
default: "ReadWriteOnce"
|
|
enum:
|
|
- value: "ReadWriteOnce"
|
|
description: "ReadWriteOnce"
|
|
- value: "ReadOnlyMany"
|
|
description: "ReadOnlyMany"
|
|
- value: "ReadWriteMany"
|
|
description: "ReadWriteMany"
|
|
- variable: size
|
|
label: "Size quotum of storage"
|
|
schema:
|
|
type: string
|
|
default: "100Gi"
|
|
```
|
|
|
|
### Unlimited Custom Storage Mounts
|
|
|
|
We support presenting the user with a "Do it yourself" style list, in which the user can add unlimited paths on the host system to mount.
|
|
It should always be included in any App, to give users the option to customise things however they like.
|
|
|
|
##### Example
|
|
|
|
```
|
|
- variable: additionalAppVolumeMounts
|
|
label: "Custom app storage"
|
|
group: "Storage and Devices"
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: volumeMount
|
|
label: "Custom Storage"
|
|
schema:
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enabled"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
required: true
|
|
hidden: true
|
|
editable: false
|
|
- variable: setPermissions
|
|
label: "Automatic Permissions"
|
|
description: "Automatically set permissions on install"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: false
|
|
- variable: name
|
|
label: "Mountpoint Name"
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
editable: true
|
|
- variable: emptyDir
|
|
label: "emptyDir"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
hidden: true
|
|
editable: false
|
|
- variable: mountPath
|
|
label: "Mount Path"
|
|
description: "Path to mount inside the pod"
|
|
schema:
|
|
type: path
|
|
required: true
|
|
default: ""
|
|
editable: true
|
|
- variable: hostPathEnabled
|
|
label: "host Path Enabled"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: true
|
|
- variable: hostPath
|
|
label: "Host Path"
|
|
schema:
|
|
type: hostpath
|
|
required: true
|
|
```
|