pulumi Deploy
Last updated
Last updated
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 action. For others, simply run the Pulumi CLI as usual from the project root.
Stack outputs are made available as action outputs. These can then be referenced by other actions under ${actions.<action-kind>.<action-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 the action. For an introduction to configuring Garden, please look at our .
pulumi
actions also export values that are available in template strings. See the section below for details.
type
The type of action, e.g. exec
, container
or kubernetes
. Some are built into Garden but mostly these will be defined by your configured providers.
Type | Required |
---|
name
A valid name for the action. Must be unique across all actions of the same kind in your project.
Type | Required |
---|
description
A description of the action.
source
By default, the directory where the action is defined is used as the source for the build context.
You can override this by setting either source.path
to another (POSIX-style) path relative to the action source directory, or source.repository
to get the source from an external repository.
If using source.path
, you must make sure the target path is in a git repository.
source.path
A relative POSIX-style path to the source directory for this action. You must make sure this path exists and is in a git repository!
source.repository
When set, Garden will import the action source from this repository, but use this action configuration (and not scan for configs in the separate repository).
source.repository.url
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>
Example:
dependencies[]
A list of other actions that this action depends on, and should be built, deployed or run (depending on the action type) before processing this action.
Each dependency should generally be expressed as a "<kind>.<name>"
string, where is one of build
, deploy
, run
or test
, and is the name of the action to depend on.
You may also optionally specify a dependency as an object, e.g. { kind: "Build", name: "some-image" }
.
Any empty values (i.e. null or empty strings) are ignored, so that you can conditionally add in a dependency via template expressions.
Example:
disabled
Set this to true
to disable the action. You can use this with conditional template strings to disable actions 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 actions for specific environments, e.g. only for development.
For Build actions, this means the build is not performed unless it is declared as a dependency by another enabled action (in which case the Build is assumed to be necessary for the dependant action to be run or built).
For other action kinds, the action is skipped in all scenarios, and dependency declarations to it are ignored. Note however that template strings referencing outputs (i.e. runtime outputs) will fail to resolve when the action is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.
environments[]
If set, the action is only enabled for the listed environment types. This is effectively a cleaner shorthand for the disabled
field with an expression for environments. For example, environments: ["prod"]
is equivalent to disabled: ${environment.name != "prod"}
.
include[]
Specify a list of POSIX-style paths or globs that should be regarded as source files for this action, and thus will affect the computed version of the action.
For actions other than Build actions, this is usually not necessary to specify, or is implicitly inferred. An exception would be e.g. an exec
action without a build
reference, where the relevant files cannot be inferred and you want to define which files should affect the version of the action, e.g. to make sure a Test action is run when certain files are modified.
Build actions have a different behavior, since they generally are based on some files in the source tree, so please reference the docs for more information on those.
Example:
exclude[]
Specify a list of POSIX-style paths or glob patterns that should be explicitly excluded from the action's version.
Unlike the scan.exclude
field in the project config, the filters here have no effect on which files and directories are watched for changes when watching is enabled. Use the project scan.exclude
field to affect those, if you have large directories that should not be watched for changes.
Example:
variables
A map of variables scoped to this particular action. These are resolved before any other parts of the action configuration and take precedence over group-scoped variables (if applicable) and project-scoped variables, in that order. They may reference group-scoped and project-scoped variables, and generally can use any template strings normally allowed when resolving the action.
varfiles[]
Specify a list of paths (relative to the directory where the action is defined) to a file containing variables, that we apply on top of the action-level variables
field, and take precedence over group-level variables (if applicable) and project-level variables, in that order.
If you specify multiple paths, they are merged in the order specified, i.e. the last one takes precedence over the previous ones.
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. YAML format is used by default.
.json
- JSON. Must contain a single JSON object (not an array).
NOTE: The default varfile format was changed to YAML in Garden v0.13, since YAML allows for definition of nested objects and arrays.
To use different varfiles in different environments, you can template in the environment name to the varfile name, e.g. varfile: "my-action.${environment.name}.env"
(this assumes that the corresponding varfiles exist).
If a listed varfile cannot be found, throwing an error. To add optional varfiles, you can use a list item object with a path
and an optional optional
boolean field.
Example:
varfiles[].path
Path to a file containing a path.
varfiles[].optional
Whether the varfile is optional.
build
Specify a Build action, and resolve this action from the context of that Build.
For example, you might create an exec
Build which prepares some manifests, and then reference that in a kubernetes
Deploy action, and the resulting manifests from the Build.
This would mean that instead of looking for manifest files relative to this action's location in your project structure, the output directory for the referenced exec
Build would be the source.
kind
timeout
Timeout for the deploy to complete, in seconds.
spec
spec.allowDestroy
If set to true, Garden will destroy the stack when calling garden cleanup namespace
or garden cleanup deploy <deploy action name>
. This is useful to prevent unintentional destroys in production or shared environments.
spec.autoApply
If set to false, deployments will fail unless a planPath
is provided for this deploy action. This is useful when deploying to production or shared environments, or when the action deploys infrastructure that you don't want to unintentionally update/create.
spec.createStack
If set to true, Garden will automatically create the stack if it doesn't already exist.
spec.root
Specify the path to the Pulumi project root, relative to the deploy action's root.
spec.pulumiVariables
A map of config variables to use when applying the stack. These are merged with the contents of any pulumiVarfiles
provided for this deploy action. The deploy action's stack config will be overwritten with the resulting merged config. Variables declared here override any conflicting config variables defined in this deploy action's pulumiVarfiles
.
Note: pulumiVariables
should not include action outputs from other pulumi deploy actions when cacheStatus
is set to true, since the outputs may change from the time the stack status of the dependency action is initially queried to when it's been deployed.
Instead, use pulumi stack references when using the cacheStatus
config option.
spec.pulumiVarfiles[]
Specify one or more paths (relative to the deploy action's 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.
spec.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.
spec.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 deploy action configuration.
When using stack references to other pulumi deploy actions in your project, we recommend including them in this deploy action's stackReferences
config field (see the documentation for that field on this page).
cacheStatus: true
is not supported for self-managed state backends.
spec.stackReferences[]
When setting cacheStatus
to true for this deploy action, you should include all stack references used by this deploy action'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:
spec.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 deploy action.
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).
spec.stack
The name of the pulumi stack to use. Defaults to the current environment name.
spec.showSecretsInOutput
When set to true, stack outputs which are marked as secrets will be shown in the output.
By default, Pulumi will print secret stack outputs as the string '[secret]' instead of the true content of the output.
The following keys are available via the ${actions.deploy.<name>}
template string key for pulumi
action.
${actions.deploy.<name>.name}
The name of the action.
${actions.deploy.<name>.disabled}
Whether the action is disabled.
Example:
${actions.deploy.<name>.buildPath}
The local path to the action build directory.
Example:
${actions.deploy.<name>.sourcePath}
The local path to the action source directory.
Example:
${actions.deploy.<name>.mode}
The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.
Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.
Example:
${actions.deploy.<name>.var.*}
The variables configured on the action.
${actions.deploy.<name>.var.<name>}
${actions.deploy.<name>.outputs.*}
A map of all the outputs returned by the Pulumi stack.
${actions.deploy.<name>.outputs.<name>}
Type | Required |
---|
For source.repository
behavior, please refer to the .
Type | Required |
---|
> path
Type | Required |
---|
> repository
Type | Required |
---|
> > url
Type | Required |
---|
Type | Default | Required |
---|
Type | Default | Required |
---|
Type | Required |
---|
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 for details.
Type | Required |
---|
For actions other than Build actions, this is usually not necessary to specify, or is implicitly inferred. For Deploy, Run and Test actions, the exclusions specified here only applied on top of explicitly set include
paths, or such paths inferred by providers. See the for details.
Type | Required |
---|
Type | Required |
---|
.env
- Standard "dotenv" format, as defined by .
Type | Default | Required |
---|
> path
Type | Required |
---|
> optional
Type | Required |
---|
Type | Required |
---|
Type | Allowed Values | Required |
---|
Type | Default | Required |
---|
Type | Required |
---|
> allowDestroy
Type | Default | Required |
---|
> autoApply
Type | Default | Required |
---|
> createStack
Type | Default | Required |
---|
> root
Type | Default | Required |
---|
> pulumiVariables
Type | Default | Required |
---|
> pulumiVarfiles
Type | Default | Required |
---|
> orgName
Type | Required |
---|
> cacheStatus
Type | Default | Required |
---|
> stackReferences
Type | Default | Required |
---|
> deployFromPreview
Type | Default | Required |
---|
> stack
Type | Required |
---|
> showSecretsInOutput
Type | Default | Required |
---|
Type |
---|
Type |
---|
Type |
---|
Type |
---|
Type | Default |
---|
Type | Default |
---|
Type |
---|
Type | Default |
---|
Type |
---|