Bitnami package for Argo Workflows

Argo Workflows is meant to orchestrate Kubernetes jobs in parallel. It uses DAG and step-based workflows

Overview of Argo Workflows

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/argo-workflows

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository.

Introduction

This chart bootstraps a Argo Workflows deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.0+
  • PV provisioner support in the underlying infrastructure
  • ReadWriteMany volumes for deployment scaling

Installing the Chart

To install the chart with the release name my-release:

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/argo-workflows

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

The command deploys Argo Workflows on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Configuration and installation details

Resource requests and limits

Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.

To make this process easier, the chart contains the resourcesPreset values, which automatically sets the resources section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcePreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Database support

You may want to have Argo Workflows controller connected to a database to store controller evidences. To achieve this, the chart can be deployed with the PostgreSQL or MySQL dependency (see next section to configure an external database instead of using the dependency). In order to configure the database, just change postgresql.enabled=true (default configuration) or mysql.enabled=true. The database will be configured automatically. Here is an example:

postgresql.enabled=true

If your installation does not require to to store controller evidences, you can disable the controller persistence by setting postgresql.enabled=false, mysql.enabled=false and externalDatabase.enabled=false.

External database

You may want to have Argo Workflows controller connected to an external database to store controller evidences. To achieve this, the chart allows you to specify credentials for an external database (using either postgresql or mysql) with the controller.persistence.postgresql.enabled or controller.persistence.mysql.enabled parameter. You should also set persistence.enabled to true. Here is an example:

externalDatabase.enabled=true
externalDatabase.type=postgresql
externalDatabase.host=<database_host>
externalDatabase.port=5432
externalDatabase.user=<database_user>
externalDatabase.password=<database_password>
externalDatabase.database=bitnami_workflows

Ingress

This chart provides support for Ingress resources. If you have an ingress controller installed on your cluster, such as nginx-ingress-controller or contour you can utilize the ingress controller to serve your application. To enable Ingress integration, set ingress.enabled to true.

The most common scenario is to have one host name mapped to the deployment. In this case, the ingress.hostname property can be used to set the host name. The ingress.tls parameter can be used to add the TLS configuration for this host.

However, it is also possible to have more than one host. To facilitate this, the ingress.extraHosts parameter (if available) can be set with the host names specified as an array. The ingress.extraTLS parameter (if available) can also be used to add the TLS configuration for extra hosts.

NOTE: For each host specified in the ingress.extraHosts parameter, it is necessary to set a name, path, and any annotations that the Ingress controller should know about. Not all annotations are supported by all Ingress controllers, but this annotation reference document lists the annotations supported by many popular Ingress controllers.

Adding the TLS parameter (where available) will cause the chart to generate HTTPS URLs, and the application will be available on port 443. The actual TLS secrets do not have to be generated by this chart. However, if TLS is enabled, the Ingress record will not work until the TLS secret exists.

Learn more about Ingress controllers.

TLS secrets

This chart facilitates the creation of TLS secrets for use with the Ingress controller (although this is not mandatory). There are several common use cases:

  • Generate certificate secrets based on chart parameters.
  • Enable externally generated certificates.
  • Manage application certificates via an external service (like cert-manager).
  • Create self-signed certificates within the chart (if supported).

In the first two cases, a certificate and a key are needed. Files are expected in .pem format.

Here is an example of a certificate file:

NOTE: There may be more than one certificate if there is a certificate chain.

-----BEGIN CERTIFICATE-----
MIID6TCCAtGgAwIBAgIJAIaCwivkeB5EMA0GCSqGSIb3DQEBCwUAMFYxCzAJBgNV
...
jScrvkiBO65F46KioCL9h5tDvomdU1aqpI/CBzhvZn1c0ZTf87tGQR8NK7v7
-----END CERTIFICATE-----

Here is an example of a certificate key:

-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAvLYcyu8f3skuRyUgeeNpeDvYBCDcgq+LsWap6zbX5f8oLqp4
...
wrj2wDbCDCFmfqnSJ+dKI3vFLlEz44sAV8jX/kd4Y6ZTQhlLbYc=
-----END RSA PRIVATE KEY-----
  • If using Helm to manage the certificates based on the parameters, copy these values into the certificate and key values for a given *.ingress.secrets entry.
  • If managing TLS secrets separately, it is necessary to create a TLS secret with name INGRESS_HOSTNAME-tls (where INGRESS_HOSTNAME is a placeholder to be replaced with the hostname you set using the *.ingress.hostname parameter).
  • If your cluster has a cert-manager add-on to automate the management and issuance of TLS certificates, add to *.ingress.annotations the corresponding ones for cert-manager.
  • If using self-signed certificates created by Helm, set both *.ingress.tls and *.ingress.selfSigned to true.

Additional environment variables

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property.

argo-workflows:
  extraEnvVars:
    - name: LOG_LEVEL
      value: error

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values.

Sidecars

If additional containers are needed in the same pod as argo-workflows (such as additional metrics or logging exporters), they can be defined using the sidecars parameter.

sidecars:
- name: your-image-name
  image: your-image
  imagePullPolicy: Always
  ports:
  - name: portname
    containerPort: 1234

If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts parameter (where available), as shown in the example below:

service:
  extraPorts:
  - name: extraPort
    port: 11311
    targetPort: 11311

NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the --enable-metrics=true parameter at deployment time. The sidecars parameter should therefore only be used for any extra sidecar containers.

If additional init containers are needed in the same pod, they can be defined using the initContainers parameter. Here is an example:

initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

Learn more about sidecar containers and init containers.

Pod affinity

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod affinity in the kubernetes documentation.

As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Parameters

Global parameters

Name Description Value
global.imageRegistry Global Docker image registry ""
global.imagePullSecrets Global Docker registry secret names as an array []
global.storageClass Global StorageClass for Persistent Volume(s) ""
global.compatibility.openshift.adaptSecurityContext Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) auto

Common parameters

Name Description Value
kubeVersion Override Kubernetes version ""
nameOverride String to partially override common.names.fullname ""
fullnameOverride String to fully override common.names.fullname ""
commonLabels Labels to add to all deployed objects {}
commonAnnotations Annotations to add to all deployed objects {}
clusterDomain Kubernetes cluster domain name cluster.local
extraDeploy Array of extra objects to deploy with the release []
rbac.singleNamespace Restrict Argo to only deploy into a single namespace by apply Roles and RoleBindings instead of the Cluster equivalents, and start argo-cli with the –namespaced flag. Use it in clusters with strict access policy. false
createAggregateRoles Create Aggregated cluster roles true

Argo Workflows Server configuration parameters

Name Description Value
server.image.registry server image registry REGISTRY_NAME
server.image.repository server image repository REPOSITORY_NAME/argo-workflow-cli
server.image.digest server image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag ""
server.image.pullPolicy server image pull policy IfNotPresent
server.image.pullSecrets server image pull secrets []
server.enabled Enable server deployment true
server.replicaCount Number of server replicas to deploy 1
server.livenessProbe.enabled Enable livenessProbe on server nodes true
server.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 10
server.livenessProbe.periodSeconds Period seconds for livenessProbe 20
server.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 1
server.livenessProbe.failureThreshold Failure threshold for livenessProbe 3
server.livenessProbe.successThreshold Success threshold for livenessProbe 1
server.readinessProbe.enabled Enable readinessProbe on server nodes true
server.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 10
server.readinessProbe.periodSeconds Period seconds for readinessProbe 20
server.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 1
server.readinessProbe.failureThreshold Failure threshold for readinessProbe 3
server.readinessProbe.successThreshold Success threshold for readinessProbe 1
server.startupProbe.enabled Enable startupProbe false
server.startupProbe.path Path to check for startupProbe /
server.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 300
server.startupProbe.periodSeconds Period seconds for startupProbe 10
server.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
server.startupProbe.failureThreshold Failure threshold for startupProbe 6
server.startupProbe.successThreshold Success threshold for startupProbe 1
server.customLivenessProbe Server custom livenessProbe that overrides the default one {}
server.customReadinessProbe Server custom readinessProbe that overrides the default one {}
server.customStartupProbe Server custom startupProbe that overrides the default one {}
server.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if server.resources is set (server.resources is recommended for production). nano
server.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}
server.podSecurityContext.enabled Enabled server pods’ Security Context true
server.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
server.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
server.podSecurityContext.supplementalGroups Set filesystem extra groups []
server.podSecurityContext.fsGroup Set server pod’s Security Context fsGroup 1001
server.containerSecurityContext.enabled Enabled server containers’ Security Context true
server.containerSecurityContext.seLinuxOptions Set SELinux options in container {}
server.containerSecurityContext.runAsUser Set server containers’ Security Context runAsUser 1001
server.containerSecurityContext.runAsGroup Set server containers’ Security Context runAsGroup 1001
server.containerSecurityContext.runAsNonRoot Set server containers’ Security Context runAsNonRoot true
server.containerSecurityContext.readOnlyRootFilesystem Set read only root file system pod’s Security Conte true
server.containerSecurityContext.privileged Set server container’s Security Context privileged false
server.containerSecurityContext.allowPrivilegeEscalation Set server container’s Security Context allowPrivilegeEscalation false
server.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
server.containerSecurityContext.seccompProfile.type Set container’s Security Context seccomp profile RuntimeDefault
server.rbac.create Create RBAC resources for the Argo workflows server true
server.extraArgs Extra arguments for the server command line ""
server.auth.enabled Enable authentication true
server.auth.mode Set authentication mode. Either server, client or sso. client
server.auth.sso.enabled Enable SSO configuration for the server auth mode false
server.auth.sso.config.issuer Root URL for the OIDC identity provider ""
server.auth.sso.config.clientId.name Name of the secret containing the OIDC client ID ""
server.auth.sso.config.clientId.key Key in the secret to obtain the OIDC client ID ""
server.auth.sso.config.clientSecret.name Name of the secret containing the OIDC client secret ""
server.auth.sso.config.clientSecret.key Key in the secret to obtain the OIDC client secret ""
server.auth.sso.config.redirectUrl The OIDC redirect URL. Should be in the form /oauth2/callback. ""
server.auth.sso.rbac.enabled Create RBAC resources for SSO true
server.auth.sso.rbac.secretWhitelist Restricts the secrets that the server can read []
server.auth.sso.scopes Scopes requested from the SSO ID provider []
server.clusterWorkflowTemplates.enabled Create ClusterRole and CRB for the controoler to access ClusterWorkflowTemplates true
server.clusterWorkflowTemplates.enableEditing Give the server permissions to edit ClusterWorkflowTemplates true
server.pdb.enabled Create Pod Disruption Budget for the server component true
server.pdb.minAvailable Sets the min number of pods availables for the Pod Disruption Budget ""
server.pdb.maxUnavailable Sets the max number of pods unavailable for the Pod Disruption Budget ""
server.secure Run Argo server in secure mode false
server.baseHref Base href of the Argo Workflows deployment /
server.containerPorts.web argo Server container port 2746
server.serviceAccount.create Specifies whether a ServiceAccount should be created true
server.serviceAccount.name Name of the service account to use. If not set and create is true, a name is generated using the fullname template. ""
server.serviceAccount.automountServiceAccountToken Automount service account token for the server service account false
server.serviceAccount.annotations Annotations for service account. Evaluated as a template. Only used if create is true. {}
server.command Override default container command (useful when using custom images) []
server.args Override default container args (useful when using custom images) []
server.automountServiceAccountToken Mount Service Account token in pod true
server.hostAliases server pods host aliases []
server.podLabels Extra labels for server pods {}
server.podAnnotations Annotations for server pods {}
server.podAffinityPreset Pod affinity preset. Ignored if server.affinity is set. Allowed values: soft or hard ""
server.podAntiAffinityPreset Pod anti-affinity preset. Ignored if server.affinity is set. Allowed values: soft or hard soft
server.nodeAffinityPreset.type Node affinity preset type. Ignored if server.affinity is set. Allowed values: soft or hard ""
server.nodeAffinityPreset.key Node label key to match. Ignored if server.affinity is set ""
server.nodeAffinityPreset.values Node label values to match. Ignored if server.affinity is set []
server.affinity Affinity for server pods assignment {}
server.nodeSelector Node labels for server pods assignment {}
server.tolerations Tolerations for server pods assignment []
server.updateStrategy.type server statefulset strategy type RollingUpdate
server.topologySpreadConstraints Topology spread constraints rely on node labels to identify the topology domain(s) that each Node is in []
server.schedulerName Alternate scheduler for the server deployment ""
server.priorityClassName server pods’ priorityClassName ""
server.lifecycleHooks for the server container(s) to automate configuration before or after startup {}
server.extraEnvVars Array with extra environment variables to add to server nodes []
server.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for server nodes ""
server.extraEnvVarsSecret Name of existing Secret containing extra env vars for server nodes ""
server.extraVolumes Optionally specify extra list of additional volumes for the server pod(s) []
server.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the server container(s) []
server.sidecars Add additional sidecar containers to the server pod(s) []
server.initContainers Add additional init containers to the server pod(s) []
server.service.type server service type ClusterIP
server.service.ports.http server service HTTP port 80
server.service.nodePorts.http Node port for HTTP ""
server.service.clusterIP server service Cluster IP ""
server.service.loadBalancerIP server service Load Balancer IP ""
server.service.loadBalancerSourceRanges server service Load Balancer sources []
server.service.externalTrafficPolicy server service external traffic policy Cluster
server.service.annotations Additional custom annotations for server service {}
server.service.extraPorts Extra port to expose on the server service []
server.networkPolicy.enabled Specifies whether a NetworkPolicy should be created true
server.networkPolicy.allowExternal Don’t require server label for connections true
server.networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations. true
server.networkPolicy.kubeAPIServerPorts List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security) []
server.networkPolicy.extraIngress Add extra ingress rules to the NetworkPolicy []
server.networkPolicy.extraEgress Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true) []
server.networkPolicy.ingressNSMatchLabels Labels to match to allow traffic from other namespaces {}
server.networkPolicy.ingressNSPodMatchLabels Pod labels to match to allow traffic from other namespaces {}

Argo Workflows Controller configuration parameters

Name Description Value
controller.image.registry controller image registry REGISTRY_NAME
controller.image.repository controller image repository REPOSITORY_NAME/argo-workflow-controller
controller.image.digest controller image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag ""
controller.image.pullPolicy controller image pull policy IfNotPresent
controller.image.pullSecrets controller image pull secrets []
controller.replicaCount Number of controller replicas to deploy 1
controller.livenessProbe.enabled Enable livenessProbe on controller nodes true
controller.livenessProbe.initialDelaySeconds Initial delay seconds for livenessProbe 90
controller.livenessProbe.periodSeconds Period seconds for livenessProbe 60
controller.livenessProbe.timeoutSeconds Timeout seconds for livenessProbe 30
controller.livenessProbe.failureThreshold Failure threshold for livenessProbe 3
controller.livenessProbe.successThreshold Success threshold for livenessProbe 1
controller.readinessProbe.enabled Enable readinessProbe on controller nodes true
controller.readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 30
controller.readinessProbe.periodSeconds Period seconds for readinessProbe 60
controller.readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 30
controller.readinessProbe.failureThreshold Failure threshold for readinessProbe 3
controller.readinessProbe.successThreshold Success threshold for readinessProbe 1
controller.startupProbe.enabled Enable startupProbe false
controller.startupProbe.path Path to check for startupProbe /
controller.startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 300
controller.startupProbe.periodSeconds Period seconds for startupProbe 10
controller.startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
controller.startupProbe.failureThreshold Failure threshold for startupProbe 6
controller.startupProbe.successThreshold Success threshold for startupProbe 1
controller.customLivenessProbe Controller custom livenessProbe that overrides the default one {}
controller.customReadinessProbe Controller custom readinessProbe that overrides the default one {}
controller.customStartupProbe Controller custom startupProbe that overrides the default one {}
controller.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if controller.resources is set (controller.resources is recommended for production). nano
controller.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}
controller.podSecurityContext.enabled Enabled controller pods’ Security Context true
controller.podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
controller.podSecurityContext.sysctls Set kernel settings using the sysctl interface []
controller.podSecurityContext.supplementalGroups Set filesystem extra groups []
controller.podSecurityContext.fsGroup Set controller pod’s Security Context fsGroup 1001
controller.containerSecurityContext.enabled Enabled controller containers’ Security Context true
controller.containerSecurityContext.seLinuxOptions Set SELinux options in container {}
controller.containerSecurityContext.runAsUser Set controller containers’ Security Context runAsUser 1001
controller.containerSecurityContext.runAsGroup Set controller containers’ Security Context runAsGroup 1001
controller.containerSecurityContext.runAsNonRoot Set controller containers’ Security Context runAsNonRoot true
controller.containerSecurityContext.readOnlyRootFilesystem Set read only root file system pod’s Security Conte true
controller.containerSecurityContext.privileged Set controller container’s Security Context privileged false
controller.containerSecurityContext.allowPrivilegeEscalation Set controller container’s Security Context allowPrivilegeEscalation false
controller.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
controller.containerSecurityContext.seccompProfile.type Set container’s Security Context seccomp profile RuntimeDefault
controller.containerPorts.metrics Port to expose controller metrics 9090
controller.containerPorts.telemetry Port to expose controller telemetry 8081
controller.rbac.create Create RBAC resources for the Argo workflows controller true
controller.existingConfigMap ""
controller.extraArgs Extra arguments for the controller command line ""
controller.persistence.archive.enabled Save completed workflows to an SQL database. false
controller.config Controller configmap configuration content {}
controller.instanceID.enabled Enable submission filtering based on instanceID attribute. Requires to set instanceID.useReleaseName or instanceID.explicitID false
controller.instanceID.useReleaseName Use the release name to filter submissions false
controller.instanceID.explicitID Filter submissions based on an explicit instance ID ""
controller.clusterWorkflowTemplates.enabled Whether to create a ClusterRole and Cluster Role Binding to access ClusterWokflowTemplates resources true
controller.metrics.enabled Enable controller metrics exporter false
controller.metrics.path Path to expose controller metrics /metrics
controller.metrics.serviceMonitor.enabled Enable prometheus service monitor configuration false
controller.telemetry.enabled Enable telemetry for the controller false
controller.telemetry.path Path to expose telemetry information /telemetry
controller.workflowWorkers Number of workflow workers to deploy 32
controller.workflowNamespaces Namespaces allowed to run workflows ["default"]
controller.workflowDefaults Default Workflow Values {}
controller.logging.level Level for the controller logging info
controller.logging.globalLevel Global logging level for the controller 0
controller.pdb.enabled Create Pod Disruption Budget for the controller component true
controller.pdb.minAvailable Sets the min number of pods availables for the Pod Disruption Budget ""
controller.pdb.maxUnavailable Sets the max number of pods unavailable for the Pod Disruption Budget ""
controller.serviceAccount.create Specifies whether a ServiceAccount should be created true
controller.serviceAccount.name Name of the service account to use. If not set and create is true, a name is generated using the fullname template. ""
controller.serviceAccount.automountServiceAccountToken Automount service account token for the server service account false
controller.serviceAccount.annotations Annotations for service account. Evaluated as a template. Only used if create is true. {}
controller.command Override default container command (useful when using custom images) []
controller.args Override default container args (useful when using custom images) []
controller.automountServiceAccountToken Mount Service Account token in pod true
controller.hostAliases controller pods host aliases []
controller.podLabels Extra labels for controller pods {}
controller.podAnnotations Annotations for controller pods {}
controller.podAffinityPreset Pod affinity preset. Ignored if controller.affinity is set. Allowed values: soft or hard ""
controller.podAntiAffinityPreset Pod anti-affinity preset. Ignored if controller.affinity is set. Allowed values: soft or hard soft
controller.nodeAffinityPreset.type Node affinity preset type. Ignored if controller.affinity is set. Allowed values: soft or hard ""
controller.nodeAffinityPreset.key Node label key to match. Ignored if controller.affinity is set ""
controller.nodeAffinityPreset.values Node label values to match. Ignored if controller.affinity is set []
controller.affinity Affinity for controller pods assignment {}
controller.nodeSelector Node labels for controller pods assignment {}
controller.tolerations Tolerations for controller pods assignment []
controller.updateStrategy.type controller statefulset strategy type RollingUpdate
controller.topologySpreadConstraints Topology spread constraints rely on node labels to identify the topology domain(s) that each Node is in []
controller.schedulerName Alternate scheduler for the server controller ""
controller.priorityClassName controller pods’ priorityClassName ""
controller.lifecycleHooks for the controller container(s) to automate configuration before or after startup {}
controller.extraEnvVars Array with extra environment variables to add to controller nodes []
controller.extraEnvVarsCM Name of existing ConfigMap containing extra env vars for controller nodes ""
controller.extraEnvVarsSecret Name of existing Secret containing extra env vars for controller nodes ""
controller.extraVolumes Optionally specify extra list of additional volumes for the controller pod(s) []
controller.extraVolumeMounts Optionally specify extra list of additional volumeMounts for the controller container(s) []
controller.sidecars Add additional sidecar containers to the controller pod(s) []
controller.initContainers Add additional init containers to the controller pod(s) []
controller.service.type controller service type ClusterIP
controller.service.ports.metrics Metrics port for the controller 8080
controller.service.ports.telemetry Telemetry port for the controller 8081
controller.service.nodePorts.metrics Node port for HTTP ""
controller.service.nodePorts.telemetry Node port for HTTPS ""
controller.service.clusterIP controller service Cluster IP ""
controller.service.loadBalancerIP controller service Load Balancer IP ""
controller.service.loadBalancerSourceRanges controller service Load Balancer sources []
controller.service.externalTrafficPolicy controller service external traffic policy Cluster
controller.service.annotations Additional custom annotations for controller service {}
controller.service.extraPorts Extra port to expose on the controller service []
controller.networkPolicy.enabled Specifies whether a NetworkPolicy should be created true
controller.networkPolicy.allowExternal Don’t require server label for connections true
controller.networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations. true
controller.networkPolicy.kubeAPIServerPorts List of possible endpoints to kube-apiserver (limit to your cluster settings to increase security) []
controller.networkPolicy.extraIngress Add extra ingress rules to the NetworkPolicy []
controller.networkPolicy.extraEgress Add extra ingress rules to the NetworkPolicy (ignored if allowExternalEgress=true) []
controller.networkPolicy.ingressNSMatchLabels Labels to match to allow traffic from other namespaces {}
controller.networkPolicy.ingressNSPodMatchLabels Pod labels to match to allow traffic from other namespaces {}

Executor configuration section

Name Description Value
executor.image.registry executor image registry REGISTRY_NAME
executor.image.repository executor image repository REPOSITORY_NAME/argo-workflow-exec
executor.image.digest executor image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag ""
executor.image.pullPolicy executor image pull policy IfNotPresent
executor.image.pullSecrets executor image pull secrets []
executor.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if executor.resources is set (executor.resources is recommended for production). nano
executor.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}
executor.extraEnvVars Array with extra environment variables to add to server nodes []
executor.containerSecurityContext.enabled Enabled executor containers’ Security Context true
executor.containerSecurityContext.seLinuxOptions Set SELinux options in container {}
executor.containerSecurityContext.runAsUser Set executor containers’ Security Context runAsUser 1001
executor.containerSecurityContext.runAsGroup Set executor containers’ Security Context runAsGroup 1001
executor.containerSecurityContext.runAsNonRoot Set executor containers’ Security Context runAsNonRoot true
executor.containerSecurityContext.readOnlyRootFilesystem Set read only root file system pod’s Security Conte true
executor.containerSecurityContext.privileged Set executor container’s Security Context privileged false
executor.containerSecurityContext.allowPrivilegeEscalation Set executor container’s Security Context allowPrivilegeEscalation false
executor.containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
executor.containerSecurityContext.seccompProfile.type Set container’s Security Context seccomp profile RuntimeDefault

Traffic Exposure Parameters

Name Description Value
ingress.enabled Enable ingress record generation for server false
ingress.pathType Ingress path type ImplementationSpecific
ingress.apiVersion Force Ingress API version (automatically detected if not set) ""
ingress.hostname Default host for the ingress record server.local
ingress.path Default path for the ingress record /
ingress.ingressClassName IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) ""
ingress.annotations Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations. {}
ingress.tls Enable TLS configuration for the host defined at ingress.hostname parameter false
ingress.selfSigned Create a TLS secret for this ingress record using self-signed certificates generated by Helm false
ingress.extraHosts An array with additional hostname(s) to be covered with the ingress record []
ingress.extraPaths An array with additional arbitrary paths that may need to be added to the ingress under the main host []
ingress.extraTls TLS configuration for additional hostname(s) to be covered with this ingress record []
ingress.secrets Custom TLS certificates as secrets []
ingress.extraRules Additional rules to be covered with this ingress record []

Workflows configuration

Name Description Value
workflows.serviceAccount.create Whether to create a service account to run workflows true
workflows.serviceAccount.name Service account name to run workflows ""
workflows.serviceAccount.automountServiceAccountToken Automount service account token for the workflows service account false
workflows.serviceAccount.annotations Annotations for service account. Evaluated as a template. Only used if create is true. {}
workflows.rbac.create Whether to create RBAC resource to run workflows true

PostgreSQL subchart

Name Description Value
postgresql.enabled Enable PostgreSQL subchart and controller persistence using PostgreSQL true
postgresql.service.ports.postgresql PostgreSQL port 5432
postgresql.auth.username PostgreSQL username postgres
postgresql.auth.database PortgreSQL database name bn_argo_workflows
postgresql.auth.password PortgreSQL database password ""
postgresql.primary.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if primary.resources is set (primary.resources is recommended for production). nano
postgresql.primary.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}

MySQL subchart

Name Description Value
mysql.enabled Enable MySQL subchart and controller persistence using MySQL false
mysql.service.ports.mysql MySQL port 3306
mysql.auth.username MySQL username mysql
mysql.auth.database MySQL database name bn_argo_workflows
mysql.auth.password MySQL database password ""
mysql.primary.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if primary.resources is set (primary.resources is recommended for production). small
mysql.primary.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}

External Database configuration

Name Description Value
externalDatabase.enabled Enable using externaldatabase and the controller to use persistence with it false
externalDatabase.host External Database server host localhost
externalDatabase.port External Database server port 3306
externalDatabase.username External Database username bn_workflows
externalDatabase.password External Database user password ""
externalDatabase.database External Database database name bitnami_workflows
externalDatabase.existingSecret The name of an existing secret with database credentials ""
externalDatabase.type Either postgresql or mysql ""

See https://github.com/bitnami/readme-generator-for-helm to create the table

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install my-release \
  --set argo-workflowsUsername=admin \
  --set argo-workflowsPassword=password \
  --set mysql.auth.rootPassword=secretpassword \
    oci://REGISTRY_NAME/REPOSITORY_NAME/argo-workflows

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

The above command sets the Argo Workflows administrator account username and password to admin and password respectively. Additionally, it sets the MySQL root user password to secretpassword.

NOTE: Once this chart is deployed, it is not possible to change the application’s access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application’s built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

helm install my-release -f values.yaml oci://REGISTRY_NAME/REPOSITORY_NAME/argo-workflows

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts. Tip: You can use the default values.yaml

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

To 9.0.0

This major updates the MySQL subchart to its newest major, 11.0.0. For more information on this subchart’s major, please refer to Mysql upgrade notes.

To 8.0.0

This major bump changes the following security defaults:

  • resourcesPreset is changed from none to the minimum size working in our test suites (NOTE: resourcesPreset is not meant for production usage, but resources adapted to your use case).
  • global.compatibility.openshift.adaptSecurityContext is changed from disabled to auto.

This could potentially break any customization or init scripts used in your deployment. If this is the case, change the default values to the previous ones.

To 7.0.0

This major release bumps the PostgreSQL chart version to 14.x.x; no major issues are expected during the upgrade.

To 6.0.0

This major updates the PostgreSQL subchart to its newest major, 13.0.0. Here you can find more information about the changes introduced in that version.

To 5.0.0

This major moved the parameters under server.auth.sso to server.auth.sso.config.

To 4.0.0

This major updates the PostgreSQL subchart to its newest major, 12.0.0. Here you can find more information about the changes introduced in that version.

To 2.0.0

This major release updates the MySQL subchart to its newest major 9.x.x, which contain several changes in the supported values (check the upgrade notes to obtain more information).

To 1.0.0

This major release updates the PostgreSQL subchart to its newest major 11.x.x, which contain several changes in the supported values (check the upgrade notes to obtain more information).

Upgrading Instructions

To upgrade to 1.0.0 from 0.x, it should be done reusing the PVC(s) used to hold the data on your previous release. To do so, follow the instructions below (the following example assumes that the release name is argo-workflows and the release namespace default):

  1. Obtain the credentials and the names of the PVCs used to hold the data on your current release:
        export POSTGRESQL_PASSWORD=$(kubectl get secret --namespace default argo-workflows-postgresql -o jsonpath="{.data.postgresql-password}" | base64 --decode)
        export POSTGRESQL_PVC=$(kubectl get pvc -l app.kubernetes.io/instance=argo-workflows,app.kubernetes.io/name=postgresql,role=primary -o jsonpath="{.items[0].metadata.name}")
  1. Delete the PostgreSQL statefulset (notice the option –cascade=false) and secret:
        kubectl delete statefulsets.apps --cascade=false argo-workflows-postgresql
        kubectl delete secret argo-workflows-postgresql --namespace default
  1. Upgrade your release using the same PostgreSQL version:
        CURRENT_PG_VERSION=$(kubectl exec argo-workflows-postgresql-0 -- bash -c 'echo $BITNAMI_IMAGE_VERSION')
        helm upgrade argo-workflows bitnami/argo-workflows \
          --set postgresql.image.tag=$CURRENT_PG_VERSION \
          --set postgresql.auth.password=$POSTGRESQL_PASSWORD \
          --set postgresql.persistence.existingClaim=$POSTGRESQL_PVC
  1. Delete the existing PostgreSQL pods and the new statefulset will create a new one:
        kubectl delete pod argo-workflows-postgresql-0

License

Copyright © 2024 Broadcom. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

check-circle-line exclamation-circle-line close-line
Scroll to top icon