LogoLogo
Bonsai (0.13) DocsGitHubDiscord CommunityGarden Enterprise
Docs Edge
Docs Edge
  • Welcome to Garden!
  • Overview
    • What is Garden
    • Use Cases
      • Isolated On-Demand Preview Environments
      • Fast, Portable CI Pipelines that Run Anywhere
      • Shift Testing Left
      • Local Development With Remote Clusters
      • Jumpstart your Internal Developer Platform
    • Garden vs Other Tools
  • Getting Started
    • Quickstart
    • Garden Basics
    • Next Steps
  • Tutorials
    • Your First Project
      • 1. Create a Garden Project
      • 2. Pick a Kubernetes Plugin
      • 3. Add Actions
      • 4. Add Tests
      • 5. Code Syncing (Hot Reload)
      • 6. Next Steps
    • Setting up a Kubernetes cluster
      • 1. Create a Cluster
        • AWS
        • GCP
        • Azure
      • 2. Configure Container Registry
        • AWS
        • GCP
        • Azure
        • Docker Hub
      • 3. Set Up Ingress, TLS and DNS
      • 4. Configure the Provider
  • Using Garden With
    • Containers
      • Using Remote Container Builder
      • Building Containers
    • Kubernetes
      • Using Remote Kubernetes
      • Using Local Kubernetes
      • Deploying K8s Resources
      • Installing Helm charts
      • Running Tests and Tasks
    • Terraform
      • Using Terraform
      • Applying Terrform Stacks
    • Pulumi
      • Using Pulumi
      • Applying Pulumi Stacks
    • Local Scripts
  • Features
    • Remote Container Builder
    • Team Caching
    • Variables and Templating
    • Config Templates
    • Workflows
    • Code Synchronization
    • Custom Commands
    • Remote Sources
  • Guides
    • Connecting a Project
    • Environments and Namespaces
    • Installing Garden
    • Including/Excluding files
    • Installing Local Kubernetes
    • Migrating from Docker Compose to Garden
    • Using the CLI
    • Using Garden in CircleCI
    • Minimal RBAC Configuration for Development Clusters
    • Deploying to Production
    • Using a Registry Mirror
    • Local mode
  • Reference
    • Providers
      • container
      • ephemeral-kubernetes
      • exec
      • jib
      • kubernetes
      • local-kubernetes
      • otel-collector
      • pulumi
      • terraform
    • Action Types
      • Build
        • container Build
        • exec Build
        • jib-container Build
      • Deploy
        • configmap Deploy
        • container Deploy
        • exec Deploy
        • helm Deploy
        • kubernetes Deploy
        • persistentvolumeclaim Deploy
        • pulumi Deploy
        • terraform Deploy
      • Run
        • container Run
        • exec Run
        • helm-pod Run
        • kubernetes-exec Run
        • kubernetes-pod Run
      • Test
        • container Test
        • exec Test
        • helm-pod Test
        • kubernetes-exec Test
        • kubernetes-pod Test
    • Template Strings
      • Project template context
      • Environment template context
      • Provider template context
      • Action (all fields) template context
      • Action spec template context
      • Module template context
      • Remote Source template context
      • Project Output template context
      • Custom Command template context
      • Workflow template context
      • Template Helper Functions
    • Commands
    • Project Configuration
    • ConfigTemplate Reference
    • RenderTemplate Reference
    • Workflow Configuration
    • Garden Containers on Docker Hub
    • Glossary
    • Module Template Configuration
    • Module Types
      • configmap
      • container
      • exec
      • helm
      • jib-container
      • kubernetes
      • persistentvolumeclaim
      • pulumi
      • templated
      • terraform
  • Misc
    • FAQ
    • Troubleshooting
    • Telemetry
    • How Organizations Adopt Garden
    • New Garden Cloud Version
    • Migrating to Bonsai
  • Contributing to Garden
    • Contributor Covenant Code of Conduct
    • Contributing to the Docs
    • Setting up Your Developer Environment
    • Developing Garden
    • Config Resolution
    • Graph Execution
Powered by GitBook
On this page
  • Description
  • Complete YAML Schema
  • Configuration Keys
  • providers[]
  • providers[].name
  • providers[].dependencies[]
  • providers[].environments[]
  • providers[].allowDestroy
  • providers[].autoApply
  • providers[].initRoot
  • providers[].variables
  • providers[].version
  • providers[].workspace
  • providers[].streamLogsToCloud
  • providers[].backendConfig

Was this helpful?

  1. Reference
  2. Providers

terraform

PreviouspulumiNextAction Types

Last updated 1 month ago

Was this helpful?

Description

This provider allows you to integrate Terraform stacks into your Garden project. See the for details and usage information.

Below is the full schema reference for the provider configuration..

The reference is divided into two sections. The contains the complete YAML schema, and the 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:

    # List other providers that should be resolved before this one.
    dependencies: []

    # 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 run `terraform destroy` on the project root stack when calling `garden delete env`.
    allowDestroy: false

    # 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/cedar-0.14/advanced/terraform) for more information.
    initRoot:

    # A map of variables to use when applying Terraform stacks. You can define these here, in individual
    # `terraform` action configs, or you can place a `terraform.tfvars` file in each working directory.
    variables:

    # The version of Terraform to use. Set to `null` to use whichever version of `terraform` that is on your PATH.
    version: 1.4.6

    # Use the specified Terraform workspace.
    workspace:

    # Set to `true` to make logs from Terraform Deploy actions visible in Garden Cloud/Enterprise. Defaults to `false`
    streamLogsToCloud: false

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

Configuration Keys

providers[]

Type
Default
Required

array[object]

[]

No

providers[].name

The name of the provider plugin to use.

Type
Required

string

Yes

Example:

providers:
  - name: "local-kubernetes"

providers[].dependencies[]

List other providers that should be resolved before this one.

Type
Default
Required

array[string]

[]

No

Example:

providers:
  - dependencies:
      - exec

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[].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

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

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.

Type
Required

posixPath

No

providers[].variables

A map of variables to use when applying Terraform stacks. You can define these here, in individualterraform action configs, or you can place a terraform.tfvars file in each working directory.

Type
Required

object

No

providers[].version

The version of Terraform to use. Set to null to use whichever version of terraform that is on your PATH.

Type
Allowed Values
Default
Required

string

"0.12.26", "0.13.3", "0.14.7", "1.0.5", "1.2.9", "1.4.6", null

"1.4.6"

Yes

providers[].workspace

Use the specified Terraform workspace.

Type
Required

string

No

providers[].streamLogsToCloud

Set to true to make logs from Terraform Deploy actions visible in Garden Cloud/Enterprise. Defaults to false

Type
Default
Required

boolean

false

No

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

providers:
  - backendConfig:
        "bucket: ${environment.name\\}-bucket\nkey: tf-state/${local.username\\}/terraform.tfstate"

> name

> dependencies

> environments

> allowDestroy

> autoApply

> initRoot

See the for more information.

> variables

> version

> workspace

> streamLogsToCloud

> backendConfig

Terraform guide
Terraform guide
first section
second section
providers
providers
providers
providers
providers
providers
providers
providers
providers
providers
providers