Go to file
Martin Atkins 1879a39d2d configs: Refined error messages for mismatched provider passing
This set of diagnostic messages is under a number of unusual constraints
that make them tough to get right:
 - They are discussing a couple finicky concepts which authors are
   likely to be encountering for the first time in these error messages:
   the idea of "local names" for providers, the relationship between those
   and provider source addresses, and additional ("aliased") provider
   configurations.
 - They are reporting concerns that span across a module call boundary,
   and so need to take care to be clear about whether they are talking
   about a problem in the caller or a problem in the callee.
 - Some of them are effectively deprecation warnings for features that
   might be in use by a third-party module that the user doesn't control,
   in which case they have no recourse to address them aside from opening
   a feature request with the upstream module maintainer.
 - Terraform has, for backward-compatibility reasons, a lot of implied
   default behaviors regarding providers and provider configurations,
   and these errors can arise in situations where Terraform's assumptions
   don't match the author's intent, and so we need to be careful to
   explain what Terraform assumed in order to make the messages
   understandable.

After seeing some confusion with these messages in the community, and
being somewhat confused by some of them myself, I decided to try to edit
them a bit for consistency of terminology (both between the messages and
with terminology in our docs), being explicit about caller vs. callee
by naming them in the messages, and making explicit what would otherwise
be implicit with regard to the correspondences between provider source
addresses and local names.

My assumed audience for all of these messages is the author of the caller
module, because it's the caller who is responsible for creating the
relationship between caller and callee. As much as possible I tried to
make the messages include specific actions for that author to take to
quiet the warning or fix the error, but some of the warnings are only
fixable by the callee's maintainer and so those messages are, in effect,
a suggestion to send a request to the author to stop using a deprecated
feature.

I think these new messages are also not ideal by any means, because it's
just tough to pack so much information into concise messages while being
clear and consistent, but I hope at least this will give users seeing
these messages enough context to infer what's going on, possibly with the
help of our documentation.

I intentionally didn't change which cases Terraform will return warnings
or errors -- only the message texts -- although I did highlight in a
comment in one of the tests that what it is a asserting seems a bit
suspicious to me. I don't intend to address that here; instead, I intend
that note to be something to refer to if we later see a bug report that
calls that behavior into question.

This does actually silence some _unrelated_ warnings and errors in cases
where a provider block has an invalid provider local name as its label,
because our other functions for dealing with provider addresses are
written to panic if given invalid addresses under the assumption that
earlier code will have guarded against that. Doing this allowed for the
provider configuration validation logic to safely include more information
about the configuration as helpful context, without risking tripping over
known-invalid configuration and panicking in the process.
2022-03-10 10:05:56 -08:00
.circleci build: Remove broken website link check job 2022-01-24 16:57:16 -05:00
.github Merge pull request #30017 from RubyElders/internal-contributing-docs 2022-02-07 14:23:52 -05:00
docs Introduce Terraform Plugin Protocol 6.2 with legacy_type_system fields from Protocol 5 (#30375) 2022-01-20 09:57:42 -05:00
internal configs: Refined error messages for mismatched provider passing 2022-03-10 10:05:56 -08:00
scripts no need for TF_FORK=0 2021-10-28 11:51:39 -04:00
tools build: Add exhaustive switch statement lint 2021-09-24 15:12:44 -04:00
version main: Report version information for "interesting" dependencies 2021-11-05 16:47:38 -07:00
website website: Update docs for check rule error messages 2022-03-04 15:39:31 -05:00
.gitignore Remove several ignore rules 2021-09-01 14:37:26 -05:00
.go-version update to go1.17.2 2021-10-08 15:54:02 -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 2022-03-07 12:12:28 -05:00
CODEOWNERS etcdv3 backend is unmaintained 2021-07-20 13:59:08 -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 update make website workflow 2021-12-16 16:10:17 -08:00
README.md fix broken logo in readme (#29705) 2021-10-05 16:31:02 -04:00
checkpoint.go Move command/ to internal/command/ 2021-05-17 14:09:07 -07:00
codecov.yml update to match new default branch name (#27909) 2021-02-24 13:36:47 -05:00
commands.go command: Remove the experimental "terraform add" command 2021-10-20 06:42:47 -07:00
go.mod Merge pull request #30602 from hashicorp/barrettclark/update-go-slug 2022-03-02 11:02:23 -06:00
go.sum Merge pull request #30602 from hashicorp/barrettclark/update-go-slug 2022-03-02 11:02:23 -06:00
help.go Improve the help.go docs: typo and a more explicit comment. 2022-01-24 10:52:37 +00:00
main.go main: Report version information for "interesting" dependencies 2021-11-05 16:47:38 -07:00
main_test.go remove the use of panicwrap 2021-10-28 11:51:39 -04:00
plugins.go Move command/ to internal/command/ 2021-05-17 14:09:07 -07:00
provider_source.go Move command/ to internal/command/ 2021-05-17 14:09:07 -07:00
signal_unix.go Upgrade to Go 1.17 2021-08-17 15:20:05 -07:00
signal_windows.go Upgrade to Go 1.17 2021-08-17 15:20:05 -07:00
version.go Remove revision from version command 2021-01-12 16:35:30 -05:00
working_dir.go workdir: Start of a new package for working directory state management 2021-09-10 14:56:49 -07: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