github.com/ljosa/terraform@v0.7.0-rc2.0.20160617205345-fe540b408f59/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 [`govendor`](https://github.com/kardianos/govendor) to manage the vendored dependencies. 73 74 If you're developing Terraform, there are a few tasks you might need to perform. 75 76 #### Adding a dependency 77 78 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. 79 80 To add a dependency: 81 82 Assuming your work is on a branch called `my-feature-branch`, the steps look like this: 83 84 1. Add the new package to your GOPATH: 85 86 ```bash 87 go get github.com/hashicorp/my-project 88 ``` 89 90 2. Add the new package to your vendor/ directory: 91 92 ```bash 93 govendor add github.com/hashicorp/my-project/package 94 ``` 95 96 3. Review the changes in git and commit them. 97 98 #### Updating a dependency 99 100 To update a dependency: 101 102 1. Fetch the dependency: 103 104 ```bash 105 govendor fetch github.com/hashicorp/my-project 106 ``` 107 108 2. Review the changes in git and commit them. 109 110 ### Acceptance Tests 111 112 Terraform has a comprehensive [acceptance 113 test](http://en.wikipedia.org/wiki/Acceptance_testing) suite covering the 114 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. 115 116 117 ### Cross Compilation and Building for Distribution 118 119 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. 120 121 For example, to compile 64-bit Linux binaries on Mac OS X Linux, you can run: 122 123 ```sh 124 $ XC_OS=linux XC_ARCH=amd64 make bin 125 ... 126 $ file pkg/linux_amd64/terraform 127 terraform: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, not stripped 128 ``` 129 130 `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: 131 132 ```sh 133 $ XC_OS="linux darwin" XC_ARCH="386 amd64" make bin 134 ... 135 $ tree ./pkg/ -P "terraform|*.zip" 136 ./pkg/ 137 ├── darwin_386 138 │ └── terraform 139 ├── darwin_386.zip 140 ├── darwin_amd64 141 │ └── terraform 142 ├── darwin_amd64.zip 143 ├── linux_386 144 │ └── terraform 145 ├── linux_386.zip 146 ├── linux_amd64 147 │ └── terraform 148 └── linux_amd64.zip 149 150 4 directories, 8 files 151 ``` 152 153 _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._