Workload
Appears in
Section titled “Appears in”.Values.workload
Naming scheme
Section titled “Naming scheme”- Primary:
$FullName(release-name-chart-name) - Non-Primary:
$FullName-$WorkloadName(release-name-chart-name-workload-name)
workload
Section titled “workload”Define workload objects
| Key | workload |
| Type | map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | {} |
Example
workload: {}Define workload
| Key | workload.$name |
| Type | map |
| Required | ✅ |
Helm tpl | ❌ |
| Default | {} |
Example
workload: workload-name: {}enabled
Section titled “enabled”Enable or disable workload
| Key | workload.$name.enabled |
| Type | bool |
| Required | ✅ |
Helm tpl | ✅ |
| Default | false |
Example
workload: workload-name: enabled: trueprimary
Section titled “primary”Set workload as primary
| Key | workload.$name.primary |
| Type | bool |
| Required | ✅ |
Helm tpl | ❌ |
| Default | false |
Example
workload: workload-name: primary: truelabels
Section titled “labels”Define labels for workload
| Key | workload.$name.labels |
| Type | map |
| Required | ❌ |
Helm tpl | ✅ (On value only) |
| Default | {} |
Example
workload: workload-name: labels: key: valueannotations
Section titled “annotations”Define annotations for workload
| Key | workload.$name.annotations |
| Type | map |
| Required | ❌ |
Helm tpl | ✅ (On value only) |
| Default | {} |
Example
workload: workload-name: annotations: key: valuenamespace
Section titled “namespace”Define the namespace for this object
| Key | workload.$name.namespace |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ (On value only) |
| Default | "" |
Example
workload: workload-name: namespace: some-namespaceDefine the kind of the workload
| Key | workload.$name.type |
| Type | string |
| Required | ✅ |
Helm tpl | ❌ |
| Default | "" |
Valid values
Example
workload: workload-name: type: DeploymentpodSpec
Section titled “podSpec”Define the podSpec for the workload
| Key | workload.$name.podSpec |
| Type | map |
| Required | ✅ |
Helm tpl | ❌ |
| Default | {} |
Example
workload: workload-name: podSpec: {}labels
Section titled “labels”Define labels for podSpec
| Key | workload.$name.podSpec.labels |
| Type | map |
| Required | ❌ |
Helm tpl | ✅ (On value only) |
| Default | {} |
Example
workload: workload-name: podSpec: labels: key: valueannotations
Section titled “annotations”Define annotations for podSpec
| Key | workload.$name.podSpec.annotations |
| Type | map |
| Required | ❌ |
Helm tpl | ✅ (On value only) |
| Default | {} |
Example
workload: workload-name: podSpec: annotations: key: valueautomountServiceAccountToken
Section titled “automountServiceAccountToken”Pod’s automountServiceAccountToken
| Key | workload.$name.podSpec.automountServiceAccountToken |
| Type | bool |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: automountServiceAccountToken: trueserviceAccountName
Section titled “serviceAccountName”Define the service account name for the workload
| Key | workload.$name.serviceAccountName |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ (On value only) |
| Default | "" |
Example
workload: workload-name: serviceAccountName: some-service-accountExample
workload: workload-name: podSpec: serviceAccountName: some-service-accounthostNetwork
Section titled “hostNetwork”Bind pod to host’s network
| Key | workload.$name.podSpec.hostNetwork |
| Type | bool |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: hostNetwork: truehostPID
Section titled “hostPID”Allow pod to access host’s PID namespace
| Key | workload.$name.podSpec.hostPID |
| Type | bool |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: hostPID: truehostIPC
Section titled “hostIPC”Allow pod to access host’s IPC namespace
| Key | workload.$name.podSpec.hostIPC |
| Type | bool |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: hostIPC: truehostUsers
Section titled “hostUsers”Allow pod to access host’s users namespace
| Key | workload.$name.podSpec.hostUsers |
| Type | bool |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: hostUsers: trueshareProcessNamespace
Section titled “shareProcessNamespace”Share Process Namespace with other containers in the pod
| Key | workload.$name.podSpec.shareProcessNamespace |
| Type | bool |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: shareProcessNamespace: trueenableServiceLinks
Section titled “enableServiceLinks”Pod’s enableServiceLinks
| Key | workload.$name.podSpec.enableServiceLinks |
| Type | bool |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: enableServiceLinks: truerestartPolicy
Section titled “restartPolicy”Pod’s restartPolicy
| Key | workload.$name.podSpec.restartPolicy |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ |
| Default | See default here |
Valid values
AlwaysNeverOnFailure
Example
workload: workload-name: podSpec: restartPolicy: OnFailureschedulerName
Section titled “schedulerName”Pod’s schedulerName
| Key | workload.$name.podSpec.schedulerName |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ |
| Default | See default here |
Example
workload: workload-name: podSpec: schedulerName: some-schedulerpriorityClassName
Section titled “priorityClassName”Pod’s priorityClassName
| Key | workload.$name.podSpec.priorityClassName |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ |
| Default | See default here |
Example
workload: workload-name: podSpec: priorityClassName: some-priority-class-namehostname
Section titled “hostname”Pod’s hostname
| Key | workload.$name.podSpec.hostname |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ |
| Default | "" |
Example
workload: workload-name: podSpec: hostname: some-hostnameterminationGracePeriodSeconds
Section titled “terminationGracePeriodSeconds”Pod’s terminationGracePeriodSeconds
| Key | workload.$name.podSpec.terminationGracePeriodSeconds |
| Type | int |
| Required | ❌ |
Helm tpl | ✅ |
| Default | See default here |
Example
workload: workload-name: podSpec: terminationGracePeriodSeconds: 100nodeSelector
Section titled “nodeSelector”Pod’s nodeSelector
| Key | workload.$name.podSpec.nodeSelector |
| Type | map |
| Required | ❌ |
Helm tpl | ✅ (On value only) |
| Default | See default here |
Example
workload: workload-name: podSpec: nodeSelector: disk_type: ssdtopologySpreadConstraints
Section titled “topologySpreadConstraints”Pod’s topologySpreadConstraints
| Key | workload.$name.podSpec.topologySpreadConstraints |
| Type | list of map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
hostAliases
Section titled “hostAliases”Pod’s hostAliases
| Key | workload.$name.podSpec.hostAliases |
| Type | list of map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: hostAliases: []Pod’s hostAliases ip
| Key | workload.$name.podSpec.hostAliases.ip |
| Type | string |
| Required | ✅ |
Helm tpl | ✅ |
| Default | "" |
Example
workload: workload-name: podSpec: hostAliases: - ip: 1.2.3.4hostnames
Section titled “hostnames”Pod’s hostAliases hostnames
| Key | workload.$name.podSpec.hostAliases.hostnames |
| Type | list of string |
| Required | ✅ |
Helm tpl | ✅ (On each entry) |
| Default | [] |
Example
workload: workload-name: podSpec: hostAliases: - ip: 1.2.3.4 hostnames: - myserver.local - storage.localdnsPolicy
Section titled “dnsPolicy”Pod’s dnsPolicy
| Key | workload.$name.podSpec.dnsPolicy |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ |
| Default | See default here |
Valid values
NoneDefaultClusterFirstClusterFirstWithHostNet
Example
workload: workload-name: podSpec: dnsPolicy: ClusterFirstdnsConfig
Section titled “dnsConfig”Pod’s dnsConfig
| Key | workload.$name.podSpec.dnsConfig |
| Type | map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: dnsConfig: {}dnsConfig.nameservers
Section titled “dnsConfig.nameservers”Pod’s dnsConfig nameservers
| Key | workload.$name.podSpec.dnsConfig.nameservers |
| Type | list of string |
| Required | ❌ |
Helm tpl | ✅ (On each entry) |
| Default | [] |
Example
workload: workload-name: podSpec: dnsConfig: nameservers: - 1.1.1.1dnsConfig.searches
Section titled “dnsConfig.searches”Pod’s dnsConfig searches
| Key | workload.$name.podSpec.dnsConfig.searches |
| Type | list of string |
| Required | ❌ |
Helm tpl | ✅ (On each entry) |
| Default | [] |
Example
workload: workload-name: podSpec: dnsConfig: searches: - ns1.svc.cluster-domain.examplednsConfig.options
Section titled “dnsConfig.options”Pod’s dnsConfig options
| Key | workload.$name.podSpec.dnsConfig.options |
| Type | list of map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | [{"ndots": "1"}] |
Example
workload: workload-name: podSpec: dnsConfig: options: []dnsConfig.options.name
Section titled “dnsConfig.options.name”Pod’s dnsConfig options name
| Key | workload.$name.podSpec.dnsConfig.options.name |
| Type | string |
| Required | ✅ |
Helm tpl | ✅ |
| Default | "" |
Example
workload: workload-name: podSpec: dnsConfig: options: - name: ndots value: "1"dnsConfig.options.value
Section titled “dnsConfig.options.value”Pod’s dnsConfig options value
| Key | workload.$name.podSpec.dnsConfig.options.value |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ |
| Default | "" |
Example
workload: workload-name: podSpec: dnsConfig: options: - name: ndots value: "1"tolerations
Section titled “tolerations”Pod’s tolerations
| Key | workload.$name.podSpec.tolerations |
| Type | list of map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: tolerations: []tolerations.operator
Section titled “tolerations.operator”Pod’s tolerations operator
| Key | workload.$name.podSpec.tolerations.operator |
| Type | string |
| Required | ✅ |
Helm tpl | ✅ |
| Default | "" |
Valid values
EqualExists
Example
workload: workload-name: podSpec: tolerations: - operator: Existstolerations.key
Section titled “tolerations.key”Pod’s tolerations key
| Key | workload.$name.podSpec.tolerations.key |
| Type | string |
| Required | ❌/✅ |
Helm tpl | ✅ |
| Default | "" |
Example
workload: workload-name: podSpec: tolerations: - operator: Equal key: keytolerations.value
Section titled “tolerations.value”Pod’s tolerations value
| Key | workload.$name.podSpec.tolerations.value |
| Type | string |
| Required | ❌/✅ |
Helm tpl | ✅ |
| Default | "" |
Example
workload: workload-name: podSpec: tolerations: - operator: Equal key: key value: valuetolerations.effect
Section titled “tolerations.effect”Pod’s tolerations effect
| Key | workload.$name.podSpec.tolerations.effect |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ |
| Default | "" |
Valid values
NoExecuteNoSchedulePreferNoSchedule
Example
workload: workload-name: podSpec: tolerations: - operator: Exists effect: NoExecutetolerations.tolerationSeconds
Section titled “tolerations.tolerationSeconds”Pod’s tolerations tolerationSeconds
| Key | workload.$name.podSpec.tolerations.tolerationSeconds |
| Type | int |
| Required | ❌ |
Helm tpl | ❌ |
| Default | unset |
Example
workload: workload-name: podSpec: tolerations: - operator: Exists effect: NoExecute tolerationSeconds: 3600runtimeClassName
Section titled “runtimeClassName”Pod’s runtimeClassName
| Key | workload.$name.podSpec.runtimeClassName |
| Type | string |
| Required | ❌ |
Helm tpl | ✅ |
| Default | See default here |
Example
workload: workload-name: podSpec: runtimeClassName: some-runtime-classsecurityContext
Section titled “securityContext”Pod’s securityContext
| Key | workload.$name.podSpec.securityContext |
| Type | map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Default
securityContext: pod: fsGroup: 568 fsGroupChangePolicy: OnRootMismatch supplementalGroups: - 568Example
workload: workload-name: podSpec: securityContext: {}securityContext.fsGroup
Section titled “securityContext.fsGroup”Pod’s securityContext fsGroup
| Key | workload.$name.podSpec.securityContext.fsGroup |
| Type | int |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: securityContext: fsGroup: 568securityContext.fsGroupChangePolicy
Section titled “securityContext.fsGroupChangePolicy”Pod’s securityContext fsGroupChangePolicy
| Key | workload.$name.podSpec.securityContext.fsGroupChangePolicy |
| Type | string |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Valid values
AlwaysOnRootMismatch
Example
workload: workload-name: podSpec: securityContext: fsGroupChangePolicy: OnRootMismatchsecurityContext.supplementalGroups
Section titled “securityContext.supplementalGroups”Pod’s securityContext supplementalGroups
| Key | workload.$name.podSpec.securityContext.supplementalGroups |
| Type | list of int |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: securityContext: supplementalGroups: - 568securityContext.sysctls
Section titled “securityContext.sysctls”| Key | workload.$name.podSpec.securityContext.sysctls |
| Type | list of map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | See default here |
Example
workload: workload-name: podSpec: securityContext: sysctls: []securityContext.sysctls.name
Section titled “securityContext.sysctls.name”Pod’s securityContext sysctls name
| Key | workload.$name.podSpec.securityContext.sysctls.name |
| Type | string |
| Required | ✅ |
Helm tpl | ✅ |
| Default | "" |
Example
workload: workload-name: podSpec: securityContext: sysctls: - name: net.ipv4.ip_local_port_range value: 1024 65535securityContext.sysctls.value
Section titled “securityContext.sysctls.value”Pod’s securityContext sysctls value
| Key | workload.$name.podSpec.securityContext.sysctls.value |
| Type | string |
| Required | ✅ |
Helm tpl | ✅ |
| Default | "" |
Example
workload: workload-name: podSpec: securityContext: sysctls: - name: net.ipv4.ip_local_port_range value: 1024 65535containers
Section titled “containers”Define container(s) for the workload
See Container for more information
| Key | workload.$name.containers |
| Type | map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | {} |
Example
workload: workload-name: containers: {}initContainers
Section titled “initContainers”Define initContainer(s) for the workload
See Container for more information
| Key | workload.$name.initContainers |
| Type | map |
| Required | ❌ |
Helm tpl | ❌ |
| Default | {} |
Example
workload: workload-name: initContainers: {}Full Examples
Section titled “Full Examples”workload: workload-name: enabled: true primary: true namespace: some-namespace labels: key: value annotations: key: value podSpec: labels: key: value annotations: key: value automountServiceAccountToken: true hostNetwork: false hostPID: false shareProcessNamespace: false enableServiceLinks: false schedulerName: some-scheduler priorityClassName: some-priority-class-name hostname: some-hostname terminationGracePeriodSeconds: 100 nodeSelector: disk_type: ssd hostAliases: - ip: 10.10.10.100 hostnames: - myserver.local - storage.local - ip: 10.10.10.101 hostnames: - myotherserver.local - backups.local dnsPolicy: ClusterFirst dnsConfig: nameservers: - 1.1.1.1 - 1.0.0.1 searches: - ns1.svc.cluster-domain.example - my.dns.search.suffix options: - name: ndots value: "1" - name: edns0 tolerations: - operator: Exists effect: NoExecute tolerationSeconds: 3600 runtimeClassName: some-runtime-class securityContext: fsGroup: 568 fsGroupChangePolicy: OnRootMismatch supplementalGroups: - 568 sysctls: - name: net.ipv4.ip_local_port_range value: 1024 65535Full examples for each workload type can be found here