github.com/kevholditch/terraform@v0.9.7-0.20170613192930-9706042ddd51/README.md (about) 1 Terraform 2 ========= 3 4 - Website: https://www.terraform.io 5 - [](https://gitter.im/hashicorp-terraform/Lobby) 6 - Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool) 7 8  9 10 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. 11 12 The key features of Terraform are: 13 14 - **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. 15 16 - **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. 17 18 - **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. 19 20 - **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. 21 22 For more information, see the [introduction section](http://www.terraform.io/intro) of the Terraform website. 23 24 Getting Started & Documentation 25 ------------------------------- 26 27 All documentation is available on the [Terraform website](http://www.terraform.io). 28 29 Developing Terraform 30 -------------------- 31 32 If you wish to work on Terraform itself or any of its built-in providers, you'll first need [Go](http://www.golang.org) 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. 33 34 For local dev first make sure Go is properly installed, including setting up a [GOPATH](http://golang.org/doc/code.html#GOPATH). You will also need to add `$GOPATH/bin` to your `$PATH`. 35 36 Next, using [Git](https://git-scm.com/), 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! 37 38 ```sh 39 $ cd "$GOPATH/src/github.com/hashicorp/terraform" 40 $ make 41 ``` 42 43 To compile a development version of Terraform and the built-in plugins, run `make dev`. This will build everything using [gox](https://github.com/mitchellh/gox) and put Terraform binaries in the `bin` and `$GOPATH/bin` folders: 44 45 ```sh 46 $ make dev 47 ... 48 $ bin/terraform 49 ... 50 ``` 51 52 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. 53 54 ```sh 55 $ make test TEST=./terraform 56 ... 57 ``` 58 59 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: 60 61 ```sh 62 $ make plugin-dev PLUGIN=provider-azure 63 ``` 64 65 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: 66 67 ```sh 68 $ make core-dev 69 ``` 70 71 ### Dependencies 72 73 Terraform stores its dependencies under `vendor/`, which [Go 1.6+ will automatically recognize and load](https://golang.org/cmd/go/#hdr-Vendor_Directories). We use [`govendor`](https://github.com/kardianos/govendor) to manage the vendored dependencies. 74 75 If you're developing Terraform, there are a few tasks you might need to perform. 76 77 #### Adding a dependency 78 79 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. 80 81 To add a dependency: 82 83 Assuming your work is on a branch called `my-feature-branch`, the steps look like this: 84 85 1. Add the new package to your GOPATH: 86 87 ```bash 88 go get github.com/hashicorp/my-project 89 ``` 90 91 2. Add the new package to your `vendor/` directory: 92 93 ```bash 94 govendor add github.com/hashicorp/my-project/package 95 ``` 96 97 3. Review the changes in git and commit them. 98 99 #### Updating a dependency 100 101 To update a dependency: 102 103 1. Fetch the dependency: 104 105 ```bash 106 govendor fetch github.com/hashicorp/my-project 107 ``` 108 109 2. Review the changes in git and commit them. 110 111 ### Acceptance Tests 112 113 Terraform has a comprehensive [acceptance 114 test](http://en.wikipedia.org/wiki/Acceptance_testing) suite covering the 115 built-in providers. Our [Contributing Guide](https://github.com/hashicorp/terraform/blob/master/.github/CONTRIBUTING.md) includes details about how and when to write and run acceptance tests in order to help contributions get accepted quickly. 116 117 118 ### Cross Compilation and Building for Distribution 119 120 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. 121 122 For example, to compile 64-bit Linux binaries on Mac OS X, you can run: 123 124 ```sh 125 $ XC_OS=linux XC_ARCH=amd64 make bin 126 ... 127 $ file pkg/linux_amd64/terraform 128 terraform: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, not stripped 129 ``` 130 131 `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: 132 133 ```sh 134 $ XC_OS="linux darwin" XC_ARCH="386 amd64" make bin 135 ... 136 $ tree ./pkg/ -P "terraform|*.zip" 137 ./pkg/ 138 ├── darwin_386 139 │ └── terraform 140 ├── darwin_386.zip 141 ├── darwin_amd64 142 │ └── terraform 143 ├── darwin_amd64.zip 144 ├── linux_386 145 │ └── terraform 146 ├── linux_386.zip 147 ├── linux_amd64 148 │ └── terraform 149 └── linux_amd64.zip 150 151 4 directories, 8 files 152 ``` 153 154 _Note: Cross-compilation uses [gox](https://github.com/mitchellh/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._ 155 156 #### Docker 157 158 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. 159 160 For example, run the following command to build terraform in a linux-based container for macOS. 161 162 ```sh 163 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" 164 ```