Go to file
Eric Westfall 72da290e1d provider/aws: Fix error message returned when an invalid SSM document type is provided. The original error appears to have been copied from the CodeBuild resource and provides incorrect information about valid types. 2017-02-25 06:26:59 +00:00
.github Fix a few typos in contributing guidelines (#10825) 2016-12-19 10:17:12 +00:00
backend Merge pull request #12173 from hashicorp/b-remote-state-ds 2017-02-22 18:43:06 -08:00
builtin provider/aws: Fix error message returned when an invalid SSM document type is provided. The original error appears to have been copied from the CodeBuild resource and provides incorrect information about valid types. 2017-02-25 06:26:59 +00:00
command Fix the Push test outputs 2017-02-24 18:37:06 -05:00
communicator Add upload tests 2017-02-10 10:30:05 -05:00
config Fixed broken build for netbsd 2017-02-22 00:30:18 +08:00
contrib command: Change module-depth default to -1 2016-01-20 13:58:02 -06:00
dag Fix removeEdge test failures 2017-02-20 19:54:34 -05:00
digraph Fix TestWriteDot random order error 2014-07-29 10:26:50 -07:00
examples Fix markdown format (#12090) 2017-02-20 14:43:49 +02:00
flatmap flatmap: mark computed list as a computed value in Expand 2017-02-23 10:03:59 -08:00
helper terraform: InstanceState.Meta is value type interface{} 2017-02-23 10:44:05 -08:00
plugin plugin: bump the protocol version due to Provisioner change 2017-01-26 15:03:27 -08:00
repl terraform: improve error messages to assist REPL 2016-11-13 23:17:04 -08:00
scripts scripts: update tests for generate plugins to pass new style 2017-01-26 15:10:03 -08:00
state remove the legacy Inmem remote state 2017-02-20 14:50:31 -05:00
terraform Merge pull request #12219 from hashicorp/jbardin/state-mv-sort 2017-02-24 09:49:26 -05:00
test-fixtures terraformrc can contain env var references 2017-02-13 17:52:51 -08:00
vendor remove the docker packages that aren't needed 2017-02-24 15:13:22 -05:00
website provider/digitalocean: Add support for LoadBalancers (#12077) 2017-02-23 23:41:20 +02:00
.gitattributes Adding in root level .gitattributes file. 2017-02-03 15:14:31 +00:00
.gitignore gitignore should ignore test files that use .terraform/tfstate 2017-01-26 14:33:49 -08:00
.travis.yml check vendor status in travis 2017-02-24 15:06:32 -05:00
BUILDING.md Makefile/docs: Lock in 1.6 req, doc vendored deps 2016-02-24 16:13:49 -06:00
CHANGELOG.md Fix typo in CHANGELOG.md 2017-02-24 09:04:02 -08:00
LICENSE Adding license 2014-07-28 13:54:06 -04:00
Makefile Disallow parallelism in Makefile 2017-02-17 15:31:58 -08:00
README.md Update README.md 2017-01-31 11:56:37 -08:00
Vagrantfile build: Bump Vagrant to go1.8 (#12026) 2017-02-17 00:45:19 +02:00
checkpoint.go fixing version numbers RCs should be labeled x.x.x-rcx 2015-02-07 16:56:56 +01:00
commands.go Remove lock command and rename lock/force-unlock 2017-02-07 18:28:48 -05:00
config.go terraformrc can contain env var references 2017-02-13 17:52:51 -08:00
config_test.go terraformrc can contain env var references 2017-02-13 17:52:51 -08:00
config_unix.go core: use !windows instead of a list of unixes 2015-12-30 17:37:24 -05:00
config_windows.go config looks in a plugin directory if it exists 2014-09-27 12:36:13 -07:00
help.go Remind future maintainers to update the docs when changing CLI usage 2016-11-24 09:22:18 -08:00
main.go log the Go runtime version at TF startup 2017-02-15 16:11:42 -08:00
main_test.go support nested subcommands with TF_CLI_ARGS 2017-02-13 15:18:50 -08:00
panic.go panic: Instruct the user to include terraform's version for bug reports. 2015-05-14 18:14:56 -04:00
signal_unix.go Forward SIGTERM and handle that as an interrupt 2016-12-08 12:20:25 -05:00
signal_windows.go Forward SIGTERM and handle that as an interrupt 2016-12-08 12:20:25 -05:00
version.go Expose Terraform version internally & externally 2015-06-21 12:24:42 +01:00

README.md

Terraform

Terraform

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.

Developing Terraform

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.7+ 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 $PATH.

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 bin and $GOPATH/bin folders:

$ 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, onlyterraform 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

Dependencies

Terraform stores its dependencies under vendor/, which Go 1.6+ will automatically recognize and load. We use govendor to manage the vendored dependencies.

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:

  1. Add the new package to your GOPATH:

    go get github.com/hashicorp/my-project
    
  2. Add the new package to your vendor/ directory:

    govendor add github.com/hashicorp/my-project/package
    
  3. Review the changes in git and commit them.

Updating a dependency

To update a dependency:

  1. Fetch the dependency:

    govendor fetch github.com/hashicorp/my-project
    
  2. Review the changes in git and commit them.

Acceptance Tests

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_OS and 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_OS and 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.