|
@@ -1,41 +1,44 @@
|
|
|
groups:
|
|
|
- - name: "Collabora Configuration"
|
|
|
- description: "Configure Collabora"
|
|
|
- - name: "Collabora Environment Variables"
|
|
|
- description: "Set the environment that will be visible to the container"
|
|
|
- - name: "Networking"
|
|
|
- description: "Configure Networking for Collabora"
|
|
|
- - name: "Storage"
|
|
|
- description: "Configure Storage for Collabora"
|
|
|
- - name: "Resource Limits"
|
|
|
- description: "Set CPU/memory limits for Kubernetes Pod"
|
|
|
+ - name: Collabora Configuration
|
|
|
+ description: Configure Collabora
|
|
|
+ - name: User and Group Configuration
|
|
|
+ description: Configure User and Group for Collabora
|
|
|
+ - name: Network Configuration
|
|
|
+ description: Configure Network for Collabora
|
|
|
+ - name: Storage Configuration
|
|
|
+ description: Configure Storage for Collabora
|
|
|
+ - name: Resources Configuration
|
|
|
+ description: Configure Resources for Collabora
|
|
|
|
|
|
portals:
|
|
|
web_portal:
|
|
|
protocols:
|
|
|
- - "https"
|
|
|
+ - "$kubernetes-resource_configmap_portal_protocol"
|
|
|
host:
|
|
|
- - "$variable-config.server_name"
|
|
|
+ - "$kubernetes-resource_configmap_portal_host"
|
|
|
ports:
|
|
|
- - "$variable-nodePort"
|
|
|
- path: "/browser/dist/admin/admin.html"
|
|
|
+ - "$kubernetes-resource_configmap_portal_port"
|
|
|
+ path: "$kubernetes-resource_configmap_portal_path"
|
|
|
|
|
|
questions:
|
|
|
- - variable: config
|
|
|
- label: "Container Configuration"
|
|
|
- group: "Collabora Configuration"
|
|
|
+ - variable: TZ
|
|
|
+ group: Collabora Configuration
|
|
|
+ label: Timezone
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ default: Etc/UTC
|
|
|
+ required: true
|
|
|
+ $ref:
|
|
|
+ - definitions/timezone
|
|
|
+
|
|
|
+ - variable: collaboraConfig
|
|
|
+ label: ""
|
|
|
+ group: Collabora Configuration
|
|
|
schema:
|
|
|
type: dict
|
|
|
attrs:
|
|
|
- - variable: timezone
|
|
|
- label: "Timezone"
|
|
|
- group: "Collabora Configuration"
|
|
|
- schema:
|
|
|
- type: string
|
|
|
- $ref:
|
|
|
- - "definitions/timezone"
|
|
|
- variable: enableWebUI
|
|
|
- label: "Enable WebUI"
|
|
|
+ label: Enable WebUI
|
|
|
description: |
|
|
|
Enable WebUI for Collabora
|
|
|
If you enable this, you will need to set a username and password</br>
|
|
@@ -43,147 +46,326 @@ questions:
|
|
|
type: boolean
|
|
|
default: true
|
|
|
- variable: username
|
|
|
- label: "Username for WebUI"
|
|
|
+ label: Username for WebUI
|
|
|
show_if: [[enableWebUI, "=", true]]
|
|
|
schema:
|
|
|
type: string
|
|
|
- default: "admin"
|
|
|
+ default: ""
|
|
|
required: true
|
|
|
- variable: password
|
|
|
- label: "Password for WebUI"
|
|
|
+ label: Password for WebUI
|
|
|
schema:
|
|
|
type: string
|
|
|
+ default: ""
|
|
|
private: true
|
|
|
- default: "changeme"
|
|
|
+ required: true
|
|
|
show_if: [[enableWebUI, "=", true]]
|
|
|
valid_chars: "[a-zA-Z0-9!@#%^&*?]{8,}"
|
|
|
valid_chars_error: |
|
|
|
- Password must be at least 8 characters long</br>
|
|
|
- Can contain at numbers, letters, and the following characters: !@#%^&*?
|
|
|
- required: true
|
|
|
- - variable: aliasgroup1
|
|
|
- label: "Alias Group 1"
|
|
|
+ Password must be at least 8 characters long and contain at least one of the following:</br>
|
|
|
+ - Uppercase letter</br>
|
|
|
+ - Lowercase letter</br>
|
|
|
+ - Number</br>
|
|
|
+ - Special character</br>
|
|
|
+ - variable: serverName
|
|
|
+ label: Server Name
|
|
|
+ description: The server name for Collabora.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ default: ""
|
|
|
+ $ref:
|
|
|
+ - "definitions/nodeIP"
|
|
|
+ - variable: aliasGroup1
|
|
|
+ label: Alias Group 1
|
|
|
description: |
|
|
|
List of domains that will be allowed to access the Collabora server
|
|
|
Type one domain per line
|
|
|
schema:
|
|
|
type: list
|
|
|
+ default: []
|
|
|
items:
|
|
|
- variable: alias
|
|
|
- label: "Alias"
|
|
|
+ label: Alias
|
|
|
schema:
|
|
|
type: string
|
|
|
- variable: dictionaries
|
|
|
- label: "Dictionaries to use, leave empty to use all"
|
|
|
+ label: Dictionaries
|
|
|
+ description: Dictionaries to be used by Collabora.
|
|
|
schema:
|
|
|
- type: string
|
|
|
- default: "de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru"
|
|
|
- - variable: extra_params
|
|
|
- label: "Extra Parameters to add"
|
|
|
- description: 'e.g. "--o:welcome.enable=false", See more on /etc/loolwsd/loowsd.xml. Separate params with space'
|
|
|
+ type: list
|
|
|
+ default:
|
|
|
+ - de_DE
|
|
|
+ - en_GB
|
|
|
+ - en_US
|
|
|
+ - es_ES
|
|
|
+ - fr_FR
|
|
|
+ - it
|
|
|
+ - nl
|
|
|
+ - pt_BR
|
|
|
+ - pt_PT
|
|
|
+ - ru
|
|
|
+ items:
|
|
|
+ - variable: dictionary
|
|
|
+ label: Dictionary
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ default: ""
|
|
|
+ required: true
|
|
|
+ - variable: extraParams
|
|
|
+ label: Extra Parameters
|
|
|
+ description: Extra parameters to be passed to Collabora.
|
|
|
schema:
|
|
|
- type: string
|
|
|
- default: "--o:welcome.enable=false --o:user_interface.mode=notebookbar --o:ssl.termination=true --o:ssl.enable=false --o:net.proto=IPv4"
|
|
|
- - variable: server_name
|
|
|
- label: "Server Name"
|
|
|
- description: |
|
|
|
- When this environment variable is set (is not “”), then its value will be used as server name in /etc/loolwsd/loolwsd.xml.
|
|
|
- Without this, CODE is not delivering a correct host for the websocket connection in case of a proxy in front of it.</br>
|
|
|
- If a port is not specified, the below configured Node Port will be used.
|
|
|
+ type: list
|
|
|
+ default:
|
|
|
+ - --o:welcome.enable=false
|
|
|
+ - --o:user_interface.mode=notebookbar
|
|
|
+ - --o:ssl.termination=true
|
|
|
+ - --o:ssl.enable=false
|
|
|
+ - --o:net.proto=IPv4
|
|
|
+ - --o:logging.level=warning
|
|
|
+ - --o:logging.level_startup=warning
|
|
|
+ - --o:mount_jail_tree=false
|
|
|
+ items:
|
|
|
+ - variable: extraParam
|
|
|
+ label: Extra Parameter
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ default: ""
|
|
|
+ required: true
|
|
|
+ - variable: additionalEnvs
|
|
|
+ label: Additional Environment Variables
|
|
|
+ description: Configure additional environment variables forCollabora.
|
|
|
schema:
|
|
|
- type: string
|
|
|
- $ref:
|
|
|
- - "definitions/nodeIP"
|
|
|
+ type: list
|
|
|
+ default: []
|
|
|
+ items:
|
|
|
+ - variable: env
|
|
|
+ label: Environment Variable
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: name
|
|
|
+ label: Name
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ - variable: value
|
|
|
+ label: Value
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
|
|
|
- - variable: certificate
|
|
|
- description: |
|
|
|
- Collabora Certificate</br>
|
|
|
- If you do not choose a certificate and do not configure an external reverse proxy</br>
|
|
|
- you might have to adjust the extra_params.
|
|
|
- label: "Certificate"
|
|
|
- group: "Collabora Configuration"
|
|
|
+ - variable: collaboraNetwork
|
|
|
+ label: ""
|
|
|
+ group: Network Configuration
|
|
|
schema:
|
|
|
- type: int
|
|
|
- $ref:
|
|
|
- - "definitions/certificate"
|
|
|
- "null": true
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: webPort
|
|
|
+ label: Web Port
|
|
|
+ description: The port for the Collabora Web UI.
|
|
|
+ schema:
|
|
|
+ type: int
|
|
|
+ default: 9980
|
|
|
+ min: 9000
|
|
|
+ max: 65535
|
|
|
+ required: true
|
|
|
+ - variable: certificateID
|
|
|
+ label: Certificate
|
|
|
+ description: The certificate for Collabora.
|
|
|
+ schema:
|
|
|
+ type: int
|
|
|
+ "null": true
|
|
|
+ $ref:
|
|
|
+ - "definitions/certificate"
|
|
|
|
|
|
- - variable: extraAppVolumeMounts
|
|
|
- label: "Collabora Extra Host Path Volumes"
|
|
|
- group: "Storage"
|
|
|
+ - variable: collaboraStorage
|
|
|
+ label: ""
|
|
|
+ group: Storage Configuration
|
|
|
schema:
|
|
|
- type: list
|
|
|
- items:
|
|
|
- - variable: extraAppVolume
|
|
|
- label: "Collabora Host Path Volume"
|
|
|
- description: "Add an extra host path volume for Collabora application"
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: additionalStorages
|
|
|
+ label: Additional Storage
|
|
|
+ description: Additional storage for Collabora.
|
|
|
schema:
|
|
|
- type: dict
|
|
|
- attrs:
|
|
|
- - variable: mountPath
|
|
|
- label: "Mount Path in Pod"
|
|
|
- description: "Path where the volume will be mounted inside the pod"
|
|
|
- schema:
|
|
|
- type: path
|
|
|
- required: true
|
|
|
- - variable: hostPath
|
|
|
- label: "Host Path"
|
|
|
- description: "Host path"
|
|
|
+ type: list
|
|
|
+ default: []
|
|
|
+ items:
|
|
|
+ - variable: storageEntry
|
|
|
+ label: Storage Entry
|
|
|
schema:
|
|
|
- type: hostpath
|
|
|
- required: true
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: type
|
|
|
+ label: Type
|
|
|
+ description: |
|
|
|
+ ixVolume: Is dataset created automatically by the system.</br>
|
|
|
+ Host Path: Is a path that already exists on the system.</br>
|
|
|
+ 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: Host Path Configuration
|
|
|
+ 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]]
|
|
|
+ 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: environmentVariables
|
|
|
- label: "Environment Variables"
|
|
|
- group: "Collabora Environment Variables"
|
|
|
+ - variable: resources
|
|
|
+ group: Resources Configuration
|
|
|
+ label: ""
|
|
|
schema:
|
|
|
- type: list
|
|
|
- default: []
|
|
|
- items:
|
|
|
- - variable: environmentVariable
|
|
|
- label: "Environment Variable"
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: limits
|
|
|
+ label: Limits
|
|
|
schema:
|
|
|
type: dict
|
|
|
attrs:
|
|
|
- - variable: name
|
|
|
- label: "Name"
|
|
|
+ - variable: cpu
|
|
|
+ label: CPU
|
|
|
+ description: CPU limit for WG-Easy.
|
|
|
schema:
|
|
|
type: string
|
|
|
- - variable: value
|
|
|
- label: "Value"
|
|
|
+ max_length: 6
|
|
|
+ valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
|
|
|
+ valid_chars_error: |
|
|
|
+ Valid CPU limit formats are</br>
|
|
|
+ - Plain Integer - eg. 1</br>
|
|
|
+ - Float - eg. 0.5</br>
|
|
|
+ - Milicpu - eg. 500m
|
|
|
+ default: "4000m"
|
|
|
+ required: true
|
|
|
+ - variable: memory
|
|
|
+ label: Memory
|
|
|
+ description: Memory limit for WG-Easy.
|
|
|
schema:
|
|
|
type: string
|
|
|
-
|
|
|
- - variable: nodePort
|
|
|
- label: "Node Port to use for Collabora"
|
|
|
- group: "Networking"
|
|
|
- schema:
|
|
|
- type: int
|
|
|
- default: 9980
|
|
|
- min: 9000
|
|
|
- max: 65535
|
|
|
-
|
|
|
- - variable: enableResourceLimits
|
|
|
- label: "Enable Pod resource limits"
|
|
|
- group: "Resource Limits"
|
|
|
- schema:
|
|
|
- type: boolean
|
|
|
- default: false
|
|
|
- - variable: cpuLimit
|
|
|
- label: "CPU Limit"
|
|
|
- description: "CPU resource limit allow plain integer values with suffix m(milli) e.g 1000m, 100."
|
|
|
- group: "Resource Limits"
|
|
|
- schema:
|
|
|
- type: string
|
|
|
- show_if: [["enableResourceLimits", "=", true]]
|
|
|
- valid_chars: "^\\d+(?:\\.\\d+(?!.*m$)|m?$)"
|
|
|
- default: "4000m"
|
|
|
- - variable: memLimit
|
|
|
- label: "Memory Limit"
|
|
|
- group: "Resource Limits"
|
|
|
- description: "Memory limits is specified by number of bytes. Followed by quantity suffix like E,P,T,G,M,k and Ei,Pi,Ti,Mi,Gi,Ki can also be used. e.g 129e6, 129M, 128974848000m, 123Mi"
|
|
|
- schema:
|
|
|
- type: string
|
|
|
- show_if: [["enableResourceLimits", "=", true]]
|
|
|
- valid_chars: "^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"
|
|
|
- default: "8Gi"
|
|
|
+ max_length: 12
|
|
|
+ valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
|
|
|
+ valid_chars_error: |
|
|
|
+ Valid Memory limit formats are</br>
|
|
|
+ - Suffixed with E/P/T/G/M/K - eg. 1G</br>
|
|
|
+ - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
|
|
|
+ - Plain Integer in bytes - eg. 1024</br>
|
|
|
+ - Exponent - eg. 134e6
|
|
|
+ default: "8Gi"
|
|
|
+ required: true
|