2021-05-05 11:56:00 -04:00
groups :
- name : "Container Image"
description : "Image to be used for container"
2021-05-30 10:09:07 -04:00
- name : "Controller"
2021-05-05 11:56:00 -04:00
description : "Configure workload deployment"
2021-05-30 10:09:07 -04:00
- name : "Container Configuration"
2021-05-05 11:56:00 -04:00
description : "additional container configuration"
2021-05-30 10:09:07 -04:00
- name : "App Configuration"
description : "App specific config options"
- name : "Networking and Services"
2021-05-22 11:59:46 -04:00
description : "Configure Network and Services for container"
2021-05-30 10:09:07 -04:00
- 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"
2021-05-05 11:56:00 -04:00
- name : "Resources and Devices"
description : "Specify resources/devices to be allocated to workload"
- name : "Advanced"
description : "Advanced Configuration"
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 10:09:07 -04:00
- variable : controller
group : "Controller"
label : ""
2021-05-05 11:56:00 -04:00
schema :
2021-05-30 10:09:07 -04: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-05-22 11:59:46 -04:00
- variable : env
2021-05-30 10:09:07 -04:00
group : "Container Configuration"
2021-05-22 11:59:46 -04:00
label : "Image Environment"
schema :
type : dict
attrs :
2021-05-23 11:04:55 -04:00
- variable : TZ
2021-05-22 19:15:39 -04:00
label : "Timezone"
schema :
type : string
default : "Etc/UTC"
$ref :
- "definitions/timezone"
2021-05-22 11:59:46 -04:00
- variable : UMASK
label : "UMASK"
description : "Sets the UMASK env var for LinuxServer.io (compatible) containers"
schema :
type : string
default : "002"
2021-05-05 11:56:00 -04:00
# Configure Enviroment Variables
2021-05-22 11:59:46 -04:00
- variable : envList
2021-05-05 11:56:00 -04:00
label : "Image environment"
2021-05-30 10:09:07 -04:00
group : "Container Configuration"
2021-05-05 11:56:00 -04:00
schema :
type : list
default : [ ]
items :
2021-05-22 11:59:46 -04:00
- variable : envItem
2021-05-05 11:56:00 -04:00
label : "Environment Variable"
schema :
type : dict
attrs :
- variable : name
label : "Name"
schema :
type : string
- variable : value
label : "Value"
schema :
type : string
2021-05-30 10:09:07 -04:00
2021-05-05 11:56:00 -04:00
- variable : hostNetwork
2021-05-30 10:09:07 -04:00
group : "Networking and Services"
2021-05-05 11:56:00 -04:00
label : "Enable Host Networking"
schema :
type : boolean
default : false
2021-05-30 10:09:07 -04:00
- variable : externalInterfaces
description : "External Interfaces"
label : "(Advanced) External Interfaces"
group : "Networking and Services"
schema :
type : list
items :
- variable : interfaceConfiguration
description : "Interface Configuration"
label : "Interface Configuration"
schema :
type : dict
$ref :
- "normalize/interfaceConfiguration"
attrs :
- variable : hostInterface
description : "Please specify host interface"
label : "Host Interface"
schema :
type : string
required : true
$ref :
- "definitions/interface"
- variable : ipam
description : "Define how IP Address will be managed"
label : "IP Address Management"
schema :
type : dict
required : true
attrs :
- variable : type
description : "Specify type for IPAM"
label : "IPAM Type"
schema :
type : string
required : true
enum :
- value : "dhcp"
description : "Use DHCP"
- value : "static"
description : "Use static IP"
show_subquestions_if : "static"
subquestions :
- variable : staticIPConfigurations
label : "Static IP Addresses"
schema :
type : list
items :
- variable : staticIP
label : "Static IP"
schema :
type : ipaddr
cidr : true
- variable : staticRoutes
label : "Static Routes"
schema :
type : list
items :
- variable : staticRouteConfiguration
label : "Static Route Configuration"
schema :
type : dict
attrs :
- variable : destination
label : "Destination"
schema :
type : ipaddr
cidr : true
required : true
- variable : gateway
label : "Gateway"
schema :
type : ipaddr
cidr : false
required : true
2021-05-22 11:59:46 -04:00
- variable : service
2021-05-30 10:09:07 -04:00
group : "Networking and Services"
2021-05-22 11:59:46 -04:00
label : "Configure Service(s)"
2021-05-05 11:56:00 -04:00
schema :
type : dict
attrs :
- variable : main
2021-05-22 11:59:46 -04:00
label : "Main Service"
2021-05-05 11:56:00 -04: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 11:59:46 -04: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 11:56:00 -04:00
schema :
type : string
2021-05-22 11:59:46 -04:00
default : "NodePort"
2021-05-05 11:56:00 -04:00
enum :
- value : "NodePort"
description : "NodePort"
- value : "ClusterIP"
description : "ClusterIP"
2021-05-22 11:59:46 -04:00
- value : "LoadBalancer"
description : "LoadBalancer"
- variable : loadBalancerIP
label : "LoadBalancer IP"
description : "LoadBalancerIP"
2021-05-05 11:56:00 -04:00
schema :
2021-05-22 11:59:46 -04: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 11:56:00 -04:00
schema :
type : string
2021-05-22 11:59:46 -04:00
- variable : ports
label : "Service's Port(s) Configuration"
schema :
type : dict
attrs :
- variable : main
label : "Main Service Port Configuration"
2021-05-05 11:56:00 -04:00
schema :
2021-05-22 11:59:46 -04:00
type : dict
attrs :
2021-05-24 17:01:43 -04:00
- variable : enabled
label : "Enable the port"
schema :
type : boolean
default : true
hidden : true
2021-05-22 11:59:46 -04: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"
- variable : port
label : "Container Port"
schema :
type : int
default : 9117
editable : false
hidden : true
- variable : targetport
label : "Target Port"
description : "This port exposes the container port on the service"
schema :
type : int
default : 9117
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 : 36009
required : true
## TrueCharts Specific
2021-05-05 11:56:00 -04:00
- variable : persistence
label : "Integrated Persistent Storage"
2021-05-30 10:09:07 -04:00
group : "Storage and Persistence"
2021-05-05 11:56:00 -04:00
schema :
type : dict
attrs :
- variable : config
label : "App Config Storage"
description : "Stores the Application Configuration."
schema :
type : dict
attrs :
- variable : enabled
label : "Enable the storage"
schema :
type : boolean
default : true
- variable : storageClass
label : "Type of Storage"
2021-05-24 15:17:29 -04:00
description : " Warning: Anything other than SCALE-ZFS will break rollback!"
2021-05-05 11:56:00 -04:00
schema :
type : string
2021-05-24 15:17:29 -04:00
default : "SCALE-ZFS"
2021-05-05 11:56:00 -04:00
- variable : mountPath
label : "mountPath"
description : "Path inside the container the storage is mounted"
schema :
type : string
default : "/config"
hidden : true
- variable : emptyDir
2021-05-24 15:56:45 -04:00
label : "EmptyDir Volume"
2021-05-05 11:56:00 -04:00
schema :
2021-05-23 13:38:29 -04:00
type : dict
attrs :
- variable : enabled
2021-05-24 15:56:45 -04:00
label : "Use emptyDir volume"
2021-05-23 13:38:29 -04:00
schema :
type : boolean
default : false
2021-05-24 15:56:45 -04:00
show_subquestions_if : true
subquestions :
- variable : medium
label : "EmptyDir Medium"
schema :
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "Memory"
description : "Memory"
2021-05-05 11:56:00 -04:00
- 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"
2021-05-19 09:12:45 -04:00
- variable : hostPathMounts
2021-05-05 11:56:00 -04:00
label : "Custom app storage"
2021-05-30 10:09:07 -04:00
group : "Storage and Persistence"
2021-05-05 11:56:00 -04:00
schema :
type : list
default : [ ]
items :
- variable : volumeMount
label : "Custom Storage"
schema :
type : dict
attrs :
- variable : enabled
label : "Enabled"
schema :
type : boolean
default : true
hidden : true
- variable : setPermissions
label : "Automatic Permissions"
description : "Automatically set permissions on install"
schema :
type : boolean
default : true
- variable : readOnly
label : "Mount as ReadOnly"
description : "prevent any write from being done to the mounted volume"
schema :
type : boolean
default : false
- variable : emptyDir
2021-05-24 15:56:45 -04:00
label : "EmptyDir Volume"
2021-05-05 11:56:00 -04:00
schema :
2021-05-24 15:56:45 -04:00
type : dict
attrs :
- variable : enabled
label : "Use emptyDir volume"
schema :
type : boolean
default : false
2021-05-24 17:01:43 -04:00
- variable : medium
label : "EmptyDir Medium"
schema :
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "Memory"
description : "Memory"
2021-05-05 11:56:00 -04:00
- variable : mountPath
label : "Mount Path"
description : "Path to mount inside the pod"
schema :
type : path
required : true
default : ""
editable : true
- variable : hostPath
label : "Host Path"
2021-05-24 15:56:45 -04:00
description : "Path on the host to mount inside the container, ignored when emptyDir is enabled"
2021-05-05 11:56:00 -04:00
schema :
type : hostpath
required : true
# Enable privileged
- variable : securityContext
2021-05-30 10:09:07 -04:00
group : "Security and Permissions"
2021-05-05 11:56:00 -04:00
label : "Security Context"
schema :
type : dict
attrs :
- variable : privileged
label : "Enable privileged mode for Common-Chart based charts"
schema :
type : boolean
default : false
# Set Pod Security Policy
- variable : podSecurityContext
2021-05-30 10:09:07 -04:00
group : "Security and Permissions"
2021-05-05 11:56:00 -04:00
label : "Pod Security Context"
schema :
type : dict
attrs :
- variable : runAsNonRoot
label : "runAsNonRoot"
schema :
type : boolean
default : true
- variable : runAsUser
label : "runAsUser"
description : "The UserID of the user running the application"
schema :
type : int
default : 568
- variable : runAsGroup
label : "runAsGroup"
description : The groupID this App of the user running the application"
schema :
type : int
default : 568
- variable : fsGroup
label : "fsGroup"
description : "The group that should own ALL storage."
schema :
type : int
default : 568
- variable : fsGroupChangePolicy
label : "When should we take ownership?"
schema :
type : string
default : "OnRootMismatch"
enum :
- value : "OnRootMismatch"
description : "OnRootMismatch"
- value : "Always"
description : "Always"
2021-05-30 10:09:07 -04:00
- 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"
- variable : memory
label : "Memory RAM"
schema :
type : string
default : "2Gi"
- variable : requests
label : "Advanced Request minimum resources required"
schema :
type : dict
attrs :
- variable : cpu
label : "CPU"
schema :
type : string
default : "10m"
- variable : memory
label : "Memory RAM"
schema :
type : string
default : "50Mi"