kubernetes
Description
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.
Complete YAML Schema
The values in the schema below are the default values.
Configuration Keys
apiVersion
apiVersion
The schema version of this config (currently not used).
string
"garden.io/v0"
"garden.io/v0"
Yes
kind
kind
string
"Module"
"Module"
Yes
type
type
The type of this module.
string
Yes
Example:
name
name
The name of this module.
string
Yes
Example:
build
build
Specify how to build the module. Note that plugins may define additional keys on this object.
object
{"dependencies":[]}
No
build.dependencies[]
build.dependencies[]
build > dependencies
A list of modules that must be built before this module is built.
array[object]
[]
No
Example:
build.dependencies[].name
build.dependencies[].name
build > dependencies > name
Module name to build ahead of this module.
string
Yes
build.dependencies[].copy[]
build.dependencies[].copy[]
build > dependencies > copy
Specify one or more files or directories to copy from the built dependency to this module.
array[object]
[]
No
build.dependencies[].copy[].source
build.dependencies[].copy[].source
build > dependencies > copy > source
POSIX-style path or filename of the directory or file(s) to copy to the target.
posixPath
Yes
build.dependencies[].copy[].target
build.dependencies[].copy[].target
build > dependencies > copy > target
POSIX-style path or filename to copy the directory or file(s), relative to the build directory. Defaults to the same as source path.
posixPath
No
build.timeout
build.timeout
build > timeout
Maximum time in seconds to wait for build to finish.
number
1200
No
description
description
A description of the module.
string
No
disabled
disabled
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.
boolean
false
No
include[]
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, 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.
array[posixPath]
No
Example:
exclude[]
exclude[]
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.
array[posixPath]
No
Example:
repositoryUrl
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: #<branch|tag>
Garden will import the repository source code into this module, but read the module's config from the local garden.yml file.
gitUrl | string
No
Example:
allowPublish
allowPublish
When false, disables pushing this module to remote registries.
boolean
true
No
generateFiles[]
generateFiles[]
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.
array[object]
[]
No
generateFiles[].sourcePath
generateFiles[].sourcePath
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.
posixPath
No
generateFiles[].targetPath
generateFiles[].targetPath
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.
posixPath
Yes
generateFiles[].resolveTemplates
generateFiles[].resolveTemplates
generateFiles > resolveTemplates
By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the value
field, since that's resolved earlier when parsing the configuration.
boolean
true
No
generateFiles[].value
generateFiles[].value
generateFiles > value
The desired file contents as a string.
string
No
variables
variables
A map of variables scoped to this particular module. These are resolved before any other parts of the module configuration and take precedence over project-scoped variables. They may reference project-scoped variables, and generally use any template strings normally allowed when resolving modules.
object
No
varfile
varfile
Specify a path (relative to the module root) to a file containing variables, that we apply on top of the module-level variables
field.
The format of the files is determined by the configured file's extension:
.env
- Standard "dotenv" format, as defined by dotenv..yaml
/.yml
- YAML. The file must consist of a YAML document, which must be a map (dictionary). Keys may contain any value type..json
- JSON. Must contain a single JSON object (not an array).
NOTE: The default varfile format will change to YAML in Garden v0.13, since YAML allows for definition of nested objects and arrays.
To use different module-level varfiles in different environments, you can template in the environment name to the varfile name, e.g. varfile: "my-module.${environment.name}.env
(this assumes that the corresponding varfiles exist).
posixPath
No
Example:
dependencies[]
dependencies[]
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.
array[string]
[]
No
devMode
devMode
Specifies which files or directories to sync to which paths inside the running containers of the service when it's in dev mode, and overrides for the container command and/or arguments.
Note that serviceResource
must also be specified to enable dev mode.
Dev mode is enabled when running the garden dev
command, and by setting the --dev
flag on the garden deploy
command.
See the Code Synchronization guide for more information.
object
No
devMode.args[]
devMode.args[]
devMode > args
Override the default container arguments when in dev mode.
array[string]
No
devMode.command[]
devMode.command[]
devMode > command
Override the default container command (i.e. entrypoint) when in dev mode.
array[string]
No
devMode.sync[]
devMode.sync[]
devMode > sync
Specify one or more source files or directories to automatically sync with the running container.
array[object]
No
devMode.sync[].target
devMode.sync[].target
POSIX-style absolute path to sync the directory to inside the container. The root path (i.e. "/") is not allowed.
posixPath
Yes
Example:
devMode.sync[].exclude[]
devMode.sync[].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.
array[posixPath]
No
Example:
devMode.sync[].source
devMode.sync[].source
POSIX-style path of the directory to sync to the target. Can be either a relative or an absolute path. Defaults to the module's top-level directory if no value is provided.
posixPath
"."
No
Example:
devMode.sync[].mode
devMode.sync[].mode
The sync mode to use for the given paths. See the Dev Mode guide for details.
string
"one-way", "one-way-safe", "one-way-replica", "one-way-reverse", "one-way-replica-reverse", "two-way", "two-way-safe", "two-way-resolved"
"one-way-safe"
Yes
devMode.sync[].defaultFileMode
devMode.sync[].defaultFileMode
devMode > sync > defaultFileMode
The default permission bits, specified as an octal, to set on files at the sync target. Defaults to 0600 (user read/write). See the Mutagen docs for more information.
number
No
devMode.sync[].defaultDirectoryMode
devMode.sync[].defaultDirectoryMode
devMode > sync > defaultDirectoryMode
The default permission bits, specified as an octal, to set on directories at the sync target. Defaults to 0700 (user read/write). See the Mutagen docs for more information.
number
No
devMode.sync[].defaultOwner
devMode.sync[].defaultOwner
Set the default owner of files and directories at the target. Specify either an integer ID or a string name. See the Mutagen docs for more information.
number | string
No
devMode.sync[].defaultGroup
devMode.sync[].defaultGroup
Set the default group on files and directories at the target. Specify either an integer ID or a string name. See the Mutagen docs for more information.
number | string
No
devMode.containerName
devMode.containerName
devMode > containerName
Optionally specify the name of a specific container to sync to. If not specified, the first container in the workload is used.
string
No
localMode
localMode
Configures the local application which will send and receive network requests instead of the target resource specified by serviceResource
.
Note that serviceResource
must also be specified to enable local mode. Local mode configuration for the kubernetes
module type relies on the serviceResource.kind
and serviceResource.name
fields to select a target Kubernetes resource.
The serviceResource.containerName
field is not used by local mode configuration. Note that localMode
uses its own field containerName
to specify a target container name explicitly.
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 deployed application and back.
Local mode is enabled by setting the --local
option on the garden deploy
or garden dev
commands. Local mode always takes the precedence over dev mode if there are any conflicting service names.
Health checks are disabled for services running in local mode.
See the Local Mode guide for more information.
object
No
localMode.ports[]
localMode.ports[]
localMode > ports
The reverse port-forwards configuration for the local application.
array[object]
No
localMode.ports[].local
localMode.ports[].local
The local port to be used for reverse port-forward.
number
No
localMode.ports[].remote
localMode.ports[].remote
The remote port to be used for reverse port-forward.
number
No
localMode.command[]
localMode.command[]
localMode > command
The command to run the local application. If not present, then the local application should be started manually.
array[string]
No
localMode.restart
localMode.restart
localMode > restart
Specifies restarting policy for the local application. By default, the local application will be restarting infinitely with 1000ms between attempts.
object
{"delayMsec":1000,"max":null}
No
localMode.restart.delayMsec
localMode.restart.delayMsec
localMode > restart > delayMsec
Delay in milliseconds between the local application restart attempts. The default value is 1000ms.
number
1000
No
localMode.restart.max
localMode.restart.max
Max number of the local application restarts. Unlimited by default.
number
null
No
localMode.containerName
localMode.containerName
localMode > containerName
The name of the target container. The first available container will be used if this field is not defined.
string
No
files[]
files[]
POSIX-style paths to YAML files to load manifests from. Each can contain multiple manifests, and can include any Garden template strings, which will be resolved before applying the manifests.
array[posixPath]
[]
No
kustomize
kustomize
Resolve the specified kustomization and include the resulting resources. Note that if you specify files
or manifests
as well, these are also included.
object
No
kustomize.path
kustomize.path
kustomize > path
The directory path where the desired kustomization.yaml is, or a git repository URL. This could be the path to an overlay directory, for example. If it's a path, must be a relative POSIX-style path and must be within the module root. Defaults to the module root. If you set this to null, kustomize will not be run.
posixPath | string
"."
No
kustomize.extraArgs[]
kustomize.extraArgs[]
kustomize > extraArgs
A list of additional arguments to pass to the kustomize build
command. Note that specifying '-o' or '--output' is not allowed.
array[string]
[]
No
manifests[]
manifests[]
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.
array[object]
[]
No
manifests[].apiVersion
manifests[].apiVersion
manifests > apiVersion
The API version of the resource.
string
Yes
manifests[].kind
manifests[].kind
manifests > kind
The kind of the resource.
string
Yes
manifests[].metadata
manifests[].metadata
manifests > metadata
object
Yes
manifests[].metadata.name
manifests[].metadata.name
The name of the resource.
string
Yes
namespace
namespace
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.
string
No
portForwards[]
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.
array[object]
No
portForwards[].name
portForwards[].name
portForwards > name
An identifier to describe the port forward.
string
No
portForwards[].resource
portForwards[].resource
portForwards > resource
The 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.
string
Yes
portForwards[].targetPort
portForwards[].targetPort
portForwards > targetPort
The port number on the remote resource to forward to.
number
Yes
portForwards[].localPort
portForwards[].localPort
portForwards > localPort
The 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.
number
No
serviceResource
serviceResource
The Deployment, DaemonSet or StatefulSet or Pod that Garden should regard as the Garden service in this module (not to be confused with Kubernetes Service resources).
This can either reference a workload (i.e. a Deployment, DaemonSet or StatefulSet) via the kind
and name
fields, or a Pod via the podSelector
field.
Because a kubernetes
module can contain any number of Kubernetes resources, this needs to be specified for certain Garden features and commands to work.
object
No
serviceResource.kind
serviceResource.kind
serviceResource > kind
The type of Kubernetes resource to sync files to.
string
"Deployment", "DaemonSet", "StatefulSet"
"Deployment"
Yes
serviceResource.name
serviceResource.name
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.
string
No
serviceResource.containerName
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.
string
No
serviceResource.podSelector
serviceResource.podSelector
serviceResource > podSelector
A 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.
object
No
serviceResource.containerModule
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 and dev mode, 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 (not required for dev mode).
Note: If you specify a module here, you don't need to specify it additionally under build.dependencies
.
string
No
Example:
serviceResource.hotReloadArgs[]
serviceResource.hotReloadArgs[]
serviceResource > hotReloadArgs
If specified, overrides the arguments for the main container when running in hot-reload mode.
array[string]
No
Example:
tasks[]
tasks[]
array[object]
[]
No
tasks[].name
tasks[].name
tasks > name
The name of the task.
string
Yes
tasks[].description
tasks[].description
tasks > description
A description of the task.
string
No
tasks[].dependencies[]
tasks[].dependencies[]
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.
array[string]
[]
No
tasks[].disabled
tasks[].disabled
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.
boolean
false
No
tasks[].timeout
tasks[].timeout
tasks > timeout
Maximum duration (in seconds) of the task's execution.
number
null
No
tasks[].resource
tasks[].resource
tasks > resource
The Deployment, DaemonSet, StatefulSet or Pod 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.
This can either reference a workload (i.e. a Deployment, DaemonSet or StatefulSet) via the kind
and name
fields, or a Pod via the podSelector
field.
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
object
No
tasks[].resource.kind
tasks[].resource.kind
The type of Kubernetes resource to sync files to.
string
"Deployment", "DaemonSet", "StatefulSet"
"Deployment"
Yes
tasks[].resource.name
tasks[].resource.name
The name of the resource to sync to. If the module contains a single resource of the specified Kind, this can be omitted.
string
No
tasks[].resource.containerName
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.
string
No
tasks[].resource.podSelector
tasks[].resource.podSelector
tasks > resource > podSelector
A 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.
object
No
tasks[].cacheResult
tasks[].cacheResult
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
.
boolean
true
No
tasks[].command[]
tasks[].command[]
tasks > command
The command/entrypoint used to run the task inside the container.
array[string]
No
Example:
tasks[].args[]
tasks[].args[]
tasks > args
The arguments to pass to the container used for execution.
array[string]
No
Example:
tasks[].env
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 or references to secrets.
object
{}
No
Example:
tasks[].artifacts[]
tasks[].artifacts[]
tasks > artifacts
Specify artifacts to copy out of the container after the run. The artifacts are stored locally under the .garden/artifacts
directory.
array[object]
[]