Below is the schema reference for the Project and Module garden.yml configuration files. For an introduction to configuring a Garden project, please look at our configuration guide.

The reference is divided into four sections. The first section lists and describes the available schema keys for the project level configuration, and the second section contains the project level YAML schema.

The third section lists and describes the available schema keys for the module level configuration, and the fourth section contains the module level YAML schema.

Note that individual providers, e.g. kubernetes, add their own project level configuration keys. The provider types are listed on the Providers page.

Likewise, individual module types, e.g. container, add additional configuration keys at the module level. Module types are listed on the Module Types page.

Please refer to those for more details on provider and module configuration.

Project configuration keys

apiVersion

The schema version of this project's config (currently not used).

kind

name

The name of the project.

Example:

name: "my-sweet-project"

defaultEnvironment

The default environment to use when calling commands without the --env parameter.

dotIgnoreFiles

Specify a list of filenames that should be used as ".ignore" files across the project, using the same syntax and semantics as .gitignore files. By default, patterns matched in .gitignore and .gardenignore files, found anywhere in the project, are ignored when scanning for modules and module sources. Note that these take precedence over the project module.include field, and module include fields, so any paths matched by the .ignore files will be ignored even if they are explicitly specified in those fields. See the [Configuration Files guide] (https://docs.garden.io/using-garden/configuration-files#including-excluding-files-and-directories) for details.

environmentDefaults

DEPRECATED - Please use the providers field instead, and omit the environments key in the configured provider to use it for all environments, and use the variables field to configure variables across all environments.

Example:

environmentDefaults:
    providers: []
    variables: {}

environmentDefaults.providers[]

​environmentDefaults > providers

DEPRECATED - Please use the top-level providers field instead, and if needed use the environments key on the provider configurations to limit them to specific environments.

environmentDefaults.providers[].name

​environmentDefaults > providers > name

The name of the provider plugin to use.

Example:

environmentDefaults:
    providers: []
    variables: {}
  ...
  providers:
    - name: "local-kubernetes"

environmentDefaults.providers[].environments[]

​environmentDefaults > providers > environments

If specified, this provider will only be used in the listed environments. Note that an empty array effectively disables the provider. To use a provider in all environments, omit this field.

Example:

environmentDefaults:
    providers: []
    variables: {}
  ...
  providers:
    - environments:
      - dev
      - stage

environmentDefaults.varfile

​environmentDefaults > varfile

Specify a path (relative to the project root) to a file containing variables, that we apply on top of the environment-specific variables field. The file should be in a standard "dotenv" format, specified here.

If you don't set the field and the garden.<env-name>.env file does not exist, we simply ignore it. If you do override the default value and the file doesn't exist, an error will be thrown.

environmentDefaults.variables

​environmentDefaults > variables

A key/value map of variables that modules can reference when using this environment. These take precedence over variables defined in the top-level variables field.

modules

modules.include[]

​modules > include

Specify a list of POSIX-style paths or globs that should be scanned for Garden modules.

Note that you can also exclude path 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 paths should be included.

Example:

modules:
  ...
  include:
    - modules/**/*

modules.exclude[]

​modules > exclude

Specify a list of POSIX-style paths or glob patterns that should be excluded when scanning for modules. Note that you can also explicitly include files using the include field. If you also specify the include field, the paths/patterns specified here are filtered from the files matched by include. See the Configuration Files guide for details.

Example:

modules:
  ...
  exclude:
    - public/**/*
    - tmp/**/*

providers

A list of providers that should be used for this project, and their configuration. Please refer to individual plugins/providers for details on how to configure them.

providers[].name

​providers > name

The name of the provider plugin to use.

Example:

providers:
  - name: "local-kubernetes"

providers[].environments[]

​providers > environments

If specified, this provider will only be used in the listed environments. Note that an empty array effectively disables the provider. To use a provider in all environments, omit this field.

Example:

providers:
  - environments:
    - dev
    - stage

sources

A list of remote sources to import into project.

sources[].name

​sources > name

The name of the source to import

sources[].repositoryUrl

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

Example:

sources:
  - repositoryUrl: "git+https://github.com/org/repo.git#v2.0"

varfile

Specify a path (relative to the project root) to a file containing variables, that we apply on top of the project-wide variables field. The file should be in a standard "dotenv" format, specified here.

If you don't set the field and the garden.env file does not exist, we simply ignore it. If you do override the default value and the file doesn't exist, an error will be thrown.

Note that in many cases it is advisable to only use environment-specific var files, instead of combining multiple ones. See the environments[].varfile field for this option.

variables

Variables to configure for all environments.

environments

environments[].providers[]

​environments > providers

DEPRECATED - Please use the top-level providers field instead, and if needed use the environments key on the provider configurations to limit them to specific environments.

environments[].providers[].name

​environments > providers > name

The name of the provider plugin to use.

Example:

environments:
  - providers:
      - name: "local-kubernetes"

environments[].providers[].environments[]

​environments > providers > environments

If specified, this provider will only be used in the listed environments. Note that an empty array effectively disables the provider. To use a provider in all environments, omit this field.

Example:

environments:
  - providers:
      - environments:
        - dev
        - stage

environments[].varfile

​environments > varfile

Specify a path (relative to the project root) to a file containing variables, that we apply on top of the environment-specific variables field. The file should be in a standard "dotenv" format, specified here.

If you don't set the field and the garden.<env-name>.env file does not exist, we simply ignore it. If you do override the default value and the file doesn't exist, an error will be thrown.

environments[].variables

​environments > variables

A key/value map of variables that modules can reference when using this environment. These take precedence over variables defined in the top-level variables field.

environments[].name

​environments > name

The name of the environment.

Project YAML schema

apiVersion: garden.io/v0
kind: Project
name:
defaultEnvironment: ''
dotIgnoreFiles:
  - .gitignore
  - .gardenignore
environmentDefaults:
  providers:
    - name:
      environments:
  varfile: garden.<env-name>.env
  variables: {}
modules:
  include:
  exclude:
providers:
  - name:
    environments:
sources:
  - name:
    repositoryUrl:
varfile: garden.env
variables: {}
environments:
  - providers:
      - name:
        environments:
  - varfile: garden.<env-name>.env
    variables: {}
    name:

Module configuration keys

apiVersion

The schema version of this module's config (currently not used).

kind

type

The type of this module.

Example:

type: "container"

name

The name of this module.

Example:

name: "my-sweet-module"

description

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.

Example:

include:
  - Dockerfile
  - my-app.js

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 guidefor details.

Example:

exclude:
  - tmp/**/*
  - '*.log'

repositoryUrl

A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific branch or tag, with the format: #

Garden will import the repository source code into this module, but read the module's config from the local garden.yml file.

Example:

repositoryUrl: "git+https://github.com/org/repo.git#v2.0"

allowPublish

When false, disables pushing this module to remote registries.

build

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

build.dependencies[]

​build > dependencies

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

Example:

build:
  ...
  dependencies:
    - name: some-other-module-name

build.dependencies[].name

​build > dependencies > name

Module name to build ahead of this module.

build.dependencies[].copy[]

​build > dependencies > copy

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

build.dependencies[].copy[].source

​build > dependencies > copy > source

POSIX-style path or filename of the directory or file(s) to copy to the target.

build.dependencies[].copy[].target

​build > dependencies > copy > target

POSIX-style path or filename to copy the directory or file(s).

Module YAML schema

apiVersion: garden.io/v0
kind: Module
type:
name:
description:
include:
exclude:
repositoryUrl:
allowPublish: true
build:
  dependencies:
    - name:
      copy:
        - source:
          target: <same as source path>