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" - name: "Middlewares" description: "Traefik Middlewares" - name: "Metrics" description: "Metrics" - name: "Addons" description: "Addon Configuration" - 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 - variable: operator group: "App Configuration" label: "Operator Settings" schema: type: dict attrs: - variable: enabled label: "Enable" schema: type: boolean default: true show_subquestions_if: true subquestions: - variable: logLevel label: "Log Level" description: "Log level for Operator" schema: type: string default: "info" - variable: prometheus group: "App Configuration" label: "Prometheus Settings" schema: type: dict attrs: - variable: enabled label: "Enable" schema: type: boolean default: true show_subquestions_if: true subquestions: - variable: logLevel label: "Log Level" description: "Log level for Prometheus" schema: type: string default: "info" - variable: retention label: "Retention" description: "Metrics retention days" schema: type: string default: "31d" - variable: retentionSize label: "Max Retention Size" description: "Maximum size of metrics" schema: type: string default: "" - variable: disableCompaction label: "Disable Compaction" description: "Disable the compaction of the Prometheus TSDB" schema: type: boolean default: false - variable: walCompression label: "WAL Compression" description: "Enable compression of the write-ahead log using Snappy" schema: type: boolean default: false - variable: alertmanager group: "App Configuration" label: "Alertmanager Settings" schema: type: dict attrs: - variable: enabled label: "Enable" schema: type: boolean default: true show_subquestions_if: true subquestions: - variable: logLevel label: "Log Level" description: "Log level for Alertmanager" schema: type: string default: "info" - variable: retention label: "Retention" description: "Metrics retention days" schema: type: string default: "240h" - variable: service group: "Networking and Services" label: "Configure Service(s)" schema: type: dict attrs: - variable: main label: "Main Service" description: "The serving the Prometheus 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 default: "Simple" enum: - value: "Simple" description: "Simple" - value: "ClusterIP" description: "ClusterIP" - value: "NodePort" description: "NodePort (Advanced)" - value: "LoadBalancer" description: "LoadBalancer (Advanced)" - 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: port label: "Port" description: "This port exposes the container port on the service" schema: type: int default: 10086 required: true - variable: advanced label: "Show Advanced settings" schema: type: boolean default: false show_subquestions_if: true subquestions: - variable: enabled label: "Enable the port" schema: type: boolean default: true - 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: nodePort label: "Node Port (Optional)" description: "This port gets exposed to the node. Only considered when service type is NodePort, Simple or LoadBalancer" schema: type: int min: 9000 max: 65535 - variable: targetPort label: "Target Port" description: "The internal(!) port on the container the Application runs on" schema: type: int default: 9090 - variable: alertmanager label: "alertmanager Service" description: "alertmanager service " 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 default: "Simple" enum: - value: "Simple" description: "Simple" - value: "ClusterIP" description: "ClusterIP" - value: "NodePort" description: "NodePort (Advanced)" - value: "LoadBalancer" description: "LoadBalancer (Advanced)" - 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: alertmanager label: "alertmanager Service Port Configuration" schema: type: dict attrs: - variable: port label: "Port" description: "This port exposes the container port on the service" schema: type: int default: 10087 required: true - variable: advanced label: "Show Advanced settings" schema: type: boolean default: false show_subquestions_if: true subquestions: - variable: enabled label: "Enable the port" schema: type: boolean default: true - 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: nodePort label: "Node Port (Optional)" description: "This port gets exposed to the node. Only considered when service type is NodePort, Simple or LoadBalancer" schema: type: int min: 9000 max: 65535 - variable: targetPort label: "Target Port" description: "The internal(!) port on the container the Application runs on" schema: type: int default: 9093 - 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: dict attrs: - variable: name label: "Name" schema: type: string - variable: value label: "Value" schema: type: string - variable: searches label: "Searches" schema: default: [] type: list items: - variable: search label: "Search Entry" schema: type: string - variable: serviceList label: "Add Manual Custom Services" group: "Networking and Services" schema: type: list default: [] items: - variable: serviceListEntry label: "Custom Service" schema: type: dict attrs: - variable: enabled label: "Enable the service" schema: type: boolean default: true hidden: true - variable: name label: "Name" schema: type: string 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" schema: type: string default: "Simple" enum: - value: "Simple" description: "Simple" - 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: portsList label: "Additional Service Ports" schema: type: list default: [] items: - variable: portsListEntry label: "Custom ports" schema: 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 - 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 hidden: true - variable: name label: "Name (optional)" description: "Not required, please set to config when mounting /config or temp when mounting /tmp" schema: type: string - variable: type label: "Type of Storage" description: "Sets the persistence type, Anything other than PVC could break rollback!" schema: type: string default: "simpleHP" enum: - value: "simplePVC" description: "PVC (simple)" - value: "simpleHP" description: "HostPath (simple)" - value: "emptyDir" description: "emptyDir" - value: "pvc" description: "pvc" - value: "hostPath" description: "hostPath" - variable: setPermissionsSimple label: "Automatic Permissions" description: "Automatically set permissions on install" schema: show_if: [["type", "=", "simpleHP"]] type: boolean default: true - 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: hostPathSimple label: "hostPath" description: "Path inside the container the storage is mounted" schema: show_if: [["type", "=", "simpleHP"]] type: hostpath - variable: hostPath label: "hostPath" description: "Path inside the container the storage is mounted" schema: show_if: [["type", "=", "hostPath"]] type: hostpath - variable: mountPath label: "mountPath" description: "Path inside the container the storage is mounted" schema: type: string default: "" required: true valid_chars: '^\/([a-zA-Z0-9._-]+(\s?[a-zA-Z0-9._-]+|\/?))+$' - variable: medium label: "EmptyDir Medium" schema: show_if: [["type", "=", "emptyDir"]] type: string default: "" enum: - value: "" description: "Default" - value: "Memory" description: "Memory" - variable: size label: "Size quotum of storage" schema: show_if: [["type", "=", "pvc"]] type: string default: "999Gi" - variable: hostPathType label: "(Advanced) 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: storageClass label: "(Advanced) storageClass" description: "Warning: Anything other than SCALE-ZFS or empty will break rollback!" schema: show_if: [["type", "=", "pvc"]] type: string default: "SCALE-ZFS" - variable: accessMode label: "(Advanced) Access Mode" 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: 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 - 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: enableFixedMiddlewares description: "These middlewares enforce a number of best practices." label: "Enable Default Middlewares" schema: type: boolean default: true - 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: ingressList label: "Add Manual Custom Ingresses" 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: autoscaling group: "Advanced" label: "(Advanced) Horizontal Pod Autoscaler" 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