Go to file
Annie Hedgpeth a37a70b133 provider/azurerm: Example of Openshift origin (#15294)
* initial commit - 101-vm-from-user-image

* changed branch name

* not deploying - storage problems

* provisions vm but image not properly prepared

* storage not correct

* provisions properly

* changed main.tf to azuredeploy.tf

* added tfvars and info for README

* tfvars ignored and corrected file ext

* added CI config; added sane defaults for variables; updated deployment script, added mac specific deployment for local testing

* deploy.sh to be executable

* executable deploy files

* added CI files; changed vars

* prep for PR

* removal of old folder

* prep for PR

* wrong args for travis

* more PR prep

* updated README

* commented out variables in terraform.tfvars

* Topic 101 vm from user image (#2)

* initial commit - 101-vm-from-user-image
* added tfvars and info for README
* added CI config; added sane defaults for variables; updated deployment script, added mac specific deployment for local testing
* prep for PR

* added new template

* oops, left off master

* prep for PR

* correct repository for destination

* renamed scripts to be more intuitive; added check for docker

* merge vm simple; vm from image

* initial commit

* deploys locally

* updated deploy

* consolidated deploy and after_deploy into a single script; simplified ci process; added os_profile_linux_config

* added terraform show

* changed to allow http & https (like ARM tmplt)

* changed host_name & host_name variable desc

* added az cli check

* on this branch, only build test_dir; master will aggregate all the examples

* merge master

* added new constructs/naming for deploy scripts, etc.

* suppress az login output

* suppress az login output

* forgot about line breaks

* breaking build as an example

* fixing broken build example

* merge of CI config

* fixed grammar in readme

* prep for PR

* took out armviz button and minor README changes

* changed host_name

* fixed merge conflicts

* changed host_name variable

* updating Hashicorp's changes to merged simple linux branch

* updating files to merge w/master and prep for Hashicorp pr

* Revert "updating files to merge w/master and prep for Hashicorp pr"

This reverts commit b850cd5d2a858eff073fc5a1097a6813d0f8b362.

* Revert "updating Hashicorp's changes to merged simple linux branch"

This reverts commit dbaf8d14a9cdfcef0281919671357f6171ebd4e6.

* removing vm from user image example from this branch

* removed old branch

* azure-2-vms-loadbalancer-lbrules (#13)

* initial commit

* need to change lb_rule & nic

* deploys locally

* updated README

* updated travis and deploy scripts for Hari's repo

* renamed deploy script

* clean up

* prep for PR

* updated readme

* fixing conflict in .travis.yml

* add CI build tag

* initial commit; in progress

* in progress; merged Hashicorp master into this branch

* in progress

* in progress; created nsg

* added vars to deploy; added vnet

* chmod on deploy

* edited vars

* added var in travis

* added var

* added var to deploy

* added storage accounts

* fixed storage typos

* removed storage tags

* added PIPs

* changed dns name vars

* corrected PIP naming convention

* added availability sets

* added master-lb & rules

* added infra lb & rules

* added nics

* added VMs, ready for VM extensions, can modularize in the future

* added vm exts.; nsg is possibly broken; can't ssh

* in progress

* master ext succeeds

* in progress, infra and nodes exts not succeeding

* infra and node extensions fail

* provisions with extensions

* disabled password auth; ssh config added

* changed ssh key vars

* adding ssh var to deploy

* commenting out validation

* in progress; building openshift ext

* troubleshooting openshift deploy script

* changed vm names; added container

* increased os disk size

* in progress; troubleshooting deploy opnshft script

* Updated the readme

* updated deployment scripts; cleaned up variables, use remote-exec

* more variable cleanup

* more cleanup

* simplified password; got rid of a needless comment

* merge conflicts resolved
2017-06-15 19:26:59 +03:00
.github Update ISSUE_TEMPLATE (#15222) 2017-06-12 14:53:56 +03:00
backend rename aws provider import in s3 backend 2017-06-12 13:43:51 -04:00
builtin Use the InstanceState to query any connection details (#15271) 2017-06-14 21:40:31 +02:00
command reverse init test to check for dataDir in PWD 2017-06-14 15:22:30 -04:00
communicator Add upload tests 2017-02-10 10:30:05 -05:00
config config: fix provider version constraint validation 2017-06-09 14:03:59 -07:00
contrib Shell completions for fish 2017-04-17 15:40:55 +00:00
dag dag: method for filtering a set on arbitrary criteria 2017-05-11 11:57:46 -07:00
digraph Fix TestWriteDot random order error 2014-07-29 10:26:50 -07:00
docs docs: Add Maintainer's etiquette 2017-05-04 15:27:25 +01:00
examples provider/azurerm: Example of Openshift origin (#15294) 2017-06-15 19:26:59 +03:00
flatmap correct spelling mistakes (#13979) 2017-04-27 02:10:04 +12:00
helper Fix resource.UniqueId to be properly ordered over multiple runs 2017-06-15 08:09:23 -07:00
moduledeps plugin/discovery: PluginRequirements can specify SHA256 digests 2017-06-09 14:03:59 -07:00
plugin plugin/discovery: Installer.PurgeUnused method 2017-06-13 12:28:07 -07:00
repl terraform: improve error messages to assist REPL 2016-11-13 23:17:04 -08:00
scripts remove "core" distinction 2017-06-12 13:43:54 -04:00
state rename openstack provider for swift remote state 2017-06-12 13:43:51 -04:00
terraform core: terraform.env variable is now terraform.workspace 2017-06-09 15:01:39 -07:00
test-fixtures terraformrc can contain env var references 2017-02-13 17:52:51 -08:00
vendor final vendor cleanup 2017-06-12 13:43:54 -04:00
website website: new filesystem layout for core/provider split 2017-06-13 11:25:32 -07:00
.gitignore gitignore should ignore test files that use .terraform/tfstate 2017-01-26 14:33:49 -08:00
.travis.yml provider/azurerm: Add example of Spark and Cassrandra on CentOS (#15123) 2017-06-08 19:38:34 +03:00
BUILDING.md Makefile/docs: Lock in 1.6 req, doc vendored deps 2016-02-24 16:13:49 -06:00
CHANGELOG.md Create CHANGELOG.md 2017-06-14 21:48:36 +02:00
LICENSE Adding license 2014-07-28 13:54:06 -04:00
Makefile remove "core" distinction 2017-06-12 13:43:54 -04:00
README.md Fix README logo 2017-04-10 11:54:14 -04:00
Vagrantfile Update Vagrantfile to use go1.8.1 (#14008) 2017-04-27 08:01:59 +12: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: shallow UI-focused rename of "environment" to "workspace" 2017-06-09 15:01:39 -07:00
config.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
config_test.go terraformrc can contain env var references 2017-02-13 17:52:51 -08:00
config_unix.go prevent log output during init 2017-06-12 15:05:59 -04:00
config_windows.go config looks in a plugin directory if it exists 2014-09-27 12:36:13 -07:00
help.go Remind future maintainers to update the docs when changing CLI usage 2016-11-24 09:22:18 -08:00
main.go Push plugin discovery down into command package 2017-06-09 14:03:59 -07:00
main_test.go support nested subcommands with TF_CLI_ARGS 2017-02-13 15:18:50 -08:00
panic.go panic: Instruct the user to include terraform's version for bug reports. 2015-05-14 18:14:56 -04:00
plugins.go move some more plugin search path logic to command 2017-06-09 14:03:59 -07:00
signal_unix.go Forward SIGTERM and handle that as an interrupt 2016-12-08 12:20:25 -05:00
signal_windows.go Forward SIGTERM and handle that as an interrupt 2016-12-08 12:20:25 -05:00
synchronized_writers.go main: synchronize writes to VT100-faker on Windows 2017-05-04 15:36:51 -07:00
version.go core: Use environment variables to set VersionPrerelease at compile time 2017-05-22 10:49:15 -04: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.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.

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, using Git, 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!

$ cd "$GOPATH/src/github.com/hashicorp/terraform"
$ make

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

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:

$ make plugin-dev PLUGIN=provider-azure

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:

$ make core-dev

Dependencies

Terraform stores its dependencies under vendor/, which Go 1.6+ will automatically recognize and load. We use govendor to manage the vendored dependencies.

If you're developing Terraform, there are a few tasks you might need to perform.

Adding a dependency

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.

To add a dependency:

Assuming your work is on a branch called my-feature-branch, the steps look like this:

  1. Add the new package to your GOPATH:

    go get github.com/hashicorp/my-project
    
  2. Add the new package to your vendor/ directory:

    govendor add github.com/hashicorp/my-project/package
    
  3. Review the changes in git and commit them.

Updating a dependency

To update a dependency:

  1. Fetch the dependency:

    govendor fetch github.com/hashicorp/my-project
    
  2. Review the changes in git and commit them.

Acceptance Tests

Terraform has a comprehensive acceptance test suite covering the built-in providers. Our Contributing Guide includes details about how and when to write and run acceptance tests in order to help contributions get accepted quickly.

Cross Compilation and Building for Distribution

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.

For example, to compile 64-bit Linux binaries on Mac OS X, you can run:

$ XC_OS=linux XC_ARCH=amd64 make bin
...
$ file pkg/linux_amd64/terraform
terraform: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, not stripped

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:

$ XC_OS="linux darwin" XC_ARCH="386 amd64" make bin
...
$ tree ./pkg/ -P "terraform|*.zip"
./pkg/
├── darwin_386
│   └── terraform
├── darwin_386.zip
├── darwin_amd64
│   └── terraform
├── darwin_amd64.zip
├── linux_386
│   └── terraform
├── linux_386.zip
├── linux_amd64
│   └── terraform
└── linux_amd64.zip

4 directories, 8 files

Note: Cross-compilation uses 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.

Docker

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.

For example, run the following command to build terraform in a linux-based container for macOS.

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"