exec
Description
A simple module for executing commands in your shell. This can be a useful escape hatch if no other module type fits your needs, and you just need to execute something (as opposed to deploy it, track its status etc.).
By default, the exec
module type executes the commands in the Garden build directory (under .garden/build/). By setting local: true
, the commands are executed in the module source directory instead.
Note that Garden does not sync the source code for local exec modules into the Garden build directory. This means that include/exclude filters and ignore files are not applied to local exec modules, as the filtering is done during the sync.
Below is the full schema reference. For an introduction to configuring Garden modules, please look at our Configuration guide.
The first section contains the complete YAML schema, and the second section describes each schema key.
exec
modules also export values that are available in template strings. See the Outputs section below for details.
Complete 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
type
type
The type of this module.
Example:
name
name
The name of this module.
Example:
build
build
Specify how to build the module. Note that plugins may define additional keys on this object.
build.dependencies[]
build.dependencies[]
build > dependencies
A list of modules that must be built before this module is built.
Example:
build.dependencies[].name
build.dependencies[].name
build > dependencies > name
Module name to build ahead of this module.
build.dependencies[].copy[]
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
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
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.
build.timeout
build.timeout
build > timeout
Maximum time in seconds to wait for build to finish.
build.command[]
build.command[]
build > command
The command to run to perform the build.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level local
directive is set to true
, the command runs in the module source directory instead.
Example:
description
description
A description of the module.
disabled
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.
include[]
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:
exclude[]
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:
repositoryUrl
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:
allowPublish
allowPublish
When false, disables pushing this module to remote registries.
generateFiles[]
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.
generateFiles[].sourcePath
generateFiles[].sourcePath
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.
generateFiles[].targetPath
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.
generateFiles[].resolveTemplates
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.
generateFiles[].value
generateFiles[].value
generateFiles > value
The desired file contents as a string.
variables
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.
varfile
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:
local
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 exec modules. This means that include/exclude filters and ignore files are not applied to local exec modules.
env
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.
services[]
services[]
A list of services to deploy from this module.
services[].name
services[].name
services > name
Valid RFC1035/RFC1123 (DNS) label (may contain lowercase letters, numbers and dashes, must start with a letter, and cannot end with a dash), cannot contain consecutive dashes or start with garden
, or be longer than 63 characters.
services[].dependencies[]
services[].dependencies[]
services > 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.
services[].disabled
services[].disabled
services > disabled
Set this to true
to disable the service. You can use this with conditional template strings to enable/disable services based on, for example, the current environment or other variables (e.g. enabled: ${environment.name != "prod"}
). This can be handy when you only need certain services for specific environments, e.g. only for development.
Disabling a service means that it will not be deployed, 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 service's outputs (i.e. runtime outputs) will fail to resolve when the service is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.
services[].deployCommand[]
services[].deployCommand[]
services > deployCommand
The command to run to deploy the service.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level local
directive is set to true
, the command runs in the module source directory instead.
services[].statusCommand[]
services[].statusCommand[]
services > statusCommand
Optionally set a command to check the status of the service. If this is specified, it is run before the deployCommand
. If the command runs successfully and returns exit code of 0, the service is considered already deployed and the deployCommand
is not run.
If this is not specified, the service is always reported as "unknown", so it's highly recommended to specify this command if possible.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level local
directive is set to true
, the command runs in the module source directory instead.
services[].cleanupCommand[]
services[].cleanupCommand[]
services > cleanupCommand
Optionally set a command to clean the service up, e.g. when running garden delete env
.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level local
directive is set to true
, the command runs in the module source directory instead.
services[].timeout
services[].timeout
services > timeout
The maximum duration (in seconds) to wait for a local script to exit.
services[].env
services[].env
services > env
Environment variables to set when running the deploy and status commands.
services[].devMode
services[].devMode
services > devMode
services[].devMode.command[]
services[].devMode.command[]
The command to run to deploy the service in dev mode. When in dev mode, Garden assumes that the command starts a persistent process and does not wait for it return. The logs from the process can be retrieved via the garden logs
command as usual.
If a statusCommand
is set, Garden will wait until it returns a zero exit code before considering the service ready. Otherwise it considers the service immediately ready.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level local
directive is set to true
, the command runs in the module source directory instead.
services[].devMode.statusCommand[]
services[].devMode.statusCommand[]
services > devMode > statusCommand
Optionally set a command to check the status of the service in dev mode. Garden will run the status command at an interval until it returns a zero exit code or times out.
If no statusCommand
is set, Garden will consider the service ready as soon as it has started the process.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level local
directive is set to true
, the command runs in the module source directory instead.
services[].devMode.timeout
services[].devMode.timeout
The maximum duration (in seconds) to wait for a for the statusCommand
to return a zero exit code. Ignored if no statusCommand
is set.
tasks[]
tasks[]
A list of tasks that can be run in this module.
tasks[].name
tasks[].name
tasks > name
The name of the task.
tasks[].description
tasks[].description
tasks > description
A description of the task.
tasks[].dependencies[]
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.
tasks[].disabled
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.
tasks[].timeout
tasks[].timeout
tasks > timeout
Maximum duration (in seconds) of the task's execution.
tasks[].artifacts[]
tasks[].artifacts[]
tasks > artifacts
A list of artifacts to copy after the task run.
tasks[].artifacts[].source
tasks[].artifacts[].source
A POSIX-style path or glob to copy, relative to the build root.
tasks[].artifacts[].target
tasks[].artifacts[].target
A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at .garden/artifacts
.
tasks[].command[]
tasks[].command[]
tasks > command
The command to run.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level local
directive is set to true
, the command runs in the module source directory instead.
tasks[].env
tasks[].env
tasks > env
Environment variables to set when running the command.
tests[]
tests[]
A list of tests to run in the module.
tests[].name
tests[].name
tests > name
The name of the test.
tests[].dependencies[]
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.
tests[].disabled
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.
tests[].timeout
tests[].timeout
tests > timeout
Maximum duration (in seconds) of the test run.
tests[].command[]
tests[].command[]
tests > command
The command to run to test the module.
By default, the command is run inside the Garden build directory (under .garden/build/). If the top level local
directive is set to true
, the command runs in the module source directory instead.
tests[].env
tests[].env
tests > env
Environment variables to set when running the command.
tests[].artifacts[]
tests[].artifacts[]
tests > artifacts
A list of artifacts to copy after the test run.
tests[].artifacts[].source
tests[].artifacts[].source
A POSIX-style path or glob to copy, relative to the build root.
tests[].artifacts[].target
tests[].artifacts[].target
A POSIX-style path to copy the artifacts to, relative to the project artifacts directory at .garden/artifacts
.
Outputs
Module Outputs
The following keys are available via the ${modules.<module-name>}
template string key for exec
modules.
${modules.<module-name>.buildPath}
${modules.<module-name>.buildPath}
The build path of the module.
Example:
${modules.<module-name>.name}
${modules.<module-name>.name}
The name of the module.
${modules.<module-name>.path}
${modules.<module-name>.path}
The local path of the module.
Example:
${modules.<module-name>.var.*}
${modules.<module-name>.var.*}
A map of all variables defined in the module.
${modules.<module-name>.var.<variable-name>}
${modules.<module-name>.var.<variable-name>}
${modules.<module-name>.version}
${modules.<module-name>.version}
The current version of the module.
Example:
Service Outputs
The following keys are available via the ${runtime.services.<service-name>}
template string key for exec
module services. Note that these are only resolved when deploying/running dependants of the service, so they are not usable for every field.
${runtime.services.<service-name>.version}
${runtime.services.<service-name>.version}
The current version of the service.
Example:
Task Outputs
The following keys are available via the ${runtime.tasks.<task-name>}
template string key for exec
module tasks. Note that these are only resolved when deploying/running dependants of the task, so they are not usable for every field.
${runtime.tasks.<task-name>.version}
${runtime.tasks.<task-name>.version}
The current version of the task.
Example:
${runtime.tasks.<task-name>.outputs.log}
${runtime.tasks.<task-name>.outputs.log}
The full log from the executed task. (Pro-tip: Make it machine readable so it can be parsed by dependant tasks and services!)
Last updated