Specify one or more Kubernetes manifests to deploy.
You can either (or both) specify the manifests as part of the garden.yml
configuration, or you can refer to one or more files with existing manifests.
Note that if you include the manifests in the garden.yml
file, you can use template strings to interpolate values into the manifests.
If you need more advanced templating features you can use the helm module type.
Below is the full schema reference. For an introduction to configuring Garden modules, please look at our Configuration guide.
The first section contains the complete YAML schema, and the second section describes each schema key.
kubernetes
modules also export values that are available in template strings. See the Outputs section below for details.
The values in the schema below are the default values.
# The schema version of this config (currently not used).apiVersion: garden.io/v0kind: Module# The type of this module.type:# The name of this module.name:# Specify how to build the module. Note that plugins may define additional keys on this object.build:# A list of modules that must be built before this module is built.dependencies:- # Module name to build ahead of this module.name:# Specify one or more files or directories to copy from the built dependency to this module.copy:- # POSIX-style path or filename of the directory or file(s) to copy to the target.source:# POSIX-style path or filename to copy the directory or file(s), relative to the build directory.# Defaults to to same as source path.target: ''# A description of the module.description:# Set this to `true` to disable the module. You can use this with conditional template strings to disable modules# 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 modules for specific environments, e.g. only for development.## Disabling a module means that any services, tasks and tests contained in it will not be deployed or run. It also# means that the module is not built _unless_ it is declared as a build dependency by another enabled module (in which# case building this module is necessary for the dependant to be built).## If you disable the module, and its services, tasks or tests are referenced as _runtime_ dependencies, Garden will# automatically ignore those dependency declarations. Note however that template strings referencing the module's# service or task outputs (i.e. runtime outputs) will fail to resolve when the module is disabled, so you need to make# sure to provide alternate values for those if you're using them, using conditional expressions.disabled: false# 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, when responding to# filesystem watch events, and when staging builds.## 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 [Configuration Files# guide](https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories) for# details.## Also note that specifying an empty list here means _no sources_ should be included.## If neither `include` nor `exclude` is set, Garden automatically sets `include` to equal the# `files` directive so that only the Kubernetes manifests get included.include:# Specify a list of POSIX-style paths or glob patterns that should be excluded from the module. Files that match these# paths or globs are excluded when computing the version of the module, when responding to filesystem watch events,# and when staging builds.## Note that you can also explicitly _include_ files using the `include` field. If you also specify the `include`# field, the files/patterns specified here are filtered from the files matched by `include`. See the [Configuration# Files guide](https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories)# for details.## Unlike the `modules.exclude` field in the project config, the filters here have _no effect_ on which files and# directories are watched for changes. Use the project `modules.exclude` field to affect those, if you have large# directories that should not be watched for changes.exclude:# A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific# branch or tag, with the format: <git remote url>#<branch|tag>## Garden will import the repository source code into this module, but read the module's config from the local# garden.yml file.repositoryUrl:# When false, disables pushing this module to remote registries.allowPublish: true# A list of files to write to the module directory when resolving this module. This is useful to automatically# generate (and template) any supporting files needed for the module.generateFiles:- # POSIX-style filename to read the source file contents from, relative to the path of the module (or the# ModuleTemplate configuration file if one is being applied).# This file may contain template strings, much like any other field in the configuration.sourcePath:# POSIX-style filename to write the resolved file contents to, relative to the path of the module source directory# (for remote modules this means the root of the module repository, otherwise the directory of the module# configuration).## Note that any existing file with the same name will be overwritten. If the path contains one or more# directories, they will be automatically created if missing.targetPath:# The desired file contents as a string.value:# The names of any services that this service depends on at runtime, and the names of any tasks that should be# executed before this service is deployed.dependencies: []# List of Kubernetes resource manifests to deploy. Use this instead of the `files` field if you need to resolve# template strings in any of the manifests.manifests:- # The API version of the resource.apiVersion:# The kind of the resource.kind:metadata:# The name of the resource.name:# POSIX-style paths to YAML files to load manifests from. Each can contain multiple manifests.files: []# A 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.namespace:# 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 `kubernetes-module` can contain any number of Kubernetes# resources, this needs to be specified for certain Garden features and commands to work.serviceResource:# The type of Kubernetes resource to sync files to.kind: Deployment# The name of the resource to sync to. If the module contains a single resource of the specified Kind, this can be# omitted.name:# 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.containerName:# The Garden module that contains the sources for the container. This needs to be specified under `serviceResource`# in order to enable hot-reloading, 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`containerModule:# If specified, overrides the arguments for the main container when running in hot-reload mode.hotReloadArgs:tasks:- # The name of the task.name:# A description of the task.description:# The names of any tasks that must be executed, and the names of any services that must be running, before this# task is executed.dependencies: []# Set this to `true` to disable the task. You can use this with conditional template strings to enable/disable# tasks based on, for example, the current environment or other variables (e.g. `enabled: \${environment.name !=# "prod"}`). This can be handy when you only want certain tasks to run in specific environments, e.g. only for# development.## Disabling a task means that it will not be run, and will also be ignored if it is declared as a runtime# dependency for another service, test or task.## Note however that template strings referencing the task's outputs (i.e. runtime outputs) will fail to resolve# when the task is disabled, so you need to make sure to provide alternate values for those if you're using them,# using conditional expressions.disabled: false# Maximum duration (in seconds) of the task's execution.timeout: null# 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.## The following pod spec fields from the service resource will be used (if present) when executing the task:# * `affinity`# * `automountServiceAccountToken`# * `containers`# * `dnsConfig`# * `dnsPolicy`# * `enableServiceLinks`# * `hostAliases`# * `hostIPC`# * `hostNetwork`# * `hostPID`# * `hostname`# * `imagePullSecrets`# * `nodeName`# * `nodeSelector`# * `overhead`# * `preemptionPolicy`# * `priority`# * `priorityClassName`# * `runtimeClassName`# * `schedulerName`# * `securityContext`# * `serviceAccount`# * `serviceAccountName`# * `shareProcessNamespace`# * `subdomain`# * `tolerations`# * `topologySpreadConstraints`# * `volumes`resource:# The type of Kubernetes resource to sync files to.kind: Deployment# The name of the resource to sync to. If the module contains a single resource of the specified Kind, this can# be omitted.name:# 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.containerName:# Set to false if you don't want the task's result to be cached. Use this if the task needs to be run any time# your project (or one or more of the task's dependants) is deployed. Otherwise the task is only re-run when its# version changes (i.e. the module or one of its dependencies is modified), or when you run `garden run task`.cacheResult: true# The command/entrypoint used to run the task inside the container.command:# The arguments to pass to the container used for execution.args:# Key/value map of environment variables. Keys must be valid POSIX environment variable names (must not start with# `GARDEN`) and values must be primitives or references to secrets.env: {}# Specify artifacts to copy out of the container after the run. The artifacts are stored locally under# the `.garden/artifacts` directory.artifacts:- # A POSIX-style path or glob to copy. Must be an absolute path. May contain wildcards.source:# A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at# `.garden/artifacts`.target: .tests:- # The name of the test.name:# The names of any services that must be running, and the names of any tasks that must be executed, before the# test is run.dependencies: []# Set this to `true` to disable the test. You can use this with conditional template strings to# enable/disable tests based on, for example, the current environment or other variables (e.g.# `enabled: \${environment.name != "prod"}`). This is handy when you only want certain tests to run in# specific environments, e.g. only during CI.disabled: false# Maximum duration (in seconds) of the test run.timeout: null# 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.## The following pod spec fields from the service resource will be used (if present) when executing the test suite:# * `affinity`# * `automountServiceAccountToken`# * `containers`# * `dnsConfig`# * `dnsPolicy`# * `enableServiceLinks`# * `hostAliases`# * `hostIPC`# * `hostNetwork`# * `hostPID`# * `hostname`# * `imagePullSecrets`# * `nodeName`# * `nodeSelector`# * `overhead`# * `preemptionPolicy`# * `priority`# * `priorityClassName`# * `runtimeClassName`# * `schedulerName`# * `securityContext`# * `serviceAccount`# * `serviceAccountName`# * `shareProcessNamespace`# * `subdomain`# * `tolerations`# * `topologySpreadConstraints`# * `volumes`resource:# The type of Kubernetes resource to sync files to.kind: Deployment# The name of the resource to sync to. If the module contains a single resource of the specified Kind, this can# be omitted.name:# 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.containerName:# The command/entrypoint used to run the test inside the container.command:# The arguments to pass to the container used for testing.args:# Key/value map of environment variables. Keys must be valid POSIX environment variable names (must not start with# `GARDEN`) and values must be primitives or references to secrets.env: {}# Specify artifacts to copy out of the container after the run. The artifacts are stored locally under# the `.garden/artifacts` directory.artifacts:- # A POSIX-style path or glob to copy. Must be an absolute path. May contain wildcards.source:# A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at# `.garden/artifacts`.target: .
The schema version of this config (currently not used).
Type | Allowed Values | Default | Required |
| "garden.io/v0" |
| Yes |
Type | Allowed Values | Default | Required |
| "Module" |
| Yes |
The type of this module.
Type | Required |
| Yes |
Example:
type: "container"
The name of this module.
Type | Required |
| Yes |
Example:
name: "my-sweet-module"
Specify how to build the module. Note that plugins may define additional keys on this object.
Type | Default | Required |
|
| No |
build > dependencies
A list of modules that must be built before this module is built.
Type | Default | Required |
|
| No |
Example:
build:...dependencies:- name: some-other-module-name
build > dependencies > name
Module name to build ahead of this module.
Type | Required |
| Yes |
build > dependencies > copy
Specify one or more files or directories to copy from the built dependency to this module.
Type | Default | Required |
|
| No |
build > dependencies > copy > source
POSIX-style path or filename of the directory or file(s) to copy to the target.
Type | Required |
| Yes |
build > dependencies > copy > target
POSIX-style path or filename to copy the directory or file(s), relative to the build directory. Defaults to to same as source path.
Type | Default | Required |
|
| No |
A description of the module.
Type | Required |
| No |
Set this to true
to disable the module. You can use this with conditional template strings to disable modules 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 modules for specific environments, e.g. only for development.
Disabling a module means that any services, tasks and tests contained in it will not be deployed or run. It also means that the module is not built unless it is declared as a build dependency by another enabled module (in which case building this module is necessary for the dependant to be built).
If you disable the module, and its services, tasks or tests are referenced as runtime dependencies, Garden will automatically ignore those dependency declarations. Note however that template strings referencing the module's service or task outputs (i.e. runtime outputs) will fail to resolve when the module is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.
Type | Default | Required |
|
| No |
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, when responding to filesystem watch events, and when staging builds.
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 Configuration Files guide for details.
Also note that specifying an empty list here means no sources should be included.
If neither include
nor exclude
is set, Garden automatically sets include
to equal the files
directive so that only the Kubernetes manifests get included.
Type | Required |
| No |
Example:
include:- Dockerfile- my-app.js
Specify a list of POSIX-style paths or glob patterns that should be excluded from the module. Files that match these paths or globs are excluded when computing the version of the module, when responding to filesystem watch events, and when staging builds.
Note that you can also explicitly include files using the include
field. If you also specify the include
field, the files/patterns specified here are filtered from the files matched by include
. See the Configuration Files guide for details.
Unlike the modules.exclude
field in the project config, the filters here have no effect on which files and directories are watched for changes. Use the project modules.exclude
field to affect those, if you have large directories that should not be watched for changes.
Type | Required |
| No |
Example:
exclude:- tmp/**/*- '*.log'
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 | |
`gitUrl | string` | No |
Example:
repositoryUrl: "git+https://github.com/org/repo.git#v2.0"
When false, disables pushing this module to remote registries.
Type | Default | Required |
|
| No |
A list of files to write to the module directory when resolving this module. This is useful to automatically generate (and template) any supporting files needed for the module.
Type | Default | Required |
|
| No |
generateFiles > sourcePath
POSIX-style filename to read the source file contents from, relative to the path of the module (or the ModuleTemplate configuration file if one is being applied). This file may contain template strings, much like any other field in the configuration.
Type | Required |
| No |
generateFiles > targetPath
POSIX-style filename to write the resolved file contents to, relative to the path of the module source directory (for remote modules this means the root of the module repository, otherwise the directory of the module configuration).
Note that any existing file with the same name will be overwritten. If the path contains one or more directories, they will be automatically created if missing.
Type | Required |
| Yes |
generateFiles > value
The desired file contents as a string.
Type | Required |
| No |
The names of any services that this service depends on at runtime, and the names of any tasks that should be executed before this service is deployed.
Type | Default | Required |
|
| No |
List of Kubernetes resource manifests to deploy. Use this instead of the files
field if you need to resolve template strings in any of the manifests.
Type | Default | Required |
|
| No |
manifests > apiVersion
The API version of the resource.
Type | Required |
| Yes |
manifests > kind
The kind of the resource.
Type | Required |
| Yes |
manifests > metadata
Type | Required |
| Yes |
The name of the resource.
Type | Required |
| Yes |
POSIX-style paths to YAML files to load manifests from. Each can contain multiple manifests.
Type | Default | Required |
|
| No |
A 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.
Type | Required |
| No |
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 kubernetes-module
can contain any number of Kubernetes resources, this needs to be specified for certain Garden features and commands to work.
Type | Required |
| No |
serviceResource > kind
The type of Kubernetes resource to sync files to.
Type | Allowed Values | Default | Required |
| "Deployment", "DaemonSet", "StatefulSet" |
| Yes |
serviceResource > name
The name of the resource to sync to. If the module contains a single resource of the specified Kind, this can be omitted.
Type | Required |
| No |
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 |
| No |
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, 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 |
| No |
Example:
serviceResource:...containerModule: "my-container-module"
serviceResource > hotReloadArgs
If specified, overrides the arguments for the main container when running in hot-reload mode.
Type | Required |
| No |
Example:
serviceResource:...hotReloadArgs:- nodemon- my-server.js
Type | Default | Required |
|
| No |
tasks > name
The name of the task.
Type | Required |
| Yes |
tasks > description
A description of the task.
Type | Required |
| No |
tasks > dependencies
The names of any tasks that must be executed, and the names of any services that must be running, before this task is executed.
Type | Default | Required |
|
| No |
tasks > disabled
Set this to true
to disable the task. You can use this with conditional template strings to enable/disable tasks based on, for example, the current environment or other variables (e.g. enabled: \${environment.name != "prod"}
). This can be handy when you only want certain tasks to run in specific environments, e.g. only for development.
Disabling a task means that it will not be run, and will also be ignored if it is declared as a runtime dependency for another service, test or task.
Note however that template strings referencing the task's outputs (i.e. runtime outputs) will fail to resolve when the task is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.
Type | Default | Required |
|
| No |
tasks > timeout
Maximum duration (in seconds) of the task's execution.
Type | Default | Required |
|
| No |
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.
The following pod spec fields from the service resource will be used (if present) when executing the task:
affinity
automountServiceAccountToken
containers
dnsConfig
dnsPolicy
enableServiceLinks
hostAliases
hostIPC
hostNetwork
hostPID
hostname
imagePullSecrets
nodeName
nodeSelector
overhead
preemptionPolicy
priority
priorityClassName
runtimeClassName
schedulerName
securityContext
serviceAccount
serviceAccountName
shareProcessNamespace
subdomain
tolerations
topologySpreadConstraints
volumes
Type | Required |
| No |
The type of Kubernetes resource to sync files to.
Type | Allowed Values | Default | Required |
| "Deployment", "DaemonSet", "StatefulSet" |
| Yes |
The name of the resource to sync to. If the module contains a single resource of the specified Kind, this can be omitted.
Type | Required |
| No |
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 |
| No |
tasks > cacheResult
Set to false if you don't want the task's result to be cached. Use this if the task needs to be run any time your project (or one or more of the task's dependants) is deployed. Otherwise the task is only re-run when its version changes (i.e. the module or one of its dependencies is modified), or when you run garden run task
.
Type | Default | Required |
|
| No |
tasks > command
The command/entrypoint used to run the task inside the container.
Type | Required |
| No |
Example:
tasks:- command:- /bin/sh- '-c'
tasks > args
The arguments to pass to the container used for execution.
Type | Required |
| No |
Example:
tasks:- args:- rake- 'db:migrate'
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 or references to secrets.
Type | Default | Required |
|
| No |
Example:
tasks:- env:- MY_VAR: some-valueMY_SECRET_VAR:secretRef:name: my-secretkey: some-key- {}
tasks > artifacts
Specify artifacts to copy out of the container after the run. The artifacts are stored locally under the .garden/artifacts
directory.
Type | Default | Required |
|
| No |
A POSIX-style path or glob to copy. Must be an absolute path. May contain wildcards.
Type | Required |
| Yes |
Example:
tasks:- artifacts:- source: "/output/**/*"
A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at .garden/artifacts
.
Type | Default | Required |
|
| No |
Example:
tasks:- artifacts:- target: "outputs/foo/"
Type | Default | Required |
|
| No |
tests > name
The name of the test.
Type | Required |
| Yes |
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 | Default | Required |
|
| No |
tests > disabled
Set this to true
to disable the test. You can use this with conditional template strings to enable/disable tests based on, for example, the current environment or other variables (e.g. enabled: \${environment.name != "prod"}
). This is handy when you only want certain tests to run in specific environments, e.g. only during CI.
Type | Default | Required |
|
| No |
tests > timeout
Maximum duration (in seconds) of the test run.
Type | Default | Required |
|
| No |
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.
The following pod spec fields from the service resource will be used (if present) when executing the test suite:
affinity
automountServiceAccountToken
containers
dnsConfig
dnsPolicy
enableServiceLinks
hostAliases
hostIPC
hostNetwork
hostPID
hostname
imagePullSecrets
nodeName
nodeSelector
overhead
preemptionPolicy
priority
priorityClassName
runtimeClassName
schedulerName
securityContext
serviceAccount
serviceAccountName
shareProcessNamespace
subdomain
tolerations
topologySpreadConstraints
volumes
Type | Required |
| No |
The type of Kubernetes resource to sync files to.
Type | Allowed Values | Default | Required |
| "Deployment", "DaemonSet", "StatefulSet" |
| Yes |
The name of the resource to sync to. If the module contains a single resource of the specified Kind, this can be omitted.
Type | Required |
| No |
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 |
| No |
tests > command
The command/entrypoint used to run the test inside the container.
Type | Required |
| No |
Example:
tests:- command:- /bin/sh- '-c'
tests > args
The arguments to pass to the container used for testing.
Type | Required |
| No |
Example:
tests:- args:- npm- test
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 or references to secrets.
Type | Default | Required |
|
| No |
Example:
tests:- env:- MY_VAR: some-valueMY_SECRET_VAR:secretRef:name: my-secretkey: some-key- {}
tests > artifacts
Specify artifacts to copy out of the container after the run. The artifacts are stored locally under the .garden/artifacts
directory.
Type | Default | Required |
|
| No |
A POSIX-style path or glob to copy. Must be an absolute path. May contain wildcards.
Type | Required |
| Yes |
Example:
tests:- artifacts:- source: "/output/**/*"
A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at .garden/artifacts
.
Type | Default | Required |
|
| No |
Example:
tests:- artifacts:- target: "outputs/foo/"
The following keys are available via the ${modules.<module-name>}
template string key for kubernetes
modules.
The build path of the module.
Type |
|
Example:
my-variable: ${modules.my-module.buildPath}
The name of the module.
Type |
|
The local path of the module.
Type |
|
Example:
my-variable: ${modules.my-module.path}
The current version of the module.
Type |
|
Example:
my-variable: ${modules.my-module.version}