pulumi
Description
Deploys a Pulumi stack and either creates/updates it automatically (if autoApply: true
) or warns when the stack resources are not up-to-date, or errors if it's missing entirely.
Note: It is not recommended to set autoApply
to true
for production or shared environments, since this may result in accidental or conflicting changes to the stack. Instead, it is recommended to manually preview and update using the provided plugin commands. Run garden plugins pulumi
for details. Note that not all Pulumi CLI commands are wrapped by the plugin, only the ones where it's important to apply any variables defined in the module. For others, simply run the Pulumi CLI as usual from the project root.
Stack outputs are made available as service outputs. These can then be referenced by other modules under ${runtime.services.<module-name>.outputs.<key>}
. You can template in those values as e.g. command arguments or environment variables for other services.
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[]
A list of modules that must be built before this module is built.
Example:
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), relative to the build directory. Defaults to the same as source path.
build.timeout
build.timeout
Maximum time in seconds to wait for build to finish.
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.
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.
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
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
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
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
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:
.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:
allowDestroy
allowDestroy
If set to true, Garden will destroy the stack when calling garden delete env
or garden delete service <module name>
. This is useful to prevent unintentional destroys in production or shared environments.
autoApply
autoApply
If set to false, deployments will fail unless a planPath
is provided for this module. This is useful when deploying to production or shared environments, or when the module deploys infrastructure that you don't want to unintentionally update/create.
createStack
createStack
If set to true, Garden will automatically create the stack if it doesn't already exist.
dependencies[]
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.
root
root
Specify the path to the Pulumi project root, relative to the module root.
pulumiVariables
pulumiVariables
A map of config variables to use when applying the stack. These are merged with the contents of any pulumiVarfiles
provided for this module. The module's stack config will be overwritten with the resulting merged config. Variables declared here override any conflicting config variables defined in this module's pulumiVarfiles
.
Note: pulumiVariables
should not include runtime outputs from other pulumi modules when cacheStatus
is set to true, since the outputs may change from the time the stack status of the dependency module is initially queried to when it's been deployed.
Instead, use pulumi stack references when using the cacheStatus
config option.
pulumiVarfiles[]
pulumiVarfiles[]
Specify one or more paths (relative to the module root) to YAML files containing pulumi config variables.
Templated paths that resolve to null
, undefined
or an empty string are ignored.
Any Garden template strings in these varfiles will be resolved when the files are loaded.
Each file must consist of a single YAML document, which must be a map (dictionary). Keys may contain any value type.
If one or more varfiles is not found, no error is thrown (that varfile path is simply ignored).
Note: There is no need to nest the variables under a config
field as is done in a pulumi config. Simply specify all the config variables at the top level.
orgName
orgName
The name of the pulumi organization to use. Overrides the orgName
set on the pulumi provider (if any). To use the default org, set to null.
cacheStatus
cacheStatus
When set to true, the pulumi stack will be tagged with the Garden service version when deploying. The tag will then be used for service status checks for this service. If the version doesn't change between deploys, the subsequent deploy is skipped.
Note that this will not pick up changes to stack outputs referenced via stack references in your pulumi stack, unless they're referenced via template strings in the module configuration.
When using stack references to other pulumi modules in your project, we recommend including them in this module's stackReferences
config field (see the documentation for that field on this page).
cacheStatus: true
is not supported for self-managed state backends.
stackReferences[]
stackReferences[]
When setting cacheStatus
to true for this module, you should include all stack references used by this module's pulumi stack in this field.
This lets Garden know to redeploy the pulumi stack if the output values of one or more of these stack references have changed since the last deployment.
Example:
deployFromPreview
deployFromPreview
When set to true, will use pulumi plans generated by the garden plugins pulumi preview
command when deploying, and will fail if no plan exists locally for the module.
When this option is used, the pulumi plugin bypasses the status check altogether and passes the plan directly to pulumi up
(via the --plan
option, which is experimental as of March 2022). You should therefore take care to only use this config option when you're sure you want to apply the changes in the plan.
This option is intended for two-phase pulumi deployments, where pulumi preview diffs are first reviewed (e.g. during code review).
stack
stack
The name of the pulumi stack to use. Defaults to the current environment name.
Outputs
Module Outputs
The following keys are available via the ${modules.<module-name>}
template string key for pulumi
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 pulumi
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:
${runtime.services.<service-name>.outputs.*}
${runtime.services.<service-name>.outputs.*}
A map of all the outputs returned by the Pulumi stack.
${runtime.services.<service-name>.outputs.<name>}
${runtime.services.<service-name>.outputs.<name>}
Task Outputs
The following keys are available via the ${runtime.tasks.<task-name>}
template string key for pulumi
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:
Last updated