Go to file
Martin Atkins 140c613ae8 lang/funcs: "one" function
In the Terraform language we typically use lists of zero or one values in
some sense interchangably with single values that might be null, because
various Terraform language constructs are designed to work with
collections rather than with nullable values.

In Terraform v0.12 we made the splat operator [*] have a "special power"
of concisely converting from a possibly-null single value into a
zero-or-one list as a way to make that common operation more concise.

In a sense this "one" function is the opposite operation to that special
power: it goes from a zero-or-one collection (list, set, or tuple) to a
possibly-null single value.

This is a concise alternative to the following clunky conditional
expression, with the additional benefit that the following expression is
also not viable for set values, and it also properly handles the case
where there's unexpectedly more than one value:

    length(var.foo) != 0 ? var.foo[0] : null

Instead, we can write:

    one(var.foo)

As with the splat operator, this is a tricky tradeoff because it could be
argued that it's not something that'd be immediately intuitive to someone
unfamiliar with Terraform. However, I think that's justified given how
often zero-or-one collections arise in typical Terraform configurations.
Unlike the splat operator, it should at least be easier to search for its
name and find its documentation the first time you see it in a
configuration.

My expectation that this will become a common pattern is also my
justification for giving it a short, concise name. Arguably it could be
better named something like "oneornull", but that's a pretty clunky name
and I'm not convinced it really adds any clarity for someone who isn't
already familiar with it.
2021-04-12 15:32:03 -07:00
.circleci remove unsupported platforms from tests 2021-03-30 11:10:03 -04:00
.github update to match new default branch name (#27909) 2021-02-24 13:36:47 -05:00
addrs Improve ModuleInstance String() performance (#28246) 2021-04-05 08:44:27 -04:00
backend call the InConfigBody with addresses 2021-04-06 15:15:52 -04:00
builtin remote provisioners require a connection config 2021-02-24 13:25:58 -05:00
command "with" formatting 2021-04-06 15:50:30 -04:00
communicator Grammar nit: "setup" as a verb should be spelled "set up" 2021-01-26 20:39:11 +01:00
configs terraform: validate providers' schemas during NewContext (#28124) 2021-03-22 13:17:50 -04:00
dag Set Intersection #performance (#28183) 2021-03-24 13:04:37 -04:00
docs update destroying doc to show show more CBD detail 2021-03-23 11:21:43 -04:00
e2e command/cliconfig: Allow development overrides for providers 2020-10-16 14:31:15 -07:00
experiments Conclude provider sensitivity experiment 2021-03-10 12:10:26 -05: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 Accept TF_LOG=json to enable TRACE logs in JSON format 2021-03-16 14:59:15 -07:00
lang lang/funcs: "one" function 2021-04-12 15:32:03 -07:00
moduledeps remove LegacyProvider (#26433) 2020-10-05 08:33:49 -04:00
plans plans/planfile: Add required-replace and sensitive 2021-03-25 14:42:34 -04:00
plugin use WholeContainingBody instead of Sourceless 2021-04-06 15:15:52 -04:00
plugin6 providers.Interface: rename ValidateDataSourceConfig to ValidateDataResourceConfig (#27874) 2021-02-24 12:04:28 -05:00
providers providers.Interface: rename ValidateDataSourceConfig to ValidateDataResourceConfig (#27874) 2021-02-24 12:04:28 -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 Mildwonkey/providers interface renaming (#27805) 2021-02-18 10:13:43 -05:00
scripts Remove revision from version command 2021-01-12 16:35:30 -05:00
states fix ResourceInstanceObject.DeepCopy 2021-03-25 17:39:53 -04:00
terraform lang/funcs: Make nonsensitive more permissive 2021-04-12 12:31:59 -04:00
tfdiags add addresses to diagnostics 2021-04-06 15:15:52 -04:00
tools terraform-bundle: return an error if "versions" argument is omitted (#28158) 2021-03-22 10:51:03 -04:00
version Cleanup after v0.15.0-alpha20210210 release 2021-02-10 18:00:31 +00:00
website lang/funcs: "one" function 2021-04-12 15:32:03 -07:00
.gitignore ignoring the vendor folder 2020-10-27 19:07:32 +01:00
.go-version build: Use Go 1.16.2 2021-03-17 10:27:37 -07: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-24 10:09:08 -08: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 to match new default branch name (#27909) 2021-02-24 13:36:47 -05:00
checkpoint.go Remove config.go and update things using its aliases 2020-01-13 16:50:05 -05:00
codecov.yml update to match new default branch name (#27909) 2021-02-24 13:36:47 -05:00
commands.go command: Experimental "terraform test" command 2021-02-22 14:21:45 -08:00
go.mod bump go-getter to 1.5.2 (#28189) 2021-04-05 09:01:47 -04:00
go.sum bump go-getter to 1.5.2 (#28189) 2021-04-05 09:01:47 -04:00
help.go Update links to CLI docs in code comments, messages, and readme 2021-01-22 12:22:21 -08:00
main.go don't error when processing autocomplete commands 2021-03-31 13:28:08 -04:00
main_test.go don't error when processing autocomplete commands 2021-03-31 13:28:08 -04:00
plugins.go Remove config.go and update things using its aliases 2020-01-13 16:50:05 -05:00
provider_source.go Correct the spelling of heirarchy/hierarchy throughout 2021-02-05 15:07:04 +00: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