OpenTofu lets you declaratively manage your cloud infrastructure.
Go to file
James Bardin 1ee851f256
Merge pull request #22846 from hashicorp/jbardin/evaluate-resource
Always evaluate resources in their entirety
2019-10-08 07:57:15 -04:00
.github Small typo fix 2019-09-25 11:55:43 -04:00
addrs Merge pull request #22846 from hashicorp/jbardin/evaluate-resource 2019-10-08 07:57:15 -04:00
backend vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
builtin Merge pull request #22705 from kmott/habitat-provisioner-updates 2019-10-01 14:27:52 -04:00
command website / help: reconcile 'validate' command docs 2019-10-03 15:31:33 -07:00
communicator Update communicator/ssh/communicator.go 2019-10-02 15:03:18 -04:00
config vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
configs Merge pull request #22846 from hashicorp/jbardin/evaluate-resource 2019-10-08 07:57:15 -04:00
contrib Remove support for the -module-depth flag 2018-11-02 18:44:04 +01:00
dag terraform: ugly huge change to weave in new HCL2-oriented types 2018-10-16 18:46:46 -07:00
digraph Fix TestWriteDot random order error 2014-07-29 10:26:50 -07:00
docs vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
e2e Standardise directory name for test data 2019-06-30 10:16:15 +02:00
examples Fix Google Cloud Platform name across docs. 2019-01-15 12:10:20 -08:00
flatmap prune references to config/module 2019-08-07 17:50:59 -04:00
helper vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
httpclient Merge pull request #22272 from hashicorp/f-httpclient-ua 2019-08-12 20:20:03 +01:00
internal backend/remote-state: etcdv3, oss, and manta acc tests should fail 2019-09-27 08:45:12 -04:00
lang Merge pull request #22846 from hashicorp/jbardin/evaluate-resource 2019-10-08 07:57:15 -04:00
moduledeps plugin/discovery: PluginRequirements can specify SHA256 digests 2017-06-09 14:03:59 -07:00
plans Regenerate protobuf files under latest versions 2019-09-05 14:36:15 +02:00
plugin plugin/discovery: use new addrs.ProviderType in place of a provider typeName string (#22724) 2019-09-09 16:59:50 -04:00
providers send and receive Private through ReadResource 2019-06-03 18:08:26 -04:00
provisioners provisioners: Add Factory type and FactoryFixed helper 2018-10-16 19:14:11 -07:00
registry registry/response: Remove unused verified bool 2019-08-07 12:33:51 -04:00
repl vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
scripts make: Add check for protobuf dependencies 2019-09-05 14:30:54 +02:00
state Merge pull request #20571 from sergkondr/fix_misspelling 2019-08-13 17:13:13 -04:00
states Fix copy-paste errors in test data 2019-08-21 11:45:06 +01:00
svchost svchost/disco: Disco.CredentialsSource 2019-08-30 10:57:17 -07:00
terraform Merge pull request #22846 from hashicorp/jbardin/evaluate-resource 2019-10-08 07:57:15 -04:00
tfdiags vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
tools tools/terraform-bundle: update e2e tests with current tf and provider 2019-09-25 14:55:26 -04:00
vendor vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
version Cleanup after v0.12.10 release 2019-10-07 16:23:38 +00:00
website website / help: reconcile 'validate' command docs 2019-10-03 15:31:33 -07:00
.gitignore Standardise directory name for test data 2019-06-30 10:16:15 +02:00
.go-version build: Use Go 1.12.9 2019-08-16 16:29:43 -07:00
.hashibot.hcl apply special label for PRs affecting sdk paths 2019-09-06 15:22:43 -04:00
.tfdev .tfdev: remove platform build constraint 2019-08-09 15:10:52 -07:00
.travis.yml build: Use the official Go module proxy for Travis-CI runs (#22711) 2019-09-06 15:45:31 -04:00
BUILDING.md remove references to vagrant file 2019-06-26 19:41:08 -07:00
CHANGELOG.md Update CHANGELOG.md 2019-10-07 16:07:31 -04:00
checkpoint.go fixing version numbers RCs should be labeled x.x.x-rcx 2015-02-07 16:56:56 +01:00
CODEOWNERS First pass at adding CODEOWNERS to link remote-state backends with maintainers of the associated providers. 2019-02-11 15:52:19 -08:00
commands.go main: use cliconfig.ConfigDir instead of just ConfigDir 2019-09-09 11:15:24 -07:00
config.go command/cliconfig: Factor out CLI config handling 2019-08-01 10:56:41 -07:00
Dockerfile build: Stop using deprecated MAINTAINER in Dockerfile 2017-10-27 17:25:44 -07:00
go.mod vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
go.sum vendor: switch to HCL 2.0 in the HCL repository 2019-10-02 15:10:21 -07:00
help.go help: Make version and help flags consistent 2018-08-01 14:28:39 -07:00
LICENSE Adding license 2014-07-28 13:54:06 -04:00
main_test.go main: make configuration available when initializing commands 2017-09-29 14:03:09 -07:00
main.go command/login: Use Cli.Ask to request confirmation 2019-09-09 11:15:24 -07:00
Makefile build/Makefile: Properly exclude files under "./vendor/" path for go fmt (#19097) 2019-09-06 08:58:34 -04: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 keep .terraform.d/plugins for discovery 2017-08-09 17:46:49 -04:00
README.md website/contributing: update contribution documentation (#22883) 2019-09-23 16:21:46 -04: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 states/statemgr: Fix the Filesystem state manager tests 2018-11-19 09:02:35 -08:00

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

If you're new to Terraform and want to get started creating infrastructure, please checkout our Getting Started guide, available on the Terraform website.

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.11+ is required).

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 on GitHub. Instructions for developing each provider are in the associated README file. For more information, see the provider development overview.

For local development of Terraform core, first make sure Go is properly installed and that a GOPATH has been set. You will also need to add $GOPATH/bin to your $PATH.

Next, using Git, clone this repository into $GOPATH/src/github.com/hashicorp/terraform.

You'll need to run make tools to install some required tools, then make. This will compile the code and then run the tests. If this exits with exit status 0, then everything is working! You only need to run make tools once (or when the tools change).

$ cd "$GOPATH/src/github.com/hashicorp/terraform"
$ make tools
$ 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, only terraform package tests will be run.

$ make test TEST=./terraform
...

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:

$ make plugin-dev PLUGIN=provider-test

Dependencies

Terraform uses Go Modules for dependency management, but for the moment is continuing to use Go 1.6-style vendoring for compatibility with tools that have not yet been updated for full Go Modules support.

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 an import statement to a suitable package in the Terraform code.

  2. Run go mod vendor to download the latest version of the module containing the imported package into the vendor/ directory, and update the go.mod and go.sum files.

  3. Review the changes in git and commit them.

Updating a dependency

To update a dependency:

  1. Run go get -u module-path@version-number, such as go get -u github.com/hashicorp/hcl@2.0.0

  2. Run go mod vendor to update the vendored copy in the vendor/ directory.

  3. Review the changes in git and commit them.

Acceptance Tests

Terraform has a comprehensive acceptance test suite covering the built-in providers.

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 install the required tools and 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 tools bin"

License

Mozilla Public License v2.0