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 contains the config YAML schema
Configuration keys describes each individual schema key for the configuration files.
Also check out the templated
module type reference.
YAML Schema
The values in the schema below are the default values.
Configuration Keys
apiVersion
apiVersion
The schema version of this config (currently not used).
kind
kind
name
name
The name of the template.
inputsSchemaPath
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.
modules[]
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).
modules[].apiVersion
modules[].apiVersion
modules > apiVersion
The schema version of this config (currently not used).
modules[].kind
modules[].kind
modules > kind
modules[].type
modules[].type
modules > type
The type of this module.
Example:
modules[].name
modules[].name
modules > name
The name of this module.
Example:
modules[].build
modules[].build
modules > build
Specify how to build the module. Note that plugins may define additional keys on this object.
modules[].build.dependencies[]
modules[].build.dependencies[]
modules > build > dependencies
A list of modules that must be built before this module is built.
Example:
modules[].build.dependencies[].name
modules[].build.dependencies[].name
modules > build > dependencies > name
Module name to build ahead of this module.
modules[].build.dependencies[].copy[]
modules[].build.dependencies[].copy[]
modules > build > dependencies > copy
Specify one or more files or directories to copy from the built dependency to this module.
modules[].build.dependencies[].copy[].source
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.
modules[].build.dependencies[].copy[].target
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 the same as source path.
modules[].build.timeout
modules[].build.timeout
Maximum time in seconds to wait for build to finish.
modules[].description
modules[].description
modules > description
A description of the module.
modules[].disabled
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.
modules[].include[]
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.
Example:
modules[].exclude[]
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.
Example:
modules[].repositoryUrl
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.
Example:
modules[].allowPublish
modules[].allowPublish
modules > allowPublish
When false, disables pushing this module to remote registries.
modules[].generateFiles[]
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.
modules[].generateFiles[].sourcePath
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.
modules[].generateFiles[].targetPath
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.
modules[].generateFiles[].resolveTemplates
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.
modules[].generateFiles[].value
modules[].generateFiles[].value
modules > generateFiles > value
The desired file contents as a string.
modules[].variables
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.
modules[].varfile
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).
Example:
modules[].path
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.
Last updated