Search…
Module Template Configuration
Below is the schema reference for ModuleTemplate configuration files. To learn more about module templates, see the Module Templates guide.
The reference is divided into two sections:

YAML Schema

The values in the schema below are the default values.
1
# The schema version of this config (currently not used).
2
apiVersion: garden.io/v0
3
​
4
kind: ModuleTemplate
5
​
6
# The name of the template.
7
name:
8
​
9
# Path to a JSON schema file describing the expected inputs for the template. Must be an object schema. If none is
10
# provided, no inputs will be accepted and an error thrown if attempting to do so.
11
inputsSchemaPath:
12
​
13
# A list of modules this template will output. The schema for each is the same as when you create modules normally in
14
# configuration files, with the addition of a `path` field, which allows you to specify a sub-directory to set as the
15
# module root.
16
#
17
# In addition to any template strings you can normally use for modules (see [the
18
# reference](./template-strings/modules.md)), you can reference the inputs described by the inputs schema for the
19
# template, using ${inputs.*} template strings, as well as ${parent.name} and ${template.name}, to reference the name
20
# of the module using the template, and the name of the template itself, respectively. This also applies to file
21
# contents specified under the `files` key.
22
#
23
# **Important: Make sure you use templates for any identifiers that must be unique, such as module names, service
24
# names and task names. Otherwise you'll inevitably run into configuration errors. The module names can reference the
25
# ${inputs.*}, ${parent.name} and ${template.name} keys. Other identifiers can also reference those, plus any other
26
# keys available for module templates (see [the module context reference](./template-strings/modules.md)).**
27
modules:
28
- # The schema version of this config (currently not used).
29
apiVersion: garden.io/v0
30
​
31
kind: Module
32
​
33
# The type of this module.
34
type:
35
​
36
# The name of this module.
37
name:
38
​
39
# Specify how to build the module. Note that plugins may define additional keys on this object.
40
build:
41
# A list of modules that must be built before this module is built.
42
dependencies:
43
- # Module name to build ahead of this module.
44
name:
45
​
46
# Specify one or more files or directories to copy from the built dependency to this module.
47
copy:
48
- # POSIX-style path or filename of the directory or file(s) to copy to the target.
49
source:
50
​
51
# POSIX-style path or filename to copy the directory or file(s), relative to the build directory.
52
# Defaults to to same as source path.
53
target: ''
54
​
55
# Maximum time in seconds to wait for build to finish.
56
timeout: 1200
57
​
58
# A description of the module.
59
description:
60
​
61
# Set this to `true` to disable the module. You can use this with conditional template strings to disable modules
62
# based on, for example, the current environment or other variables (e.g. `disabled: \${environment.name ==
63
# "prod"}`). This can be handy when you only need certain modules for specific environments, e.g. only for
64
# development.
65
#
66
# Disabling a module means that any services, tasks and tests contained in it will not be deployed or run. It also
67
# means that the module is not built _unless_ it is declared as a build dependency by another enabled module (in
68
# which case building this module is necessary for the dependant to be built).
69
#
70
# If you disable the module, and its services, tasks or tests are referenced as _runtime_ dependencies, Garden
71
# will automatically ignore those dependency declarations. Note however that template strings referencing the
72
# module's service or task outputs (i.e. runtime outputs) will fail to resolve when the module is disabled, so you
73
# need to make sure to provide alternate values for those if you're using them, using conditional expressions.
74
disabled: false
75
​
76
# Specify a list of POSIX-style paths or globs that should be regarded as the source files for this module. Files
77
# that do *not* match these paths or globs are excluded when computing the version of the module, when responding
78
# to filesystem watch events, and when staging builds.
79
#
80
# Note that you can also _exclude_ files using the `exclude` field or by placing `.gardenignore` files in your
81
# source tree, which use the same format as `.gitignore` files. See the [Configuration Files
82
# guide](https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories) for
83
# details.
84
#
85
# Also note that specifying an empty list here means _no sources_ should be included.
86
include:
87
​
88
# Specify a list of POSIX-style paths or glob patterns that should be excluded from the module. Files that match
89
# these paths or globs are excluded when computing the version of the module, when responding to filesystem watch
90
# events, and when staging builds.
91
#
92
# Note that you can also explicitly _include_ files using the `include` field. If you also specify the `include`
93
# field, the files/patterns specified here are filtered from the files matched by `include`. See the
94
# [Configuration Files
95
# guide](https://docs.garden.io/using-garden/configuration-overview#including-excluding-files-and-directories) for
96
# details.
97
#
98
# Unlike the `modules.exclude` field in the project config, the filters here have _no effect_ on which files and
99
# directories are watched for changes. Use the project `modules.exclude` field to affect those, if you have large
100
# directories that should not be watched for changes.
101
exclude:
102
​
103
# A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific
104
# branch or tag, with the format: <git remote url>#<branch|tag>
105
#
106
# Garden will import the repository source code into this module, but read the module's config from the local
107
# garden.yml file.
108
repositoryUrl:
109
​
110
# When false, disables pushing this module to remote registries.
111
allowPublish: true
112
​
113
# A list of files to write to the module directory when resolving this module. This is useful to automatically
114
# generate (and template) any supporting files needed for the module.
115
generateFiles:
116
- # POSIX-style filename to read the source file contents from, relative to the path of the module (or the
117
# ModuleTemplate configuration file if one is being applied).
118
# This file may contain template strings, much like any other field in the configuration.
119
sourcePath:
120
​
121
# POSIX-style filename to write the resolved file contents to, relative to the path of the module source
122
# directory (for remote modules this means the root of the module repository, otherwise the directory of the
123
# module configuration).
124
#
125
# Note that any existing file with the same name will be overwritten. If the path contains one or more
126
# directories, they will be automatically created if missing.
127
targetPath:
128
​
129
# By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to
130
# skip resolving template strings. Note that this does not apply when setting the `value` field, since that's
131
# resolved earlier when parsing the configuration.
132
resolveTemplates: true
133
​
134
# The desired file contents as a string.
135
value:
136
​
137
# A map of variables scoped to this particular module. These are resolved before any other parts of the module
138
# configuration and take precedence over project-scoped variables. They may reference project-scoped variables,
139
# and generally use any template strings normally allowed when resolving modules.
140
variables:
141
​
142
# Specify a path (relative to the module root) to a file containing variables, that we apply on top of the
143
# module-level `variables` field.
144
#
145
# The format of the files is determined by the configured file's extension:
146
#
147
# * `.env` - Standard "dotenv" format, as defined by [dotenv](https://github.com/motdotla/dotenv#rules).
148
# * `.yaml`/`.yml` - YAML. The file must consist of a YAML document, which must be a map (dictionary). Keys may
149
# contain any value type.
150
# * `.json` - JSON. Must contain a single JSON _object_ (not an array).
151
#
152
# _NOTE: The default varfile format will change to YAML in Garden v0.13, since YAML allows for definition of
153
# nested objects and arrays._
154
#
155
# To use different module-level varfiles in different environments, you can template in the environment name
156
# to the varfile name, e.g. `varfile: "my-module.\$\{environment.name\}.env` (this assumes that the corresponding
157
# varfiles exist).
158
varfile:
159
​
160
# POSIX-style path of a sub-directory to set as the module root. If the directory does not exist, it is
161
# automatically created.
162
path:
Copied!

Configuration Keys

apiVersion

The schema version of this config (currently not used).
Type
Allowed Values
Default
Required
string
"garden.io/v0"
"garden.io/v0"
Yes

kind

Type
Allowed Values
Default
Required
string
"ModuleTemplate"
"ModuleTemplate"
Yes

name

The name of the template.
Type
Required
string
No

inputsSchemaPath

Path to a JSON schema file describing the expected inputs for the template. Must be an object schema. If none is provided, no inputs will be accepted and an error thrown if attempting to do so.
Type
Required
posixPath
No

modules[]

A list of modules this template will output. The schema for each is the same as when you create modules normally in configuration files, with the addition of a path field, which allows you to specify a sub-directory to set as the module root.
In addition to any template strings you can normally use for modules (see the reference), you can reference the inputs described by the inputs schema for the template, using ${inputs.*} template strings, as well as ${parent.name} and ${template.name}, to reference the name of the module using the template, and the name of the template itself, respectively. This also applies to file contents specified under the files key.
Important: Make sure you use templates for any identifiers that must be unique, such as module names, service names and task names. Otherwise you'll inevitably run into configuration errors. The module names can reference the ${inputs.*}, ${parent.name} and ${template.name} keys. Other identifiers can also reference those, plus any other keys available for module templates (see the module context reference).
Type
Required
array[object]
No

modules[].apiVersion

​modules > apiVersion
The schema version of this config (currently not used).
Type
Allowed Values
Default
Required
string
"garden.io/v0"
"garden.io/v0"
Yes

modules[].kind

​modules > kind
Type
Allowed Values
Default
Required
string
"Module"
"Module"
Yes

modules[].type

​modules > type
The type of this module.
Type
Required
string
Yes
Example:
1
modules:
2
- type: "container"
Copied!

modules[].name

​modules > name
The name of this module.
Type
Required
string
Yes
Example:
1
modules:
2
- name: "my-sweet-module"
Copied!

modules[].build

​modules > build
Specify how to build the module. Note that plugins may define additional keys on this object.
Type
Default
Required
object
{"dependencies":[]}
No

modules[].build.dependencies[]

​modules > build > dependencies
A list of modules that must be built before this module is built.
Type
Default
Required
array[object]
[]
No
Example:
1
modules:
2
- build:
3
...
4
dependencies:
5
- name: some-other-module-name
Copied!

modules[].build.dependencies[].name

​modules > build > dependencies > name
Module name to build ahead of this module.
Type
Required
string
Yes

modules[].build.dependencies[].copy[]

​modules > 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

modules[].build.dependencies[].copy[].source

​modules > build > dependencies > copy > source
POSIX-style path or filename of the directory or file(s) to copy to the target.
Type
Required
posixPath
Yes

modules[].build.dependencies[].copy[].target

​modules > build > dependencies > copy > target
POSIX-style path or filename to copy the directory or file(s), relative to the build directory. Defaults to to same as source path.
Type
Default
Required
posixPath
""
No

modules[].build.timeout

​modules > build > timeout
Maximum time in seconds to wait for build to finish.
Type
Default
Required
number
1200
No

modules[].description

​modules > description
A description of the module.
Type
Required
string
No

modules[].disabled

​modules > 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.
Type
Default
Required
boolean
false
No

modules[].include[]

​modules > 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.
Type
Required
array[posixPath]
No
Example:
1
modules:
2
- include:
3
- Dockerfile
4
- my-app.js
Copied!

modules[].exclude[]

​modules > 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.
Type
Required
array[posixPath]
No
Example:
1
modules:
2
- exclude:
3
- tmp/**/*
4
- '*.log'
Copied!

modules[].repositoryUrl

​modules > 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`
Example:
1
modules:
2
- repositoryUrl: "git+https://github.com/org/repo.git#v2.0"
Copied!

modules[].allowPublish

​modules > allowPublish
When false, disables pushing this module to remote registries.
Type
Default
Required
boolean
true
No

modules[].generateFiles[]

​modules > 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

modules[].generateFiles[].sourcePath

​modules > generateFiles > sourcePath
POSIX-style filename to read the source file contents from, relative to the path of the module (or the ModuleTemplate configuration file if one is being applied). This file may contain template strings, much like any other field in the configuration.
Type
Required
posixPath
No

modules[].generateFiles[].targetPath

​modules > 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

modules[].generateFiles[].resolveTemplates

​modules > 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

modules[].generateFiles[].value

​modules > generateFiles > value
The desired file contents as a string.
Type
Required
string
No

modules[].variables

​modules > 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

modules[].varfile

​modules > 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).
Type
Required
posixPath
No
Example:
1
modules:
2
- varfile: "my-module.env"
Copied!

modules[].path

​modules > path
POSIX-style path of a sub-directory to set as the module root. If the directory does not exist, it is automatically created.
Type
Required
posixPath
No