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.

providers:
- # The name of the provider plugin to use.
name:
โ€‹
# 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.
environments:
โ€‹
# 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!**
autoApply: false
โ€‹
# 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](https://docs.garden.io/advanced/terraform) for more information.
initRoot:
โ€‹
# 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.
variables:
โ€‹
# The version of Terraform to use.
version: 0.12.24

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:

providers:
- name: "local-kubernetes"

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:

providers:
- environments:
- dev
- stage

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.

Type

Default

Required

string

"0.12.24"

No