Go to file
Max Englander 8b946a6b6b Merge branch 'master' of github.com:hashicorp/terraform into 2087-consul-service-resource 2015-09-29 21:53:15 -04:00
builtin Merge branch 'master' of github.com:hashicorp/terraform into 2087-consul-service-resource 2015-09-29 21:53:15 -04:00
command Merge pull request #3223 from scalp42/typos 2015-09-14 07:48:59 +01:00
communicator remove various typos 2015-09-11 11:56:20 -07:00
config remove various typos 2015-09-11 11:56:20 -07:00
contrib Correct misspellings 2015-05-29 10:25:42 +09:00
dag core: log every 5s while waiting for dependencies 2015-08-10 15:50:36 -05:00
depgraph depgraph: Adding method to get incoming edges 2014-09-30 11:20:15 -07:00
deps v0.6.3 2015-08-11 15:45:58 +00:00
digraph Fix TestWriteDot random order error 2014-07-29 10:26:50 -07:00
dot core: graph command gets -verbose and -draw-cycles 2015-04-27 09:23:47 -05:00
examples Documentation and tests written for GCE VPN config 2015-09-15 16:13:48 -04:00
flatmap flatmap: never auto-convert ints 2014-07-24 11:41:01 -07:00
helper remove various typos 2015-09-11 11:56:20 -07:00
plugin Adding some abstractions for the communicators 2015-05-01 18:48:54 +02:00
rpc Reverting a few lines from PR #2406 2015-06-25 16:28:04 +02:00
scripts Use a faster middleman deploy 2015-09-20 14:08:28 -04:00
state remote/atlas: if `ATLAS_RUN_ID` is set, send it with remote state save 2015-08-20 13:54:26 -07:00
terraform Merge pull request #2988 from hashicorp/b-input-var-partially-computed 2015-09-24 15:07:49 -05:00
test-fixtures Remove all traces of libucl 2014-08-19 09:57:04 -07:00
website docs: rundeck: Remove extra backslashes 2015-09-25 10:51:55 +01:00
.gitignore update gitignore so the acceptance test for terraform gets in 2015-05-07 09:59:23 -07:00
.travis.yml travis: run `go vet` on every build 2015-03-05 14:59:51 -06:00
BUILDING.md trim to just steps for building the binaries 2015-08-18 13:11:49 -05:00
CHANGELOG.md Update CHANGELOG.md 2015-09-25 16:42:31 -04:00
CONTRIBUTING.md Initial commit. This adds the initial bits of a Docker provider. 2015-03-10 15:38:52 +00:00
LICENSE Adding license 2014-07-28 13:54:06 -04:00
Makefile Support go get in go 1.5 2015-07-31 00:34:58 +02:00
README.md Remove unnecessary tabs from the README file 2015-08-27 10:10:16 +02:00
Vagrantfile v0.6.2 2015-08-06 18:59:05 +00:00
checkpoint.go fixing version numbers RCs should be labeled x.x.x-rcx 2015-02-07 16:56:56 +01:00
commands.go command/push: start it 2015-03-24 13:30:21 -07:00
config.go Initial commit. This adds the initial bits of a Docker provider. 2015-03-10 15:38:52 +00:00
config_test.go Update config test to handle provisioners 2014-07-10 11:38:57 -07:00
config_unix.go config looks in a plugin directory if it exists 2014-09-27 12:36:13 -07:00
config_windows.go config looks in a plugin directory if it exists 2014-09-27 12:36:13 -07:00
log.go fmt 2014-10-10 14:50:35 -07:00
main.go Remove duplicate code 2015-06-16 17:40:59 +02:00
make.bat make.bat: Makefile-like test functionality for Windows 2015-02-04 16:25:20 +01:00
panic.go panic: Instruct the user to include terraform's version for bug reports. 2015-05-14 18:14:56 -04: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.4+ 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, install the following software packages, which are needed for some dependencies:

Next, clone this repository into $GOPATH/src/github.com/hashicorp/terraform. Install the necessary dependencies by running make updatedeps and then just type make. This will compile some more dependencies and then run the tests. If this exits with exit status 0, then everything is working!

$ make updatedeps
...
$ make
...

To compile a development version of Terraform and the built-in plugins, run make dev. This will 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
...

Acceptance Tests

Terraform also has a comprehensive acceptance test suite covering most of the major features of the built-in providers.

If you're working on a feature of a provider and want to verify it is functioning (and hasn't broken anything else), we recommend running the acceptance tests. Note that we do not require that you run or write acceptance tests to have a PR accepted. The acceptance tests are just here for your convenience.

Warning: The acceptance tests create/destroy/modify real resources, which may incur real costs. In the presence of a bug, it is technically possible that broken providers could corrupt existing infrastructure as well. Therefore, please run the acceptance providers at your own risk. At the very least, we recommend running them in their own private account for whatever provider you're testing.

To run the acceptance tests, invoke make testacc:

$ make testacc TEST=./builtin/providers/aws TESTARGS='-run=Vpc'
go generate ./...
TF_ACC=1 go test ./builtin/providers/aws -v -run=Vpc -timeout 90m
=== RUN TestAccVpc_basic
2015/02/10 14:11:17 [INFO] Test: Using us-west-2 as test region
[...]
[...]
...

The TEST variable is required, and you should specify the folder where the provider is. The TESTARGS variable is recommended to filter down to a specific resource to test, since testing all of them at once can take a very long time.

Acceptance tests typically require other environment variables to be set for things such as access keys. The provider itself should error early and tell you what to set, so it is not documented here.