helm Deploy
Last updated
Last updated
Specify a Helm chart (either in your repository or remote from a registry) to deploy.
Refer to the for usage instructions.
Garden uses Helm 3.16.2.
Below is the full schema reference for the action. For an introduction to configuring Garden, please look at our .
helm actions also export values that are available in template strings. See the section below for details.
typeThe type of action, e.g. exec, container or kubernetes. Some are built into Garden but mostly these will be defined by your configured providers.
| Type | Required |
|---|
nameA valid name for the action. Must be unique across all actions of the same kind in your project.
| Type | Required |
|---|
descriptionA description of the action.
sourceBy default, the directory where the action is defined is used as the source for the build context.
You can override this by setting either source.path to another (POSIX-style) path relative to the action source directory, or source.repository to get the source from an external repository.
If using source.path, you must make sure the target path is in a git repository.
source.pathA relative POSIX-style path to the source directory for this action. You must make sure this path exists and is in a git repository!
source.repositoryWhen set, Garden will import the action source from this repository, but use this action configuration (and not scan for configs in the separate repository).
source.repository.urlA remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific branch or tag, with the format: #<branch|tag>
Example:
dependencies[]A list of other actions that this action depends on, and should be built, deployed or run (depending on the action type) before processing this action.
Each dependency should generally be expressed as a "<kind>.<name>" string, where is one of build, deploy, run or test, and is the name of the action to depend on.
You may also optionally specify a dependency as an object, e.g. { kind: "Build", name: "some-image" }.
Any empty values (i.e. null or empty strings) are ignored, so that you can conditionally add in a dependency via template expressions.
Example:
disabledSet this to true to disable the action. You can use this with conditional template strings to disable actions based on, for example, the current environment or other variables (e.g. disabled: ${environment.name == "prod"}). This can be handy when you only need certain actions for specific environments, e.g. only for development.
For Build actions, this means the build is not performed unless it is declared as a dependency by another enabled action (in which case the Build is assumed to be necessary for the dependant action to be run or built).
For other action kinds, the action is skipped in all scenarios, and dependency declarations to it are ignored. Note however that template strings referencing outputs (i.e. runtime outputs) will fail to resolve when the action is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.
environments[]If set, the action is only enabled for the listed environment types. This is effectively a cleaner shorthand for the disabled field with an expression for environments. For example, environments: ["prod"] is equivalent to disabled: ${environment.name != "prod"}.
include[]Specify a list of POSIX-style paths or globs that should be regarded as source files for this action, and thus will affect the computed version of the action.
For actions other than Build actions, this is usually not necessary to specify, or is implicitly inferred. An exception would be e.g. an exec action without a build reference, where the relevant files cannot be inferred and you want to define which files should affect the version of the action, e.g. to make sure a Test action is run when certain files are modified.
Build actions have a different behavior, since they generally are based on some files in the source tree, so please reference the docs for more information on those.
Example:
exclude[]Specify a list of POSIX-style paths or glob patterns that should be explicitly excluded from the action's version.
Unlike the scan.exclude field in the project config, the filters here have no effect on which files and directories are watched for changes when watching is enabled. Use the project scan.exclude field to affect those, if you have large directories that should not be watched for changes.
Example:
variablesA map of variables scoped to this particular action. These are resolved before any other parts of the action configuration and take precedence over group-scoped variables (if applicable) and project-scoped variables, in that order. They may reference group-scoped and project-scoped variables, and generally can use any template strings normally allowed when resolving the action.
varfiles[]Specify a list of paths (relative to the directory where the action is defined) to a file containing variables, that we apply on top of the action-level variables field, and take precedence over group-level variables (if applicable) and project-level variables, in that order.
If you specify multiple paths, they are merged in the order specified, i.e. the last one takes precedence over the previous ones.
The format of the files is determined by the configured file's extension:
.yaml/.yml - YAML. The file must consist of a YAML document, which must be a map (dictionary). Keys may contain any value type. YAML format is used by default.
.json - JSON. Must contain a single JSON object (not an array).
NOTE: The default varfile format was changed to YAML in Garden v0.13, since YAML allows for definition of nested objects and arrays.
To use different varfiles in different environments, you can template in the environment name to the varfile name, e.g. varfile: "my-action.${environment.name}.env" (this assumes that the corresponding varfiles exist).
If a listed varfile cannot be found, throwing an error. To add optional varfiles, you can use a list item object with a path and an optional optional boolean field.
Example:
varfiles[].pathPath to a file containing a path.
varfiles[].optionalWhether the varfile is optional.
buildSpecify a Build action, and resolve this action from the context of that Build.
For example, you might create an exec Build which prepares some manifests, and then reference that in a kubernetes Deploy action, and the resulting manifests from the Build.
This would mean that instead of looking for manifest files relative to this action's location in your project structure, the output directory for the referenced exec Build would be the source.
kindtimeoutTimeout for the deploy to complete, in seconds.
specspec.namespaceA valid Kubernetes namespace name. Must be a valid RFC1035/RFC1123 (DNS) label (may contain lowercase letters, numbers and dashes, must start with a letter, and cannot end with a dash) and must not be longer than 63 characters.
spec.portForwards[]Manually specify port forwards that Garden should set up when deploying in dev or watch mode. If specified, these override the auto-detection of forwardable ports, so you'll need to specify the full list of port forwards to create.
spec.portForwards[].nameAn identifier to describe the port forward.
spec.portForwards[].resourceThe full resource kind and name to forward to, e.g. Service/my-service or Deployment/my-deployment. Note that Garden will not validate this ahead of attempting to start the port forward, so you need to make sure this is correctly set. The types of resources supported will match that of the kubectl port-forward CLI command.
spec.portForwards[].targetPortThe port number on the remote resource to forward to.
spec.portForwards[].localPortThe preferred local port to forward from. If none is set, a random port is chosen. If the specified port is not available, a warning is shown and a random port chosen instead.
spec.releaseNameOptionally override the release name used when installing (defaults to the Deploy name).
spec.timeoutTime in seconds to wait for Helm to complete any individual Kubernetes operation (like Jobs for hooks).
spec.valuesMap of values to pass to Helm when rendering the templates. May include arrays and nested objects. When specified, these take precedence over the values in the values.yaml file (or the files specified in valueFiles).
spec.valueFiles[]Specify value files to use when rendering the Helm chart. These will take precedence over the values.yaml file bundled in the Helm chart, and should be specified in ascending order of precedence. Meaning, the last file in this list will have the highest precedence.
If you also specify keys under the values field, those will effectively be added as another file at the end of this list, so they will take precedence over other files listed here.
Note that the paths here should be relative to the config root, and the files should be contained in this action config's directory.
spec.atomicWhether to set the --atomic flag during installs and upgrades. Set to true if you'd like the changes applied to be reverted on failure. Set to false if e.g. you want to see more information about failures and then manually roll back, instead of having Helm do it automatically on failure.
Note that setting atomic to true implies wait.
spec.waitForUnhealthyResourcesWhether to wait for the Helm command to complete before throwing an error if one of the resources being installed/upgraded is unhealthy.
By default, Garden will monitor the resources being created by Helm and throw an error as soon as one of them is unhealthy. This allows Garden to fail fast if there's an issue with one of the resources. If no issue is detected, Garden waits for the Helm command to complete.
If however waitForUnhealthyResources is set to true and some resources are unhealthy, then Garden will wait for Helm itself to throw an error which typically happens when it times out in the case of unhealthy resources (e.g. due to ImagePullBackOff or CrashLoopBackOff errors).
Waiting for the timeout can take awhile so using the default value here is recommended unless you'd like to completely mimic Helm's behaviour and not rely on Garden's resource monitoring.
Note that setting atomic to true implies waitForUnhealthyResources.
spec.chartSpecify the Helm chart to use.
If the chart is defined in the same directory as the action, you can skip this, and the chart sources will be detected. If the chart is in the source tree but in a sub-directory, you should set chart.path to the directory path, relative to the action directory.
For remote charts, there are multiple options:
Absolute URL to a packaged chart: specify chart.url.
One of chart.name, chart.path or chart.url must be specified.
spec.chart.nameA valid Helm chart name or URI (same as you'd input to helm install) Required if the action doesn't contain the Helm chart itself.
Example:
spec.chart.pathThe path, relative to the action path, to the chart sources (i.e. where the Chart.yaml file is, if any).
spec.chart.repoThe repository URL to fetch the chart from. Defaults to the "stable" helm repo (https://charts.helm.sh/stable).
spec.chart.urlURL to OCI repository, or a URL to a packaged Helm chart archive.
spec.chart.versionThe chart version to deploy.
spec.defaultTargetSpecify a default resource in the deployment to use for syncs, local mode, and for the garden exec command.
Specify either kind and name, or a podSelector. The resource should be one of the resources deployed by this action (otherwise the target is not guaranteed to be deployed with adjustments required for syncing or local mode).
Set containerName to specify a container to connect to in the remote Pod. By default the first container in the Pod is used.
Note that if you specify podSelector here, it is not validated to be a selector matching one of the resources deployed by the action.
spec.defaultTarget.kindThe kind of Kubernetes resource to find.
spec.defaultTarget.nameThe name of the resource, of the specified kind. If specified, you must also specify kind.
spec.defaultTarget.podSelectorA map of string key/value labels to match on any Pods in the namespace. When specified, a random ready Pod with matching labels will be picked as a target, so make sure the labels will always match a specific Pod type.
spec.defaultTarget.containerNameThe name of a container in the target. Specify this if the target contains more than one container and the main container is not the first container in the spec.
spec.syncConfigure path syncs for the resources in this Deploy.
If you have multiple syncs for the Deploy, you can use the defaults field to set common configuration for every individual sync.
spec.sync.defaultsDefaults to set across every sync for this Deploy. If you use the exclude field here, it will be merged with any excludes set in individual syncs. These are applied on top of any defaults set in the provider configuration.
spec.sync.defaults.exclude[]Specify a list of POSIX-style paths or glob patterns that should be excluded from the sync.
Any exclusion patterns defined in individual sync specs will be applied in addition to these patterns.
.git directories and .garden directories are always ignored.
Example:
spec.sync.defaults.fileModespec.sync.defaults.directoryModespec.sync.defaults.ownerspec.sync.defaults.groupspec.sync.paths[]A list of syncs to start once the Deploy is successfully started.
spec.sync.paths[].targetThe Kubernetes resource to sync to. If specified, this is used instead of spec.defaultTarget.
spec.sync.paths[].target.kindThe kind of Kubernetes resource to find.
spec.sync.paths[].target.nameThe name of the resource, of the specified kind. If specified, you must also specify kind.
spec.sync.paths[].target.podSelectorA map of string key/value labels to match on any Pods in the namespace. When specified, a random ready Pod with matching labels will be picked as a target, so make sure the labels will always match a specific Pod type.
spec.sync.paths[].target.containerNameThe name of a container in the target. Specify this if the target contains more than one container and the main container is not the first container in the spec.
spec.sync.paths[].sourcePathPath to a local directory to be synchronized with the target. This should generally be a templated path to another action's source path (e.g. ${actions.build.my-container-image.sourcePath}), or a relative path. If a path is hard-coded, we recommend sticking with relative paths here, and using forward slashes (/) as a delimiter, as Windows-style paths with back slashes (\) and absolute paths will work on some platforms, but they are not portable and will not work for users on other platforms. Defaults to the Deploy action's config's directory if no value is provided.
Example:
spec.sync.paths[].containerPathPOSIX-style absolute path to sync to inside the container. The root path (i.e. "/") is not allowed.
Example:
spec.sync.paths[].exclude[]Specify a list of POSIX-style paths or glob patterns that should be excluded from the sync.
.git directories and .garden directories are always ignored.
Example:
spec.sync.paths[].modespec.sync.paths[].defaultFileModespec.sync.paths[].defaultDirectoryModespec.sync.paths[].defaultOwnerspec.sync.paths[].defaultGroupspec.sync.overrides[]Overrides for the container command and/or arguments for when in sync mode.
spec.sync.overrides[].targetThe Kubernetes resources to override. If specified, this is used instead of spec.defaultTarget.
spec.sync.overrides[].target.kindThe kind of Kubernetes resource to find.
spec.sync.overrides[].target.nameThe name of the resource, of the specified kind. If specified, you must also specify kind.
spec.sync.overrides[].target.podSelectorA map of string key/value labels to match on any Pods in the namespace. When specified, a random ready Pod with matching labels will be picked as a target, so make sure the labels will always match a specific Pod type.
spec.sync.overrides[].target.containerNameThe name of a container in the target. Specify this if the target contains more than one container and the main container is not the first container in the spec.
spec.sync.overrides[].command[]Override the command/entrypoint in the matched container.
spec.sync.overrides[].args[]Override the args in the matched container.
spec.sync.overrides[].imageOverride the image of the matched container.
spec.localMode[EXPERIMENTAL] Configures the local application which will send and receive network requests instead of the target resource specified by localMode.target or defaultTarget. One of those fields must be specified to enable local mode for the action.
The selected container of the target Kubernetes resource will be replaced by a proxy container which runs an SSH server to proxy requests. Reverse port-forwarding will be automatically configured to route traffic to the locally run application and back.
Local mode is enabled by setting the --local option on the garden deploy command. Local mode always takes the precedence over sync mode if there are any conflicting service names.
Health checks are disabled for services running in local mode.
Note! This feature is still experimental. Some incompatible changes can be made until the first non-experimental release.
spec.localMode.ports[]The reverse port-forwards configuration for the local application.
spec.localMode.ports[].localThe local port to be used for reverse port-forward.
spec.localMode.ports[].remoteThe remote port to be used for reverse port-forward.
spec.localMode.command[]The command to run the local application. If not present, then the local application should be started manually.
spec.localMode.restartSpecifies restarting policy for the local application. By default, the local application will be restarting infinitely with 1000ms between attempts.
spec.localMode.restart.delayMsecDelay in milliseconds between the local application restart attempts. The default value is 1000ms.
spec.localMode.restart.maxMax number of the local application restarts. Unlimited by default.
spec.localMode.targetThe remote Kubernetes resource to proxy traffic from. If specified, this is used instead of defaultTarget.
spec.localMode.target.kindThe kind of Kubernetes resource to find.
spec.localMode.target.nameThe name of the resource, of the specified kind. If specified, you must also specify kind.
spec.localMode.target.podSelectorA map of string key/value labels to match on any Pods in the namespace. When specified, a random ready Pod with matching labels will be picked as a target, so make sure the labels will always match a specific Pod type.
spec.localMode.target.containerNameThe name of a container in the target. Specify this if the target contains more than one container and the main container is not the first container in the spec.
The following keys are available via the ${actions.deploy.<name>} template string key for helm action.
${actions.deploy.<name>.name}The name of the action.
${actions.deploy.<name>.disabled}Whether the action is disabled.
Example:
${actions.deploy.<name>.buildPath}The local path to the action build directory.
Example:
${actions.deploy.<name>.sourcePath}The local path to the action source directory.
Example:
${actions.deploy.<name>.mode}The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.
Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.
Example:
${actions.deploy.<name>.var.*}The variables configured on the action.
${actions.deploy.<name>.var.<name>}| Type | Required |
|---|
For source.repository behavior, please refer to the .
| Type | Required |
|---|
> path
| Type | Required |
|---|
> repository
| Type | Required |
|---|
> > url
| Type | Required |
|---|
| Type | Default | Required |
|---|
| Type | Default | Required |
|---|
| Type | Required |
|---|
Note that you can also exclude files using the exclude field or by placing .gardenignore files in your source tree, which use the same format as .gitignore files. See the for details.
| Type | Required |
|---|
For actions other than Build actions, this is usually not necessary to specify, or is implicitly inferred. For Deploy, Run and Test actions, the exclusions specified here only applied on top of explicitly set include paths, or such paths inferred by providers. See the for details.
| Type | Required |
|---|
| Type | Required |
|---|
.env - Standard "dotenv" format, as defined by .
| Type | Default | Required |
|---|
> path
| Type | Required |
|---|
> optional
| Type | Required |
|---|
| Type | Required |
|---|
| Type | Allowed Values | Required |
|---|
| Type | Default | Required |
|---|
| Type | Required |
|---|
> namespace
| Type | Required |
|---|
> portForwards
| Type | Required |
|---|
> > name
| Type | Required |
|---|
> > resource
| Type | Required |
|---|
> > targetPort
| Type | Required |
|---|
> > localPort
| Type | Required |
|---|
> releaseName
| Type | Required |
|---|
> timeout
| Type | Default | Required |
|---|
> values
| Type | Default | Required |
|---|
> valueFiles
| Type | Default | Required |
|---|
> atomic
| Type | Default | Required |
|---|
> waitForUnhealthyResources
| Type | Default | Required |
|---|
> chart
: specify chart.name and chart.version\, and optionally chart.repo` (if the chart is not in the default "stable" repo).
: specify chart.url with the oci:// URL and optionally chart.version.
| Type | Required |
|---|
> > name
| Type | Required |
|---|
> > path
| Type | Required |
|---|
> > repo
| Type | Required |
|---|
> > url
| Type | Required |
|---|
> > version
| Type | Required |
|---|
> defaultTarget
| Type | Required |
|---|
> > kind
| Type | Allowed Values | Required |
|---|
> > name
| Type | Required |
|---|
> > podSelector
| Type | Required |
|---|
> > containerName
| Type | Required |
|---|
> sync
| Type | Required |
|---|
> > defaults
| Type | Required |
|---|
> > > exclude
| Type | Required |
|---|
> > > fileMode
The default permission bits, specified as an octal, to set on files at the sync target. Defaults to 0o644 (user can read/write, everyone else can read). See the for more information.
| Type | Default | Required |
|---|
> > > directoryMode
The default permission bits, specified as an octal, to set on directories at the sync target. Defaults to 0o755 (user can read/write, everyone else can read). See the for more information.
| Type | Default | Required |
|---|
> > > owner
Set the default owner of files and directories at the target. Specify either an integer ID or a string name. See the for more information.
| Type | Required |
|---|
> > > group
Set the default group on files and directories at the target. Specify either an integer ID or a string name. See the for more information.
| Type | Required |
|---|
> > paths
| Type | Required |
|---|
> > > target
| Type | Required |
|---|
> > > > kind
| Type | Allowed Values | Required |
|---|
> > > > name
| Type | Required |
|---|
> > > > podSelector
| Type | Required |
|---|
> > > > containerName
| Type | Required |
|---|
> > > sourcePath
| Type | Default | Required |
|---|
> > > containerPath
| Type | Required |
|---|
> > > exclude
| Type | Required |
|---|
> > > mode
The sync mode to use for the given paths. See the for details.
| Type | Allowed Values | Default | Required |
|---|
> > > defaultFileMode
The default permission bits, specified as an octal, to set on files at the sync target. Defaults to 0o644 (user can read/write, everyone else can read). See the for more information.
| Type | Default | Required |
|---|
> > > defaultDirectoryMode
The default permission bits, specified as an octal, to set on directories at the sync target. Defaults to 0o755 (user can read/write, everyone else can read). See the for more information.
| Type | Default | Required |
|---|
> > > defaultOwner
Set the default owner of files and directories at the target. Specify either an integer ID or a string name. See the for more information.
| Type | Required |
|---|
> > > defaultGroup
Set the default group on files and directories at the target. Specify either an integer ID or a string name. See the for more information.
| Type | Required |
|---|
> > overrides
| Type | Required |
|---|
> > > target
| Type | Required |
|---|
> > > > kind
| Type | Allowed Values | Required |
|---|
> > > > name
| Type | Required |
|---|
> > > > podSelector
| Type | Required |
|---|
> > > > containerName
| Type | Required |
|---|
> > > command
| Type | Required |
|---|
> > > args
| Type | Required |
|---|
> > > image
| Type | Required |
|---|
> localMode
See the for more information.
| Type | Required |
|---|
> > ports
| Type | Required |
|---|
> > > local
| Type | Required |
|---|
> > > remote
| Type | Required |
|---|
> > command
| Type | Required |
|---|
> > restart
| Type | Default | Required |
|---|
> > > delayMsec
| Type | Default | Required |
|---|
> > > max
| Type | Default | Required |
|---|
> > target
| Type | Required |
|---|
> > > kind
| Type | Allowed Values | Required |
|---|
> > > name
| Type | Required |
|---|
> > > podSelector
| Type | Required |
|---|
> > > containerName
| Type | Required |
|---|
| Type |
|---|
| Type |
|---|
| Type |
|---|
| Type |
|---|
| Type | Default |
|---|
| Type | Default |
|---|
| Type |
|---|
| No |
| No |
| No |
| No |
| Yes |
|
| No |
|
| No |
| No |
| No |
| No |
| No |
|
| No |
| Yes |
| No |
| No |
| "Deploy" | Yes |
|
| No |
| No |
| No |
| No |
| No |
| Yes |
| Yes |
| No |
| No |
|
| No |
|
| No |
|
| No |
|
| No |
|
| No |
| No |
| No |
| No |
| No |
| No |
| No |
| No |
| "Deployment", "DaemonSet", "StatefulSet" | Yes |
| No |
| No |
| No |
| No |
| No |
| No |
|
| No |
|
| No |
| No |
| No |
| No |
| No |
| "Deployment", "DaemonSet", "StatefulSet" | Yes |
| No |
| No |
| No |
|
| No |
| Yes |
| No |
| "one-way", "one-way-safe", "one-way-replica", "one-way-reverse", "one-way-replica-reverse", "two-way", "two-way-safe", "two-way-resolved" |
| Yes |
|
| No |
|
| No |
| No |
| No |
| No |
| No |
| "Deployment", "DaemonSet", "StatefulSet" | Yes |
| No |
| No |
| No |
| No |
| No |
| No |
| No |
| No |
| No |
| No |
| No |
|
| No |
|
| No |
|
| No |
| No |
| "Deployment", "DaemonSet", "StatefulSet" | Yes |
| No |
| No |
| No |
|
|
|
|
|
|
|
|
|
| Yes |
| Yes |