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.8+ 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.
For local dev first make sure Go is properly installed, including setting up a GOPATH. You will also need to add
$GOPATH/bin to your
Next, using Git, clone this repository into
$GOPATH/src/github.com/hashicorp/terraform. All the necessary dependencies are either vendored or automatically installed, so you just need to type
make. This will compile the code and then run the tests. If this exits with exit status 0, then everything is working!
$ cd "$GOPATH/src/github.com/hashicorp/terraform" $ 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 and only wish to rebuild that provider, you can use the
plugin-dev target. For example, to build only the Azure provider:
$ make plugin-dev PLUGIN=provider-azure
If you're working on the core of Terraform, and only wish to rebuild that without rebuilding providers, you can use the
core-dev target. It is important to note that some types of changes may require both core and providers to be rebuilt - for example work on the RPC interface. To build just the core of Terraform:
$ make core-dev
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:
Add the new package to your GOPATH:
go get github.com/hashicorp/my-project
Add the new package to your
govendor add github.com/hashicorp/my-project/package
Review the changes in git and commit them.
Updating a dependency
To update a dependency:
Fetch the dependency:
govendor fetch github.com/hashicorp/my-project
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"
There is no documentation for this package.
Source Files ¶
Package backend provides interfaces that the CLI uses to interact with Terraform.
|Package backend provides interfaces that the CLI uses to interact with Terraform.|
Package init contains the list of backends that can be initialized and basic helper functions for initializing those backends.
|Package init contains the list of backends that can be initialized and basic helper functions for initializing those backends.|
Package legacy contains a backend implementation that can be used with the legacy remote state clients.
|Package legacy contains a backend implementation that can be used with the legacy remote state clients.|
Package remotestate implements a Backend for remote state implementations from the state/remote package that also implement a backend schema for configuration.
|Package remotestate implements a Backend for remote state implementations from the state/remote package that also implement a backend schema for configuration.|
This file is automatically generated by scripts/generate-plugins.go -- Do not edit!
|This file is automatically generated by scripts/generate-plugins.go -- Do not edit!|
Package state exposes common helpers for working with state from the CLI.
|Package state exposes common helpers for working with state from the CLI.|
Package format contains helpers for formatting various Terraform structures for human-readabout output.
|Package format contains helpers for formatting various Terraform structures for human-readabout output.|
The config package is responsible for loading and validating the configuration.
|The config package is responsible for loading and validating the configuration.|
Package acctest contains for Terraform Acceptance Tests
|Package acctest contains for Terraform Acceptance Tests|
experiment package contains helper functions for tracking experimental features throughout Terraform.
|experiment package contains helper functions for tracking experimental features throughout Terraform.|
Helpers for dealing with file paths and their contents
|Helpers for dealing with file paths and their contents|
schema is a high-level framework for easily writing new providers for Terraform.
|schema is a high-level framework for easily writing new providers for Terraform.|
Package signalwrapper is used to run functions that are sensitive to signals that may be received from outside the process.
|Package signalwrapper is used to run functions that are sensitive to signals that may be received from outside the process.|
Package variables provides functions and types for working with Terraform variables provided as input.
|Package variables provides functions and types for working with Terraform variables provided as input.|
wrappedreadline is a package that has helpers for interacting with readline from a panicwrap executable.
|wrappedreadline is a package that has helpers for interacting with readline from a panicwrap executable.|
Package wrappedstreams provides access to the standard OS streams (stdin, stdout, stderr) even if wrapped under panicwrap.
|Package wrappedstreams provides access to the standard OS streams (stdin, stdout, stderr) even if wrapped under panicwrap.|
Package repl provides the structs and functions necessary to run REPL for Terraform.
|Package repl provides the structs and functions necessary to run REPL for Terraform.|
Generate Plugins is a small program that updates the lists of plugins in command/internal_plugin_list.go so they will be compiled into the main terraform binary.
|Generate Plugins is a small program that updates the lists of plugins in command/internal_plugin_list.go so they will be compiled into the main terraform binary.|