2021-09-13 10:58:34 +00:00
# Include{groups}
2021-05-05 20:31:59 +00:00
portals :
web_portal :
protocols :
- "$kubernetes-resource_configmap_portal_protocol"
host :
- "$kubernetes-resource_configmap_portal_host"
ports :
- "$kubernetes-resource_configmap_portal_port"
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
default : true
2021-05-30 14:09:07 +00:00
- variable : controller
group : "Controller"
label : ""
2021-05-05 20:31:59 +00:00
schema :
2021-05-30 14:09:07 +00:00
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 10:58:34 +00:00
# Include{controllerExpert}
2021-05-22 15:59:46 +00:00
# Docker specific env
- variable : env
2021-05-30 14:09:07 +00:00
group : "Container Configuration"
2021-05-22 15:59:46 +00:00
label : "Image Environment"
schema :
type : dict
attrs :
2021-05-23 15:04:55 +00:00
- variable : TZ
2021-05-22 23:15:39 +00:00
label : "Timezone"
schema :
type : string
default : "Etc/UTC"
$ref :
- "definitions/timezone"
2021-05-22 15:59:46 +00:00
- variable : APP_KEY
label : "App Key"
description : "Your unique 32 application character key"
schema :
type : string
default : ""
2021-06-29 13:09:32 +00:00
min_length : 32
max_length : 32
2021-07-13 21:40:12 +00:00
valid_chars : '[a-zA-Z0-9!@#$%^&*?]{32}'
2021-05-22 15:59:46 +00:00
required : true
- variable : UMASK
label : "UMASK"
description : "Sets the UMASK env var for LinuxServer.io (compatible) containers"
schema :
type : string
default : "002"
2021-09-13 10:58:34 +00:00
# Include{containerConfig}
2021-05-30 14:09:07 +00:00
2021-05-22 15:59:46 +00:00
- variable : service
2021-05-30 14:09:07 +00:00
group : "Networking and Services"
2021-05-22 15:59:46 +00:00
label : "Configure Service(s)"
2021-05-05 20:31:59 +00:00
schema :
type : dict
attrs :
- variable : main
2021-05-22 15:59:46 +00:00
label : "Main Service"
2021-05-05 20:31:59 +00:00
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
2021-05-22 15:59:46 +00:00
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-05-05 20:31:59 +00:00
schema :
type : string
2021-05-22 15:59:46 +00:00
default : "NodePort"
2021-05-05 20:31:59 +00:00
enum :
- value : "NodePort"
description : "NodePort"
- value : "ClusterIP"
description : "ClusterIP"
2021-05-22 15:59:46 +00:00
- value : "LoadBalancer"
description : "LoadBalancer"
- variable : loadBalancerIP
label : "LoadBalancer IP"
description : "LoadBalancerIP"
2021-05-05 20:31:59 +00:00
schema :
2021-05-22 15:59:46 +00:00
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-05-05 20:31:59 +00:00
schema :
type : string
2021-05-22 15:59:46 +00:00
- variable : ports
label : "Service's Port(s) Configuration"
schema :
type : dict
attrs :
- variable : main
label : "Main Service Port Configuration"
2021-05-05 20:31:59 +00:00
schema :
2021-05-22 15:59:46 +00:00
type : dict
attrs :
2021-05-24 21:01:43 +00:00
- variable : enabled
label : "Enable the port"
schema :
type : boolean
default : true
hidden : true
2021-05-22 15:59:46 +00:00
- variable : protocol
label : "Port Type"
schema :
type : string
default : "HTTP"
enum :
- value : HTTP
description : "HTTP"
- value : "HTTPS"
description : "HTTPS"
- value : TCP
description : "TCP"
- value : "UDP"
description : "UDP"
2021-08-30 20:55:51 +00:00
- variable : targetPort
label : "Target Port"
description : "This port exposes the container port on the service"
2021-05-22 15:59:46 +00:00
schema :
type : int
default : 8080
editable : false
hidden : true
2021-08-30 20:55:51 +00:00
- variable : port
label : "Container Port"
2021-05-22 15:59:46 +00:00
schema :
type : int
2021-09-09 15:14:19 +00:00
default : 8080
2021-05-22 15:59:46 +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
default : 36048
2021-06-11 11:59:46 +00:00
2021-09-13 16:49:14 +00:00
- 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
- 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-13 10:58:34 +00:00
# Include{serviceList}
2021-08-30 13:58:30 +00:00
2021-05-05 20:31:59 +00:00
- variable : persistence
label : "Integrated Persistent Storage"
2021-05-22 15:59:46 +00:00
description : "Integrated Persistent Storage"
2021-05-30 14:09:07 +00:00
group : "Storage and Persistence"
2021-05-05 20:31:59 +00:00
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
2021-06-11 11:59:46 +00:00
- 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"
2021-05-05 20:31:59 +00:00
- variable : storageClass
2021-06-11 11:59:46 +00:00
label : "(Advanced) storageClass"
2021-05-24 19:17:29 +00:00
description : " Warning: Anything other than SCALE-ZFS will break rollback!"
2021-05-05 20:31:59 +00:00
schema :
2021-06-11 11:59:46 +00:00
show_if : [ [ "type" , "=" , "pvc" ] ]
2021-05-05 20:31:59 +00:00
type : string
2021-05-24 19:17:29 +00:00
default : "SCALE-ZFS"
2021-06-11 11:59:46 +00:00
- 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"
2021-05-05 20:31:59 +00:00
- variable : mountPath
label : "mountPath"
description : "Path inside the container the storage is mounted"
schema :
type : string
default : "/data"
hidden : true
2021-06-11 11:59:46 +00:00
- variable : medium
label : "EmptyDir Medium"
2021-05-05 20:31:59 +00:00
schema :
2021-06-11 11:59:46 +00:00
show_if : [ [ "type" , "=" , "emptyDir" ] ]
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "Memory"
description : "Memory"
2021-05-05 20:31:59 +00:00
- variable : accessMode
label : "Access Mode (Advanced)"
2021-06-11 11:59:46 +00:00
description : "Allow or disallow multiple PVC's writhing to the same PV"
2021-05-05 20:31:59 +00:00
schema :
2021-06-11 11:59:46 +00:00
show_if : [ [ "type" , "=" , "pvc" ] ]
2021-05-05 20:31:59 +00:00
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 :
2021-06-11 11:59:46 +00:00
show_if : [ [ "type" , "=" , "pvc" ] ]
2021-05-05 20:31:59 +00:00
type : string
default : "100Gi"
2021-08-12 13:03:22 +00:00
2021-09-13 10:58:34 +00:00
# Include{persistenceList}
2021-06-08 11:20:47 +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
2021-07-01 08:26:42 +00:00
- variable : scaleCert
2021-06-08 11:20:47 +00:00
label : "Select TrueNAS SCALE Certificate"
schema :
type : int
$ref :
- "definitions/certificate"
2021-06-30 19:26:16 +00:00
- variable : entrypoint
2021-09-13 16:49:14 +00:00
label : "(Advanced) Traefik Entrypoint"
2021-06-30 19:26:16 +00:00
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
2021-06-08 11:20:47 +00:00
2021-09-13 16:49:14 +00:00
- 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-13 10:58:34 +00:00
# Include{ingressList}
2021-08-30 13:58:30 +00:00
2021-05-05 20:31:59 +00:00
- variable : securityContext
2021-05-30 14:09:07 +00:00
group : "Security and Permissions"
2021-05-05 20:31:59 +00:00
label : "Security Context"
schema :
type : dict
attrs :
- variable : privileged
2021-09-07 22:47:09 +00:00
label : "Privileged mode"
2021-08-28 12:27:27 +00:00
schema :
type : boolean
default : false
- variable : readOnlyRootFilesystem
label : "ReadOnly Root Filesystem"
2021-05-05 20:31:59 +00:00
schema :
type : boolean
default : false
2021-08-28 12:27:27 +00:00
- variable : allowPrivilegeEscalation
label : "Allow Privilege Escalation"
schema :
type : boolean
2021-09-26 18:05:21 +00:00
default : false
2021-09-10 13:26:10 +00:00
- variable : runAsNonRoot
label : "runAsNonRoot"
schema :
type : boolean
2021-09-26 18:05:21 +00:00
default : true
2021-06-08 11:20:47 +00:00
2021-05-05 20:31:59 +00:00
- variable : podSecurityContext
2021-05-30 14:09:07 +00:00
group : "Security and Permissions"
2021-05-05 20:31:59 +00:00
label : "Pod Security Context"
schema :
type : dict
attrs :
- variable : runAsUser
label : "runAsUser"
description : "The UserID of the user running the application"
schema :
type : int
2021-09-26 18:05:21 +00:00
default : 568
2021-05-05 20:31:59 +00:00
- variable : runAsGroup
label : "runAsGroup"
description : The groupID this App of the user running the application"
schema :
type : int
2021-09-26 18:05:21 +00:00
default : 568
2021-05-05 20:31:59 +00:00
- variable : fsGroup
label : "fsGroup"
description : "The group that should own ALL storage."
schema :
type : int
2021-09-26 18:05:21 +00:00
default : 568
2021-08-24 10:53:31 +00:00
- variable : supplementalGroups
2021-08-30 13:58:30 +00:00
label : "supplemental Groups"
2021-08-24 10:53:31 +00:00
schema :
type : list
default : [ ]
items :
- variable : supplementalGroupsEntry
2021-08-30 13:58:30 +00:00
label : "supplemental Group"
2021-08-24 10:53:31 +00:00
schema :
type : int
2021-05-05 20:31:59 +00:00
- variable : fsGroupChangePolicy
label : "When should we take ownership?"
schema :
type : string
default : "OnRootMismatch"
enum :
- value : "OnRootMismatch"
description : "OnRootMismatch"
- value : "Always"
description : "Always"
2021-09-26 18:05:21 +00:00
2021-09-26 18:44:02 +00:00
# Include{resources}
2021-08-30 13:58:30 +00:00
- variable : autoscaling
group : "Resources and Devices"
2021-09-13 10:58:34 +00:00
label : "(Advanced) Horizontal Pod Autoscaler"
2021-08-30 13:58:30 +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 10:58:34 +00:00
# Include{addons}
