Go to file
Alisdair McDiarmid c5a6aa31d3 cli: Add initial command views abstraction
Terraform supports multiple output formats for several sub-commands.
The default format is user-readable text, but many sub-commands support
a `-json` flag to output a machine-readable format for the result. The
output command also supports a `-raw` flag for a simpler, scripting-
focused machine readable format.

This commit adds a "views" abstraction, intended to help ensure
consistency between the various output formats. This extracts the render
specific code from the command package, and moves it into a views
package. Each command is expected to create an interface for its view,
and one or more implementations of that interface.

By doing so, we separate the concerns of generating the sub-command
result from rendering the result in the specified output format. This
should make it easier to ensure that all output formats will be updated
together when changes occur in the result-generating phase.

There are some other consequences of this restructuring:

- Views now directly access the terminal streams, rather than the
  now-redundant cli.Ui instance;
- With the reorganization of commands, parsing CLI arguments is now the
  responsibility of a separate "arguments" package.

For now, views are added only for the output sub-command, as an example.
Because this command uses code which is shared with the apply and
refresh commands, those are also partially updated.
2021-02-11 15:06:39 -05:00
.circleci CI: Add broken link checking job for website content 2021-01-13 15:09:41 -08:00
.github Grammar nit: "setup" as a verb should be spelled "set up" 2021-01-26 20:39:11 +01:00
addrs fix break from switch in loop 2020-12-02 13:59:19 -05:00
backend only print horizontal rule at first attempt 2021-02-10 20:47:50 -05:00
builtin Grammar nit: "setup" as a verb should be spelled "set up" 2021-01-26 20:39:11 +01:00
command cli: Add initial command views abstraction 2021-02-11 15:06:39 -05:00
communicator Grammar nit: "setup" as a verb should be spelled "set up" 2021-01-26 20:39:11 +01:00
configs Block.AttribuuteByPath 2021-01-12 16:31:18 -05:00
dag Grammar nit: "setup" as a verb should be spelled "set up" 2021-01-26 20:39:11 +01:00
docs Update links to CLI docs in code comments, messages, and readme 2021-01-22 12:22:21 -08:00
e2e command/cliconfig: Allow development overrides for providers 2020-10-16 14:31:15 -07:00
experiments Add provider sensitivity propagation experiment 2020-10-26 15:05:22 -04:00
httpclient Merge pull request #22272 from hashicorp/f-httpclient-ua 2019-08-12 20:20:03 +01:00
instances instances: staticcheck 2020-12-02 13:59:19 -05:00
internal terminal: StreamsForTesting helper 2021-02-10 11:51:56 -08:00
lang lang: Improved robustness of sum function 2020-12-10 17:13:56 -05:00
moduledeps remove LegacyProvider (#26433) 2020-10-05 08:33:49 -04:00
plans Unmark before ElementIterator in couldHaveUnknownBlockPlaceholder 2021-01-29 17:06:12 -05:00
plugin don't use legacy import for the UIInput interface 2020-12-02 15:44:58 -05:00
providers udpate PrepareProviderConfig docs 2020-11-04 13:02:04 -05:00
provisioners provisioners: Add Factory type and FactoryFixed helper 2018-10-16 19:14:11 -07:00
registry registry: staticcheck 2020-12-02 13:59:19 -05:00
repl update MockProvider usage 2021-01-12 17:47:55 -05:00
scripts Remove revision from version command 2021-01-12 16:35:30 -05:00
states states/statefile: staticcheck 2020-12-02 13:59:19 -05:00
terraform removed orphaned data sources from the state 2021-01-28 16:35:21 -05:00
tfdiags consistent reciever names 2020-12-02 13:59:18 -05:00
tools correct terraform-bundle default plugins dir docs (#26965) 2020-12-15 13:52:31 -05:00
version Cleanup after v0.15.0-alpha20210210 release 2021-02-10 18:00:31 +00:00
website Merge pull request #27708 from philipsahli/patch-1 2021-02-09 11:14:16 -05:00
.gitignore Coverage 2020-03-03 13:01:05 -05:00
.go-version update to go1.15.2 2020-09-23 15:18:22 -04:00
.hashibot.hcl Restore issue migrator 2020-10-09 15:41:15 -04:00
.tfdev Remove revision from version command 2021-01-12 16:35:30 -05:00
BUGPROCESS.md Update BUGPROCESS.md 2020-12-10 12:15:39 -05:00
CHANGELOG.md Update CHANGELOG.md 2021-02-04 10:16:31 -05:00
CODEOWNERS Updating codeowners with our deprecated status for tool-specific provisioners 2020-09-29 14:19:56 -04:00
Dockerfile switch to hashicorp docker mirror 2020-10-29 22:37:11 -04:00
LICENSE Adding license 2014-07-28 13:54:06 -04:00
Makefile Remove website-test task from Makefile 2021-01-13 17:35:54 -08:00
README.md Update links to CLI docs in code comments, messages, and readme 2021-01-22 12:22:21 -08:00
checkpoint.go Remove config.go and update things using its aliases 2020-01-13 16:50:05 -05:00
codecov.yml build: Set Codecov to informational mode again 2020-10-23 15:58:33 -04:00
commands.go cli: Add initial command views abstraction 2021-02-11 15:06:39 -05:00
go.mod deps: Bump github.com/aws/aws-sdk-go@v1.37.0 2021-01-28 15:22:01 -05:00
go.sum deps: Bump github.com/aws/aws-sdk-go@v1.37.0 2021-01-28 15:22:01 -05:00
help.go Update links to CLI docs in code comments, messages, and readme 2021-01-22 12:22:21 -08:00
main.go Grammar nit: "setup" as a verb should be spelled "set up" 2021-01-26 20:39:11 +01:00
main_test.go Grammar nit: "setup" as a verb should be spelled "set up" 2021-01-26 20:39:11 +01:00
plugins.go Remove config.go and update things using its aliases 2020-01-13 16:50:05 -05:00
provider_source.go command/cliconfig: Allow development overrides for providers 2020-10-16 14:31:15 -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
version.go Remove revision from version command 2021-01-12 16:35:30 -05: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

Documentation is available on the Terraform website:

If you're new to Terraform and want to get started creating infrastructure, please check out our Getting Started guides on HashiCorp's learning platform. There are also additional guides to continue your learning.

Show off your Terraform knowledge by passing a certification exam. Visit the certification page for information about exams and find study materials on HashiCorp's learning platform.

Developing Terraform

This repository contains only Terraform core, which includes the command line interface and the main graph engine. Providers are implemented as plugins, and Terraform can automatically download providers that are published on the Terraform Registry. HashiCorp develops some providers, and others are developed by other organizations. For more information, see Extending Terraform.

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

To learn more about how we handle bug reports, please read the bug triage guide.

License

Mozilla Public License v2.0