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.

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.

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

# The schema version of this config (currently not used).
apiVersion: garden.io/v0

kind: Module

# The type of this module.
type:

# The name of this module.
name:

# Specify how to build the module. Note that plugins may define additional keys on this object.
build:
  # A list of modules that must be built before this module is built.
  dependencies:
    - # Module name to build ahead of this module.
      name:

      # Specify one or more files or directories to copy from the built dependency to this module.
      copy:
        - # POSIX-style path or filename of the directory or file(s) to copy to the target.
          source:

          # POSIX-style path or filename to copy the directory or file(s), relative to the build directory.
          # Defaults to the same as source path.
          target:

  # Maximum time in seconds to wait for build to finish.
  timeout: 1200

# A description of the module.
description:

# 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.
disabled: false

# 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](https://docs.garden.io/v/acorn-0.12/using-garden/configuration-overview#including-excluding-files-and-directories)
# for details.
#
# Also note that specifying an empty list here means _no sources_ should be included.
include:

# 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](https://docs.garden.io/v/acorn-0.12/using-garden/configuration-overview#including-excluding-files-and-directories)
# 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.
exclude:

# 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>
#
# Garden will import the repository source code into this module, but read the module's config from the local
# garden.yml file.
repositoryUrl:

# When false, disables pushing this module to remote registries.
allowPublish: true

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

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

    # 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.
    resolveTemplates: true

    # The desired file contents as a string.
    value:

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

# 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](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._
#
# 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).
varfile:

# 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.
allowDestroy: true

# 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.
autoApply: true

# If set to true, Garden will automatically create the stack if it doesn't already exist.
createStack: false

# 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.
dependencies: []

# Specify the path to the Pulumi project root, relative to the module root.
root: .

# 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.
pulumiVariables: {}

# 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.
pulumiVarfiles: []

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

# 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.
cacheStatus: false

# 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.
stackReferences: []

# 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).
deployFromPreview: false

# The name of the pulumi stack to use. Defaults to the current environment name.
stack:

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	"Module"	"Module"	Yes

type

The type of this module.

Type	Required
string	Yes

Example:

type: "container"

name

The name of this module.

Type	Required
string	Yes

Example:

name: "my-sweet-module"

build

Specify how to build the module. Note that plugins may define additional keys on this object.

Type	Default	Required
object	{"dependencies":[]}	No

build.dependencies[]

build > dependencies

A list of modules that must be built before this module is built.

Type	Default	Required
array[object]	[]	No

Example:

build:
  ...
  dependencies:
    - name: some-other-module-name

build.dependencies[].name

build > dependencies > name

Module name to build ahead of this module.

Type	Required
string	Yes

build.dependencies[].copy[]

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

build.dependencies[].copy[].source

build > dependencies > copy > source

POSIX-style path or filename of the directory or file(s) to copy to the target.

Type	Required
posixPath	Yes

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.

Type	Required
posixPath	No

build.timeout

build > timeout

Maximum time in seconds to wait for build to finish.

Type	Default	Required
number	1200	No

description

A description of the module.

Type	Required
string	No

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

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:

include:
  - Dockerfile
  - my-app.js

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:

exclude:
  - tmp/**/*
  - '*.log'

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	No

Example:

repositoryUrl: "git+https://github.com/org/repo.git#v2.0"

allowPublish

When false, disables pushing this module to remote registries.

Type	Default	Required
boolean	true	No

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

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.

Type	Required
posixPath	No

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.

Type	Required
posixPath	Yes

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.

Type	Default	Required
boolean	true	No

generateFiles[].value

generateFiles > value

The desired file contents as a string.

Type	Required
string	No

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

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:

varfile: "my-module.env"

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.

Type	Default	Required
boolean	true	No

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.

Type	Default	Required
boolean	true	No

createStack

If set to true, Garden will automatically create the stack if it doesn't already exist.

Type	Default	Required
boolean	false	No

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.

Type	Default	Required
array[string]	[]	No

root

Specify the path to the Pulumi project root, relative to the module root.

Type	Default	Required
posixPath	"."	No

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.

Type	Default	Required
object	{}	No

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.

Type	Default	Required
array[posixPath]	[]	No

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.

Type	Required
string	No

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.

Type	Default	Required
boolean	false	No

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.

Type	Default	Required
array[string]	[]	No

Example:

stackReferences:
  - '${runtime.services.some-pulumi-module.outputs.ip-address}'
  - '${runtime.services.some-other-pulumi-module.outputs.database-url}'

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

Type	Default	Required
boolean	false	No

stack

The name of the pulumi stack to use. Defaults to the current environment name.

Type	Required
string	No

Outputs

Module Outputs

The following keys are available via the ${modules.<module-name>} template string key for pulumi modules.

${modules.<module-name>.buildPath}

The build path of the module.

Type
string

Example:

my-variable: ${modules.my-module.buildPath}

${modules.<module-name>.name}

The name of the module.

Type
string

${modules.<module-name>.path}

The local path of the module.

Type
string

Example:

my-variable: ${modules.my-module.path}

${modules.<module-name>.var.*}

A map of all variables defined in the module.

Type	Default
object	{}

${modules.<module-name>.var.<variable-name>}

Type
string | number | boolean | link | array[link]

${modules.<module-name>.version}

The current version of the module.

Type
string

Example:

my-variable: ${modules.my-module.version}

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}

The current version of the service.

Type
string

Example:

my-variable: ${runtime.services.my-service.version}

${runtime.services.<service-name>.outputs.*}

A map of all the outputs returned by the Pulumi stack.

Type	Default
object	{}

${runtime.services.<service-name>.outputs.<name>}

Type
string | number | boolean | link | array[link]

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}

The current version of the task.

Type
string

Example:

my-variable: ${runtime.tasks.my-tasks.version}