Terraform is a tool for building, changing, and versioning infrastructure safely and efficiently. Terraform can manage existing and popular service providers as well as custom in-house solutions.
The key features of Terraform are:
Infrastructure as Code: Infrastructure is described using a high-level configuration syntax. This allows a blueprint of your datacenter to be versioned and treated as you would any other code. Additionally, infrastructure can be shared and re-used.
Execution Plans: Terraform has a "planning" step where it generates an execution plan. The execution plan shows what Terraform will do when you call apply. This lets you avoid any surprises when Terraform manipulates infrastructure.
Resource Graph: Terraform builds a graph of all your resources, and parallelizes the creation and modification of any non-dependent resources. Because of this, Terraform builds infrastructure as efficiently as possible, and operators get insight into dependencies in their infrastructure.
Change Automation: Complex changesets can be applied to your infrastructure with minimal human interaction. With the previously mentioned execution plan and resource graph, you know exactly what Terraform will change and in what order, avoiding many possible human errors.
For more information, see the introduction section of the Terraform website.
Getting Started & Documentation
All documentation is available on the Terraform website:
If you wish to work on Terraform itself or any of its built-in providers, you'll first need Go installed on your machine (version 1.11+ is required). Alternatively, you can use the Vagrantfile in the root of this repo to stand up a virtual machine with the appropriate dev tooling already set up for you.
This repository contains only Terraform core, which includes the command line interface and the main graph engine. Providers are implemented as plugins that each have their own repository in the
terraform-providers organization on GitHub. Instructions for developing each provider are in the associated README file. For more information, see the provider development overview.
For local development of Terraform core, first make sure Go is properly installed and that a
GOPATH has been set. You will also need to add
$GOPATH/bin to your
Next, using Git, clone this repository into
You'll need to run
make tools to install some required tools, then
make. This will compile the code and then run the tests. If this exits with exit status 0, then everything is working!
You only need torun
make tools once (or when the tools change).
$ cd "$GOPATH/src/github.com/hashicorp/terraform" $ make tools $ make
To compile a development version of Terraform and the built-in plugins, run
make dev. This will build everything using gox and put Terraform binaries in the
$ make dev ... $ bin/terraform ...
If you're developing a specific package, you can run tests for just that package by specifying the
TEST variable. For example below, only
terraform package tests will be run.
$ make test TEST=./terraform ...
If you're working on a specific provider which has not been separated into an individual repository and only wish to rebuild that provider, you can use the
plugin-dev target. For example, to build only the Test provider:
$ make plugin-dev PLUGIN=provider-test
Terraform uses Go Modules for dependency management, but for the moment is continuing to use Go 1.6-style vendoring for compatibility with tools that have not yet been updated for full Go Modules support.
If you're developing Terraform, there are a few tasks you might need to perform.
Adding a dependency
If you're adding a dependency, you'll need to vendor it in the same Pull Request as the code that depends on it. You should do this in a separate commit from your code, as makes PR review easier and Git history simpler to read in the future.
To add a dependency:
Assuming your work is on a branch called
my-feature-branch, the steps look like this:
importstatement to a suitable package in the Terraform code.
go mod vendorto download the latest version of the module containing the imported package into the
vendor/directory, and update the
Review the changes in git and commit them.
Updating a dependency
To update a dependency:
go get -u module-path@version-number, such as
go get -u firstname.lastname@example.org
go mod vendorto update the vendored copy in the
Review the changes in git and commit them.
Terraform has a comprehensive acceptance test suite covering the built-in providers. Our Contributing Guide includes details about how and when to write and run acceptance tests in order to help contributions get accepted quickly.
Cross Compilation and Building for Distribution
If you wish to cross-compile Terraform for another architecture, you can set the
XC_ARCH environment variables to values representing the target operating system and architecture before calling
make. The output is placed in the
pkg subdirectory tree both expanded in a directory representing the OS/architecture combination and as a ZIP archive.
For example, to compile 64-bit Linux binaries on Mac OS X, you can run:
$ XC_OS=linux XC_ARCH=amd64 make bin ... $ file pkg/linux_amd64/terraform terraform: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, not stripped
XC_ARCH can be space separated lists representing different combinations of operating system and architecture. For example, to compile for both Linux and Mac OS X, targeting both 32- and 64-bit architectures, you can run:
$ XC_OS="linux darwin" XC_ARCH="386 amd64" make bin ... $ tree ./pkg/ -P "terraform|*.zip" ./pkg/ ├── darwin_386 │ └── terraform ├── darwin_386.zip ├── darwin_amd64 │ └── terraform ├── darwin_amd64.zip ├── linux_386 │ └── terraform ├── linux_386.zip ├── linux_amd64 │ └── terraform └── linux_amd64.zip 4 directories, 8 files
Note: Cross-compilation uses gox, which requires toolchains to be built with versions of Go prior to 1.5. In order to successfully cross-compile with older versions of Go, you will need to run
gox -build-toolchain before running the commands detailed above.
When using docker you don't need to have any of the Go development tools installed and you can clone terraform to any location on disk (doesn't have to be in your $GOPATH). This is useful for users who want to build
master or a specific branch for testing without setting up a proper Go environment.
For example, run the following command to build terraform in a linux-based container for macOS.
docker run --rm -v $(pwd):/go/src/github.com/hashicorp/terraform -w /go/src/github.com/hashicorp/terraform -e XC_OS=darwin -e XC_ARCH=amd64 golang:latest bash -c "apt-get update && apt-get install -y zip && make bin"