Helm Values
Helm values
Values that could be used are listed below:
Image parameters
| Name | Description | Value |
|---|---|---|
image.repository |
Mongodb, Controller and Agent images repository base name | "" |
image.pullPolicy |
Mongodb, Controller and Agent images pull policy | Always |
imagePullSecrets |
Registry secret names as an array | [] |
Commons parameters
| Name | Description | Value |
|---|---|---|
commons.version |
Step version to use | 3.25.1 |
commons.edition |
Step edition to use (os or ee) | ee |
commons.nodeSelector |
Shared node labels for Controller and Agent pods assignment | {} |
MongoDB parameters
Refer to the official Bitnami MongoDB Chart values at https://github.com/bitnami/charts/tree/main/bitnami/mongodb
Controller parameters
| Name | Description | Value |
|---|---|---|
controller.enabled |
Define if the Controller material should be created | true |
controller.extraContainers |
Define any extra containers to run alongside the Controller | [] |
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.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.podSecurityContext |
Controller Pod security context | nil |
controller.topologySpreadConstraints |
Controller Pod topology spread constraint | [] |
controller.containerSecurityContext |
Controller Container security context | {} |
controller.license |
Base64 encoded Step license, to be used with Step version < 22 | "" |
controller.licenseconfig |
Base64 encoded Step license configuration, to be used with Step version >= 22 | "" |
controller.licenses |
Base64 encoded Step licenses, to be used with 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) | 17 |
controller.config.port |
Controller UI port | 8080 |
controller.config.NON_HEAP_MEMORY_MB |
Environment variable to set non heap memory and so Xmx value | 256 |
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.nodeSelector |
Controller node selectors | {} |
controller.affinity |
Controller affinity | {} |
controller.resources |
Controller 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 | default |
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 | default |
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.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.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.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) | 17 |
gridproxy.config.port |
Grid Proxy port | 8081 |
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
| Name | Description | Value |
|---|---|---|
agent.pools[0].name |
Agent pool name | java |
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].tech.type |
Used to build image tag ( commons.version-tech.type-tech.version). Available values are java or dotnet | java |
agent.pools[0].tech.version |
Used to build image tag ( commons.version-tech.type-tech.version) Available values are 11 and 17 for java, 5 and 6 for dotnet | 17 |
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].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 | 256 |
agent.pools[0].config.docker.enabled |
Define if Docker has to be installed in the Agent container | false |
agent.pools[0].config.tokenGroups |
Agent pool token groups configuration | [] |
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 | [] |
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-domaine.ch |
ingress.domain |
Domain used to create certificate matching ingress.host | your-domaine.ch |
ingress.ingressClassName |
Ingress class name | nginx |
ingress.annotations |
Additional labels to be added to the Ingress rule | {} |
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.