github.com/jdextraze/terraform@v0.6.17-0.20160511153921-e33847c8a8af/README.md (about) 1 Terraform 2 ========= 3 4 - Website: http://www.terraform.io 5 - IRC: `#terraform-tool` on Freenode 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.6+ 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 $ make 40 ``` 41 42 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: 43 44 ```sh 45 $ make dev 46 ... 47 $ bin/terraform 48 ... 49 ``` 50 51 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. 52 53 ```sh 54 $ make test TEST=./terraform 55 ... 56 ``` 57 58 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: 59 60 ```sh 61 $ make plugin-dev PLUGIN=provider-azure 62 ``` 63 64 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: 65 66 ```sh 67 $ make core-dev 68 ``` 69 70 ### Dependencies 71 72 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 [`godep`](https://github.com/tools/godep) to manage the vendored dependencies. 73 74 Generally speaking, `godep` operations follow this pattern: 75 76 1. Get current state of dependencies into your `$GOPATH` with `godep restore`. 77 2. Make changes to the packages in `$GOPATH`. 78 3. Tell `godep` to capture those changes in the Terraform repo. 79 80 If you're developing Terraform, there are a few tasks you might need to perform. 81 82 #### Adding a dependency 83 84 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. 85 86 Because godep captures new dependencies from the local `$GOPATH`, you first need to `godep restore` from the master branch to ensure that the only diff is your new dependency. 87 88 Assuming your work is on a branch called `my-feature-branch`, the steps look like this: 89 90 ```bash 91 # Get latest master branch's dependencies staged in local $GOPATH 92 git checkout master 93 git pull 94 godep restore -v 95 96 # Capture the new dependency referenced from my-feature-branch 97 git checkout my-feature-branch 98 git rebase master 99 godep save ./... 100 101 # There should now be a diff in `vendor/` with added files for your dependency, 102 # and a diff in Godeps/Godeps.json with metadata for your dependency. 103 104 # Make a commit with your new dependencies added 105 git add -A 106 git commit -m "vendor: Capture new dependency upstream-pkg" 107 108 # Push to your branch (may need -f if you rebased) 109 git push origin my-feature-branch 110 ``` 111 112 #### Updating a dependency 113 114 If you're updating an existing dependency, godep provides a specific command to snag the newer version from your `$GOPATH`. 115 116 ```bash 117 # Get latest master branch's dependencies staged in local $GOPATH 118 git checkout master 119 git pull 120 godep restore -v 121 122 # Make your way to the dependency in question and checkout the target ref 123 pushd $GOPATH/src/github.com/some/dependency 124 git checkout v-1.next 125 126 # Head back to Terraform on a feature branch and update the dependncy to the 127 # version currently in your $GOPATH 128 popd 129 git checkout my-feature-branch 130 godep update github.com/some/dependency/... 131 132 # There should now be a diff in `vendor/` with changed files for your dependency, 133 # and a diff in Godeps/Godeps.json with metadata for the updated dependency. 134 135 # Make a commit with the updated dependency 136 git add -A 137 git commit -m "vendor: Update dependency upstream-pkg to 1.4.6" 138 139 # Push to your branch 140 git push origin my-feature-branch 141 ``` 142 143 ### Acceptance Tests 144 145 Terraform has a comprehensive [acceptance 146 test](http://en.wikipedia.org/wiki/Acceptance_testing) suite covering the 147 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. 148 149 150 ### Cross Compilation and Building for Distribution 151 152 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. 153 154 For example, to compile 64-bit Linux binaries on Mac OS X Linux, you can run: 155 156 ```sh 157 $ XC_OS=linux XC_ARCH=amd64 make bin 158 ... 159 $ file pkg/linux_amd64/terraform 160 terraform: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, not stripped 161 ``` 162 163 `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: 164 165 ```sh 166 $ XC_OS="linux darwin" XC_ARCH="386 amd64" make bin 167 ... 168 $ tree ./pkg/ -P "terraform|*.zip" 169 ./pkg/ 170 ├── darwin_386 171 │ └── terraform 172 ├── darwin_386.zip 173 ├── darwin_amd64 174 │ └── terraform 175 ├── darwin_amd64.zip 176 ├── linux_386 177 │ └── terraform 178 ├── linux_386.zip 179 ├── linux_amd64 180 │ └── terraform 181 └── linux_amd64.zip 182 183 4 directories, 8 files 184 ``` 185 186 _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._