terraform

Description

This provider allows you to integrate Terraform stacks into your Garden project. See the Terraform guide for details and usage information.
Below is the full schema reference for the provider configuration. For an introduction to configuring a Garden project with providers, please look at our configuration guide.
The reference is divided into two sections. The first section contains the complete YAML schema, and the second section describes each schema key.

Complete YAML Schema

The values in the schema below are the default values.
1
providers:
2
- # The name of the provider plugin to use.
3
name:
4
​
5
# List other providers that should be resolved before this one.
6
dependencies: []
7
​
8
# If specified, this provider will only be used in the listed environments. Note that an empty array effectively
9
# disables the provider. To use a provider in all environments, omit this field.
10
environments:
11
​
12
# If set to true, Garden will run `terraform destroy` on the project root stack when calling `garden delete env`.
13
allowDestroy: false
14
​
15
# If set to true, Garden will automatically run `terraform apply -auto-approve` when a stack is not up-to-date.
16
# Otherwise, a warning is logged if the stack is out-of-date, and an error thrown if it is missing entirely.
17
#
18
# **Note: This is not recommended for production, or shared environments in general!**
19
autoApply: false
20
​
21
# Specify the path to a Terraform config directory, that should be resolved when initializing the provider. This
22
# is useful when other providers need to be able to reference the outputs from the stack.
23
#
24
# See the [Terraform guide](https://docs.garden.io/advanced/terraform) for more information.
25
initRoot:
26
​
27
# A map of variables to use when applying Terraform stacks. You can define these here, in individual
28
# `terraform` module configs, or you can place a `terraform.tfvars` file in each working directory.
29
variables:
30
​
31
# The version of Terraform to use. Set to `null` to use whichever version of `terraform` that is on your PATH.
32
version: 0.13.3
33
​
34
# Use the specified Terraform workspace.
35
workspace:
Copied!

Configuration Keys

providers[]

Type
Default
Required
array[object]
[]
No

providers[].name

​providers > name
The name of the provider plugin to use.
Type
Required
string
Yes
Example:
1
providers:
2
- name: "local-kubernetes"
Copied!

providers[].dependencies[]

​providers > dependencies
List other providers that should be resolved before this one.
Type
Default
Required
array[string]
[]
No
Example:
1
providers:
2
- dependencies:
3
- exec
Copied!

providers[].environments[]

​providers > environments
If specified, this provider will only be used in the listed environments. Note that an empty array effectively disables the provider. To use a provider in all environments, omit this field.
Type
Required
array[string]
No
Example:
1
providers:
2
- environments:
3
- dev
4
- stage
Copied!

providers[].allowDestroy

​providers > allowDestroy
If set to true, Garden will run terraform destroy on the project root stack when calling garden delete env.
Type
Default
Required
boolean
false
No

providers[].autoApply

​providers > autoApply
If set to true, Garden will automatically run terraform apply -auto-approve when a 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!
Type
Default
Required
boolean
false
No

providers[].initRoot

​providers > initRoot
Specify the path to a Terraform config directory, that should be resolved when initializing the provider. This is useful when other providers need to be able to reference the outputs from the stack.
See the Terraform guide for more information.
Type
Required
posixPath
No

providers[].variables

​providers > variables
A map of variables to use when applying Terraform stacks. You can define these here, in individual terraform module configs, or you can place a terraform.tfvars file in each working directory.
Type
Required
object
No

providers[].version

​providers > version
The version of Terraform to use. Set to null to use whichever version of terraform that is on your PATH.
Type
Default
Required
string
"0.13.3"
No

providers[].workspace

​providers > workspace
Use the specified Terraform workspace.
Type
Required
string
No