2021-09-11 19:47:14 +00:00
groups :
- name : "Container Image"
description : "Image to be used for container"
- name : "Controller"
description : "Configure workload deployment"
- name : "Container Configuration"
description : "additional container configuration"
- name : "App Configuration"
description : "App specific config options"
- name : "Networking and Services"
description : "Configure Network and Services for container"
- name : "Storage and Persistence"
description : "Persist and share data that is separate from the container"
- name : "Ingress"
description : "Ingress Configuration"
- name : "Security and Permissions"
description : "Configure security context and permissions"
- name : "Resources and Devices"
description : "Specify resources/devices to be allocated to workload"
2021-09-13 12:17:51 +00:00
- name : "Middlewares"
description : "Traefik Middlewares"
- name : "Addons"
description : "Addon Configuration"
2021-09-11 19:47:14 +00:00
- name : "Advanced"
description : "Advanced Configuration"
2021-09-13 17:07:56 +00:00
portals :
web_portal :
protocols :
- "$kubernetes-resource_configmap_portal_protocol"
host :
- "$kubernetes-resource_configmap_portal_host"
ports :
- "$kubernetes-resource_configmap_portal_port"
2021-09-11 19:47:14 +00:00
questions :
- variable : portal
group : "Container Image"
label : "Configure Portal Button"
schema :
type : dict
hidden : true
attrs :
- variable : enabled
label : "Enable"
description : "enable the portal button"
schema :
hidden : true
editable : false
type : boolean
2021-09-13 17:07:56 +00:00
default : true
2021-09-11 19:47:14 +00:00
- variable : controller
group : "Controller"
label : ""
schema :
type : dict
attrs :
- variable : type
description : "Please specify type of workload to deploy"
label : "(Advanced) Controller Type"
schema :
type : string
default : "deployment"
required : true
enum :
- value : "deployment"
description : "Deployment"
- value : "statefulset"
description : "Statefulset"
- value : "daemonset"
description : "Daemonset"
- variable : replicas
description : "Number of desired pod replicas"
label : "Desired Replicas"
schema :
type : int
default : 1
required : true
- variable : strategy
description : "Please specify type of workload to deploy"
label : "(Advanced) Update Strategy"
schema :
type : string
default : "Recreate"
required : true
enum :
- value : "Recreate"
description : "Recreate: Kill existing pods before creating new ones"
- value : "RollingUpdate"
description : "RollingUpdate: Create new pods and then kill old ones"
- value : "OnDelete"
description : "(Legacy) OnDelete: ignore .spec.template changes"
2021-09-13 12:17:51 +00:00
- variable : advanced
label : "Show Expert Configuration Options"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : extraArgs
label : "Extra Args"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : list
default : [ ]
items :
- variable : argItem
label : "Arg"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
- variable : labelsList
label : "Controller Labels"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : list
default : [ ]
items :
- variable : labelItem
label : "Label"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
- variable : annotationsList
label : " Controller Annotations"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : list
default : [ ]
items :
- variable : annotationItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
2021-09-11 19:47:14 +00:00
2021-09-13 17:07:56 +00:00
2021-09-11 19:47:14 +00:00
- variable : env
group : "Container Configuration"
label : "Image Environment"
schema :
type : dict
attrs :
- variable : TZ
label : "Timezone"
schema :
type : string
default : "Etc/UTC"
$ref :
- "definitions/timezone"
2021-09-13 17:07:56 +00:00
- variable : UMASK
label : "UMASK"
description : "Sets the UMASK env var for LinuxServer.io (compatible) containers"
schema :
type : string
default : "002"
2021-09-11 19:47:14 +00:00
- variable : envList
label : "Image environment"
group : "Container Configuration"
schema :
type : list
default : [ ]
items :
- variable : envItem
label : "Environment Variable"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
2021-09-13 12:17:51 +00:00
- variable : expertpodconf
group : "Container Configuration"
label : "Show Expert Config"
schema :
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : termination
group : "Container Configuration"
label : "Termination settings"
schema :
type : dict
attrs :
- variable : gracePeriodSeconds
label : "Grace Period Seconds"
schema :
type : int
default : 10
- variable : podLabelsList
group : "Container Configuration"
label : "Pod Labels"
schema :
type : list
default : [ ]
items :
- variable : podLabelItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
- variable : podAnnotationsList
group : "Container Configuration"
label : "Pod Annotations"
schema :
type : list
default : [ ]
items :
- variable : podAnnotationItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
2021-09-11 19:47:14 +00:00
2021-09-13 17:07:56 +00:00
- variable : sogo
group : "App Configuration"
label : "SOGo Configuration "
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 17:07:56 +00:00
type : dict
attrs :
- variable : general
label : "General"
schema :
type : dict
attrs :
- variable : SOGoLanguage
label : "SOGoLanguage"
schema :
type : string
required : true
default : "English"
- variable : SOGoSuperUsernames
label : "SOGoSuperUsernames"
schema :
type : string
default : ""
- variable : SxVMemLimit
label : "SxVMemLimit"
schema :
type : int
default : 384
required : true
- variable : webui
label : "Web Interface"
schema :
type : dict
attrs :
- variable : SOGoPageTitle
label : "SOGoPageTitle"
schema :
type : string
required : true
default : "SOGo"
- variable : SOGoVacationEnabled
label : "SOGoVacationEnabled"
schema :
type : boolean
default : true
- variable : SOGoForwardEnabled
label : "SOGoForwardEnabled"
schema :
type : boolean
default : true
- variable : SOGoSieveScriptsEnabled
label : "SOGoSieveScriptsEnabled"
schema :
type : boolean
default : true
- variable : SOGoMailAuxiliaryUserAccountsEnabled
label : "SOGoMailAuxiliaryUserAccountsEnabled"
schema :
type : boolean
default : true
- variable : SOGoTrustProxyAuthentication
label : "SOGoTrustProxyAuthentication"
schema :
type : boolean
default : false
- variable : SOGoXSRFValidationEnabled
label : "SOGoXSRFValidationEnabled"
schema :
type : boolean
default : true
- variable : mail
label : "Mail"
schema :
type : dict
attrs :
- variable : SOGoDraftsFolderName
label : "SOGoDraftsFolderName"
schema :
type : string
default : "Drafts"
required : true
- variable : SOGoSentFolderName
label : "SOGoSentFolderName"
schema :
type : string
default : "Sent"
required : true
- variable : SOGoTrashFolderName
label : "SOGoTrashFolderName"
schema :
type : string
default : "Trash"
required : true
- variable : SOGoIMAPServer
label : "SOGoIMAPServer"
schema :
type : string
default : "localhost"
required : true
- variable : SOGoSieveServer
label : "SOGoSieveServer"
schema :
type : string
default : ""
- variable : SOGoMailDomain
label : "SOGoMailDomain"
schema :
type : string
default : "example.com"
required : true
- variable : SOGoMailingMechanism
label : "SOGoMailingMechanism"
schema :
type : string
default : "smtp"
enum :
- value : "smtp"
description : "smtp"
- value : "sendmail"
description : "sendmail"
- variable : SOGoSMTPServer
label : "SOGoSMTPServer"
schema :
type : string
show_if : [ [ "SOGoMailingMechanism" , "=" , "smtp" ] ]
default : "smtp://domain:port"
required : true
- variable : SOGoForceExternalLoginWithEmail
label : "SOGoForceExternalLoginWithEmail"
schema :
type : boolean
default : false
- variable : SOGoMailSpoolPath
label : "SOGoMailSpoolPath"
schema :
type : string
default : "/var/spool/sogo"
required : true
- variable : NGMimeBuildMimeTempDirectory
label : "NGMimeBuildMimeTempDirectory"
schema :
type : string
default : "/mimetmp"
required : true
- variable : notifications
label : "Notifications"
schema :
type : dict
attrs :
- variable : SOGoAppointmentSendEMailNotifications
label : "SOGoAppointmentSendEMailNotifications"
schema :
type : boolean
default : false
- variable : SOGoACLsSendEMailNotifications
label : "SOGoACLsSendEMailNotifications"
schema :
type : boolean
default : false
- variable : SOGoFoldersSendEMailNotifications
label : "SOGoFoldersSendEMailNotifications"
schema :
type : boolean
default : false
- variable : auth
label : "Authentication"
schema :
type : dict
attrs :
- variable : SOGoPasswordChangeEnabled
label : "SOGoPasswordChangeEnabled"
schema :
type : boolean
default : true
- variable : usersources
label : "User Data Sources"
schema :
type : list
default : [ ]
items :
- variable : usersourcesEntry
label : "Source"
schema :
type : dict
attrs :
- variable : id
label : "id"
schema :
type : string
default : "id"
required : true
- variable : canAuthenticate
label : "canAuthenticate"
schema :
type : boolean
default : true
- variable : isAddressBook
label : "isAddressBook"
schema :
type : boolean
default : true
- variable : type
label : "Userdata Type"
schema :
type : string
default : "LDAP"
enum :
- value : "LDAP"
description : "LDAP"
- value : "SQL"
description : "SQL"
- variable : viewURL
label : "viewURL"
schema :
show_if : [ [ "type" , "=" , "SQL" ] ]
type : string
default : "LDAP"
required : true
- variable : userPasswordAlgorithm
label : "userPasswordAlgorithm"
schema :
show_if : [ [ "type" , "=" , "SQL" ] ]
type : string
default : "md5"
required : true
- variable : CNFieldName
label : "CNFieldName"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "cn"
required : true
- variable : UIDFieldName
label : "UIDFieldName"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "uid"
required : true
- variable : IDFieldName
label : "IDFieldName"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "uid"
required : true
- variable : bindFields
label : "bindFields"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "(uid, mail)"
required : true
- variable : baseDN
label : "baseDN"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "ou=users,dc=acme,dc=com"
required : true
- variable : bindDN
label : "bindDN"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "uid=sogo,ou=users,dc=acme,dc=com"
required : true
- variable : bindPassword
label : "bindPassword"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "qwerty"
required : true
- variable : displayName
label : "displayName"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "Shared Addresses"
required : true
- variable : hostname
label : "hostname"
schema :
show_if : [ [ "type" , "=" , "LDAP" ] ]
type : string
default : "ldap://127.0.0.1:389"
required : true
- variable : custom
label : "Custom configuration Arguments"
schema :
type : list
default : [ ]
items :
- variable : customsourceEntry
label : "custom argument"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
required : true
- variable : value
label : "Value"
schema :
type : string
required : true
- variable : debug
label : "Debug"
schema :
type : dict
attrs :
- variable : show
label : "show debug options"
schema :
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : SOGoDebugRequests
label : "SOGoDebugRequests"
schema :
type : boolean
default : false
- variable : SoDebugBaseURL
label : "SoDebugBaseURL"
schema :
type : boolean
default : false
- variable : LDAPDebugEnabled
label : "LDAPDebugEnabled"
schema :
type : boolean
default : false
- variable : ImapDebugEnabled
label : "ImapDebugEnabled"
schema :
type : boolean
default : false
- variable : PGDebugEnabled
label : "PGDebugEnabled"
schema :
type : boolean
default : false
- variable : MySQL4DebugEnabled
label : "MySQL4DebugEnabled"
schema :
type : boolean
default : false
- variable : SOGoUIxDebugEnabled
label : "SOGoUIxDebugEnabled"
schema :
type : boolean
default : false
- variable : WODontZipResponse
label : "WODontZipResponse"
schema :
type : boolean
default : false
- variable : WOLogFile
label : "WOLogFile"
schema :
type : string
default : ""
- variable : custom
label : "Custom configuration Arguments"
schema :
type : list
default : [ ]
items :
- variable : customEntry
label : "custom argument"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
required : true
- variable : value
label : "Value"
schema :
type : string
required : true
2021-09-11 19:47:14 +00:00
- variable : service
group : "Networking and Services"
label : "Configure Service(s)"
schema :
type : dict
attrs :
- variable : main
label : "Main Service"
description : "The Primary service on which the healthcheck runs, often the webUI"
schema :
type : dict
attrs :
- variable : enabled
label : "Enable the service"
schema :
type : boolean
default : true
hidden : true
- variable : type
label : "Service Type"
description : "ClusterIP's are only internally available, nodePorts expose the container to the host node System, Loadbalancer exposes the service using the system loadbalancer"
schema :
type : string
2021-09-13 17:07:56 +00:00
default : "NodePort"
2021-09-11 19:47:14 +00:00
enum :
- value : "NodePort"
description : "NodePort"
- value : "ClusterIP"
description : "ClusterIP"
- value : "LoadBalancer"
description : "LoadBalancer"
- variable : loadBalancerIP
label : "LoadBalancer IP"
description : "LoadBalancerIP"
schema :
show_if : [ [ "type" , "=" , "LoadBalancer" ] ]
type : string
default : ""
- variable : externalIPs
label : "External IP's"
description : "External IP's"
schema :
show_if : [ [ "type" , "=" , "LoadBalancer" ] ]
type : list
default : [ ]
items :
- variable : externalIP
label : "External IP"
schema :
type : string
- variable : ports
label : "Service's Port(s) Configuration"
schema :
type : dict
attrs :
- variable : main
label : "Main Service Port Configuration"
schema :
type : dict
attrs :
- variable : enabled
label : "Enable the port"
schema :
type : boolean
default : true
hidden : true
- variable : protocol
label : "Port Type"
schema :
type : string
2021-09-13 17:07:56 +00:00
default : "HTTP"
2021-09-11 19:47:14 +00:00
enum :
- value : HTTP
description : "HTTP"
- value : "HTTPS"
description : "HTTPS"
- value : TCP
description : "TCP"
- value : "UDP"
description : "UDP"
- variable : targetPort
label : "Target Port"
description : "This port exposes the container port on the service"
schema :
type : int
2021-09-13 17:07:56 +00:00
default : 80
2021-09-11 19:47:14 +00:00
editable : false
hidden : true
- variable : port
label : "Container Port"
schema :
type : int
2021-09-13 17:07:56 +00:00
default : 80
2021-09-11 19:47:14 +00:00
editable : true
required : true
- variable : nodePort
label : "Node Port (Optional)"
description : "This port gets exposed to the node. Only considered when service type is NodePort"
schema :
type : int
min : 9000
max : 65535
2021-09-13 17:07:56 +00:00
default : 36102
required : true
- variable : serviceexpert
group : "Networking and Services"
label : "Show Expert Config"
schema :
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : hostNetwork
group : "Networking and Services"
label : "Host-Networking (Complicated)"
schema :
type : boolean
default : false
2021-09-11 19:47:14 +00:00
2021-09-13 17:07:56 +00:00
- variable : dnsPolicy
group : "Networking and Services"
label : "dnsPolicy"
schema :
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "ClusterFirst"
description : "ClusterFirst"
- value : "ClusterFirstWithHostNet"
description : "ClusterFirstWithHostNet"
- value : "None"
description : "None"
- variable : dnsConfig
label : "DNS Configuration"
group : "Networking and Services"
description : "Specify custom DNS configuration which will be applied to the pod"
schema :
type : dict
attrs :
- variable : nameservers
label : "Nameservers"
schema :
default : [ ]
type : list
items :
- variable : nameserver
label : "Nameserver"
schema :
type : string
- variable : options
label : "options"
schema :
default : [ ]
type : list
items :
- variable : option
label : "Option Entry"
schema :
type : string
- variable : searches
label : "Searches"
schema :
default : [ ]
type : list
items :
- variable : search
label : "Search Entry"
schema :
type : string
2021-09-11 19:47:14 +00:00
2021-09-13 12:17:51 +00:00
- variable : serviceList
label : "Add Manual Custom Services"
group : "Networking and Services"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : list
default : [ ]
items :
- variable : serviceListEntry
label : "Custom Service"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : dict
attrs :
- variable : enabled
label : "Enable the service"
schema :
type : boolean
default : true
hidden : true
- variable : name
label : "Name"
2021-09-11 19:47:14 +00:00
schema :
type : string
2021-09-13 12:17:51 +00:00
default : ""
- variable : type
label : "Service Type"
description : "ClusterIP's are only internally available, nodePorts expose the container to the host node System, Loadbalancer exposes the service using the system loadbalancer"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : string
default : "NodePort"
enum :
- value : "NodePort"
description : "NodePort"
- value : "ClusterIP"
description : "ClusterIP"
- value : "LoadBalancer"
description : "LoadBalancer"
- variable : loadBalancerIP
label : "LoadBalancer IP"
description : "LoadBalancerIP"
schema :
show_if : [ [ "type" , "=" , "LoadBalancer" ] ]
type : string
default : ""
- variable : externalIPs
label : "External IP's"
description : "External IP's"
schema :
show_if : [ [ "type" , "=" , "LoadBalancer" ] ]
type : list
default : [ ]
items :
- variable : externalIP
label : "External IP"
2021-09-11 19:47:14 +00:00
schema :
type : string
2021-09-13 12:17:51 +00:00
- variable : portsList
label : "Additional Service Ports"
schema :
type : list
default : [ ]
items :
- variable : portsListEntry
label : "Custom ports"
2021-09-11 19:47:14 +00:00
schema :
2021-09-13 12:17:51 +00:00
type : dict
attrs :
- variable : enabled
label : "Enable the port"
schema :
type : boolean
default : true
hidden : true
- variable : name
label : "Port Name"
schema :
type : string
default : ""
- variable : protocol
label : "Port Type"
schema :
type : string
default : "TCP"
enum :
- value : HTTP
description : "HTTP"
- value : "HTTPS"
description : "HTTPS"
- value : TCP
description : "TCP"
- value : "UDP"
description : "UDP"
- variable : targetPort
label : "Target Port"
description : "This port exposes the container port on the service"
schema :
type : int
required : true
- variable : port
label : "Container Port"
schema :
type : int
required : true
- variable : nodePort
label : "Node Port (Optional)"
description : "This port gets exposed to the node. Only considered when service type is NodePort"
schema :
type : int
min : 9000
max : 65535
2021-09-11 19:47:14 +00:00
- variable : persistence
label : "Integrated Persistent Storage"
2021-09-13 17:07:56 +00:00
description : "Integrated Persistent Storage"
2021-09-11 19:47:14 +00:00
group : "Storage and Persistence"
schema :
type : dict
attrs :
2021-09-13 17:07:56 +00:00
- variable : data
label : "App Data Storage"
description : "Stores the Application Data."
2021-09-11 19:47:14 +00:00
schema :
type : dict
attrs :
- variable : enabled
label : "Enable the storage"
schema :
type : boolean
default : true
- variable : type
label : "(Advanced) Type of Storage"
description : "Sets the persistence type"
schema :
type : string
default : "pvc"
enum :
- value : "pvc"
description : "pvc"
- value : "emptyDir"
description : "emptyDir"
- value : "hostPath"
description : "hostPath"
- variable : storageClass
label : "(Advanced) storageClass"
description : " Warning: Anything other than SCALE-ZFS will break rollback!"
schema :
show_if : [ [ "type" , "=" , "pvc" ] ]
type : string
default : "SCALE-ZFS"
- variable : setPermissions
label : "Automatic Permissions"
description : "Automatically set permissions on install"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : boolean
default : true
- variable : readOnly
label : "readOnly"
schema :
type : boolean
default : false
- variable : hostPath
label : "hostPath"
description : "Path inside the container the storage is mounted"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : hostpath
- variable : hostPathType
label : "hostPath Type"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "DirectoryOrCreate"
description : "DirectoryOrCreate"
- value : "Directory"
description : "Directory"
- value : "FileOrCreate"
description : "FileOrCreate"
- value : "File"
description : "File"
- value : "Socket"
description : "Socket"
- value : "CharDevice"
description : "CharDevice"
- value : "BlockDevice"
description : "BlockDevice"
- variable : mountPath
label : "mountPath"
description : "Path inside the container the storage is mounted"
schema :
type : string
2021-09-13 17:07:56 +00:00
default : "/data/conf/sogo/"
2021-09-11 19:47:14 +00:00
hidden : true
- variable : medium
label : "EmptyDir Medium"
schema :
show_if : [ [ "type" , "=" , "emptyDir" ] ]
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 PV"
schema :
show_if : [ [ "type" , "=" , "pvc" ] ]
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 :
show_if : [ [ "type" , "=" , "pvc" ] ]
type : string
default : "100Gi"
2021-09-13 17:07:56 +00:00
- variable : drafts
label : "App drafts Storage"
description : "Stores Draft emails"
2021-09-11 19:47:14 +00:00
schema :
type : dict
attrs :
- variable : enabled
label : "Enable the storage"
schema :
type : boolean
default : true
- variable : type
label : "(Advanced) Type of Storage"
description : "Sets the persistence type"
schema :
type : string
default : "pvc"
enum :
- value : "pvc"
description : "pvc"
- value : "emptyDir"
description : "emptyDir"
- value : "hostPath"
description : "hostPath"
- variable : storageClass
label : "(Advanced) storageClass"
description : " Warning: Anything other than SCALE-ZFS will break rollback!"
schema :
show_if : [ [ "type" , "=" , "pvc" ] ]
type : string
default : "SCALE-ZFS"
- variable : setPermissions
label : "Automatic Permissions"
description : "Automatically set permissions on install"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : boolean
default : true
- variable : readOnly
label : "readOnly"
schema :
type : boolean
default : false
- variable : hostPath
label : "hostPath"
description : "Path inside the container the storage is mounted"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : hostpath
- variable : hostPathType
label : "hostPath Type"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "DirectoryOrCreate"
description : "DirectoryOrCreate"
- value : "Directory"
description : "Directory"
- value : "FileOrCreate"
description : "FileOrCreate"
- value : "File"
description : "File"
- value : "Socket"
description : "Socket"
- value : "CharDevice"
description : "CharDevice"
- value : "BlockDevice"
description : "BlockDevice"
- variable : mountPath
label : "mountPath"
description : "Path inside the container the storage is mounted"
schema :
type : string
2021-09-13 17:07:56 +00:00
default : "/var/spool/sogo"
2021-09-11 19:47:14 +00:00
hidden : true
- variable : medium
label : "EmptyDir Medium"
schema :
show_if : [ [ "type" , "=" , "emptyDir" ] ]
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 PV"
schema :
show_if : [ [ "type" , "=" , "pvc" ] ]
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 :
show_if : [ [ "type" , "=" , "pvc" ] ]
type : string
default : "100Gi"
2021-09-13 17:07:56 +00:00
- variable : mimetmp
label : "App mimetmp Storage"
description : "Stores the temporary mime files"
2021-09-11 19:47:14 +00:00
schema :
type : dict
attrs :
- variable : enabled
label : "Enable the storage"
schema :
type : boolean
default : true
- variable : type
label : "(Advanced) Type of Storage"
description : "Sets the persistence type"
schema :
type : string
2021-09-13 17:07:56 +00:00
default : "emptyDir"
2021-09-11 19:47:14 +00:00
enum :
- value : "pvc"
description : "pvc"
- value : "emptyDir"
description : "emptyDir"
- value : "hostPath"
description : "hostPath"
- variable : storageClass
label : "(Advanced) storageClass"
description : " Warning: Anything other than SCALE-ZFS will break rollback!"
schema :
show_if : [ [ "type" , "=" , "pvc" ] ]
type : string
default : "SCALE-ZFS"
- variable : setPermissions
label : "Automatic Permissions"
description : "Automatically set permissions on install"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : boolean
default : true
- variable : readOnly
label : "readOnly"
schema :
type : boolean
default : false
- variable : hostPath
label : "hostPath"
description : "Path inside the container the storage is mounted"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : hostpath
- variable : hostPathType
label : "hostPath Type"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "DirectoryOrCreate"
description : "DirectoryOrCreate"
- value : "Directory"
description : "Directory"
- value : "FileOrCreate"
description : "FileOrCreate"
- value : "File"
description : "File"
- value : "Socket"
description : "Socket"
- value : "CharDevice"
description : "CharDevice"
- value : "BlockDevice"
description : "BlockDevice"
- variable : mountPath
label : "mountPath"
description : "Path inside the container the storage is mounted"
schema :
type : string
2021-09-13 17:07:56 +00:00
default : "/mimetmp"
2021-09-11 19:47:14 +00:00
hidden : true
- variable : medium
label : "EmptyDir Medium"
schema :
show_if : [ [ "type" , "=" , "emptyDir" ] ]
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 PV"
schema :
show_if : [ [ "type" , "=" , "pvc" ] ]
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 :
show_if : [ [ "type" , "=" , "pvc" ] ]
type : string
default : "100Gi"
- variable : persistenceList
label : "Additional app storage"
group : "Storage and Persistence"
schema :
type : list
default : [ ]
items :
- variable : persistenceListEntry
label : "Custom Storage"
schema :
type : dict
attrs :
- variable : enabled
label : "Enable the storage"
schema :
type : boolean
default : true
2021-09-13 12:17:51 +00:00
hidden : true
- variable : advanced
label : "Show Advanced Options"
schema :
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : labelsList
label : "Labels"
schema :
type : list
default : [ ]
items :
- variable : labelItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
- variable : annotationsList
label : "Annotations"
schema :
type : list
default : [ ]
items :
- variable : annotationItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
2021-09-11 19:47:14 +00:00
- variable : type
label : "(Advanced) Type of Storage"
description : "Sets the persistence type"
schema :
type : string
default : "hostPath"
enum :
- value : "pvc"
description : "pvc"
- value : "emptyDir"
description : "emptyDir"
- value : "hostPath"
description : "hostPath"
- variable : storageClass
label : "(Advanced) storageClass"
2021-09-13 12:17:51 +00:00
description : "Warning: Anything other than SCALE-ZFS will break rollback!"
2021-09-11 19:47:14 +00:00
schema :
show_if : [ [ "type" , "=" , "pvc" ] ]
type : string
default : "SCALE-ZFS"
- variable : setPermissions
label : "Automatic Permissions"
description : "Automatically set permissions on install"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : boolean
default : true
- variable : readOnly
label : "readOnly"
schema :
type : boolean
default : false
- variable : hostPath
label : "hostPath"
description : "Path inside the container the storage is mounted"
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : hostpath
- variable : hostPathType
2021-09-13 12:17:51 +00:00
label : "(Advanced) hostPath Type"
2021-09-11 19:47:14 +00:00
schema :
show_if : [ [ "type" , "=" , "hostPath" ] ]
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "DirectoryOrCreate"
description : "DirectoryOrCreate"
- value : "Directory"
description : "Directory"
- value : "FileOrCreate"
description : "FileOrCreate"
- value : "File"
description : "File"
- value : "Socket"
description : "Socket"
- value : "CharDevice"
description : "CharDevice"
- value : "BlockDevice"
description : "BlockDevice"
- variable : mountPath
label : "mountPath"
description : "Path inside the container the storage is mounted"
schema :
type : string
default : ""
2021-09-13 12:17:51 +00:00
required : true
2021-09-11 19:47:14 +00:00
- variable : medium
label : "EmptyDir Medium"
schema :
show_if : [ [ "type" , "=" , "emptyDir" ] ]
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "Memory"
description : "Memory"
- variable : accessMode
2021-09-13 12:17:51 +00:00
label : "(Advanced) Access Mode"
description : "Allow or disallow multiple PVC's writhing to the same PV"
2021-09-11 19:47:14 +00:00
schema :
show_if : [ [ "type" , "=" , "pvc" ] ]
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 :
show_if : [ [ "type" , "=" , "pvc" ] ]
type : string
default : "100Gi"
2021-09-13 17:07:56 +00:00
- variable : ingress
label : ""
group : "Ingress"
schema :
type : dict
attrs :
- variable : main
label : "Main Ingress"
schema :
type : dict
attrs :
- variable : enabled
label : "Enable Ingress"
schema :
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : hosts
label : "Hosts"
schema :
type : list
default : [ ]
items :
- variable : hostEntry
label : "Host"
schema :
type : dict
attrs :
- variable : host
label : "HostName"
schema :
type : string
default : ""
required : true
- variable : paths
label : "Paths"
schema :
type : list
default : [ ]
items :
- variable : pathEntry
label : "Host"
schema :
type : dict
attrs :
- variable : path
label : "path"
schema :
type : string
required : true
default : "/"
- variable : pathType
label : "pathType"
schema :
type : string
required : true
default : "Prefix"
- variable : tls
label : "TLS-Settings"
schema :
type : list
default : [ ]
items :
- variable : tlsEntry
label : "Host"
schema :
type : dict
attrs :
- variable : hosts
label : "Certificate Hosts"
schema :
type : list
default : [ ]
items :
- variable : host
label : "Host"
schema :
type : string
default : ""
required : true
- variable : scaleCert
label : "Select TrueNAS SCALE Certificate"
schema :
type : int
$ref :
- "definitions/certificate"
- variable : entrypoint
label : "(Advanced) Traefik Entrypoint"
description : "Entrypoint used by Traefik when using Traefik as Ingress Provider"
schema :
type : string
default : "websecure"
required : true
- variable : middlewares
label : "Traefik Middlewares"
description : "Add previously created Traefik Middlewares to this Ingress"
schema :
type : list
default : [ ]
items :
- variable : name
label : "Name"
schema :
type : string
default : ""
required : true
- variable : expert
label : "Show Expert Configuration Options"
schema :
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : ingressClassName
label : "IngressClass Name"
schema :
type : string
default : ""
- variable : labelsList
label : "Labels"
schema :
type : list
default : [ ]
items :
- variable : labelItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
- variable : annotationsList
label : "Annotations"
schema :
type : list
default : [ ]
items :
- variable : annotationItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
2021-09-11 19:47:14 +00:00
- variable : ingressList
2021-09-13 12:17:51 +00:00
label : "Add Manual Custom Ingresses"
2021-09-11 19:47:14 +00:00
group : "Ingress"
schema :
type : list
default : [ ]
items :
- variable : ingressListEntry
label : "Custom Ingress"
schema :
type : dict
attrs :
- variable : enabled
label : "Enable Ingress"
schema :
type : boolean
default : true
hidden : true
- variable : name
label : "Name"
schema :
type : string
default : ""
- variable : ingressClassName
label : "IngressClass Name"
schema :
type : string
default : ""
- variable : labelsList
label : "Labels"
schema :
type : list
default : [ ]
items :
- variable : labelItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
- variable : annotationsList
label : "Annotations"
schema :
type : list
default : [ ]
items :
- variable : annotationItem
label : "Label"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
- variable : hosts
label : "Hosts"
schema :
type : list
default : [ ]
items :
- variable : hostEntry
label : "Host"
schema :
type : dict
attrs :
- variable : host
label : "HostName"
schema :
type : string
default : ""
required : true
- variable : paths
label : "Paths"
schema :
type : list
default : [ ]
items :
- variable : pathEntry
label : "Host"
schema :
type : dict
attrs :
- variable : path
label : "path"
schema :
type : string
required : true
default : "/"
- variable : pathType
label : "pathType"
schema :
type : string
required : true
default : "Prefix"
- variable : service
label : "Linked Service"
schema :
type : dict
attrs :
- variable : name
label : "Service Name"
schema :
type : string
default : ""
- variable : port
label : "Service Port"
schema :
type : int
- variable : tls
label : "TLS-Settings"
schema :
type : list
default : [ ]
items :
- variable : tlsEntry
label : "Host"
schema :
type : dict
attrs :
- variable : hosts
label : "Certificate Hosts"
schema :
type : list
default : [ ]
items :
- variable : host
label : "Host"
schema :
type : string
default : ""
required : true
- variable : scaleCert
label : "Select TrueNAS SCALE Certificate"
schema :
type : int
$ref :
- "definitions/certificate"
- variable : entrypoint
label : "Traefik Entrypoint"
description : "Entrypoint used by Traefik when using Traefik as Ingress Provider"
schema :
type : string
default : "websecure"
required : true
- variable : middlewares
label : "Traefik Middlewares"
description : "Add previously created Traefik Middlewares to this Ingress"
schema :
type : list
default : [ ]
items :
- variable : name
label : "Name"
schema :
type : string
default : ""
required : true
- variable : securityContext
group : "Security and Permissions"
label : "Security Context"
schema :
type : dict
attrs :
- variable : privileged
label : "Privileged mode"
schema :
type : boolean
default : false
- variable : readOnlyRootFilesystem
label : "ReadOnly Root Filesystem"
schema :
type : boolean
default : false
- variable : allowPrivilegeEscalation
label : "Allow Privilege Escalation"
schema :
type : boolean
default : true
- variable : runAsNonRoot
label : "runAsNonRoot"
schema :
type : boolean
default : false
- variable : resources
group : "Resources and Devices"
label : ""
schema :
type : dict
attrs :
- variable : limits
label : "Advanced Limit Resource Consumption"
schema :
type : dict
attrs :
- variable : cpu
label : "CPU"
schema :
type : string
default : "2000m"
valid_chars : '^([0-9]+)(\.[0-9]?|m?)$'
- variable : memory
label : "Memory RAM"
schema :
type : string
default : "2Gi"
valid_chars : '^([0-9.]+)([EPTGMK]i?|[EPTGMK]?|e[0-9]+)$'
- variable : requests
label : "Advanced Request minimum resources required"
schema :
type : dict
attrs :
- variable : cpu
label : "CPU"
schema :
type : string
default : "10m"
valid_chars : '^([0-9]+)(\.[0-9]?|m?)$'
- variable : memory
label : "Memory RAM"
schema :
type : string
default : "50Mi"
valid_chars : '^([0-9.]+)([EPTGMK]i?|[EPTGMK]?|e[0-9]+)$'
- variable : autoscaling
group : "Resources and Devices"
2021-09-13 12:17:51 +00:00
label : "(Advanced) Horizontal Pod Autoscaler"
2021-09-11 19:47:14 +00:00
schema :
type : dict
attrs :
- variable : enabled
label : "enabled"
schema :
type : boolean
default : false
show_subquestions_if : true
subquestions :
- variable : target
label : "Target"
description : "deployment name, defaults to main deployment"
schema :
type : string
default : ""
- variable : minReplicas
label : "Minimum Replicas"
schema :
type : int
default : 1
- variable : maxReplicas
label : "Maximum Replicas"
schema :
type : int
default : 5
- variable : targetCPUUtilizationPercentage
label : "Target CPU Utilization Percentage"
schema :
type : int
default : 80
- variable : targetMemoryUtilizationPercentage
label : "Target Memory Utilization Percentage"
schema :
type : int
default : 80
2021-09-13 12:17:51 +00:00
- variable : addons
group : "Addons"
label : ""
schema :
type : dict
attrs :
- variable : vpn
label : "VPN"
schema :
type : dict
attrs :
- variable : type
label : "Type"
schema :
type : string
default : "disabled"
enum :
- value : "disabled"
description : "disabled"
- value : "openvpn"
description : "OpenVPN"
- value : "wireguard"
description : "Wireguard"
- variable : openvpn
label : "OpenVPN Settings"
schema :
type : dict
show_if : [ [ "type" , "=" , "openvpn" ] ]
attrs :
- variable : auth
label : "auth"
schema :
type : string
default : ""
- variable : authSecret
label : "authSecret"
schema :
type : string
default : ""
- variable : wireguard
label : "Wireguard Settings"
schema :
type : dict
show_if : [ [ "type" , "=" , "wireguard" ] ]
attrs :
- variable : KILLSWITCH
label : "Enable killswitch"
schema :
type : boolean
default : false
- variable : KILLSWITCH_EXCLUDEDNETWORKS_IPV4
label : "Killswitch Excluded IPv4 networks"
description : "list of killswitch excluded ipv4 addresses seperated by ;"
schema :
type : string
default : "172.16.0.0/12"
- variable : KILLSWITCH_EXCLUDEDNETWORKS_IPV6
label : "Killswitch Excluded IPv6 networks"
description : "list of killswitch excluded ipv4 addresses seperated by ;"
schema :
type : string
default : ""
- variable : configFile
label : "VPN Config File Location"
schema :
type : dict
show_if : [ [ "type" , "!=" , "disabled" ] ]
attrs :
- variable : enabled
label : "enabled"
schema :
type : boolean
default : true
hidden : true
- variable : type
label : "type"
schema :
type : string
default : "hostPath"
hidden : true
- variable : hostPathType
label : "hostPathType"
schema :
type : string
default : "File"
hidden : true
- variable : noMount
label : "noMount"
schema :
type : boolean
default : true
hidden : true
- variable : hostPath
label : "Full path to file"
schema :
type : string
default : "/mnt/tank/config/YourVPN-Config.conf"
required : true
- variable : envList
label : "VPN environment Variables"
schema :
type : list
show_if : [ [ "type" , "!=" , "disabled" ] ]
default : [ ]
items :
- variable : envItem
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