search
Bonsai (0.13) DocsGitHubDiscord CommunityGarden Enterprise

kubernetes

circle-exclamation

Modules are deprecated and will be removed in version 0.14. Please use action-based configuration instead. See the 0.12 to Bonsai migration guide for details.

hashtag
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 stringsarrow-up-right to interpolate values into the manifests.

If you need more advanced templating features you can use the helm Deploy type.

Below is the full schema reference.

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.

hashtag
Complete YAML Schema

The values in the schema below are the default values.

kind: 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 the same as source path.
          target:

  # Maximum time in seconds to wait for build to finish.
  timeout: 600

# If set to true, Garden will run the build command, services, tests, and tasks in the module source directory,
# instead of in the Garden build directory (under .garden/build/<module-name>).
#
# Garden will therefore not stage the build for local modules. This means that include/exclude filters
# and ignore files are not applied to local modules, except to calculate the module/action versions.
#
# If you use use `build.dependencies[].copy` for one or more build dependencies of this module, the copied files
# will be copied to the module source directory (instead of the build directory, as is the default case when
# `local = false`).
#
# Note: This maps to the `buildAtSource` option in this module's generated Build action (if any).
local: false

# 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 build, deployed or run.
#
# 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/cedar-0.14/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/cedar-0.14/using-garden/configuration-overview#including-excluding-files-and-directories)
# for details.
#
# Unlike the `scan.exclude` field in the project config, the filters here have _no effect_ on which files and
# directories are watched for changes. Use the project `scan.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 via the publish command.
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
    # ConfigTemplate 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:

    # 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.
    resolveTemplates: true

    # The desired file contents as a string.
    value:

# 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.
variables:

# 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:
#
# * `.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.
# * `.env` - Standard "dotenv" format, as defined by [dotenv](https://github.com/motdotla/dotenv#rules).
# * `.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 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).
varfile:

# 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.
files: []

# Resolve the specified kustomization and include the resulting resources. Note that if you specify `files` or
# `manifests` as well, these are also included.
kustomize:
  # 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 action
  # root. Defaults to the action root. If you set this to null, kustomize will not be run.
  path: .

  # The Kustomize version to use.
  version: 5

  # A list of additional arguments to pass to the `kustomize build` command. Note that specifying '-o' or '--output'
  # is not allowed.
  extraArgs: []

# List of Kubernetes resource manifests to deploy. If `files` is also specified, this is combined with the manifests
# read from the files.
manifests:
  - # The API version of the resource.
    apiVersion:

    # The kind of the resource.
    kind:

    metadata:
      # The name of the resource.
      name:

# A list of resources to patch using Kubernetes' patch strategies. This is useful for e.g. overwriting a given
# container image name with an image built by Garden
# without having to actually modify the underlying Kubernetes manifest in your source code. Another common example is
# to use this to change the number of replicas for a given
# Kubernetes Deployment.
#
# Under the hood, Garden just applies the `kubectl patch` command to the resource that matches the specified `kind`
# and `name`.
#
# Patches are applied to file manifests, inline manifests, and kustomize files.
#
# You can learn more about patching Kubernetes resources here:
# https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
patchResources:
  - # The kind of the resource to patch.
    kind:

    # The name of the resource to patch.
    name:

    # The patch strategy to use. One of 'json', 'merge', or 'strategic'. Defaults to 'strategic'.
    #
    # You can read more about the different strategies in the official Kubernetes documentation at:
    # https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/
    strategy: strategic

    # The patch to apply.
    patch:

# 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:

# 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.
portForwards:
  - # An identifier to describe the port forward.
    name:

    # 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.
    resource:

    # The port number on the remote resource to forward to.
    targetPort:

    # 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.
    localPort:

# The maximum duration (in seconds) to wait for resources to deploy and become healthy.
timeout: 300

# Additional arguments to pass to `kubectl apply`.
applyArgs:

# Wait until the jobs have been completed. Garden will wait for as long as `timeout`.
waitForJobs: true

# 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.
# You may also depend on Deploy and Run actions, but please note that you cannot reference those actions in template
# strings.
dependencies: []

# Specifies which files or directories to sync to which paths inside the running containers of the service when it's
# in sync mode, and overrides for the container command and/or arguments.
#
# Note that `serviceResource` must also be specified to enable sync.
#
# Sync is enabled by setting the `--sync` flag on the `garden deploy` command.
#
# See the [Code Synchronization guide](https://docs.garden.io/cedar-0.14/guides/code-synchronization) for more
# information.
sync:
  # Override the default container arguments when in sync mode.
  args:

  # Override the default container command (i.e. entrypoint) when in sync mode.
  command:

  # Specify one or more source files or directories to automatically sync with the running container.
  paths:
    - # Path 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.
      source: .

      # POSIX-style absolute path to sync to inside the container. The root path (i.e. "/") is not allowed.
      target:

      # 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.
      exclude:

      # The sync mode to use for the given paths. See the [Code Synchronization
      # guide](https://docs.garden.io/cedar-0.14/guides/code-synchronization) for details.
      mode: one-way-safe

      # 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 [Mutagen
      # docs](https://mutagen.io/documentation/synchronization/permissions#permissions) for more information.
      defaultFileMode: 420

      # 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 [Mutagen
      # docs](https://mutagen.io/documentation/synchronization/permissions#permissions) for more information.
      defaultDirectoryMode: 493

      # Set the default owner of files and directories at the target. Specify either an integer ID or a string name.
      # See the [Mutagen docs](https://mutagen.io/documentation/synchronization/permissions#owners-and-groups) for
      # more information.
      defaultOwner:

      # Set the default group on files and directories at the target. Specify either an integer ID or a string name.
      # See the [Mutagen docs](https://mutagen.io/documentation/synchronization/permissions#owners-and-groups) for
      # more information.
      defaultGroup:

  # Optionally specify the name of a specific container to sync to. If not specified, the first container in the
  # workload is used.
  containerName:

# 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.
serviceResource:
  # The type of Kubernetes resource to sync files to.
  kind: Deployment

  # The name of the resource to sync to. If the action 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:

  # 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.
  podSelector:

  # The Garden module that contains the sources for the container. This needs to be specified under `serviceResource`
  # in order to enable syncing, but is not necessary for tasks and tests. Must be a `container` module.
  #
  # _Note: If you specify a module here, you don't need to specify it additionally under `build.dependencies`._
  containerModule:

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.
    # You may also depend on Deploy and Run actions, but please note that you cannot reference those actions in
    # template strings.
    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: 600

    # 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:
    #
    # **Warning**: Garden will retain `configMaps` and `secrets` as volumes, but remove `persistentVolumeClaim`
    # volumes from the Pod spec, as they might already be mounted.
    # * `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 action 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:

      # 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.
      podSelector:

    # Set to false if you don't want the Run action result to be cached. Use this if the Run action needs to be run
    # any time your project (or one or more of the Run action's dependants) is deployed. Otherwise the Run action is
    # only re-run when its version changes, or when you run `garden run`.
    cacheResult: true

    # The command/entrypoint used to run inside the container.
    command:

    # The arguments to pass to the command/entrypoint 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: .

    # 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:

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: 600

    # The Deployment, DaemonSet or StatefulSet or Pod 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.
    #
    # 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 test suite:
    #
    # **Warning**: Garden will retain `configMaps` and `secrets` as volumes, but remove `persistentVolumeClaim`
    # volumes from the Pod spec, as they might already be mounted.
    # * `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 action 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:

      # 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.
      podSelector:

    # 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: .

hashtag
Configuration Keys

hashtag
kind

Type
Allowed Values
Default
Required

string

"Module"

"Module"

Yes

hashtag
type

The type of this module.

Type
Required

string

Yes

Example:

hashtag
name

The name of this module.

Type
Required

string

Yes

Example:

hashtag
build

Specify how to build the module. Note that plugins may define additional keys on this object.

Type
Default
Required

object

{"dependencies":[]}

No

hashtag
build.dependencies[]

build > dependencies

A list of modules that must be built before this module is built.

Type
Default
Required

array[object]

[]

No

Example:

hashtag
build.dependencies[].name

build > dependencies > name

Module name to build ahead of this module.

Type
Required

string

Yes

hashtag
build.dependencies[].copy[]

build > dependencies > copy

Specify one or more files or directories to copy from the built dependency to this module.

Type
Default
Required

array[object]

[]

No

hashtag
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

posixPath

Yes

hashtag
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.

Type
Required

posixPath

No

hashtag
build.timeout

build > timeout

Maximum time in seconds to wait for build to finish.

Type
Default
Required

number

600

No

hashtag
local

If set to true, Garden will run the build command, services, tests, and tasks in the module source directory, instead of in the Garden build directory (under .garden/build/).

Garden will therefore not stage the build for local modules. This means that include/exclude filters and ignore files are not applied to local modules, except to calculate the module/action versions.

If you use use build.dependencies[].copy for one or more build dependencies of this module, the copied files will be copied to the module source directory (instead of the build directory, as is the default case when local = false).

Note: This maps to the buildAtSource option in this module's generated Build action (if any).

Type
Default
Required

boolean

false

No

hashtag
description

A description of the module.

Type
Required

string

No

hashtag
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 build, deployed or run.

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

boolean

false

No

hashtag
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 guidearrow-up-right 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

array[posixPath]

No

Example:

hashtag
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 guidearrow-up-right for details.

Unlike the scan.exclude field in the project config, the filters here have no effect on which files and directories are watched for changes. Use the project scan.exclude field to affect those, if you have large directories that should not be watched for changes.

Type
Required

array[posixPath]

No

Example:

hashtag
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.

Type
Required

gitUrl | string

No

Example:

hashtag
allowPublish

When false, disables pushing this module to remote registries via the publish command.

Type
Default
Required

boolean

true

No

hashtag
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.

Type
Default
Required

array[object]

[]

No

hashtag
generateFiles[].sourcePath

generateFiles > sourcePath

POSIX-style filename to read the source file contents from, relative to the path of the module (or the ConfigTemplate configuration file if one is being applied). This file may contain template strings, much like any other field in the configuration.

Type
Required

posixPath

No

hashtag
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.

Type
Required

posixPath

Yes

hashtag
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.

Type
Default
Required

boolean

true

No

hashtag
generateFiles[].value

generateFiles > value

The desired file contents as a string.

Type
Required

string

No

hashtag
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.

Type
Required

object

No

hashtag
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:

  • .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.

  • .env - Standard "dotenv" format, as defined by dotenvarrow-up-right.

  • .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 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).

Type
Required

posixPath

No

Example:

hashtag
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.

Type
Default
Required

array[posixPath]

[]

No

hashtag
kustomize

Resolve the specified kustomization and include the resulting resources. Note that if you specify files or manifests as well, these are also included.

Type
Required

object

No

hashtag
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 action root. Defaults to the action root. If you set this to null, kustomize will not be run.

Type
Default
Required

posixPath | string

"."

No

hashtag
kustomize.version

kustomize > version

The Kustomize version to use.

Type
Allowed Values
Default
Required

number

4, 5

5

Yes

hashtag
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.

Type
Default
Required

array[string]

[]

No

hashtag
manifests[]

List of Kubernetes resource manifests to deploy. If files is also specified, this is combined with the manifests read from the files.

Type
Default
Required

array[object]

[]

No

hashtag
manifests[].apiVersion

manifests > apiVersion

The API version of the resource.

Type
Required

string

Yes

hashtag
manifests[].kind

manifests > kind

The kind of the resource.

Type
Required

string

Yes

hashtag
manifests[].metadata

manifests > metadata

Type
Required

object

Yes

hashtag
manifests[].metadata.name

manifests > metadata > name

The name of the resource.

Type
Required

string

Yes

hashtag
patchResources[]

A list of resources to patch using Kubernetes' patch strategies. This is useful for e.g. overwriting a given container image name with an image built by Garden without having to actually modify the underlying Kubernetes manifest in your source code. Another common example is to use this to change the number of replicas for a given Kubernetes Deployment.

Under the hood, Garden just applies the kubectl patch command to the resource that matches the specified kind and name.

Patches are applied to file manifests, inline manifests, and kustomize files.

You can learn more about patching Kubernetes resources here: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/

Type
Default
Required

array[object]

[]

No

hashtag
patchResources[].kind

patchResources > kind

The kind of the resource to patch.

Type
Required

string

Yes

hashtag
patchResources[].name

patchResources > name

The name of the resource to patch.

Type
Required

string

Yes

hashtag
patchResources[].strategy

patchResources > strategy

The patch strategy to use. One of 'json', 'merge', or 'strategic'. Defaults to 'strategic'.

You can read more about the different strategies in the official Kubernetes documentation at: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/

Type
Default
Required

string

"strategic"

No

hashtag
patchResources[].patch

patchResources > patch

The patch to apply.

Type
Required

object

Yes

hashtag
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.

Type
Required

string

No

hashtag
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.

Type
Required

array[object]

No

hashtag
portForwards[].name

portForwards > name

An identifier to describe the port forward.

Type
Required

string

No

hashtag
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.

Type
Required

string

Yes

hashtag
portForwards[].targetPort

portForwards > targetPort

The port number on the remote resource to forward to.

Type
Required

number

Yes

hashtag
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.

Type
Required

number

No

hashtag
timeout

The maximum duration (in seconds) to wait for resources to deploy and become healthy.

Type
Default
Required

number

300

No

hashtag
applyArgs[]

Additional arguments to pass to kubectl apply.

Type
Required

array[string]

No

hashtag
waitForJobs

Wait until the jobs have been completed. Garden will wait for as long as timeout.

Type
Default
Required

boolean

true

No

hashtag
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. You may also depend on Deploy and Run actions, but please note that you cannot reference those actions in template strings.

Type
Default
Required

array[alternatives]

[]

No

hashtag
sync

Specifies which files or directories to sync to which paths inside the running containers of the service when it's in sync mode, and overrides for the container command and/or arguments.

Note that serviceResource must also be specified to enable sync.

Sync is enabled by setting the --sync flag on the garden deploy command.

See the Code Synchronization guidearrow-up-right for more information.

Type
Required

object

No

hashtag
sync.args[]

sync > args

Override the default container arguments when in sync mode.

Type
Required

array[string]

No

hashtag
sync.command[]

sync > command

Override the default container command (i.e. entrypoint) when in sync mode.

Type
Required

array[string]

No

hashtag
sync.paths[]

sync > paths

Specify one or more source files or directories to automatically sync with the running container.

Type
Required

array[object]

No

hashtag
sync.paths[].source

sync > paths > source

Path 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.

Type
Default
Required

string

"."

No

Example:

hashtag
sync.paths[].target

sync > paths > target

POSIX-style absolute path to sync to inside the container. The root path (i.e. "/") is not allowed.

Type
Required

posixPath

Yes

Example:

hashtag
sync.paths[].exclude[]

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.

Type
Required

array[posixPath]

No

Example:

hashtag
sync.paths[].mode

sync > paths > mode

The sync mode to use for the given paths. See the Code Synchronization guidearrow-up-right for details.

Type
Allowed Values
Default
Required

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

hashtag
sync.paths[].defaultFileMode

sync > paths > 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 Mutagen docsarrow-up-right for more information.

Type
Default
Required

number

0o644

No

hashtag
sync.paths[].defaultDirectoryMode

sync > paths > 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 Mutagen docsarrow-up-right for more information.

Type
Default
Required

number

0o755

No

hashtag
sync.paths[].defaultOwner

sync > paths > defaultOwner

Set the default owner of files and directories at the target. Specify either an integer ID or a string name. See the Mutagen docsarrow-up-right for more information.

Type
Required

number | string

No

hashtag
sync.paths[].defaultGroup

sync > paths > defaultGroup

Set the default group on files and directories at the target. Specify either an integer ID or a string name. See the Mutagen docsarrow-up-right for more information.

Type
Required

number | string

No

hashtag
sync.containerName

sync > containerName

Optionally specify the name of a specific container to sync to. If not specified, the first container in the workload is used.

Type
Required

string

No

hashtag
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.

Type
Required

object

No

hashtag
serviceResource.kind

serviceResource > kind

The type of Kubernetes resource to sync files to.

Type
Allowed Values
Default
Required

string

"Deployment", "DaemonSet", "StatefulSet"

"Deployment"

Yes

hashtag
serviceResource.name

serviceResource > name

The name of the resource to sync to. If the action contains a single resource of the specified Kind, this can be omitted.

Type
Required

string

No

hashtag
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

hashtag
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.

Type
Required

object

No

hashtag
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 syncing, but is not necessary for tasks and tests. Must be a 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:

hashtag
tasks[]

Type
Default
Required

array[object]

[]

No

hashtag
tasks[].name

tasks > name

The name of the task.

Type
Required

string

Yes

hashtag
tasks[].description

tasks > description

A description of the task.

Type
Required

string

No

hashtag
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. You may also depend on Deploy and Run actions, but please note that you cannot reference those actions in template strings.

Type
Default
Required

array[alternatives]

[]

No

hashtag
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.

Type
Default
Required

boolean

false

No

hashtag
tasks[].timeout

tasks > timeout

Maximum duration (in seconds) of the task's execution.

Type
Default
Required

number

600

No

hashtag
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:

Warning: Garden will retain configMaps and secrets as volumes, but remove persistentVolumeClaim volumes from the Pod spec, as they might already be mounted.

  • 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

object

No

hashtag
tasks[].resource.kind

tasks > resource > kind

The type of Kubernetes resource to sync files to.

Type
Allowed Values
Default
Required

string

"Deployment", "DaemonSet", "StatefulSet"

"Deployment"

Yes

hashtag
tasks[].resource.name

tasks > resource > name

The name of the resource to sync to. If the action contains a single resource of the specified Kind, this can be omitted.

Type
Required

string

No

hashtag
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

hashtag
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.

Type
Required

object

No

hashtag
tasks[].cacheResult

tasks > cacheResult

Set to false if you don't want the Run action result to be cached. Use this if the Run action needs to be run any time your project (or one or more of the Run action's dependants) is deployed. Otherwise the Run action is only re-run when its version changes, or when you run garden run.

Type
Default
Required

boolean

true

No

hashtag
tasks[].command[]

tasks > command

The command/entrypoint used to run inside the container.

Type
Required

array[string]

No

Example:

hashtag
tasks[].args[]

tasks > args

The arguments to pass to the command/entrypoint used for execution.

Type
Required

array[string]

No

Example:

hashtag
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.

Type
Default
Required

object

{}

No

Example:

hashtag
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.

Type
Default
Required

array[object]

[]

No

hashtag
tasks[].artifacts[].source

tasks > artifacts > source

A POSIX-style path or glob to copy. Must be an absolute path. May contain wildcards.

Type
Required

posixPath

Yes

Example:

hashtag
tasks[].artifacts[].target

tasks > artifacts > target

A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at .garden/artifacts.

Type
Default
Required

posixPath

"."

No

Example:

hashtag
tasks[].namespace

tasks > 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.

Type
Required

string

No

hashtag
tests[]

Type
Default
Required

array[object]

[]

No

hashtag
tests[].name

tests > name

The name of the test.

Type
Required

string

Yes

hashtag
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
Default
Required

array[string]

[]

No

hashtag
tests[].disabled

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

boolean

false

No

hashtag
tests[].timeout

tests > timeout

Maximum duration (in seconds) of the test run.

Type
Default
Required

number

600

No

hashtag
tests[].resource

tests > resource

The Deployment, DaemonSet or StatefulSet or Pod 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.

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 test suite:

Warning: Garden will retain configMaps and secrets as volumes, but remove persistentVolumeClaim volumes from the Pod spec, as they might already be mounted.

  • 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

object

No

hashtag
tests[].resource.kind

tests > resource > kind

The type of Kubernetes resource to sync files to.

Type
Allowed Values
Default
Required

string

"Deployment", "DaemonSet", "StatefulSet"

"Deployment"

Yes

hashtag
tests[].resource.name

tests > resource > name

The name of the resource to sync to. If the action contains a single resource of the specified Kind, this can be omitted.

Type
Required

string

No

hashtag
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

hashtag
tests[].resource.podSelector

tests > 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.

Type
Required

object

No

hashtag
tests[].command[]

tests > command

The command/entrypoint used to run the test inside the container.

Type
Required

array[string]

No

Example:

hashtag
tests[].args[]

tests > args

The arguments to pass to the container used for testing.

Type
Required

array[string]

No

Example:

hashtag
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 or references to secrets.

Type
Default
Required

object

{}

No

Example:

hashtag
tests[].artifacts[]

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

array[object]

[]

No

hashtag
tests[].artifacts[].source

tests > artifacts > source

A POSIX-style path or glob to copy. Must be an absolute path. May contain wildcards.

Type
Required

posixPath

Yes

Example:

hashtag
tests[].artifacts[].target

tests > artifacts > target

A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at .garden/artifacts.

Type
Default
Required

posixPath

"."

No

Example:

hashtag
Outputs

hashtag
Module Outputs

The following keys are available via the ${modules.<module-name>} template string key for kubernetes modules.

hashtag
${modules.<module-name>.buildPath}

The build path of the module.

Type

string

Example:

hashtag
${modules.<module-name>.name}

The name of the module.

Type

string

hashtag
${modules.<module-name>.path}

The source path of the module.

Type

string

Example:

hashtag
${modules.<module-name>.var.*}

A map of all variables defined in the module.

Type
Default

object

{}

hashtag
${modules.<module-name>.var.<variable-name>}

Type

string | number | boolean | link | array[link]

hashtag
${modules.<module-name>.version}

The current version of the module.

Type

string

Example:

hashtag
Service Outputs

The following keys are available via the ${runtime.services.<service-name>} template string key for kubernetes module services. Note that these are only resolved when deploying/running dependants of the service, so they are not usable for every field.

hashtag
${runtime.services.<service-name>.version}

The current version of the service.

Type

string

Example:

hashtag
Task Outputs

The following keys are available via the ${runtime.tasks.<task-name>} template string key for kubernetes module tasks. Note that these are only resolved when deploying/running dependants of the task, so they are not usable for every field.

hashtag
${runtime.tasks.<task-name>.version}

The current version of the task.

Type

string

Example:

Previousjib-containerNextpulumi

Last updated

Was this helpful?