github.com/pgray/terraform@v0.5.4-0.20170822184730-b6a464c5214d/README.md (about) 1 Terraform 2 ========= 3 4 - Website: https://www.terraform.io 5 - [](https://gitter.im/hashicorp-terraform/Lobby) 6 [](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fhashicorp%2Fterraform?ref=badge_shield) 7 - Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool) 8 9  10 11 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. 12 13 The key features of Terraform are: 14 15 - **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. 16 17 - **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. 18 19 - **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. 20 21 - **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. 22 23 For more information, see the [introduction section](http://www.terraform.io/intro) of the Terraform website. 24 25 Getting Started & Documentation 26 ------------------------------- 27 28 If you're new to Terraform and want to get started creating infrastructure, please checkout our [Getting Started](https://www.terraform.io/intro/getting-started/install.html) guide, available on the [Terraform website](http://www.terraform.io). 29 30 All documentation is available on the [Terraform website](http://www.terraform.io): 31 32 - [Intro](https://www.terraform.io/intro/index.html) 33 - [Docs](https://www.terraform.io/docs/index.html) 34 35 Developing Terraform 36 -------------------- 37 38 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. 39 40 This repository contains only Terraform core, which includes the command line interface and the main graph engine. Providers are implemented as plugins that each have their own repository in [the `terraform-providers` organization](https://github.com/terraform-providers) on GitHub. Instructions for developing each provider are in the associated README file. For more information, see [the provider development overview](https://www.terraform.io/docs/plugins/provider.html). 41 42 For local development of Terraform core, first make sure Go is properly installed and that a 43 [GOPATH](http://golang.org/doc/code.html#GOPATH) has been set. You will also need to add `$GOPATH/bin` to your `$PATH`. 44 45 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! 46 47 ```sh 48 $ cd "$GOPATH/src/github.com/hashicorp/terraform" 49 $ make 50 ``` 51 52 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: 53 54 ```sh 55 $ make dev 56 ... 57 $ bin/terraform 58 ... 59 ``` 60 61 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. 62 63 ```sh 64 $ make test TEST=./terraform 65 ... 66 ``` 67 68 If you're working on a specific provider which has not been separated into an individual repository and only wish to rebuild that provider, you can use the `plugin-dev` target. For example, to build only the Test provider: 69 70 ```sh 71 $ make plugin-dev PLUGIN=provider-test 72 ``` 73 74 ### Dependencies 75 76 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. 77 78 If you're developing Terraform, there are a few tasks you might need to perform. 79 80 #### Adding a dependency 81 82 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. 83 84 To add a dependency: 85 86 Assuming your work is on a branch called `my-feature-branch`, the steps look like this: 87 88 1. Add the new package to your GOPATH: 89 90 ```bash 91 go get github.com/hashicorp/my-project 92 ``` 93 94 2. Add the new package to your `vendor/` directory: 95 96 ```bash 97 govendor add github.com/hashicorp/my-project/package 98 ``` 99 100 3. Review the changes in git and commit them. 101 102 #### Updating a dependency 103 104 To update a dependency: 105 106 1. Fetch the dependency: 107 108 ```bash 109 govendor fetch github.com/hashicorp/my-project 110 ``` 111 112 2. Review the changes in git and commit them. 113 114 ### Acceptance Tests 115 116 Terraform has a comprehensive [acceptance 117 test](http://en.wikipedia.org/wiki/Acceptance_testing) suite covering the 118 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. 119 120 121 ### Cross Compilation and Building for Distribution 122 123 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. 124 125 For example, to compile 64-bit Linux binaries on Mac OS X, you can run: 126 127 ```sh 128 $ XC_OS=linux XC_ARCH=amd64 make bin 129 ... 130 $ file pkg/linux_amd64/terraform 131 terraform: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, not stripped 132 ``` 133 134 `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: 135 136 ```sh 137 $ XC_OS="linux darwin" XC_ARCH="386 amd64" make bin 138 ... 139 $ tree ./pkg/ -P "terraform|*.zip" 140 ./pkg/ 141 ├── darwin_386 142 │ └── terraform 143 ├── darwin_386.zip 144 ├── darwin_amd64 145 │ └── terraform 146 ├── darwin_amd64.zip 147 ├── linux_386 148 │ └── terraform 149 ├── linux_386.zip 150 ├── linux_amd64 151 │ └── terraform 152 └── linux_amd64.zip 153 154 4 directories, 8 files 155 ``` 156 157 _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._ 158 159 #### Docker 160 161 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. 162 163 For example, run the following command to build terraform in a linux-based container for macOS. 164 165 ```sh 166 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" 167 ``` 168 169 170 ## License 171 [](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fhashicorp%2Fterraform?ref=badge_large)