terraform Deploy

Description

Resolves a Terraform stack and either applies it automatically (if autoApply: true) or warns when the stack resources are not up-to-date.

Note: It is not recommended to set autoApply to true for any production or shared environments, since this may result in accidental or conflicting changes to the stack. Instead, it is recommended to manually plan and apply using the provided plugin commands. Run garden plugins terraform for details.

Stack outputs are made available as service outputs, that can be referenced by other actions under ${deploys.<deploy-name>.outputs.<key>}. You can template in those values as e.g. command arguments or environment variables for other services.

Note that you can also declare a Terraform root in the terraform provider configuration by setting the initRoot parameter. This may be preferable if you need the outputs of the Terraform stack to be available to other provider configurations, e.g. if you spin up an environment with the Terraform provider, and then use outputs from that to configure another provider or other actions via ${providers.terraform.outputs.<key>} template strings.

See the Terraform guide for a high-level introduction to the terraform provider.

Below is the full schema reference for the action.

terraform actions also export values that are available in template strings. See the Outputs section below for details.

Configuration Keys

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
string	Yes

name

A valid name for the action. Must be unique across all actions of the same kind in your project.

Type	Required
string	Yes

description

A description of the action.

Type	Required
string	No

source

By default, the directory where the action is defined is used as the source for the build context.

You can override the directory that is used for the build context by setting source.path.

You can use source.repository to get the source from an external repository. For more information on remote actions, please refer to the Remote Sources guide.

Type	Required
object	No

source.path

source > path

A relative POSIX-style path to the source directory for this action.

If specified together with source.repository, the path will be relative to the repository root.

Otherwise, the path will be relative to the directory containing the Garden configuration file.

Type	Required
posixPath	No

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

Type	Required
object	No

source.repository.url

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>

Type	Required
gitUrl | string	Yes

Example:

source:
  ...
  repository:
    ...
    url: "git+https://github.com/org/repo.git#v2.0"

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.

Type	Default	Required
array[actionReference]	[]	No

Example:

dependencies:
  - build.my-image
  - deploy.api

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.

Type	Default	Required
boolean	false	No

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"}.

Type	Required
array[string]	No

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.

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.

Type	Required
array[posixPath]	No

Example:

include:
  - my-app.js
  - some-assets/**/*

exclude[]

Specify a list of POSIX-style paths or glob patterns that should be explicitly excluded from the action's version.

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 Configuration Files guide for details.

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.

Type	Required
array[posixPath]	No

Example:

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

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.

Type	Required
object	No

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.

• .env - Standard "dotenv" format, as defined by dotenv.
• .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.

varfiles:
  - path: my-action.env
    optional: true

Type	Default	Required
array[alternatives]	[]	No

Example:

varfiles:
  "my-action.env"

varfiles[].path

varfiles > path

Path to a file containing a path.

Type	Required
posixPath	Yes

varfiles[].optional

varfiles > optional

Whether the varfile is optional.

Type	Required
boolean	No

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.

Type	Required
string	No

kind

Type	Allowed Values	Required
string	"Deploy"	Yes

timeout

Timeout for the deploy to complete, in seconds.

Type	Default	Required
number	300	No

spec

Type	Required
object	No

spec.allowDestroy

spec > allowDestroy

If set to true, Garden will run terraform destroy on the stack when calling garden delete namespace or garden delete deploy <deploy name>.

Type	Default	Required
boolean	false	No

spec.autoApply

spec > autoApply

If set to true, Garden will automatically run terraform apply -auto-approve when the stack is not up-to-date. Otherwise, a warning is logged if the stack is out-of-date, and an error thrown if it is missing entirely.

NOTE: This is not recommended for production, or shared environments in general!

Defaults to the value set in the provider config.

Type	Default	Required
boolean	null	No

spec.root

spec > root

Specify the path to the working directory root—i.e. where your Terraform files are—relative to the config directory.

Type	Default	Required
posixPath	"."	No

spec.variables

spec > variables

A map of variables to use when applying the stack. You can define these here or you can place aterraform.tfvars file in the working directory root.

If you specified variables in the terraform provider config, those will be included but the variables specified here take precedence.

Type	Required
object	No

spec.version

spec > version

The version of Terraform to use. Defaults to the version set in the provider config. Set to null to use whichever version of terraform that is on your PATH.

Type	Required
string	No

spec.workspace

spec > workspace

Use the specified Terraform workspace.

Type	Required
string	No

spec.backendConfig

spec > backendConfig

Configure the Terraform backend.

The key-value pairs defined here are set as the -backend-config options when Garden runs terraform init.

This can be used to dynamically set a Terraform backend depending on the environment.

If Garden sees that the backend has changes, it'll re-initialize Terraform and set the new values.

Type	Required
object	No

Example:

spec:
  ...
  backendConfig:
      bucket: ${environment.name}-bucket
      key: tf-state/${local.username}/terraform.tfstate

Outputs

The following keys are available via the ${actions.deploy.<name>} template string key for terraform action.

${actions.deploy.<name>.name}

The name of the action.

Type
string

${actions.deploy.<name>.disabled}

Whether the action is disabled.

Type
boolean

Example:

my-variable: ${actions.deploy.my-deploy.disabled}

${actions.deploy.<name>.buildPath}

The local path to the action build directory.

Type
string

Example:

my-variable: ${actions.deploy.my-deploy.buildPath}

${actions.deploy.<name>.sourcePath}

The local path to the action source directory.

Type
string

Example:

my-variable: ${actions.deploy.my-deploy.sourcePath}

${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.

Type	Default
string	"default"

Example:

my-variable: ${actions.deploy.my-deploy.mode}

${actions.deploy.<name>.var.*}

The variables configured on the action.

Type	Default
object	{}

${actions.deploy.<name>.var.<name>}

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

${actions.deploy.<name>.outputs.*}

A map of all the outputs defined in the Terraform stack.

Type	Default
object	{}

${actions.deploy.<name>.outputs.<name>}

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