Helm

Specify a Helm chart (either in your repository or remote from a registry) to deploy. Refer to the Helm guide for usage instructions.
Below is the schema reference. For an introduction to configuring Garden modules, please look at our Configuration guide. The reference is divided into two sections. The first section lists and describes the available schema keys. The second section contains the complete YAML schema.
Configuration keys
apiVersion
The schema version of this module's config (currently not used).
Type
Required
Allowed Values
string
Yes
"garden.io/v0"
kind
Type
Required
Allowed Values
string
Yes
"Module"
type
The type of this module.
Type
Required
string
Yes
Example:
type: "container"
name
The name of this module.
Type
Required
string
Yes
Example:
name: "my-sweet-module"
description
Type
Required
string
No
include
Specify a list of POSIX-style paths or globs that should be regarded as the source files for this module. Files that do not match these paths or globs are excluded when computing the version of the module, as well as when responding to filesystem watch events.
Note that you can also exclude files by placing .gardenignore files in your source tree, which use the same format as .gitignore files.
Also note that specifying an empty list here means no sources should be included.
Type
Required
array[string]
No
Example:
include:
  - Dockerfile
  - my-app.js
repositoryUrl
A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific branch or tag, with the format: #
Garden will import the repository source code into this module, but read the module's config from the local garden.yml file.
Type
Required
string
No
Example:
repositoryUrl: "git+https://github.com/org/repo.git#v2.0"
allowPublish
When false, disables pushing this module to remote registries.
Type
Required
boolean
No
build
Specify how to build the module. Note that plugins may define additional keys on this object.
Type
Required
object
No
build.dependencies[]
​build > dependencies
A list of modules that must be built before this module is built.
Type
Required
array[object]
No
Example:
build:
  ...
  dependencies:
    - name: some-other-module-name
build.dependencies[].name
​build > dependencies > name
Module name to build ahead of this module.
Type
Required
string
Yes
build.dependencies[].copy[]
​build > dependencies > copy
Specify one or more files or directories to copy from the built dependency to this module.
Type
Required
array[object]
No
build.dependencies[].copy[].source
​build > dependencies > copy > source
POSIX-style path or filename of the directory or file(s) to copy to the target.
Type
Required
string
Yes
build.dependencies[].copy[].target
​build > dependencies > copy > target
POSIX-style path or filename to copy the directory or file(s) to (defaults to same as source path).
Type
Required
string
No
base
The name of another helm module to use as a base for this one. Use this to re-use a Helm chart across multiple services. For example, you might have an organization-wide base chart for certain types of services. If set, this module will by default inherit the following properties from the base module: serviceResource, values Each of those can be overridden in this module. They will be merged with a JSON Merge Patch (RFC 7396).
Type
Required
string
No
Example:
base: "my-base-chart"
chart
A valid Helm chart name or URI (same as you'd input to helm install). Required if the module doesn't contain the Helm chart itself.
Type
Required
string
No
Example:
chart: "stable/nginx-ingress"
chartPath
The path, relative to the module path, to the chart sources (i.e. where the Chart.yaml file is, if any). Not used when base is specified.
Type
Required
string
No
dependencies
List of names of services that should be deployed before this chart.
Type
Required
array[string]
No
releaseName
Optionally override the release name used when installing (defaults to the module name).
Type
Required
string
No
repo
The repository URL to fetch the chart from.
Type
Required
string
No
serviceResource
The Deployment, DaemonSet or StatefulSet that Garden should regard as the Garden service in this module (not to be confused with Kubernetes Service resources). Because a Helm chart can contain any number of Kubernetes resources, this needs to be specified for certain Garden features and commands to work, such as hot-reloading. We currently map a Helm chart to a single Garden service, because all the resources in a Helm chart are deployed at once.
Type
Required
object
No
serviceResource.kind
​serviceResource > kind
The type of Kubernetes resource to sync files to.
Type
Required
Allowed Values
string
Yes
"Deployment", "DaemonSet", "StatefulSet"
serviceResource.name
​serviceResource > name
The name of the resource to sync to. If the chart contains a single resource of the specified Kind, this can be omitted. This can include a Helm template string, e.g. ''. This allows you to easily match the dynamic names given by Helm. In most cases you should copy this directly from the template in question in order to match it. Note that you may need to add single quotes around the string for the YAML to be parsed correctly.
Type
Required
string
No
serviceResource.containerName
​serviceResource > containerName
The 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.
Type
Required
string
No
serviceResource.containerModule
​serviceResource > containerModule
The Garden module that contains the sources for the container. This needs to be specified under serviceResource in order to enable hot-reloading for the chart, but is not necessary for tasks and tests. Must be a container module, and for hot-reloading to work you must specify the hotReload field on the container module. Note: If you specify a module here, you don't need to specify it additionally under build.dependencies
Type
Required
string
No
Example:
serviceResource:
  ...
  containerModule: "my-container-module"
serviceResource.hotReloadArgs[]
​serviceResource > hotReloadArgs
If specified, overrides the arguments for the main container when running in hot-reload mode.
Type
Required
array[string]
No
Example:
serviceResource:
  ...
  hotReloadArgs:
    - nodemon
    - my-server.js
skipDeploy
Set this to true if the chart should only be built, but not deployed as a service. Use this, for example, if the chart should only be used as a base for other modules.
Type
Required
boolean
No
tasks
The task definitions for this module.
Type
Required
array[object]
No
tasks[].name
​tasks > name
The name of the test.
Type
Required
string
Yes
tasks[].dependencies[]
​tasks > dependencies
The names of any services that must be running, and the names of any tasks that must be executed, before the test is run.
Type
Required
array[string]
No
tasks[].timeout
​tasks > timeout
Maximum duration (in seconds) of the test run.
Type
Required
number
No
tasks[].resource
​tasks > resource
The Deployment, DaemonSet or StatefulSet that Garden should use to execute this task. If not specified, the serviceResource configured on the module will be used. If neither is specified, an error will be thrown.
Type
Required
object
No
tasks[].resource.kind
​tasks > resource > kind
The type of Kubernetes resource to sync files to.
Type
Required
Allowed Values
string
Yes
"Deployment", "DaemonSet", "StatefulSet"
tasks[].resource.name
​tasks > resource > name
The name of the resource to sync to. If the chart contains a single resource of the specified Kind, this can be omitted. This can include a Helm template string, e.g. ''. This allows you to easily match the dynamic names given by Helm. In most cases you should copy this directly from the template in question in order to match it. Note that you may need to add single quotes around the string for the YAML to be parsed correctly.
Type
Required
string
No
tasks[].resource.containerName
​tasks > resource > containerName
The 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.
Type
Required
string
No
tasks[].resource.containerModule
​tasks > resource > containerModule
The Garden module that contains the sources for the container. This needs to be specified under serviceResource in order to enable hot-reloading for the chart, but is not necessary for tasks and tests. Must be a container module, and for hot-reloading to work you must specify the hotReload field on the container module. Note: If you specify a module here, you don't need to specify it additionally under build.dependencies
Type
Required
string
No
Example:
tasks:
  - resource:
      ...
      containerModule: "my-container-module"
tasks[].resource.hotReloadArgs[]
​tasks > resource > hotReloadArgs
If specified, overrides the arguments for the main container when running in hot-reload mode.
Type
Required
array[string]
No
Example:
tasks:
  - resource:
      ...
      hotReloadArgs:
        - nodemon
        - my-server.js
tasks[].args[]
​tasks > args
The arguments to pass to the pod used for execution.
Type
Required
array[string]
No
tasks[].env
​tasks > env
Key/value map of environment variables. Keys must be valid POSIX environment variable names (must not start with GARDEN) and values must be primitives.
Type
Required
object
No
tests
The test suite definitions for this module.
Type
Required
array[object]
No
tests[].name
​tests > name
The name of the test.
Type
Required
string
Yes
tests[].dependencies[]
​tests > dependencies
The names of any services that must be running, and the names of any tasks that must be executed, before the test is run.
Type
Required
array[string]
No
tests[].timeout
​tests > timeout
Maximum duration (in seconds) of the test run.
Type
Required
number
No
tests[].resource
​tests > resource
The Deployment, DaemonSet or StatefulSet that Garden should use to execute this test suite. If not specified, the serviceResource configured on the module will be used. If neither is specified, an error will be thrown.
Type
Required
object
No
tests[].resource.kind
​tests > resource > kind
The type of Kubernetes resource to sync files to.
Type
Required
Allowed Values
string
Yes
"Deployment", "DaemonSet", "StatefulSet"
tests[].resource.name
​tests > resource > name
The name of the resource to sync to. If the chart contains a single resource of the specified Kind, this can be omitted. This can include a Helm template string, e.g. ''. This allows you to easily match the dynamic names given by Helm. In most cases you should copy this directly from the template in question in order to match it. Note that you may need to add single quotes around the string for the YAML to be parsed correctly.
Type
Required
string
No
tests[].resource.containerName
​tests > resource > containerName
The 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.
Type
Required
string
No
tests[].resource.containerModule
​tests > resource > containerModule
The Garden module that contains the sources for the container. This needs to be specified under serviceResource in order to enable hot-reloading for the chart, but is not necessary for tasks and tests. Must be a container module, and for hot-reloading to work you must specify the hotReload field on the container module. Note: If you specify a module here, you don't need to specify it additionally under build.dependencies
Type
Required
string
No
Example:
tests:
  - resource:
      ...
      containerModule: "my-container-module"
tests[].resource.hotReloadArgs[]
​tests > resource > hotReloadArgs
If specified, overrides the arguments for the main container when running in hot-reload mode.
Type
Required
array[string]
No
Example:
tests:
  - resource:
      ...
      hotReloadArgs:
        - nodemon
        - my-server.js
tests[].args[]
​tests > args
The arguments to pass to the pod used for testing.
Type
Required
array[string]
No
tests[].env
​tests > env
Key/value map of environment variables. Keys must be valid POSIX environment variable names (must not start with GARDEN) and values must be primitives.
Type
Required
object
No
version
The chart version to deploy.
Type
Required
string
No
values
Map of values to pass to Helm when rendering the templates. May include arrays and nested objects.
Type
Required
object
No
Complete YAML schema
apiVersion: garden.io/v0
kind: Module
type:
name:
description:
include:
repositoryUrl:
allowPublish: true
build:
  dependencies:
    - name:
      copy:
        - source:
          target: ''
base:
chart:
chartPath: .
dependencies: []
releaseName:
repo:
serviceResource:
  kind: Deployment
  name:
  containerName:
  containerModule:
  hotReloadArgs:
skipDeploy: false
tasks:
  - name:
    dependencies: []
    timeout: null
    resource:
      kind: Deployment
      name:
      containerName:
      containerModule:
      hotReloadArgs:
    args:
    env: {}
tests:
  - name:
    dependencies: []
    timeout: null
    resource:
      kind: Deployment
      name:
      containerName:
      containerModule:
      hotReloadArgs:
    args:
    env: {}
version:
values: {}
Exec
OpenFaaS
Last updated last month
Type	Required	Allowed Values
`string`	Yes	"Deployment", "DaemonSet", "StatefulSet"