Merge pull request #27758 from hashicorp/jbardin/configuration_aliases-docs

update docs for configuration_aliases

website/docs/language/meta-arguments/module-providers.html.md

@@ -36,7 +36,8 @@ module "example" {
 
 ## Default Behavior: Inherit Default Providers
 
-The `providers` argument is optional. If you omit it, a child module inherits
+If the child module does not declare any [configuration aliases](/docs/language/modules/develop/providers.html#provider-aliases-within-modules),
+the `providers` argument is optional. If you omit it, a child module inherits
 all of the _default_ provider configurations from its parent module. (Default
 provider configurations are ones that don't use the `alias` argument.)
 

website/docs/language/modules/develop/providers.html.md

@@ -22,18 +22,9 @@ within a `module` block. These two options are discussed in more detail in the
 following sections.
 
 A module intended to be called by one or more other modules must not contain
-any `provider` blocks, with the exception of the special
+any `provider` blocks. A module containing its own provider configurations is
-"proxy provider blocks" discussed under
+not compatible with the `for_each`, `count`, and `depends_on` arguments that
-_[Passing Providers Explicitly](#passing-providers-explicitly)_
+were introduced in Terraform v0.13. For more information, see
-below.
-
-For backward compatibility with configurations targeting Terraform v0.10 and
-earlier Terraform does not produce an error for a `provider` block in a shared
-module if the `module` block only uses features available in Terraform v0.10,
-but that is a legacy usage pattern that is no longer recommended. A legacy
-module containing its own provider configurations is not compatible with the
-`for_each`, `count`, and `depends_on` arguments that were introduced in
-Terraform v0.13. For more information, see
 [Legacy Shared Modules with Provider Configurations](#legacy-shared-modules-with-provider-configurations).
 
 Provider configurations are used for all operations on associated resources,
@@ -82,6 +73,27 @@ settings come from provider _configurations_, and a particular overall Terraform
 configuration can potentially have
 [several different configurations for the same provider](/docs/language/providers/configuration.html#alias-multiple-provider-configurations).
 
+## Provider Aliases Within Modules
+
+To declare multiple configuration names for a provider within a module, add the
+`configuration_aliases` argument:
+
+```hcl
+terraform {
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 2.7.0"
+      configuration_aliases = [ aws.alternate ]
+    }
+  }
+}
+```
+
+The above requirements are identical to the previous, with the addition of the
+alias provider configuration name `aws.alternate`, which can be referenced by
+resources using the `provider` argument.
+
 If you are writing a shared Terraform module, constrain only the minimum
 required provider version using a `>=` constraint. This should specify the
 minimum version containing the features your module relies on, and thus allow a
@@ -201,17 +213,18 @@ module "tunnel" {
 }
 ```
 
-The subdirectory `./tunnel` must then contain _proxy configuration blocks_ like
+The subdirectory `./tunnel` must then declare the configuration aliases for the
-the following, to declare that it requires its calling module to pass
+provider so the calling module can pass configurations with these names in its `providers` argument:
-configurations with these names in its `providers` argument:
 
 ```hcl
-provider "aws" {
+terraform {
-  alias = "src"
+  required_providers {
-}
+    aws = {
-
+      source  = "hashicorp/aws"
-provider "aws" {
+      version = ">= 2.7.0"
-  alias = "dst"
+      configuration_aliases = [ aws.src, aws.dest ]
+    }
+  }
 }
 ```
 
@@ -219,20 +232,6 @@ Each resource should then have its own `provider` attribute set to either
 `aws.src` or `aws.dst` to choose which of the two provider configurations to
 use.
 
-## Proxy Configuration Blocks
-
-A proxy configuration block is one that contains only the `alias` argument. It
-serves as a placeholder for provider configurations passed between modules, and
-declares that a module expects to be explicitly passed an additional (aliased)
-provider configuration.
-
--> **Note:** Although a completely empty proxy configuration block is also
-valid, it is not necessary: proxy configuration blocks are needed only to
-establish which _aliased_ provider configurations a child module expects.
-Don't use a proxy configuration block if a module only needs a single default
-provider configuration, and don't use proxy configuration blocks only to imply
-[provider requirements](/docs/language/providers/requirements.html).
-
 ## Legacy Shared Modules with Provider Configurations
 
 In Terraform v0.10 and earlier there was no explicit way to use different
@@ -282,13 +281,10 @@ its provider configurations from the calling module, by using the "providers"
 argument in the calling module block.
 ```
 
-To make a module compatible with the new features, you must either remove all
+To make a module compatible with the new features, you must remove all of the
-of the `provider` blocks from its definition or, if you need multiple
+`provider` blocks from its definition.
-configurations for the same provider, replace them with
-_proxy configuration blocks_ as described in
-[Passing Providers Explicitly](#passing-providers-explicitly).
 
-If the new version of the module uses proxy configuration blocks, or if the
+If the new version of the module declares `configuration_aliases`, or if the
 calling module needs the child module to use different provider configurations
 than its own default provider configurations, the calling module must then
 include an explicit `providers` argument to describe which provider

website/docs/language/providers/configuration.html.md

@@ -103,6 +103,24 @@ provider "aws" {
 }
 ```
 
+To declare a configuration alias within a module in order to receive an
+alternate provider configuration from the parent module, add the
+`configuration_aliases` argument to that provider's `required_providers`
+entry. The following example declares both the `mycloud` and
+`mycloud.alternate` provider configuration names within the containing module:
+
+```hcl
+terraform {
+  required_providers {
+    mycloud = {
+      source  = "mycorp/mycloud"
+      version = "~> 1.0"
+      configuration_aliases = [ mycloud.alternate ]
+    }
+  }
+}
+```
+
 ### Default Provider Configurations
 
 A `provider` block without an `alias` argument is the _default_ configuration