Project Configuration

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

The reference is divided into two sections:

  • YAML Schema contains the Project config YAML schema

  • Configuration keys describes each individual schema key for Project configuration files.

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

Please refer to those for more details on provider configuration.

YAML Schema

The values in the schema below are the default values.

# Indicate what kind of config this is.
kind: Project
# The name of the project.
name:
# A list of environments to configure for the project.
environments:
- # The name of the environment.
name:
# Set the default namespace to use. This can be templated to be user-specific, or to use an environment variable
# (e.g. in CI).
#
# You can also set this to `null`, in order to require an explicit namespace to be set on usage. This may be
# advisable for shared environments, but you may also be able to achieve the desired result by templating this
# field, as mentioned above.
defaultNamespace: default
# Flag the environment as a production environment.
#
# Setting this flag to `true` will activate the protection on the `deploy`, `test`, `task`, `build`,
# and `dev` commands. A protected command will ask for a user confirmation every time is run against
# an environment marked as production.
# Run the command with the "--yes" flag to skip the check (e.g. when running Garden in CI).
#
# This flag is also passed on to every provider, and may affect how certain providers behave.
# For more details please check the documentation for the providers in use.
production: false
# 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 format of the files is determined by the configured file's extension:
#
# * `.env` - Standard "dotenv" format, as defined by [dotenv](https://github.com/motdotla/dotenv#rules).
# * `.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._
#
# 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.
varfile:
# 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, but may also reference the top-level variables in template
# strings.
variables: {}
# 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:
- # The name of the provider plugin to use.
name:
# List other providers that should be resolved before this one.
dependencies: []
# 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.
environments:
# The default environment to use when calling commands without the `--env` parameter. May include a namespace name, in
# the format `<namespace>.<environment>`. Defaults to the first configured environment, with no namespace set.
defaultEnvironment: ''
# 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 `.gardenignore` files, found anywhere in the
# project, are ignored when scanning for modules and module sources (Note: prior to version 0.12.0, `.gitignore` files
# were also used by default).
# 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-overview#including-excluding-files-and-directories) for
# details.
dotIgnoreFiles:
- .gardenignore
# Control where to scan for modules in the project.
modules:
# 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](https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories) for
# details.
#
# Unlike the `exclude` field, the paths/globs specified here have _no effect_ on which files and directories Garden
# watches for changes. Use the `exclude` field to affect those, if you have large directories that should not be
# watched for changes.
#
# Also note that specifying an empty list here means _no paths_ should be included.
include:
# Specify a list of POSIX-style paths or glob patterns that should be excluded when scanning for modules.
#
# The filters here also affect which files and directories are watched for changes. So if you have a large number of
# directories in your project that should not be watched, you should specify them here.
#
# For example, you might want to exclude large vendor directories in your project from being scanned and watched, by
# setting `exclude: [node_modules/**/*, vendor/**/*]`.
#
# 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`.
#
# The `include` field does _not_ affect which files are watched.
#
# See the [Configuration Files
# guide](https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories) for
# details.
exclude:
# A list of output values that the project should export. These are exported by the `garden get outputs` command, as
# well as when referencing a project as a sub-project within another project.
#
# You may use any template strings to specify the values, including references to provider outputs, module
# outputs and runtime outputs. For a full reference, see the [Output configuration
# context](https://docs.garden.io/reference/template-strings#output-configuration-context) section in the Template
# String Reference.
#
# Note that if any runtime outputs are referenced, the referenced services and tasks will be deployed and run if
# necessary when resolving the outputs.
outputs:
- # The name of the output value.
name:
# The value for the output. Must be a primitive (string, number, boolean or null). May also be any valid template
# string.
value:
# A list of remote sources to import into project.
sources:
- # The name of the source to import
name:
# 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>
repositoryUrl:
# 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 format of the files is determined by the configured file's extension:
#
# * `.env` - Standard "dotenv" format, as defined by [dotenv](https://github.com/motdotla/dotenv#rules).
# * `.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._
#
# 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._
varfile: garden.env
# Key/value map of variables to configure for all environments. Keys may contain letters and numbers. Any values are
# permitted, including arrays and objects of any nesting.
variables: {}

Configuration Keys

kind

Indicate what kind of config this is.

Type

Allowed Values

Default

Required

string

"Project"

"Project"

Yes

name

The name of the project.

Type

Required

string

Yes

Example:

name: "my-sweet-project"

environments[]

A list of environments to configure for the project.

Type

Required

array[object]

No

environments[].name

environments > name

The name of the environment.

Type

Required

string

Yes

Example:

environments:
- name: "dev"

environments[].defaultNamespace

environments > defaultNamespace

Set the default namespace to use. This can be templated to be user-specific, or to use an environment variable (e.g. in CI).

You can also set this to null, in order to require an explicit namespace to be set on usage. This may be advisable for shared environments, but you may also be able to achieve the desired result by templating this field, as mentioned above.

Type

Default

Required

string

"default"

No

Example:

environments:
- defaultNamespace: "user-${local.username}"

environments[].production

environments > production

Flag the environment as a production environment.

Setting this flag to true will activate the protection on the deploy, test, task, build, and dev commands. A protected command will ask for a user confirmation every time is run against an environment marked as production. Run the command with the "--yes" flag to skip the check (e.g. when running Garden in CI).

This flag is also passed on to every provider, and may affect how certain providers behave. For more details please check the documentation for the providers in use.

Type

Default

Required

boolean

false

No

Example:

environments:
- production: true

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.

Type

Default

Required

array[object]

[]

No

environments[].providers[].name

environments > providers > name

The name of the provider plugin to use.

Type

Required

string

Yes

Example:

environments:

environments[].providers[].dependencies[]

environments > providers > dependencies

List other providers that should be resolved before this one.

Type

Default

Required

array[string]

[]

No

Example:

environments:

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.

Type

Required

array[string]

No

Example:

environments:

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

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.

Type

Required

posixPath

No

Example:

environments:
- varfile: "custom.env"

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, but may also reference the top-level variables in template strings.

Type

Default

Required

object

{}

No

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.

Type

Default

Required

array[object]

[]

No

providers[].name

providers > name

The name of the provider plugin to use.

Type

Required

string

Yes

Example:

providers:
- name: "local-kubernetes"

providers[].dependencies[]

providers > dependencies

List other providers that should be resolved before this one.

Type

Default

Required

array[string]

[]

No

Example:

providers:
- dependencies:
- exec

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.

Type

Required

array[string]

No

Example:

providers:
- environments:
- dev
- stage

defaultEnvironment

The default environment to use when calling commands without the --env parameter. May include a namespace name, in the format <namespace>.<environment>. Defaults to the first configured environment, with no namespace set.

Type

Default

Required

string

""

No

Example:

defaultEnvironment: "dev"

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 .gardenignore files, found anywhere in the project, are ignored when scanning for modules and module sources (Note: prior to version 0.12.0, .gitignore files were also used by default). 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 for details.

Type

Default

Required

array[posixPath]

[".gardenignore"]

No

Example:

dotIgnoreFiles:
- .gardenignore
- .gitignore

modules

Control where to scan for modules in the project.

Type

Required

object

No

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.

Unlike the exclude field, the paths/globs specified here have no effect on which files and directories Garden watches for changes. Use the exclude field to affect those, if you have large directories that should not be watched for changes.

Also note that specifying an empty list here means no paths should be included.

Type

Required

array[posixPath]

No

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.

The filters here also affect which files and directories are watched for changes. So if you have a large number of directories in your project that should not be watched, you should specify them here.

For example, you might want to exclude large vendor directories in your project from being scanned and watched, by setting exclude: [node_modules/**/*, vendor/**/*].

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.

The include field does not affect which files are watched.

See the Configuration Files guide for details.

Type

Required

array[posixPath]

No

Example:

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

outputs[]

A list of output values that the project should export. These are exported by the garden get outputs command, as well as when referencing a project as a sub-project within another project.

You may use any template strings to specify the values, including references to provider outputs, module outputs and runtime outputs. For a full reference, see the Output configuration context section in the Template String Reference.

Note that if any runtime outputs are referenced, the referenced services and tasks will be deployed and run if necessary when resolving the outputs.

Type

Default

Required

array[object]

[]

No

outputs[].name

outputs > name

The name of the output value.

Type

Required

string

Yes

Example:

outputs:
- name: "my-output-key"

outputs[].value

outputs > value

The value for the output. Must be a primitive (string, number, boolean or null). May also be any valid template string.

Type

Required

`number

string

boolean`

Yes

Example:

outputs:
- value: "${modules.my-module.outputs.some-output}"

sources[]

A list of remote sources to import into project.

Type

Default

Required

array[object]

[]

No

sources[].name

sources > name

The name of the source to import

Type

Required

string

Yes

Example:

sources:
- name: "my-external-repo"

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

Type

Required

`gitUrl

string`

Yes

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

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.

Type

Default

Required

posixPath

"garden.env"

No

Example:

varfile: "custom.env"

variables

Key/value map of variables to configure for all environments. Keys may contain letters and numbers. Any values are permitted, including arrays and objects of any nesting.

Type

Default

Required

object

{}

No