Categories: ADMIN GUIDE CLOUD

Helm Values

Helm values

Values that could be used are listed below.

Image parameters

Name Description Default value
image.repository Controller and Agent images repository base name ""
image.pullPolicy Controller and Agent images pull policy Always
imagePullSecrets Registry secret names as an array []

Commons parameters

Name Description Default value
commons.version Step version to use 3.29.0
commons.edition Step edition to use (os or ee) ee
commons.nodeSelector Shared node labels for Controller and Agent pods assignment {}
commons.extraDeploy Extra objects to deploy with the release (evaluated as a template) {}

Controller parameters

Name Description Value
controller.enabled Define if the Controller material should be created true
controller.agentProvisioning.enabled Defines if the agent provisioning should be enabled false
controller.agentProvisioning.agentStartTimeoutSeconds Defines how long to wait for the agent to be provisioned. Agent provisioning fails with an error if timeout is elapsed 180
controller.agentProvisioning.provisionableAgentsPerExecutionLimit Defines the maximum number of agents that could be provisioned for a single execution 1000
controller.agentProvisioning.remoteAgentPoolRegistryKeepAliveTimeoutSeconds Specifies the number of seconds Step waits for a keep-alive message from a remote agent pool (from a secondary cluster) before considering it offline and removing it from the registry 60
controller.agentProvisioning.rbac.create Optional, define if the necessary RBAC for agent provisioning should be created, default to true true
controller.lifecycleHooks Controller custom lifecycle hooks {}
controller.terminationGracePeriodSeconds Controller termination grace period 120
controller.tolerations Define tolerations for the Controller []
controller.hostAliases Define host aliases for the Controller []
controller.extraInitContainers Define any extra init containers to run prior the Controller []
controller.extraContainers Define any extra containers to run alongside the Controller []
controller.extraConfigMaps.data Additional Controller configMap data {}
controller.extraSecrets.stringData Additional clear text Controller secrets {}
controller.extraSecrets.data Additional base64 encoded Controller secrets {}
controller.serviceAccount.create Define if a dedicated service account should be created for the Controller false
controller.serviceAccount.name Define the service account that should be created and / or used by the Controller. Mandatory if create param is set to true. Use “default” if omitted. controller
controller.serviceAccount.automountServiceAccountToken Automatically mount the Controller service account token into the Pod true
controller.rbac.create Define if some custom RBAC rules needs to be created and mapped to the service account false
controller.rbac.rules RBAC rule to be created []
controller.annotations Additional labels to be added to the Controller statefulset {}
controller.extraEnvVars Extra environment variables []
controller.probes Controller probes {}
controller.podSecurityContext Controller Pod security context nil
controller.topologySpreadConstraints Controller Pod topology spread constraint []
controller.containerSecurityContext Controller Container security context {}
controller.licenseconfig Base64 encoded (line wrapping disabled) Step license configuration, to be used with Step version >= 22 ""
controller.licenses Base64 encoded (line wrapping disabled) Step licenses, to be used with Step version >= 22 ""
controller.additionalLicenses Base64 encoded Step licences (Step version >= 22) {}
controller.tech.type Used to build image tag ( commons.version-tech.type-tech.version) java
controller.tech.version Used to build image tag ( commons.version-tech.type-tech.version) 21
controller.config.port Controller UI port 8080
controller.config.placeholders Optional, placeholders can be used in step.properties to define dynamic values that have to be set at startup outside the configuration file. See https://step.dev/knowledgebase/setup/configuration/#configuration-placeholders details ""
controller.config.NON_HEAP_MEMORY_MB Environment variable to set non heap memory and so Xmx value 750
controller.config.STEP_DP Environment variable to install external dependencies from Exense private Nexus (https://nexus-enterprise.exense.ch/), format package=version ""
controller.config.FULL_STEP_DP Environment variable to install external dependencies using a fully qualified URL. ""
controller.config.JAVA_OPTS Additional JVM options ""
controller.config.additionalProperties Additional properties to be added at the end of the Controller step.properties file {}
controller.config.logbackConfiguration Optional, custom logback.xml configuration file to be passed to the Controller. Leave empty for default configuration ""
controller.nodeSelector Controller node selectors {}
controller.affinity Controller affinity {}
controller.resources Controller resources settings {}
controller.databaseInitContainerSecurityContext Controller Init Container (waiting for DB to be ready) security context {}
controller.databaseInitContainerResources Controller Init Container (waiting for DB to be ready) resources settings {}
controller.persistenceInitContainerSecurityContext Controller Init Container (copy default data folder to PVC) security context {}
controller.persistenceInitContainerResources Controller Init Container (copy default data folder to PVC) resources settings {}
controller.persistence.enabled Enabled data and / or persistence if enabled true
controller.persistence.pvc.data.mountPath Path to mount data PVC into the Controller /home/controller/data
controller.persistence.pvc.data.size Data PVC size 30Gi
controller.persistence.pvc.data.storageClass.name Storage class name to be used for data PVC. Optional. default
controller.persistence.pvc.data.accessModes Access Modes list to be used for data PVC (default to ReadWriteOnce) []
controller.persistence.pvc.log.enabled Enable log persistence if enabled false
controller.persistence.pvc.log.mountPath Path to mount log PVC into the Controller /home/controller/log
controller.persistence.pvc.log.size Log PVC size 10Gi
controller.persistence.pvc.log.storageClass.name Storage class name to be used for log PVC. Optional default
controller.persistence.pvc.log.accessModes Access Modes list to be used for log PVC (default to ReadWriteOnce) []
controller.extraVolumeMounts Controller POD extra volume mounts []
controller.extraVolumes Controller POD extra volumes []
controller.extraVolumeClaimTemplates Controller POD extra volumes claim templates []

Grid parameters

Name Description Value
grid.config.port Grid port 8081
grid.authentication.enabled Enable authentication for the grid false
grid.authentication.gridSecretKey Optional, secret key for grid authentication, will be generated if missing or left empty ""
grid.authentication.gridSecretRef Optional, reference to existing Kubernetes secret containing gridSecretKey {}
grid.expose Define if the Grid service should be exposed to the external world via Ingress false
grid.client.ssl.allowinvalidcertificate Allow Step Agent invalid certificates (useful only when SSL is enabled on the Agent) false
grid.client.token.selection.matchexist.timeout.ms Defines the timeout of the token selection in case of matching tokens in the pool 60000
grid.client.token.lifecycle.removeOn.tokenreleaseerror Defines if Agent tokens have to be marked as failing after a token release error true
grid.client.token.lifecycle.removeOn.tokenreservationerror Defines if Agent tokens have to be marked as failing after a token reservation error true
grid.client.token.lifecycle.removeOn.tokencallerror Defines if Agent tokens have to be marked as failing after a keyword call error true
grid.client.token.lifecycle.removeOn.agenterror Defines if agent tokens have to be marked as failing after an agent error (agent layer) true

Grid Proxy parameters

Name Description Value
gridproxy.enabled Should the Grid Proxy components be deployed false
gridproxy.agentProvisioning.enabled Defines if the agent provisioning should be enabled false
gridproxy.agentProvisioning.agentStartTimeoutSeconds Defines how long to wait for the agent to be provisioned. Agent provisioning fails with an error if timeout is elapsed 180
gridproxy.agentProvisioning.rbac.create Optional, define if the necessary RBAC for agent provisioning should be created, default to true true
gridproxy.serviceAccount.create Define if a dedicated service account should be created for the Grid Proxy false
gridproxy.serviceAccount.name Define the service account that should be created and / or used by the Grid Proxy. Mandatory if create param is set to true. Use “default” if omitted. gridproxy
gridproxy.serviceAccount.automountServiceAccountToken Automatically mount the Grid Proxy service account token into the Pod true
gridproxy.rbac.create Define if some custom RBAC rules needs to be created and mapped to the service account false
gridproxy.rbac.rules RBAC rule to be created []
gridproxy.annotations Additional labels to be added to the Grid Proxy statefulset {}
gridproxy.extraEnvVars Grid Proxy Extra environment variables []
gridproxy.podSecurityContext Grid Proxy Pod security context {}
gridproxy.topologySpreadConstraints Grid Proxy Container topology spread constraint []
gridproxy.containerSecurityContext Grid Proxy Container security context {}
gridproxy.exposeMetrics Define if the Grid Proxy should expose metrics that can be scrapped by prometheus true
gridproxy.tech.type Used to build image tag ( commons.version-tech.type-tech.version) java
gridproxy.tech.version Used to build image tag ( commons.version-tech.type-tech.version) 21
gridproxy.config.port Grid Proxy port 8081
gridproxy.config.gridUrl Primary grid URL https://step-primary.example.com
gridproxy.config.gridProxyName Optional, unique name of the Grid proxy MyProxy1
gridproxy.config.gridConnectTimeout Specifies how long in ms the proxy should wait before throwing a timeout when it creates a connection to the controller grid server. Should be higher than the equivalent configuration for the agents 4000
gridproxy.config.gridReadTimeout Specifies how long in ms the proxy should wait before throwing a timeout when it opens a connection or read data from the controller. Should be higher than the equivalent configuration for the agents 22000
gridproxy.config.agentConnectTimeout Defines the socket connect timeout to the agent in ms. This timeout is also added as offset to the keyword call timeout when requesting keyword execution on the agents. Should be higher than the equivalent configuration for the agents 4000
gridproxy.config.agentReserveTimeout Defines the call timeout in ms of token reservations. Should be higher than the equivalent configuration for the agents 12000
gridproxy.config.agentReleaseTimeout Defines the call timeout in ms of token releases. Should be higher than the equivalent configuration for the agents 62000
gridproxy.config.NON_HEAP_MEMORY_MB Environment variable to set non heap memory and so Xmx value 256
gridproxy.config.STEP_DP Environment variable to install external dependencies from Exense private Nexus (https://nexus-enterprise.exense.ch/), format package=version ""
gridproxy.config.FULL_STEP_DP Environment variable to install external dependencies using a fully qualified URL. ""
gridproxy.config.JAVA_OPTS Additional JVM options ""
gridproxy.config.additionalProperties Additional properties to be added at the end of the Grid Proxy properties file {}
gridproxy.nodeSelector Grid Proxy node selectors {}
gridproxy.resources Grid Proxy resources settings {}
gridproxy.extraVolumeMounts Grid Proxy extra volume mounts []
gridproxy.extraVolumes Grid Proxy extra volumes []

Agents parameters

Note that agent pools are defined as list entries : you can comment / add / or remove entries based on your needs. By default, only the first entry (“java” agent type) is set to deploy 1 pod replica, the others are set to 0 replica.

Name Description Value
agent.pools[0].name Agent pool name java
agent.pools[0].agentProvisioningTemplate Optional, define if the Agent Pools can be used as a template for Agent Provisioning. See Agent Provisioning configuration true
agent.pools[0].displayName Optional, customize the display name of the pool in the agent provisioning configuration java-enterprise-agent
agent.pools[0].agentForker.enabled Control the forking activation, default to disabled. Java Agent forker configuration is only available from Step 29+ false
agent.pools[0].agentForker.javaPath Optional, path to the JVM, could be used in custom Agent runtime images ""
agent.pools[0].agentForker.vmArgs Optional, java VM arguments for the forked Agents ""
agent.pools[0].agentForker.agentConf Optional, path to a custom agent configuration file for the forked agent ""
agent.pools[0].agentForker.logbackConf Optional, custom logback conf for the forked agents ""
agent.pools[0].agentForker.startTimeoutMs Optional, default 20_000 20_000
agent.pools[0].agentForker.shutdownTimeoutMs Optional, default 10_000 10_000
agent.pools[0].agentForker.gridPort Optional, default 0 0
agent.pools[0].agentForker.agentPortRangeStart Optional, default 0 0
agent.pools[0].agentForker.agentPortRangeEnd Optional, default 0 0
agent.pools[0].tolerations Define tolerations for that Agent pool []
agent.pools[0].hostAliases Define host aliases for that Agent pool []
agent.pools[0].extraInitContainers Define any extra init containers to run prior the Agent []
agent.pools[0].image Optional, agent runtime image to be used. Override default image name: {{ $.Values.image.repository }}/step-enterprise/base:17-debian-12-slim nil
agent.pools[0].agentImage Optional, agent image to be used (binaries copy). Override default image name: {{ $.Values.image.repository }}/step-enterprise/agent:{{ $.Values.commons.version }}-{{ .tech.type }}-{{ .tech.version }} nil
agent.pools[0].command Optional, override the Agent startup command setting (leave empty for default) []
agent.pools[0].args Optional, override the Agent startup args setting (leave empty for default) []
agent.pools[0].workingDir Optional, override the Agent working directory (default to /home/agent/bin) ""
agent.pools[0].extraConfigMaps.data Additional Agent configMap data {}
agent.pools[0].extraSecrets.stringData Additional clear text Agent secrets {}
agent.pools[0].extraSecrets.data Additional base64 encoded Agent secrets {}
agent.pools[0].annotations Additional labels to be added to the Agent pool statefulset {}
agent.pools[0].extraEnvVars Agent Extra environment variables []
agent.pools[0].probes Agent probes {}
agent.pools[0].exposeMetrics Define if the Agent should expose metrics that can be scrapped by prometheus (Java agent only) true
agent.pools[0].tech.type Used to build image tag ( commons.version-tech.type-tech.version). java
agent.pools[0].tech.version Used to build image tag ( commons.version-tech.type-tech.version) 21
agent.pools[0].lifecycleHooks Agent custom lifecycle hooks {}
agent.pools[0].podSecurityContext Agent POD security context {}
agent.pools[0].topologySpreadConstraints Agent Pod topology spread constraint []
agent.pools[0].binariesCopierInitContainerSecurityContext Binaries Copier Init Container security context {}
agent.pools[0].containerSecurityContext Agent Container security context {}
agent.pools[0].replicaCount Number of Agents in the pool 1
agent.pools[0].startup.xvfb Enable XVFB on Agent startup true
agent.pools[0].terminationGracePeriodSeconds Agent termination grace period 60
agent.pools[0].config.agentPort The port the Agent will use 33333
agent.pools[0].config.STEP_DP Environment variable to install external dependencies from Exense private Nexus (https://nexus-enterprise.exense.ch/), format package=version ""
agent.pools[0].config.FULL_STEP_DP Environment variable to install external dependencies using a fully qualified URL. ""
agent.pools[0].config.JAVA_OPTS Additional JVM options (only valid for Java agent) ""
agent.pools[0].config.NON_HEAP_MEMORY_MB Environment variable to set non heap memory and so Xmx value 1500
agent.pools[0].config.fileManagerConfiguration.enableCleanup Optional, enable or disable the file manager cleanup, default to true (enabled) true
agent.pools[0].config.fileManagerConfiguration.cleanupTimeToLiveMinutes Optional, define files that are eligible for cleanup based on their last access time, default to 1440 minutes. 1440
agent.pools[0].config.fileManagerConfiguration.cleanupFrequencyMinutes Optional, define the frequency of the cleanup job in minutes, default to 60 minutes. 60
agent.pools[0].config.executionContextCacheConfiguration.enableCleanup Optional, enable or disable the execution context cache cleanup, default to true (enabled) true
agent.pools[0].config.executionContextCacheConfiguration.cleanupTimeToLiveMinutes Optional, define context that are eligible for cleanup based on their last usage time, default to 1440 minutes. 1440
agent.pools[0].config.executionContextCacheConfiguration.cleanupFrequencyMinutes Optional, define the frequency of the cleanup job in minutes, default to 60 minutes. 60
agent.pools[0].config.logbackConfiguration Optional, custom logback.xml configuration file to be passed to the Agent (leave empty for default configuration, only available for Java) ""
agent.pools[0].nodeSelector Agent pool node selectors {}
agent.pools[0].resources Agent pool resources settings {}
agent.pools[0].extraVolumeMounts Agent extra volume mounts []
agent.pools[0].extraVolumes Agent extra volumes []
agent.pools[0].extraVolumeClaimTemplates Agent extra volumes claim templates []
agent.pools[1].name Agent pool name dotnet
agent.pools[1].agentProvisioningTemplate Optional, define if the Agent Pools can be used as a template for Agent Provisioning. See Agent Provisioning configuration true
agent.pools[1].displayName Optional, customize the display name of the pool in the agent provisioning configuration dotnet-enterprise-agent
agent.pools[1].tolerations Define tolerations for that Agent pool []
agent.pools[1].hostAliases Define host aliases for that Agent pool []
agent.pools[1].extraInitContainers Define any extra init containers to run prior the Agent []
agent.pools[1].image Optional, agent runtime image to be used. Override default image name: {{ $.Values.image.repository }}/step-enterprise/base:17-debian-12-slim nil
agent.pools[1].agentImage Optional, agent image to be used (binaries copy). Override default image name: {{ $.Values.image.repository }}/step-enterprise/agent:{{ $.Values.commons.version }}-{{ .tech.type }}-{{ .tech.version }} nil
agent.pools[1].command Optional, override the Agent startup command setting (leave empty for default) []
agent.pools[1].args Optional, override the Agent startup args setting (leave empty for default) []
agent.pools[1].workingDir Optional, override the Agent working directory (default to /home/agent/bin) ""
agent.pools[1].extraConfigMaps.data Additional Agent configMap data {}
agent.pools[1].extraSecrets.stringData Additional clear text Agent secrets {}
agent.pools[1].extraSecrets.data Additional base64 encoded Agent secrets {}
agent.pools[1].annotations Additional labels to be added to the Agent pool statefulset {}
agent.pools[1].extraEnvVars Agent Extra environment variables []
agent.pools[1].probes Agent probes {}
agent.pools[1].tech.type Used to build image tag ( commons.version-tech.type-tech.version). dotnet
agent.pools[1].tech.version Used to build image tag ( commons.version-tech.type-tech.version) 8
agent.pools[1].lifecycleHooks Agent custom lifecycle hooks {}
agent.pools[1].podSecurityContext Agent POD security context {}
agent.pools[1].topologySpreadConstraints Agent Pod topology spread constraint []
agent.pools[1].binariesCopierInitContainerSecurityContext Binaries Copier Init Container security context {}
agent.pools[1].containerSecurityContext Agent Container security context {}
agent.pools[1].replicaCount Number of Agents in the pool 0
agent.pools[1].startup.xvfb Enable XVFB on Agent startup true
agent.pools[1].terminationGracePeriodSeconds Agent termination grace period 60
agent.pools[1].config.agentPort The port the Agent will use 33333
agent.pools[1].config.STEP_DP Environment variable to install external dependencies from Exense private Nexus (https://nexus-enterprise.exense.ch/), format package=version ""
agent.pools[1].config.FULL_STEP_DP Environment variable to install external dependencies using a fully qualified URL. ""
agent.pools[1].nodeSelector Agent pool node selectors {}
agent.pools[1].resources Agent pool resources settings {}
agent.pools[1].extraVolumeMounts Agent extra volume mounts []
agent.pools[1].extraVolumes Agent extra volumes []
agent.pools[1].extraVolumeClaimTemplates Agent extra volumes claim templates []
agent.pools[2].name Agent pool name nodejs
agent.pools[2].agentProvisioningTemplate Optional, define if the Agent Pools can be used as a template for Agent Provisioning. See Agent Provisioning configuration true
agent.pools[2].displayName Optional, customize the display name of the pool in the agent provisioning configuration nodejs-enterprise-agent
agent.pools[2].tolerations Define tolerations for that Agent pool []
agent.pools[2].hostAliases Define host aliases for that Agent pool []
agent.pools[2].extraInitContainers Define any extra init containers to run prior the Agent []
agent.pools[2].image Optional, agent runtime image to be used. Override default image name: {{ $.Values.image.repository }}/step-enterprise/base:17-debian-12-slim nil
agent.pools[2].agentImage Optional, agent image to be used (binaries copy). Override default image name: {{ $.Values.image.repository }}/step-enterprise/agent:{{ $.Values.commons.version }}-{{ .tech.type }}-{{ .tech.version }} nil
agent.pools[2].command Optional, override the Agent startup command setting (leave empty for default) []
agent.pools[2].args Optional, override the Agent startup args setting (leave empty for default) []
agent.pools[2].workingDir Optional, override the Agent working directory (default to /home/agent/bin) ""
agent.pools[2].extraConfigMaps.data Additional Agent configMap data {}
agent.pools[2].extraSecrets.stringData Additional clear text Agent secrets {}
agent.pools[2].extraSecrets.data Additional base64 encoded Agent secrets {}
agent.pools[2].annotations Additional labels to be added to the Agent pool statefulset {}
agent.pools[2].extraEnvVars Agent Extra environment variables []
agent.pools[2].probes Agent probes {}
agent.pools[2].tech.type Used to build image tag ( commons.version-tech.type-tech.version). nodejs
agent.pools[2].tech.version Used to build image tag ( commons.version-tech.type-tech.version) 20
agent.pools[2].lifecycleHooks Agent custom lifecycle hooks {}
agent.pools[2].podSecurityContext Agent POD security context {}
agent.pools[2].topologySpreadConstraints Agent Pod topology spread constraint []
agent.pools[2].binariesCopierInitContainerSecurityContext Binaries Copier Init Container security context {}
agent.pools[2].containerSecurityContext Agent Container security context {}
agent.pools[2].replicaCount Number of Agents in the pool 0
agent.pools[2].startup.xvfb Enable XVFB on Agent startup true
agent.pools[2].terminationGracePeriodSeconds Agent termination grace period 60
agent.pools[2].config.agentPort The port the Agent will use 33333
agent.pools[2].config.STEP_DP Environment variable to install external dependencies from Exense private Nexus (https://nexus-enterprise.exense.ch/), format package=version ""
agent.pools[2].config.FULL_STEP_DP Environment variable to install external dependencies using a fully qualified URL. ""
agent.pools[2].nodeSelector Agent pool node selectors {}
agent.pools[2].resources Agent pool resources settings {}
agent.pools[2].extraVolumeMounts Agent extra volume mounts []
agent.pools[2].extraVolumes Agent extra volumes []
agent.pools[2].extraVolumeClaimTemplates Agent extra volumes claim templates []

Ingress definition

Name Description Value
ingress.enabled Define if an Ingress rule should be created to expose the Controller UI true
ingress.host Fully qualified URL under which the Controller UI will be reachable step.your-domain.ch
ingress.domain Domain used to create certificate matching ingress.host your-domain.ch
ingress.defaultEndpointPath Controller UI default Ingress endpoint path. Could be omitted, defaulting to “/” /
ingress.defaultEndpointPathType Controller UI default Ingress endpoint prefix. Could be omitted, defaulting to “Prefix” Prefix
ingress.hostAdditionalPaths Optional, additional path to be added to the default host []
ingress.ingressClassName Optional, Ingress class name nginx
ingress.annotations Additional labels to be added to the Ingress rule {}
ingress.defaultSecretName Optional, used to specify the default ingress host TLS secret ""
ingress.extraTls Additional TLS secret to be used []
ingress.extraRules Additional rules to be used []

Refer to the Helm and Kubernetes requirements page for recommendations on how to run Step in a Cloud environment.

See Also