Go to file
Martin Atkins f96edbb113 Revise our contributing/development documentation
Our documentation for how to contribute was in quite a state of disrepair,
with some documents still describing things as they were before moving
providers into separate repositories, others making assumptions about
Go development that are no longer true in modules mode, and so forth.

This is an attempt at a reset to a good state that should work with the
codebase as it currently stands, and should hopefully serve as a basis
for iterative improvement from here.

These new instructions lean primarily on standard Go toolchain usage and
instruct using the Makefile only for some Terraform-specific situations
that the Go toolchain does not automatically handle. The idea here is that
this direct usage of primary commands in the Go toolchain is less likely
to be broken by changes in future Go releases, and should be immediately
familiar to anyone who has experience with Go development.
2019-10-15 08:39:36 -07:00
.github Revise our contributing/development documentation 2019-10-15 08:39:36 -07:00
addrs Merge pull request #22846 from hashicorp/jbardin/evaluate-resource 2019-10-08 07:57:15 -04:00
backend backend: Allow certain commands to opt out of required variable checks 2019-10-10 10:07:01 -07:00
builtin Merge pull request #22705 from kmott/habitat-provisioner-updates 2019-10-01 14:27:52 -04:00
command command/validate: warn if unused flags are set on the command line (#22989) 2019-10-14 15:35:33 -04: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 backend/local: Handle interactive prompts for variables in UI layer 2019-10-10 10:07:01 -07: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 backend/local: Handle interactive prompts for variables in UI layer 2019-10-10 10:07:01 -07: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 deps: github.com/hashicorp/aws-sdk-go-base@v0.4.0 (#22994) 2019-10-11 12:50:12 -04:00
version Cleanup after v0.12.10 release 2019-10-07 16:23:38 +00:00
website website: Full examples for for_each with flatten and setproduct 2019-10-11 13:41:58 -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 Revise our contributing/development documentation 2019-10-15 08:39:36 -07:00
CHANGELOG.md Update CHANGELOG.md 2019-10-11 13:02:16 -04: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
Dockerfile build: Stop using deprecated MAINTAINER in Dockerfile 2017-10-27 17:25:44 -07:00
LICENSE Adding license 2014-07-28 13:54:06 -04:00
Makefile build/Makefile: Properly exclude files under "./vendor/" path for `go fmt` (#19097) 2019-09-06 08:58:34 -04:00
README.md Revise our contributing/development documentation 2019-10-15 08:39:36 -07:00
checkpoint.go fixing version numbers RCs should be labeled x.x.x-rcx 2015-02-07 16:56:56 +01: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
go.mod deps: github.com/hashicorp/aws-sdk-go-base@v0.4.0 (#22994) 2019-10-11 12:50:12 -04:00
go.sum deps: github.com/hashicorp/aws-sdk-go-base@v0.4.0 (#22994) 2019-10-11 12:50:12 -04:00
help.go help: Make version and help flags consistent 2018-08-01 14:28:39 -07:00
main.go command/login: Use Cli.Ask to request confirmation 2019-09-09 11:15:24 -07:00
main_test.go main: make configuration available when initializing commands 2017-09-29 14:03:09 -07: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
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

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

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

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.

To learn more about compiling Terraform and contributing suggested changes, please refer to the contributing guide.

License

Mozilla Public License v2.0