From 22d7c11d8a74f55d67d650ec783a2478bdc57266 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Fri, 15 Jan 2021 14:28:57 -0800 Subject: [PATCH 01/13] website: Language: Remove the "this is 0.12+" message from language docs The sun has set on 0.11, so the value of maintaining this message on nearly every page has crashed to almost zero. Time to pull it. --- website/docs/configuration/backend.html.md | 4 ---- website/docs/configuration/blocks/modules/syntax.html.md | 4 ---- website/docs/configuration/blocks/resources/syntax.html.md | 4 ---- website/docs/configuration/data-sources.html.md | 4 ---- website/docs/configuration/functions.html.md | 4 ---- website/docs/configuration/functions/abs.html.md | 4 ---- website/docs/configuration/functions/abspath.html.md | 4 ---- website/docs/configuration/functions/base64decode.html.md | 4 ---- website/docs/configuration/functions/base64encode.html.md | 4 ---- website/docs/configuration/functions/base64gzip.html.md | 4 ---- website/docs/configuration/functions/base64sha256.html.md | 4 ---- website/docs/configuration/functions/base64sha512.html.md | 4 ---- website/docs/configuration/functions/basename.html.md | 4 ---- website/docs/configuration/functions/bcrypt.html.md | 4 ---- website/docs/configuration/functions/can.html.md | 4 ---- website/docs/configuration/functions/ceil.html.md | 4 ---- website/docs/configuration/functions/chomp.html.md | 4 ---- website/docs/configuration/functions/chunklist.html.md | 4 ---- website/docs/configuration/functions/cidrhost.html.md | 4 ---- website/docs/configuration/functions/cidrnetmask.html.md | 4 ---- website/docs/configuration/functions/cidrsubnet.html.md | 4 ---- website/docs/configuration/functions/cidrsubnets.html.md | 4 ---- website/docs/configuration/functions/coalesce.html.md | 4 ---- website/docs/configuration/functions/coalescelist.html.md | 4 ---- website/docs/configuration/functions/compact.html.md | 4 ---- website/docs/configuration/functions/concat.html.md | 4 ---- website/docs/configuration/functions/contains.html.md | 4 ---- website/docs/configuration/functions/csvdecode.html.md | 4 ---- website/docs/configuration/functions/dirname.html.md | 4 ---- website/docs/configuration/functions/distinct.html.md | 4 ---- website/docs/configuration/functions/element.html.md | 4 ---- website/docs/configuration/functions/file.html.md | 4 ---- website/docs/configuration/functions/filebase64.html.md | 4 ---- .../docs/configuration/functions/filebase64sha256.html.md | 4 ---- .../docs/configuration/functions/filebase64sha512.html.md | 4 ---- website/docs/configuration/functions/fileexists.html.md | 4 ---- website/docs/configuration/functions/filemd5.html.md | 4 ---- website/docs/configuration/functions/fileset.html.md | 4 ---- website/docs/configuration/functions/filesha1.html.md | 4 ---- website/docs/configuration/functions/filesha256.html.md | 4 ---- website/docs/configuration/functions/filesha512.html.md | 4 ---- website/docs/configuration/functions/flatten.html.md | 4 ---- website/docs/configuration/functions/floor.html.md | 4 ---- website/docs/configuration/functions/format.html.md | 4 ---- website/docs/configuration/functions/formatdate.html.md | 4 ---- website/docs/configuration/functions/formatlist.html.md | 4 ---- website/docs/configuration/functions/indent.html.md | 4 ---- website/docs/configuration/functions/index.html.md | 4 ---- website/docs/configuration/functions/join.html.md | 4 ---- website/docs/configuration/functions/jsondecode.html.md | 4 ---- website/docs/configuration/functions/jsonencode.html.md | 4 ---- website/docs/configuration/functions/keys.html.md | 4 ---- website/docs/configuration/functions/length.html.md | 4 ---- website/docs/configuration/functions/list.html.md | 4 ---- website/docs/configuration/functions/log.html.md | 4 ---- website/docs/configuration/functions/lookup.html.md | 4 ---- website/docs/configuration/functions/lower.html.md | 4 ---- website/docs/configuration/functions/map.html.md | 4 ---- website/docs/configuration/functions/matchkeys.html.md | 4 ---- website/docs/configuration/functions/max.html.md | 4 ---- website/docs/configuration/functions/md5.html.md | 4 ---- website/docs/configuration/functions/merge.html.md | 4 ---- website/docs/configuration/functions/min.html.md | 4 ---- website/docs/configuration/functions/parseint.html.md | 4 ---- website/docs/configuration/functions/pathexpand.html.md | 4 ---- website/docs/configuration/functions/pow.html.md | 4 ---- website/docs/configuration/functions/range.html.md | 4 ---- website/docs/configuration/functions/regex.html.md | 4 ---- website/docs/configuration/functions/regexall.html.md | 4 ---- website/docs/configuration/functions/replace.html.md | 4 ---- website/docs/configuration/functions/reverse.html.md | 4 ---- website/docs/configuration/functions/rsadecrypt.html.md | 4 ---- .../docs/configuration/functions/setintersection.html.md | 4 ---- website/docs/configuration/functions/setproduct.html.md | 4 ---- website/docs/configuration/functions/setsubtract.html.md | 4 ---- website/docs/configuration/functions/setunion.html.md | 4 ---- website/docs/configuration/functions/sha1.html.md | 4 ---- website/docs/configuration/functions/sha256.html.md | 4 ---- website/docs/configuration/functions/sha512.html.md | 4 ---- website/docs/configuration/functions/signum.html.md | 4 ---- website/docs/configuration/functions/slice.html.md | 4 ---- website/docs/configuration/functions/sort.html.md | 4 ---- website/docs/configuration/functions/split.html.md | 4 ---- website/docs/configuration/functions/substr.html.md | 4 ---- website/docs/configuration/functions/sum.html.md | 4 ---- website/docs/configuration/functions/templatefile.html.md | 4 ---- website/docs/configuration/functions/timeadd.html.md | 4 ---- website/docs/configuration/functions/timestamp.html.md | 4 ---- website/docs/configuration/functions/title.html.md | 4 ---- website/docs/configuration/functions/tobool.html.md | 4 ---- website/docs/configuration/functions/tolist.html.md | 4 ---- website/docs/configuration/functions/tomap.html.md | 4 ---- website/docs/configuration/functions/tonumber.html.md | 4 ---- website/docs/configuration/functions/toset.html.md | 4 ---- website/docs/configuration/functions/tostring.html.md | 4 ---- website/docs/configuration/functions/transpose.html.md | 4 ---- website/docs/configuration/functions/trim.html.md | 4 ---- website/docs/configuration/functions/trimprefix.html.md | 4 ---- website/docs/configuration/functions/trimspace.html.md | 4 ---- website/docs/configuration/functions/trimsuffix.html.md | 4 ---- website/docs/configuration/functions/try.html.md | 4 ---- website/docs/configuration/functions/upper.html.md | 4 ---- website/docs/configuration/functions/urlencode.html.md | 4 ---- website/docs/configuration/functions/uuid.html.md | 4 ---- website/docs/configuration/functions/uuidv5.html.md | 4 ---- website/docs/configuration/functions/values.html.md | 4 ---- website/docs/configuration/functions/yamldecode.html.md | 4 ---- website/docs/configuration/functions/yamlencode.html.md | 4 ---- website/docs/configuration/functions/zipmap.html.md | 4 ---- website/docs/configuration/locals.html.md | 4 ---- website/docs/configuration/outputs.html.md | 4 ---- website/docs/configuration/override.html.md | 4 ---- website/docs/configuration/provider-requirements.html.md | 3 +-- website/docs/configuration/providers.html.md | 4 ---- website/docs/configuration/style.html.md | 4 ---- website/docs/configuration/syntax-json.html.md | 5 ----- website/docs/configuration/syntax.html.md | 4 ---- website/docs/configuration/terraform.html.md | 4 ---- website/docs/configuration/types.html.md | 5 ----- website/docs/configuration/variables.html.md | 4 ---- website/docs/modules/composition.html.markdown | 6 ------ 121 files changed, 1 insertion(+), 486 deletions(-) diff --git a/website/docs/configuration/backend.html.md b/website/docs/configuration/backend.html.md index 8d65e469a..9a45ffae0 100644 --- a/website/docs/configuration/backend.html.md +++ b/website/docs/configuration/backend.html.md @@ -5,10 +5,6 @@ page_title: "Backend Configuration - Configuration Language" # Backend Configuration --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Terraform Settings](../configuration-0-11/terraform.html). - Each Terraform configuration can specify a backend, which defines exactly where and how operations are performed, where [state](/docs/state/index.html) diff --git a/website/docs/configuration/blocks/modules/syntax.html.md b/website/docs/configuration/blocks/modules/syntax.html.md index e3d7d72f1..e1f75d264 100644 --- a/website/docs/configuration/blocks/modules/syntax.html.md +++ b/website/docs/configuration/blocks/modules/syntax.html.md @@ -8,10 +8,6 @@ description: |- # Module Blocks --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Modules](/docs/configuration-0-11/modules.html). - > **Hands-on:** Try the [Reuse Configuration with Modules](https://learn.hashicorp.com/collections/terraform/modules?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) collection on HashiCorp Learn. A _module_ is a container for multiple resources that are used together. diff --git a/website/docs/configuration/blocks/resources/syntax.html.md b/website/docs/configuration/blocks/resources/syntax.html.md index 2f74015d1..84dc7b2b3 100644 --- a/website/docs/configuration/blocks/resources/syntax.html.md +++ b/website/docs/configuration/blocks/resources/syntax.html.md @@ -10,10 +10,6 @@ description: |- # Resource Blocks --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Resources](/docs/configuration-0-11/resources.html). - > **Hands-on:** Try the [Terraform: Get Started](https://learn.hashicorp.com/collections/terraform/aws-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) collection on HashiCorp Learn. _Resources_ are the most important element in the Terraform language. diff --git a/website/docs/configuration/data-sources.html.md b/website/docs/configuration/data-sources.html.md index 8cb59014f..18c5dd0f7 100644 --- a/website/docs/configuration/data-sources.html.md +++ b/website/docs/configuration/data-sources.html.md @@ -8,10 +8,6 @@ description: |- # Data Sources --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Data Sources](../configuration-0-11/data-sources.html). - _Data sources_ allow data to be fetched or computed for use elsewhere in Terraform configuration. Use of data sources allows a Terraform configuration to make use of information defined outside of Terraform, diff --git a/website/docs/configuration/functions.html.md b/website/docs/configuration/functions.html.md index 8317bcf64..8c9571093 100644 --- a/website/docs/configuration/functions.html.md +++ b/website/docs/configuration/functions.html.md @@ -9,10 +9,6 @@ description: |- # Built-in Functions --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../configuration-0-11/interpolation.html). - > **Hands-on:** Try the [Perform Dynamic Operations with Functions](https://learn.hashicorp.com/tutorials/terraform/functions?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. The Terraform language includes a number of built-in functions that you can diff --git a/website/docs/configuration/functions/abs.html.md b/website/docs/configuration/functions/abs.html.md index df76e7206..51d3bc01c 100644 --- a/website/docs/configuration/functions/abs.html.md +++ b/website/docs/configuration/functions/abs.html.md @@ -8,10 +8,6 @@ description: |- # `abs` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `abs` returns the absolute value of the given number. In other words, if the number is zero or positive then it is returned as-is, but if it is negative then it is multiplied by -1 to make it positive before returning it. diff --git a/website/docs/configuration/functions/abspath.html.md b/website/docs/configuration/functions/abspath.html.md index 710b57204..3da10ed72 100644 --- a/website/docs/configuration/functions/abspath.html.md +++ b/website/docs/configuration/functions/abspath.html.md @@ -8,10 +8,6 @@ description: |- # `abspath` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `abspath` takes a string containing a filesystem path and converts it to an absolute path. That is, if the path is not absolute, it will be joined with the current working directory. diff --git a/website/docs/configuration/functions/base64decode.html.md b/website/docs/configuration/functions/base64decode.html.md index 7a562aa5e..41feab121 100644 --- a/website/docs/configuration/functions/base64decode.html.md +++ b/website/docs/configuration/functions/base64decode.html.md @@ -8,10 +8,6 @@ description: |- # `base64decode` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `base64decode` takes a string containing a Base64 character sequence and returns the original string. diff --git a/website/docs/configuration/functions/base64encode.html.md b/website/docs/configuration/functions/base64encode.html.md index 9874fcb9d..8a4ddb1c3 100644 --- a/website/docs/configuration/functions/base64encode.html.md +++ b/website/docs/configuration/functions/base64encode.html.md @@ -8,10 +8,6 @@ description: |- # `base64encode` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `base64encode` applies Base64 encoding to a string. Terraform uses the "standard" Base64 alphabet as defined in diff --git a/website/docs/configuration/functions/base64gzip.html.md b/website/docs/configuration/functions/base64gzip.html.md index 35abeb117..f8d103a9d 100644 --- a/website/docs/configuration/functions/base64gzip.html.md +++ b/website/docs/configuration/functions/base64gzip.html.md @@ -9,10 +9,6 @@ description: |- # `base64gzip` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `base64gzip` compresses a string with gzip and then encodes the result in Base64 encoding. diff --git a/website/docs/configuration/functions/base64sha256.html.md b/website/docs/configuration/functions/base64sha256.html.md index 1fd204e9b..1edfc98da 100644 --- a/website/docs/configuration/functions/base64sha256.html.md +++ b/website/docs/configuration/functions/base64sha256.html.md @@ -9,10 +9,6 @@ description: |- # `base64sha256` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `base64sha256` computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()` returns hexadecimal representation. diff --git a/website/docs/configuration/functions/base64sha512.html.md b/website/docs/configuration/functions/base64sha512.html.md index 35a6509f5..87bd52137 100644 --- a/website/docs/configuration/functions/base64sha512.html.md +++ b/website/docs/configuration/functions/base64sha512.html.md @@ -9,10 +9,6 @@ description: |- # `base64sha512` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `base64sha512` computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to `base64encode(sha512("test"))` since `sha512()` returns hexadecimal representation. diff --git a/website/docs/configuration/functions/basename.html.md b/website/docs/configuration/functions/basename.html.md index 87702481c..e7869d642 100644 --- a/website/docs/configuration/functions/basename.html.md +++ b/website/docs/configuration/functions/basename.html.md @@ -9,10 +9,6 @@ description: |- # `basename` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `basename` takes a string containing a filesystem path and removes all except the last portion from it. diff --git a/website/docs/configuration/functions/bcrypt.html.md b/website/docs/configuration/functions/bcrypt.html.md index d8bdafbb9..b1b0eb79a 100644 --- a/website/docs/configuration/functions/bcrypt.html.md +++ b/website/docs/configuration/functions/bcrypt.html.md @@ -9,10 +9,6 @@ description: |- # `bcrypt` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `bcrypt` computes a hash of the given string using the Blowfish cipher, returning a string in [the _Modular Crypt Format_](https://passlib.readthedocs.io/en/stable/modular_crypt_format.html) diff --git a/website/docs/configuration/functions/can.html.md b/website/docs/configuration/functions/can.html.md index d8450f4b8..f3c885db3 100644 --- a/website/docs/configuration/functions/can.html.md +++ b/website/docs/configuration/functions/can.html.md @@ -9,10 +9,6 @@ description: |- # `can` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `can` evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors. diff --git a/website/docs/configuration/functions/ceil.html.md b/website/docs/configuration/functions/ceil.html.md index a10ef4c9e..0b68172ce 100644 --- a/website/docs/configuration/functions/ceil.html.md +++ b/website/docs/configuration/functions/ceil.html.md @@ -9,10 +9,6 @@ description: |- # `ceil` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `ceil` returns the closest whole number that is greater than or equal to the given value, which may be a fraction. diff --git a/website/docs/configuration/functions/chomp.html.md b/website/docs/configuration/functions/chomp.html.md index ee290e4ec..5ea67e81a 100644 --- a/website/docs/configuration/functions/chomp.html.md +++ b/website/docs/configuration/functions/chomp.html.md @@ -8,10 +8,6 @@ description: |- # `chomp` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `chomp` removes newline characters at the end of a string. This can be useful if, for example, the string was read from a file that has diff --git a/website/docs/configuration/functions/chunklist.html.md b/website/docs/configuration/functions/chunklist.html.md index 9e796cc7c..21823ab47 100644 --- a/website/docs/configuration/functions/chunklist.html.md +++ b/website/docs/configuration/functions/chunklist.html.md @@ -9,10 +9,6 @@ description: |- # `chunklist` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `chunklist` splits a single list into fixed-size chunks, returning a list of lists. diff --git a/website/docs/configuration/functions/cidrhost.html.md b/website/docs/configuration/functions/cidrhost.html.md index a8da2fce1..e43540362 100644 --- a/website/docs/configuration/functions/cidrhost.html.md +++ b/website/docs/configuration/functions/cidrhost.html.md @@ -9,10 +9,6 @@ description: |- # `cidrhost` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `cidrhost` calculates a full host IP address for a given host number within a given IP network address prefix. diff --git a/website/docs/configuration/functions/cidrnetmask.html.md b/website/docs/configuration/functions/cidrnetmask.html.md index fd3807606..bb3de4f7b 100644 --- a/website/docs/configuration/functions/cidrnetmask.html.md +++ b/website/docs/configuration/functions/cidrnetmask.html.md @@ -9,10 +9,6 @@ description: |- # `cidrnetmask` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `cidrnetmask` converts an IPv4 address prefix given in CIDR notation into a subnet mask address. diff --git a/website/docs/configuration/functions/cidrsubnet.html.md b/website/docs/configuration/functions/cidrsubnet.html.md index 6b9bf6e7a..e64c894fb 100644 --- a/website/docs/configuration/functions/cidrsubnet.html.md +++ b/website/docs/configuration/functions/cidrsubnet.html.md @@ -9,10 +9,6 @@ description: |- # `cidrsubnet` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `cidrsubnet` calculates a subnet address within given IP network address prefix. ```hcl diff --git a/website/docs/configuration/functions/cidrsubnets.html.md b/website/docs/configuration/functions/cidrsubnets.html.md index 66268f8ff..fde6b4506 100644 --- a/website/docs/configuration/functions/cidrsubnets.html.md +++ b/website/docs/configuration/functions/cidrsubnets.html.md @@ -9,10 +9,6 @@ description: |- # `cidrsubnets` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `cidrsubnets` calculates a sequence of consecutive IP address ranges within a particular CIDR prefix. diff --git a/website/docs/configuration/functions/coalesce.html.md b/website/docs/configuration/functions/coalesce.html.md index d4b409d3c..6458970ee 100644 --- a/website/docs/configuration/functions/coalesce.html.md +++ b/website/docs/configuration/functions/coalesce.html.md @@ -9,10 +9,6 @@ description: |- # `coalesce` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `coalesce` takes any number of arguments and returns the first one that isn't null or an empty string. diff --git a/website/docs/configuration/functions/coalescelist.html.md b/website/docs/configuration/functions/coalescelist.html.md index 15d9f97c2..6508fa31f 100644 --- a/website/docs/configuration/functions/coalescelist.html.md +++ b/website/docs/configuration/functions/coalescelist.html.md @@ -9,10 +9,6 @@ description: |- # `coalescelist` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `coalescelist` takes any number of list arguments and returns the first one that isn't empty. diff --git a/website/docs/configuration/functions/compact.html.md b/website/docs/configuration/functions/compact.html.md index 45f804534..cd2d6379c 100644 --- a/website/docs/configuration/functions/compact.html.md +++ b/website/docs/configuration/functions/compact.html.md @@ -8,10 +8,6 @@ description: |- # `compact` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `compact` takes a list of strings and returns a new list with any empty string elements removed. diff --git a/website/docs/configuration/functions/concat.html.md b/website/docs/configuration/functions/concat.html.md index 5e616c3b2..47ef10ac0 100644 --- a/website/docs/configuration/functions/concat.html.md +++ b/website/docs/configuration/functions/concat.html.md @@ -8,10 +8,6 @@ description: |- # `concat` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `concat` takes two or more lists and combines them into a single list. ## Examples diff --git a/website/docs/configuration/functions/contains.html.md b/website/docs/configuration/functions/contains.html.md index 6fd5eed8a..8ab835eb4 100644 --- a/website/docs/configuration/functions/contains.html.md +++ b/website/docs/configuration/functions/contains.html.md @@ -8,10 +8,6 @@ description: |- # `contains` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `contains` determines whether a given list or set contains a given single value as one of its elements. diff --git a/website/docs/configuration/functions/csvdecode.html.md b/website/docs/configuration/functions/csvdecode.html.md index acd0e50a6..ef06d03cb 100644 --- a/website/docs/configuration/functions/csvdecode.html.md +++ b/website/docs/configuration/functions/csvdecode.html.md @@ -8,10 +8,6 @@ description: |- # `csvdecode` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `csvdecode` decodes a string containing CSV-formatted data and produces a list of maps representing that data. diff --git a/website/docs/configuration/functions/dirname.html.md b/website/docs/configuration/functions/dirname.html.md index 251f4a250..e39150b37 100644 --- a/website/docs/configuration/functions/dirname.html.md +++ b/website/docs/configuration/functions/dirname.html.md @@ -8,10 +8,6 @@ description: |- # `dirname` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `dirname` takes a string containing a filesystem path and removes the last portion from it. diff --git a/website/docs/configuration/functions/distinct.html.md b/website/docs/configuration/functions/distinct.html.md index 9e1635847..fc871471e 100644 --- a/website/docs/configuration/functions/distinct.html.md +++ b/website/docs/configuration/functions/distinct.html.md @@ -8,10 +8,6 @@ description: |- # `distinct` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `distinct` takes a list and returns a new list with any duplicate elements removed. diff --git a/website/docs/configuration/functions/element.html.md b/website/docs/configuration/functions/element.html.md index ba9187e72..f0f6462c6 100644 --- a/website/docs/configuration/functions/element.html.md +++ b/website/docs/configuration/functions/element.html.md @@ -8,10 +8,6 @@ description: |- # `element` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `element` retrieves a single element from a list. ```hcl diff --git a/website/docs/configuration/functions/file.html.md b/website/docs/configuration/functions/file.html.md index dc83b4f1a..48e96afa2 100644 --- a/website/docs/configuration/functions/file.html.md +++ b/website/docs/configuration/functions/file.html.md @@ -9,10 +9,6 @@ description: |- # `file` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `file` reads the contents of a file at the given path and returns them as a string. diff --git a/website/docs/configuration/functions/filebase64.html.md b/website/docs/configuration/functions/filebase64.html.md index ce59e756f..1ae07b4f3 100644 --- a/website/docs/configuration/functions/filebase64.html.md +++ b/website/docs/configuration/functions/filebase64.html.md @@ -9,10 +9,6 @@ description: |- # `filebase64` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `filebase64` reads the contents of a file at the given path and returns them as a base64-encoded string. diff --git a/website/docs/configuration/functions/filebase64sha256.html.md b/website/docs/configuration/functions/filebase64sha256.html.md index f184c3237..cedc5d3eb 100644 --- a/website/docs/configuration/functions/filebase64sha256.html.md +++ b/website/docs/configuration/functions/filebase64sha256.html.md @@ -9,10 +9,6 @@ description: |- # `filebase64sha256` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `filebase64sha256` is a variant of [`base64sha256`](./base64sha256.html) that hashes the contents of a given file rather than a literal string. diff --git a/website/docs/configuration/functions/filebase64sha512.html.md b/website/docs/configuration/functions/filebase64sha512.html.md index a0ce0b2aa..6844050e0 100644 --- a/website/docs/configuration/functions/filebase64sha512.html.md +++ b/website/docs/configuration/functions/filebase64sha512.html.md @@ -9,10 +9,6 @@ description: |- # `filebase64sha512` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `filebase64sha512` is a variant of [`base64sha512`](./base64sha512.html) that hashes the contents of a given file rather than a literal string. diff --git a/website/docs/configuration/functions/fileexists.html.md b/website/docs/configuration/functions/fileexists.html.md index cd8dd764c..019b8e61d 100644 --- a/website/docs/configuration/functions/fileexists.html.md +++ b/website/docs/configuration/functions/fileexists.html.md @@ -8,10 +8,6 @@ description: |- # `fileexists` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `fileexists` determines whether a file exists at a given path. ```hcl diff --git a/website/docs/configuration/functions/filemd5.html.md b/website/docs/configuration/functions/filemd5.html.md index 07d7c0d13..956581767 100644 --- a/website/docs/configuration/functions/filemd5.html.md +++ b/website/docs/configuration/functions/filemd5.html.md @@ -9,10 +9,6 @@ description: |- # `filemd5` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `filemd5` is a variant of [`md5`](./md5.html) that hashes the contents of a given file rather than a literal string. diff --git a/website/docs/configuration/functions/fileset.html.md b/website/docs/configuration/functions/fileset.html.md index 82ac4773d..969efbfce 100644 --- a/website/docs/configuration/functions/fileset.html.md +++ b/website/docs/configuration/functions/fileset.html.md @@ -8,10 +8,6 @@ description: |- # `fileset` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `fileset` enumerates a set of regular file names given a path and pattern. The path is automatically removed from the resulting set of file names and any result still containing path separators always returns forward slash (`/`) as diff --git a/website/docs/configuration/functions/filesha1.html.md b/website/docs/configuration/functions/filesha1.html.md index ef7a890de..a1657638e 100644 --- a/website/docs/configuration/functions/filesha1.html.md +++ b/website/docs/configuration/functions/filesha1.html.md @@ -9,10 +9,6 @@ description: |- # `filesha1` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `filesha1` is a variant of [`sha1`](./sha1.html) that hashes the contents of a given file rather than a literal string. diff --git a/website/docs/configuration/functions/filesha256.html.md b/website/docs/configuration/functions/filesha256.html.md index 02a06adb7..2392b57fa 100644 --- a/website/docs/configuration/functions/filesha256.html.md +++ b/website/docs/configuration/functions/filesha256.html.md @@ -9,10 +9,6 @@ description: |- # `filesha256` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `filesha256` is a variant of [`sha256`](./sha256.html) that hashes the contents of a given file rather than a literal string. diff --git a/website/docs/configuration/functions/filesha512.html.md b/website/docs/configuration/functions/filesha512.html.md index 5021db4c0..9786df3fc 100644 --- a/website/docs/configuration/functions/filesha512.html.md +++ b/website/docs/configuration/functions/filesha512.html.md @@ -9,10 +9,6 @@ description: |- # `filesha512` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `filesha512` is a variant of [`sha512`](./sha512.html) that hashes the contents of a given file rather than a literal string. diff --git a/website/docs/configuration/functions/flatten.html.md b/website/docs/configuration/functions/flatten.html.md index 90da0079c..e2a807d5a 100644 --- a/website/docs/configuration/functions/flatten.html.md +++ b/website/docs/configuration/functions/flatten.html.md @@ -8,10 +8,6 @@ description: |- # `flatten` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `flatten` takes a list and replaces any elements that are lists with a flattened sequence of the list contents. diff --git a/website/docs/configuration/functions/floor.html.md b/website/docs/configuration/functions/floor.html.md index 3d22ecdc5..6a1ea1804 100644 --- a/website/docs/configuration/functions/floor.html.md +++ b/website/docs/configuration/functions/floor.html.md @@ -9,10 +9,6 @@ description: |- # `floor` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `floor` returns the closest whole number that is less than or equal to the given value, which may be a fraction. diff --git a/website/docs/configuration/functions/format.html.md b/website/docs/configuration/functions/format.html.md index d53977963..7fb8c9a8a 100644 --- a/website/docs/configuration/functions/format.html.md +++ b/website/docs/configuration/functions/format.html.md @@ -9,10 +9,6 @@ description: |- # `format` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `format` produces a string by formatting a number of other values according to a specification string. It is similar to the `printf` function in C, and other similar functions in other programming languages. diff --git a/website/docs/configuration/functions/formatdate.html.md b/website/docs/configuration/functions/formatdate.html.md index 65fd6893e..c519b6eff 100644 --- a/website/docs/configuration/functions/formatdate.html.md +++ b/website/docs/configuration/functions/formatdate.html.md @@ -8,10 +8,6 @@ description: |- # `formatdate` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `formatdate` converts a timestamp into a different time format. ```hcl diff --git a/website/docs/configuration/functions/formatlist.html.md b/website/docs/configuration/functions/formatlist.html.md index a3d68792e..16043611a 100644 --- a/website/docs/configuration/functions/formatlist.html.md +++ b/website/docs/configuration/functions/formatlist.html.md @@ -9,10 +9,6 @@ description: |- # `formatlist` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `formatlist` produces a list of strings by formatting a number of other values according to a specification string. diff --git a/website/docs/configuration/functions/indent.html.md b/website/docs/configuration/functions/indent.html.md index 0c327ae78..40c995075 100644 --- a/website/docs/configuration/functions/indent.html.md +++ b/website/docs/configuration/functions/indent.html.md @@ -9,10 +9,6 @@ description: |- # `indent` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `indent` adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. diff --git a/website/docs/configuration/functions/index.html.md b/website/docs/configuration/functions/index.html.md index 566da83b8..6d8b3eb13 100644 --- a/website/docs/configuration/functions/index.html.md +++ b/website/docs/configuration/functions/index.html.md @@ -8,10 +8,6 @@ description: |- # `index` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `index` finds the element index for a given value in a list. ```hcl diff --git a/website/docs/configuration/functions/join.html.md b/website/docs/configuration/functions/join.html.md index 8c9be78ae..e3c609fb0 100644 --- a/website/docs/configuration/functions/join.html.md +++ b/website/docs/configuration/functions/join.html.md @@ -9,10 +9,6 @@ description: |- # `join` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `join` produces a string by concatenating together all elements of a given list of strings with the given delimiter. diff --git a/website/docs/configuration/functions/jsondecode.html.md b/website/docs/configuration/functions/jsondecode.html.md index b09f42cbb..52927db23 100644 --- a/website/docs/configuration/functions/jsondecode.html.md +++ b/website/docs/configuration/functions/jsondecode.html.md @@ -9,10 +9,6 @@ description: |- # `jsondecode` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `jsondecode` interprets a given string as JSON, returning a representation of the result of decoding that string. diff --git a/website/docs/configuration/functions/jsonencode.html.md b/website/docs/configuration/functions/jsonencode.html.md index 90896acf1..7e8405aba 100644 --- a/website/docs/configuration/functions/jsonencode.html.md +++ b/website/docs/configuration/functions/jsonencode.html.md @@ -8,10 +8,6 @@ description: |- # `jsonencode` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `jsonencode` encodes a given value to a string using JSON syntax. The JSON encoding is defined in [RFC 7159](https://tools.ietf.org/html/rfc7159). diff --git a/website/docs/configuration/functions/keys.html.md b/website/docs/configuration/functions/keys.html.md index 10d25b8cb..46a65e48d 100644 --- a/website/docs/configuration/functions/keys.html.md +++ b/website/docs/configuration/functions/keys.html.md @@ -8,10 +8,6 @@ description: |- # `keys` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `keys` takes a map and returns a list containing the keys from that map. The keys are returned in lexicographical order, ensuring that the result will diff --git a/website/docs/configuration/functions/length.html.md b/website/docs/configuration/functions/length.html.md index abe5dc845..5fd70ddb7 100644 --- a/website/docs/configuration/functions/length.html.md +++ b/website/docs/configuration/functions/length.html.md @@ -8,10 +8,6 @@ description: |- # `length` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `length` determines the length of a given list, map, or string. If given a list or map, the result is the number of elements in that collection. diff --git a/website/docs/configuration/functions/list.html.md b/website/docs/configuration/functions/list.html.md index 3cfafd69a..d6e7e6a91 100644 --- a/website/docs/configuration/functions/list.html.md +++ b/website/docs/configuration/functions/list.html.md @@ -8,10 +8,6 @@ description: |- # `list` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - The `list` function is no longer available. Prior to Terraform v0.12 it was the only available syntax for writing a literal list inside an expression, but Terraform v0.12 introduced a new first-class syntax. diff --git a/website/docs/configuration/functions/log.html.md b/website/docs/configuration/functions/log.html.md index af4a0fb3f..28ade0a7f 100644 --- a/website/docs/configuration/functions/log.html.md +++ b/website/docs/configuration/functions/log.html.md @@ -8,10 +8,6 @@ description: |- # `log` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `log` returns the logarithm of a given number in a given base. ```hcl diff --git a/website/docs/configuration/functions/lookup.html.md b/website/docs/configuration/functions/lookup.html.md index 194c43a01..e41ece732 100644 --- a/website/docs/configuration/functions/lookup.html.md +++ b/website/docs/configuration/functions/lookup.html.md @@ -8,10 +8,6 @@ description: |- # `lookup` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `lookup` retrieves the value of a single element from a map, given its key. If the given key does not exist, the given default value is returned instead. diff --git a/website/docs/configuration/functions/lower.html.md b/website/docs/configuration/functions/lower.html.md index c06034b0f..a767859fd 100644 --- a/website/docs/configuration/functions/lower.html.md +++ b/website/docs/configuration/functions/lower.html.md @@ -8,10 +8,6 @@ description: |- # `lower` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `lower` converts all cased letters in the given string to lowercase. ## Examples diff --git a/website/docs/configuration/functions/map.html.md b/website/docs/configuration/functions/map.html.md index 20b2c905a..118ebba76 100644 --- a/website/docs/configuration/functions/map.html.md +++ b/website/docs/configuration/functions/map.html.md @@ -8,10 +8,6 @@ description: |- # `map` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - The `map` function is no longer available. Prior to Terraform v0.12 it was the only available syntax for writing a literal map inside an expression, but Terraform v0.12 introduced a new first-class syntax. diff --git a/website/docs/configuration/functions/matchkeys.html.md b/website/docs/configuration/functions/matchkeys.html.md index 139d1a04c..390e24a25 100644 --- a/website/docs/configuration/functions/matchkeys.html.md +++ b/website/docs/configuration/functions/matchkeys.html.md @@ -9,10 +9,6 @@ description: |- # `matchkeys` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `matchkeys` constructs a new list by taking a subset of elements from one list whose indexes match the corresponding indexes of values in another list. diff --git a/website/docs/configuration/functions/max.html.md b/website/docs/configuration/functions/max.html.md index d833a22c2..33a458189 100644 --- a/website/docs/configuration/functions/max.html.md +++ b/website/docs/configuration/functions/max.html.md @@ -8,10 +8,6 @@ description: |- # `max` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `max` takes one or more numbers and returns the greatest number from the set. ## Examples diff --git a/website/docs/configuration/functions/md5.html.md b/website/docs/configuration/functions/md5.html.md index 0945ed0ec..67c9330eb 100644 --- a/website/docs/configuration/functions/md5.html.md +++ b/website/docs/configuration/functions/md5.html.md @@ -9,10 +9,6 @@ description: |- # `md5` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `md5` computes the MD5 hash of a given string and encodes it with hexadecimal digits. diff --git a/website/docs/configuration/functions/merge.html.md b/website/docs/configuration/functions/merge.html.md index f67eebe99..d01d551bb 100644 --- a/website/docs/configuration/functions/merge.html.md +++ b/website/docs/configuration/functions/merge.html.md @@ -10,10 +10,6 @@ description: |- # `merge` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `merge` takes an arbitrary number of maps or objects, and returns a single map or object that contains a merged set of elements from all arguments. diff --git a/website/docs/configuration/functions/min.html.md b/website/docs/configuration/functions/min.html.md index c04b576c4..e9712dce1 100644 --- a/website/docs/configuration/functions/min.html.md +++ b/website/docs/configuration/functions/min.html.md @@ -8,10 +8,6 @@ description: |- # `min` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `min` takes one or more numbers and returns the smallest number from the set. ## Examples diff --git a/website/docs/configuration/functions/parseint.html.md b/website/docs/configuration/functions/parseint.html.md index fe280aa1c..f7ca35d55 100644 --- a/website/docs/configuration/functions/parseint.html.md +++ b/website/docs/configuration/functions/parseint.html.md @@ -8,10 +8,6 @@ description: |- # `parseint` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `parseint` parses the given string as a representation of an integer in the specified base and returns the resulting number. The base must be between 2 and 62 inclusive. diff --git a/website/docs/configuration/functions/pathexpand.html.md b/website/docs/configuration/functions/pathexpand.html.md index 173d951ed..d7fccc3b0 100644 --- a/website/docs/configuration/functions/pathexpand.html.md +++ b/website/docs/configuration/functions/pathexpand.html.md @@ -9,10 +9,6 @@ description: |- # `pathexpand` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `pathexpand` takes a filesystem path that might begin with a `~` segment, and if so it replaces that segment with the current user's home directory path. diff --git a/website/docs/configuration/functions/pow.html.md b/website/docs/configuration/functions/pow.html.md index c6b10934a..baf73014b 100644 --- a/website/docs/configuration/functions/pow.html.md +++ b/website/docs/configuration/functions/pow.html.md @@ -8,10 +8,6 @@ description: |- # `pow` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `pow` calculates an exponent, by raising its first argument to the power of the second argument. ## Examples diff --git a/website/docs/configuration/functions/range.html.md b/website/docs/configuration/functions/range.html.md index b3c2532ba..bdb538ec8 100644 --- a/website/docs/configuration/functions/range.html.md +++ b/website/docs/configuration/functions/range.html.md @@ -8,10 +8,6 @@ description: |- # `range` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `range` generates a list of numbers using a start value, a limit value, and a step value. diff --git a/website/docs/configuration/functions/regex.html.md b/website/docs/configuration/functions/regex.html.md index cd7e6e27b..13e9419a9 100644 --- a/website/docs/configuration/functions/regex.html.md +++ b/website/docs/configuration/functions/regex.html.md @@ -9,10 +9,6 @@ description: |- # `regex` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `regex` applies a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) to a string and returns the matching substrings. diff --git a/website/docs/configuration/functions/regexall.html.md b/website/docs/configuration/functions/regexall.html.md index 8561375f2..5b5928d87 100644 --- a/website/docs/configuration/functions/regexall.html.md +++ b/website/docs/configuration/functions/regexall.html.md @@ -8,10 +8,6 @@ description: |- # `regexall` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `regexall` applies a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) to a string and returns a list of all matches. diff --git a/website/docs/configuration/functions/replace.html.md b/website/docs/configuration/functions/replace.html.md index 3781f6188..8475e26ae 100644 --- a/website/docs/configuration/functions/replace.html.md +++ b/website/docs/configuration/functions/replace.html.md @@ -9,10 +9,6 @@ description: |- # `replace` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `replace` searches a given string for another given substring, and replaces each occurrence with a given replacement string. diff --git a/website/docs/configuration/functions/reverse.html.md b/website/docs/configuration/functions/reverse.html.md index 6e7ba2686..deeb3a177 100644 --- a/website/docs/configuration/functions/reverse.html.md +++ b/website/docs/configuration/functions/reverse.html.md @@ -8,10 +8,6 @@ description: |- # `reverse` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `reverse` takes a sequence and produces a new sequence of the same length with all of the same elements as the given sequence but in reverse order. diff --git a/website/docs/configuration/functions/rsadecrypt.html.md b/website/docs/configuration/functions/rsadecrypt.html.md index 9ab4f8751..1cf0b04b4 100644 --- a/website/docs/configuration/functions/rsadecrypt.html.md +++ b/website/docs/configuration/functions/rsadecrypt.html.md @@ -8,10 +8,6 @@ description: |- # `rsadecrypt` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `rsadecrypt` decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext. diff --git a/website/docs/configuration/functions/setintersection.html.md b/website/docs/configuration/functions/setintersection.html.md index aea068e19..c582cc0cf 100644 --- a/website/docs/configuration/functions/setintersection.html.md +++ b/website/docs/configuration/functions/setintersection.html.md @@ -9,10 +9,6 @@ description: |- # `setintersection` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - The `setintersection` function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common. In other words, it computes the diff --git a/website/docs/configuration/functions/setproduct.html.md b/website/docs/configuration/functions/setproduct.html.md index 24010f722..570489be7 100644 --- a/website/docs/configuration/functions/setproduct.html.md +++ b/website/docs/configuration/functions/setproduct.html.md @@ -9,10 +9,6 @@ description: |- # `setproduct` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - The `setproduct` function finds all of the possible combinations of elements from all of the given sets by computing the [Cartesian product](https://en.wikipedia.org/wiki/Cartesian_product). diff --git a/website/docs/configuration/functions/setsubtract.html.md b/website/docs/configuration/functions/setsubtract.html.md index 5fed7f4f6..8b95b203a 100644 --- a/website/docs/configuration/functions/setsubtract.html.md +++ b/website/docs/configuration/functions/setsubtract.html.md @@ -9,10 +9,6 @@ description: |- # `setsubtract` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - The `setsubtract` function returns a new set containing the elements from the first set that are not present in the second set. In other words, it computes the [relative complement](https://en.wikipedia.org/wiki/Complement_(set_theory)#Relative_complement) of the first set in the second set. diff --git a/website/docs/configuration/functions/setunion.html.md b/website/docs/configuration/functions/setunion.html.md index 9816f02a3..2784f5d87 100644 --- a/website/docs/configuration/functions/setunion.html.md +++ b/website/docs/configuration/functions/setunion.html.md @@ -9,10 +9,6 @@ description: |- # `setunion` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - The `setunion` function takes multiple sets and produces a single set containing the elements from all of the given sets. In other words, it computes the [union](https://en.wikipedia.org/wiki/Union_(set_theory)) of diff --git a/website/docs/configuration/functions/sha1.html.md b/website/docs/configuration/functions/sha1.html.md index b2588cd80..3b1b75930 100644 --- a/website/docs/configuration/functions/sha1.html.md +++ b/website/docs/configuration/functions/sha1.html.md @@ -9,10 +9,6 @@ description: |- # `sha1` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `sha1` computes the SHA1 hash of a given string and encodes it with hexadecimal digits. diff --git a/website/docs/configuration/functions/sha256.html.md b/website/docs/configuration/functions/sha256.html.md index f364a9dee..c71157d84 100644 --- a/website/docs/configuration/functions/sha256.html.md +++ b/website/docs/configuration/functions/sha256.html.md @@ -9,10 +9,6 @@ description: |- # `sha256` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `sha256` computes the SHA256 hash of a given string and encodes it with hexadecimal digits. diff --git a/website/docs/configuration/functions/sha512.html.md b/website/docs/configuration/functions/sha512.html.md index 026b1d35f..b36c6bf9c 100644 --- a/website/docs/configuration/functions/sha512.html.md +++ b/website/docs/configuration/functions/sha512.html.md @@ -9,10 +9,6 @@ description: |- # `sha512` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `sha512` computes the SHA512 hash of a given string and encodes it with hexadecimal digits. diff --git a/website/docs/configuration/functions/signum.html.md b/website/docs/configuration/functions/signum.html.md index e778d71cf..e81365880 100644 --- a/website/docs/configuration/functions/signum.html.md +++ b/website/docs/configuration/functions/signum.html.md @@ -8,10 +8,6 @@ description: |- # `signum` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `signum` determines the sign of a number, returning a number between -1 and 1 to represent the sign. diff --git a/website/docs/configuration/functions/slice.html.md b/website/docs/configuration/functions/slice.html.md index 31d2c4dec..d6672386c 100644 --- a/website/docs/configuration/functions/slice.html.md +++ b/website/docs/configuration/functions/slice.html.md @@ -8,10 +8,6 @@ description: |- # `slice` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `slice` extracts some consecutive elements from within a list. ```hcl diff --git a/website/docs/configuration/functions/sort.html.md b/website/docs/configuration/functions/sort.html.md index 26626e085..6e50ae9f4 100644 --- a/website/docs/configuration/functions/sort.html.md +++ b/website/docs/configuration/functions/sort.html.md @@ -9,10 +9,6 @@ description: |- # `sort` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `sort` takes a list of strings and returns a new list with those strings sorted lexicographically. diff --git a/website/docs/configuration/functions/split.html.md b/website/docs/configuration/functions/split.html.md index 037b70247..a777b7b5a 100644 --- a/website/docs/configuration/functions/split.html.md +++ b/website/docs/configuration/functions/split.html.md @@ -9,10 +9,6 @@ description: |- # `split` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `split` produces a list by dividing a given string at all occurrences of a given separator. diff --git a/website/docs/configuration/functions/substr.html.md b/website/docs/configuration/functions/substr.html.md index 7ce782500..21b3bbc31 100644 --- a/website/docs/configuration/functions/substr.html.md +++ b/website/docs/configuration/functions/substr.html.md @@ -9,10 +9,6 @@ description: |- # `substr` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `substr` extracts a substring from a given string by offset and length. ```hcl diff --git a/website/docs/configuration/functions/sum.html.md b/website/docs/configuration/functions/sum.html.md index bb0c20cc4..63c241843 100644 --- a/website/docs/configuration/functions/sum.html.md +++ b/website/docs/configuration/functions/sum.html.md @@ -9,10 +9,6 @@ description: |- # `sum` Function --> **Note:** This page is about Terraform 0.13 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `sum` takes a list or set of numbers and returns the sum of those numbers. diff --git a/website/docs/configuration/functions/templatefile.html.md b/website/docs/configuration/functions/templatefile.html.md index b40929e76..0866cb299 100644 --- a/website/docs/configuration/functions/templatefile.html.md +++ b/website/docs/configuration/functions/templatefile.html.md @@ -9,10 +9,6 @@ description: |- # `templatefile` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `templatefile` reads the file at the given path and renders its content as a template using a supplied set of template variables. diff --git a/website/docs/configuration/functions/timeadd.html.md b/website/docs/configuration/functions/timeadd.html.md index 279724f09..5ba5800d4 100644 --- a/website/docs/configuration/functions/timeadd.html.md +++ b/website/docs/configuration/functions/timeadd.html.md @@ -9,10 +9,6 @@ description: |- # `timeadd` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `timeadd` adds a duration to a timestamp, returning a new timestamp. ```hcl diff --git a/website/docs/configuration/functions/timestamp.html.md b/website/docs/configuration/functions/timestamp.html.md index c17527ae2..45bb526b7 100644 --- a/website/docs/configuration/functions/timestamp.html.md +++ b/website/docs/configuration/functions/timestamp.html.md @@ -9,10 +9,6 @@ description: |- # `timestamp` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `timestamp` returns a UTC timestamp string in [RFC 3339](https://tools.ietf.org/html/rfc3339) format. In the Terraform language, timestamps are conventionally represented as diff --git a/website/docs/configuration/functions/title.html.md b/website/docs/configuration/functions/title.html.md index f13fa501d..fef24ddd4 100644 --- a/website/docs/configuration/functions/title.html.md +++ b/website/docs/configuration/functions/title.html.md @@ -9,10 +9,6 @@ description: |- # `title` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `title` converts the first letter of each word in the given string to uppercase. ## Examples diff --git a/website/docs/configuration/functions/tobool.html.md b/website/docs/configuration/functions/tobool.html.md index 24b98e6f2..4ff160929 100644 --- a/website/docs/configuration/functions/tobool.html.md +++ b/website/docs/configuration/functions/tobool.html.md @@ -8,10 +8,6 @@ description: |- # `tobool` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `tobool` converts its argument to a boolean value. Explicit type conversions are rarely necessary in Terraform because it will diff --git a/website/docs/configuration/functions/tolist.html.md b/website/docs/configuration/functions/tolist.html.md index 291e5c3b4..682a7e538 100644 --- a/website/docs/configuration/functions/tolist.html.md +++ b/website/docs/configuration/functions/tolist.html.md @@ -8,10 +8,6 @@ description: |- # `tolist` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `tolist` converts its argument to a list value. Explicit type conversions are rarely necessary in Terraform because it will diff --git a/website/docs/configuration/functions/tomap.html.md b/website/docs/configuration/functions/tomap.html.md index 9a0362cf7..da28a4d89 100644 --- a/website/docs/configuration/functions/tomap.html.md +++ b/website/docs/configuration/functions/tomap.html.md @@ -8,10 +8,6 @@ description: |- # `tomap` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `tomap` converts its argument to a map value. Explicit type conversions are rarely necessary in Terraform because it will diff --git a/website/docs/configuration/functions/tonumber.html.md b/website/docs/configuration/functions/tonumber.html.md index 60763304e..1b7e0236b 100644 --- a/website/docs/configuration/functions/tonumber.html.md +++ b/website/docs/configuration/functions/tonumber.html.md @@ -8,10 +8,6 @@ description: |- # `tonumber` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `tonumber` converts its argument to a number value. Explicit type conversions are rarely necessary in Terraform because it will diff --git a/website/docs/configuration/functions/toset.html.md b/website/docs/configuration/functions/toset.html.md index 9a48ee0da..0dc2e73c1 100644 --- a/website/docs/configuration/functions/toset.html.md +++ b/website/docs/configuration/functions/toset.html.md @@ -8,10 +8,6 @@ description: |- # `toset` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `toset` converts its argument to a set value. Explicit type conversions are rarely necessary in Terraform because it will diff --git a/website/docs/configuration/functions/tostring.html.md b/website/docs/configuration/functions/tostring.html.md index d0053e6f0..667b3619a 100644 --- a/website/docs/configuration/functions/tostring.html.md +++ b/website/docs/configuration/functions/tostring.html.md @@ -8,10 +8,6 @@ description: |- # `tostring` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `tostring` converts its argument to a string value. Explicit type conversions are rarely necessary in Terraform because it will diff --git a/website/docs/configuration/functions/transpose.html.md b/website/docs/configuration/functions/transpose.html.md index faf9ae964..dde38dac1 100644 --- a/website/docs/configuration/functions/transpose.html.md +++ b/website/docs/configuration/functions/transpose.html.md @@ -9,10 +9,6 @@ description: |- # `transpose` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `transpose` takes a map of lists of strings and swaps the keys and values to produce a new map of lists of strings. diff --git a/website/docs/configuration/functions/trim.html.md b/website/docs/configuration/functions/trim.html.md index 6c2379fa2..43f12f2af 100644 --- a/website/docs/configuration/functions/trim.html.md +++ b/website/docs/configuration/functions/trim.html.md @@ -9,10 +9,6 @@ description: |- # `trim` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `trim` removes the specified characters from the start and end of the given string. diff --git a/website/docs/configuration/functions/trimprefix.html.md b/website/docs/configuration/functions/trimprefix.html.md index 342e458df..e1058ffba 100644 --- a/website/docs/configuration/functions/trimprefix.html.md +++ b/website/docs/configuration/functions/trimprefix.html.md @@ -9,10 +9,6 @@ description: |- # `trimprefix` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `trimprefix` removes the specified prefix from the start of the given string. If the string does not start with the prefix, the string is returned unchanged. ## Examples diff --git a/website/docs/configuration/functions/trimspace.html.md b/website/docs/configuration/functions/trimspace.html.md index b6fdd7cde..b4f1a40df 100644 --- a/website/docs/configuration/functions/trimspace.html.md +++ b/website/docs/configuration/functions/trimspace.html.md @@ -9,10 +9,6 @@ description: |- # `trimspace` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `trimspace` removes any space characters from the start and end of the given string. diff --git a/website/docs/configuration/functions/trimsuffix.html.md b/website/docs/configuration/functions/trimsuffix.html.md index 44f90a5d0..727c31b55 100644 --- a/website/docs/configuration/functions/trimsuffix.html.md +++ b/website/docs/configuration/functions/trimsuffix.html.md @@ -9,10 +9,6 @@ description: |- # `trimsuffix` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `trimsuffix` removes the specified suffix from the end of the given string. ## Examples diff --git a/website/docs/configuration/functions/try.html.md b/website/docs/configuration/functions/try.html.md index e2c25e5e9..d389a066e 100644 --- a/website/docs/configuration/functions/try.html.md +++ b/website/docs/configuration/functions/try.html.md @@ -10,10 +10,6 @@ description: |- # `try` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `try` evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. diff --git a/website/docs/configuration/functions/upper.html.md b/website/docs/configuration/functions/upper.html.md index 65b3c0433..c2fe37579 100644 --- a/website/docs/configuration/functions/upper.html.md +++ b/website/docs/configuration/functions/upper.html.md @@ -8,10 +8,6 @@ description: |- # `upper` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `upper` converts all cased letters in the given string to uppercase. ## Examples diff --git a/website/docs/configuration/functions/urlencode.html.md b/website/docs/configuration/functions/urlencode.html.md index 779f6ff35..d5c396156 100644 --- a/website/docs/configuration/functions/urlencode.html.md +++ b/website/docs/configuration/functions/urlencode.html.md @@ -8,10 +8,6 @@ description: |- # `urlencode` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `urlencode` applies URL encoding to a given string. This function identifies characters in the given string that would have a diff --git a/website/docs/configuration/functions/uuid.html.md b/website/docs/configuration/functions/uuid.html.md index 7ed9ba9bc..4e47d26d0 100644 --- a/website/docs/configuration/functions/uuid.html.md +++ b/website/docs/configuration/functions/uuid.html.md @@ -8,10 +8,6 @@ description: |- # `uuid` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `uuid` generates a unique identifier string. The id is a generated and formatted as required by diff --git a/website/docs/configuration/functions/uuidv5.html.md b/website/docs/configuration/functions/uuidv5.html.md index 69043bfb5..24efce01f 100644 --- a/website/docs/configuration/functions/uuidv5.html.md +++ b/website/docs/configuration/functions/uuidv5.html.md @@ -8,10 +8,6 @@ description: |- # `uuidv5` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `uuidv5` generates a _name-based_ UUID, as described in [RFC 4122 section 4.3](https://tools.ietf.org/html/rfc4122#section-4.3), also known as a "version 5" UUID. diff --git a/website/docs/configuration/functions/values.html.md b/website/docs/configuration/functions/values.html.md index 4de7b5678..4acc3772b 100644 --- a/website/docs/configuration/functions/values.html.md +++ b/website/docs/configuration/functions/values.html.md @@ -8,10 +8,6 @@ description: |- # `values` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `values` takes a map and returns a list containing the values of the elements in that map. diff --git a/website/docs/configuration/functions/yamldecode.html.md b/website/docs/configuration/functions/yamldecode.html.md index 600c6312e..15e447bb3 100644 --- a/website/docs/configuration/functions/yamldecode.html.md +++ b/website/docs/configuration/functions/yamldecode.html.md @@ -9,10 +9,6 @@ description: |- # `yamldecode` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `yamldecode` parses a string as a subset of YAML, and produces a representation of its value. diff --git a/website/docs/configuration/functions/yamlencode.html.md b/website/docs/configuration/functions/yamlencode.html.md index aa128ea22..5e5fc9817 100644 --- a/website/docs/configuration/functions/yamlencode.html.md +++ b/website/docs/configuration/functions/yamlencode.html.md @@ -8,10 +8,6 @@ description: |- # `yamlencode` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `yamlencode` encodes a given value to a string using [YAML 1.2](https://yaml.org/spec/1.2/spec.html) block syntax. diff --git a/website/docs/configuration/functions/zipmap.html.md b/website/docs/configuration/functions/zipmap.html.md index 66457cf0c..d37926f74 100644 --- a/website/docs/configuration/functions/zipmap.html.md +++ b/website/docs/configuration/functions/zipmap.html.md @@ -9,10 +9,6 @@ description: |- # `zipmap` Function --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html). - `zipmap` constructs a map from a list of keys and a corresponding list of values. diff --git a/website/docs/configuration/locals.html.md b/website/docs/configuration/locals.html.md index d77012a32..40d0d6b7d 100644 --- a/website/docs/configuration/locals.html.md +++ b/website/docs/configuration/locals.html.md @@ -9,10 +9,6 @@ description: |- # Local Values --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Local Values](../configuration-0-11/locals.html). - > **Hands-on:** Try the [Simplify Terraform Configuration with Locals](https://learn.hashicorp.com/tutorials/terraform/locals?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. diff --git a/website/docs/configuration/outputs.html.md b/website/docs/configuration/outputs.html.md index 6eeedefdf..3d8a8eece 100644 --- a/website/docs/configuration/outputs.html.md +++ b/website/docs/configuration/outputs.html.md @@ -8,10 +8,6 @@ description: |- # Output Values --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Output Values](../configuration-0-11/outputs.html). - > **Hands-on:** Try the [Output Data From Terraform](https://learn.hashicorp.com/tutorials/terraform/outputs?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. diff --git a/website/docs/configuration/override.html.md b/website/docs/configuration/override.html.md index 2dcea4b26..334aa2eb5 100644 --- a/website/docs/configuration/override.html.md +++ b/website/docs/configuration/override.html.md @@ -9,10 +9,6 @@ description: |- # Override Files --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Override Files](../configuration-0-11/override.html). - Terraform normally loads all of the `.tf` and `.tf.json` files within a directory and expects each one to define a distinct set of configuration objects. If two files attempt to define the same object, Terraform returns diff --git a/website/docs/configuration/provider-requirements.html.md b/website/docs/configuration/provider-requirements.html.md index 40ca196da..0845b1663 100644 --- a/website/docs/configuration/provider-requirements.html.md +++ b/website/docs/configuration/provider-requirements.html.md @@ -7,8 +7,7 @@ page_title: "Provider Requirements - Configuration Language" -> **Note:** This page is about a feature of Terraform 0.13 and later; it also describes how to use the more limited version of that feature that was available -in Terraform 0.12. If you are using Terraform 0.11 or earlier, see -[0.11 Configuration Language: Provider Versions](../configuration-0-11/providers.html#provider-versions) instead. +in Terraform 0.12. Terraform relies on plugins called "providers" to interact with remote systems. diff --git a/website/docs/configuration/providers.html.md b/website/docs/configuration/providers.html.md index a6377a713..3470bfa68 100644 --- a/website/docs/configuration/providers.html.md +++ b/website/docs/configuration/providers.html.md @@ -8,10 +8,6 @@ description: |- # Provider Configuration --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Providers](../configuration-0-11/providers.html). - Terraform relies on plugins called "providers" to interact with remote systems. Terraform configurations must declare which providers they require, so that diff --git a/website/docs/configuration/style.html.md b/website/docs/configuration/style.html.md index 170b35272..c7599bd07 100644 --- a/website/docs/configuration/style.html.md +++ b/website/docs/configuration/style.html.md @@ -10,10 +10,6 @@ description: |- # Style Conventions --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language](../configuration-0-11/index.html). - The Terraform parser allows you some flexibility in how you lay out the elements in your configuration files, but the Terraform language also has some idiomatic style conventions which we recommend users always follow diff --git a/website/docs/configuration/syntax-json.html.md b/website/docs/configuration/syntax-json.html.md index be0b99856..d3e12215b 100644 --- a/website/docs/configuration/syntax-json.html.md +++ b/website/docs/configuration/syntax-json.html.md @@ -9,11 +9,6 @@ description: |- # JSON Configuration Syntax --> **Note:** This page is about Terraform 0.12 and later. The JSON configuration -syntax in 0.11 and earlier was never formally documented. For other information -about Terraform 0.11 and earlier, see -[0.11 Configuration Language](../configuration-0-11/index.html). - Most Terraform configurations are written in [the native Terraform language syntax](./syntax.html), which is designed to be relatively easy for humans to read and update. diff --git a/website/docs/configuration/syntax.html.md b/website/docs/configuration/syntax.html.md index 8de4253e3..2b85a7851 100644 --- a/website/docs/configuration/syntax.html.md +++ b/website/docs/configuration/syntax.html.md @@ -10,10 +10,6 @@ description: |- # Configuration Syntax --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Syntax](../configuration-0-11/syntax.html). - Other pages in this section have described various configuration constructs that can appear in the Terraform language. This page describes the lower-level syntax of the language in more detail, revealing the building blocks that diff --git a/website/docs/configuration/terraform.html.md b/website/docs/configuration/terraform.html.md index b6f1ffd1d..1094899f3 100644 --- a/website/docs/configuration/terraform.html.md +++ b/website/docs/configuration/terraform.html.md @@ -9,10 +9,6 @@ description: |- # Terraform Settings --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Terraform Settings](../configuration-0-11/terraform.html). - The special `terraform` configuration block type is used to configure some behaviors of Terraform itself, such as requiring a minimum Terraform version to apply your configuration. diff --git a/website/docs/configuration/types.html.md b/website/docs/configuration/types.html.md index 441cdc6fb..e9a7e352d 100644 --- a/website/docs/configuration/types.html.md +++ b/website/docs/configuration/types.html.md @@ -9,11 +9,6 @@ description: |- # Type Constraints --> **Note:** This page is about Terraform 0.12 and later, and documents a -feature that did not exist in older versions. For other information about -Terraform 0.11 and earlier, see -[0.11 Configuration Language](../configuration-0-11/index.html). - Terraform module authors and provider developers can use detailed type constraints to validate user-provided values for their input variables and resource arguments. This requires some additional knowledge about Terraform's diff --git a/website/docs/configuration/variables.html.md b/website/docs/configuration/variables.html.md index 21249c3fc..bd6d32caf 100644 --- a/website/docs/configuration/variables.html.md +++ b/website/docs/configuration/variables.html.md @@ -9,10 +9,6 @@ description: |- # Input Variables --> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and -earlier, see -[0.11 Configuration Language: Input Variables](../configuration-0-11/variables.html). - > **Hands-on:** Try the [Customize Terraform Configuration with Variables](https://learn.hashicorp.com/tutorials/terraform/variables?in=terraform/configuration-language&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. Input variables serve as parameters for a Terraform module, allowing aspects diff --git a/website/docs/modules/composition.html.markdown b/website/docs/modules/composition.html.markdown index 695690e7a..998fa5bbd 100644 --- a/website/docs/modules/composition.html.markdown +++ b/website/docs/modules/composition.html.markdown @@ -9,12 +9,6 @@ description: |- # Module Composition --> This section is written for **Terraform v0.12 or later**. The general patterns - described in this section _do_ apply to earlier versions, but the examples - shown are using v0.12-only syntax and features. For general information - on module usage in prior versions, see - [the v0.11 documentation about modules](/docs/configuration-0-11/modules.html). - In a simple Terraform configuration with only one root module, we create a flat set of resources and use Terraform's expression syntax to describe the relationships between these resources: From b71786d9de08a408c4b031875c12d3f8e3634ca0 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Thu, 14 Jan 2021 16:31:38 -0800 Subject: [PATCH 02/13] website: Language: Update sidebar nav with new URLs The files aren't moved as of this commit, but this serves as a map for the subsequent changes. --- website/layouts/language.erb | 400 ++++++++++++++++++----------------- 1 file changed, 201 insertions(+), 199 deletions(-) diff --git a/website/layouts/language.erb b/website/layouts/language.erb index 27e37e5c1..0bf51c257 100644 --- a/website/layouts/language.erb +++ b/website/layouts/language.erb @@ -1,22 +1,22 @@ <% wrap_layout :inner do %> <% content_for :sidebar do %> -

Terraform Language

+

Terraform Language

@@ -253,27 +257,27 @@ workspace @@ -288,23 +292,27 @@
  • - providers + Plugin Signing
  • - version + providers
  • - providers lock + version
  • - providers mirror + providers lock
  • - providers schema + providers mirror +
    • + +
  • + providers schema
    • @@ -317,11 +325,11 @@
  • - CLI Config File + CLI Config File
  • - Environment Variables + Environment Variables
    • @@ -350,159 +358,159 @@ From a8332703c9b5f90c4b32f1927272649a2671a67f Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Tue, 19 Jan 2021 13:34:25 -0800 Subject: [PATCH 09/13] website: CLI: Move docs files to match new URLs --- .../commands/0.12upgrade.html.md} | 0 .../commands/0.13upgrade.html.md} | 0 .../apply.html.markdown => cli/commands/apply.html.md} | 0 .../console.html.markdown => cli/commands/console.html.md} | 0 .../destroy.html.markdown => cli/commands/destroy.html.md} | 0 .../{commands/env.html.markdown => cli/commands/env.html.md} | 0 .../{commands/fmt.html.markdown => cli/commands/fmt.html.md} | 0 .../commands/force-unlock.html.md} | 0 .../{commands/get.html.markdown => cli/commands/get.html.md} | 0 .../graph.html.markdown => cli/commands/graph.html.md} | 0 website/docs/{ => cli}/commands/import.html.md | 0 .../index.html.markdown => cli/commands/index.html.md} | 0 .../init.html.markdown => cli/commands/init.html.md} | 0 .../login.html.markdown => cli/commands/login.html.md} | 0 .../logout.html.markdown => cli/commands/logout.html.md} | 0 .../output.html.markdown => cli/commands/output.html.md} | 0 .../plan.html.markdown => cli/commands/plan.html.md} | 0 .../commands/providers.html.md} | 0 website/docs/{ => cli}/commands/providers/lock.html.md | 0 website/docs/{ => cli}/commands/providers/mirror.html.md | 0 website/docs/{ => cli}/commands/providers/schema.html.md | 0 .../push.html.markdown => cli/commands/push.html.md} | 0 .../refresh.html.markdown => cli/commands/refresh.html.md} | 0 .../show.html.markdown => cli/commands/show.html.md} | 0 website/docs/{ => cli}/commands/state/index.html.md | 0 website/docs/{ => cli}/commands/state/list.html.md | 0 website/docs/{ => cli}/commands/state/mv.html.md | 0 website/docs/{ => cli}/commands/state/pull.html.md | 0 website/docs/{ => cli}/commands/state/push.html.md | 0 .../docs/{ => cli}/commands/state/replace-provider.html.md | 0 website/docs/{ => cli}/commands/state/rm.html.md | 0 website/docs/{ => cli}/commands/state/show.html.md | 0 .../taint.html.markdown => cli/commands/taint.html.md} | 0 .../untaint.html.markdown => cli/commands/untaint.html.md} | 0 .../validate.html.markdown => cli/commands/validate.html.md} | 0 .../version.html.markdown => cli/commands/version.html.md} | 0 website/docs/{ => cli}/commands/workspace/delete.html.md | 0 website/docs/{ => cli}/commands/workspace/index.html.md | 0 website/docs/{ => cli}/commands/workspace/list.html.md | 0 website/docs/{ => cli}/commands/workspace/new.html.md | 0 website/docs/{ => cli}/commands/workspace/select.html.md | 0 website/docs/{ => cli}/commands/workspace/show.html.md | 0 .../config/config-file.html.md} | 0 .../{commands => cli/config}/environment-variables.html.md | 0 website/docs/{ => cli}/import/importability.html.md | 0 website/docs/{ => cli}/import/index.html.md | 0 website/docs/{ => cli}/import/usage.html.md | 0 website/docs/{cli-index.html.md => cli/index.html.md} | 0 website/docs/{ => cli}/plugins/signing.html.md | 5 ++--- .../state/resource-addressing.html.md} | 0 50 files changed, 2 insertions(+), 3 deletions(-) rename website/docs/{commands/0.12upgrade.html.markdown => cli/commands/0.12upgrade.html.md} (100%) rename website/docs/{commands/0.13upgrade.html.markdown => cli/commands/0.13upgrade.html.md} (100%) rename website/docs/{commands/apply.html.markdown => cli/commands/apply.html.md} (100%) rename website/docs/{commands/console.html.markdown => cli/commands/console.html.md} (100%) rename website/docs/{commands/destroy.html.markdown => cli/commands/destroy.html.md} (100%) rename website/docs/{commands/env.html.markdown => cli/commands/env.html.md} (100%) rename website/docs/{commands/fmt.html.markdown => cli/commands/fmt.html.md} (100%) rename website/docs/{commands/force-unlock.html.markdown => cli/commands/force-unlock.html.md} (100%) rename website/docs/{commands/get.html.markdown => cli/commands/get.html.md} (100%) rename website/docs/{commands/graph.html.markdown => cli/commands/graph.html.md} (100%) rename website/docs/{ => cli}/commands/import.html.md (100%) rename website/docs/{commands/index.html.markdown => cli/commands/index.html.md} (100%) rename website/docs/{commands/init.html.markdown => cli/commands/init.html.md} (100%) rename website/docs/{commands/login.html.markdown => cli/commands/login.html.md} (100%) rename website/docs/{commands/logout.html.markdown => cli/commands/logout.html.md} (100%) rename website/docs/{commands/output.html.markdown => cli/commands/output.html.md} (100%) rename website/docs/{commands/plan.html.markdown => cli/commands/plan.html.md} (100%) rename website/docs/{commands/providers.html.markdown => cli/commands/providers.html.md} (100%) rename website/docs/{ => cli}/commands/providers/lock.html.md (100%) rename website/docs/{ => cli}/commands/providers/mirror.html.md (100%) rename website/docs/{ => cli}/commands/providers/schema.html.md (100%) rename website/docs/{commands/push.html.markdown => cli/commands/push.html.md} (100%) rename website/docs/{commands/refresh.html.markdown => cli/commands/refresh.html.md} (100%) rename website/docs/{commands/show.html.markdown => cli/commands/show.html.md} (100%) rename website/docs/{ => cli}/commands/state/index.html.md (100%) rename website/docs/{ => cli}/commands/state/list.html.md (100%) rename website/docs/{ => cli}/commands/state/mv.html.md (100%) rename website/docs/{ => cli}/commands/state/pull.html.md (100%) rename website/docs/{ => cli}/commands/state/push.html.md (100%) rename website/docs/{ => cli}/commands/state/replace-provider.html.md (100%) rename website/docs/{ => cli}/commands/state/rm.html.md (100%) rename website/docs/{ => cli}/commands/state/show.html.md (100%) rename website/docs/{commands/taint.html.markdown => cli/commands/taint.html.md} (100%) rename website/docs/{commands/untaint.html.markdown => cli/commands/untaint.html.md} (100%) rename website/docs/{commands/validate.html.markdown => cli/commands/validate.html.md} (100%) rename website/docs/{commands/version.html.markdown => cli/commands/version.html.md} (100%) rename website/docs/{ => cli}/commands/workspace/delete.html.md (100%) rename website/docs/{ => cli}/commands/workspace/index.html.md (100%) rename website/docs/{ => cli}/commands/workspace/list.html.md (100%) rename website/docs/{ => cli}/commands/workspace/new.html.md (100%) rename website/docs/{ => cli}/commands/workspace/select.html.md (100%) rename website/docs/{ => cli}/commands/workspace/show.html.md (100%) rename website/docs/{commands/cli-config.html.markdown => cli/config/config-file.html.md} (100%) rename website/docs/{commands => cli/config}/environment-variables.html.md (100%) rename website/docs/{ => cli}/import/importability.html.md (100%) rename website/docs/{ => cli}/import/index.html.md (100%) rename website/docs/{ => cli}/import/usage.html.md (100%) rename website/docs/{cli-index.html.md => cli/index.html.md} (100%) rename website/docs/{ => cli}/plugins/signing.html.md (93%) rename website/docs/{internals/resource-addressing.html.markdown => cli/state/resource-addressing.html.md} (100%) diff --git a/website/docs/commands/0.12upgrade.html.markdown b/website/docs/cli/commands/0.12upgrade.html.md similarity index 100% rename from website/docs/commands/0.12upgrade.html.markdown rename to website/docs/cli/commands/0.12upgrade.html.md diff --git a/website/docs/commands/0.13upgrade.html.markdown b/website/docs/cli/commands/0.13upgrade.html.md similarity index 100% rename from website/docs/commands/0.13upgrade.html.markdown rename to website/docs/cli/commands/0.13upgrade.html.md diff --git a/website/docs/commands/apply.html.markdown b/website/docs/cli/commands/apply.html.md similarity index 100% rename from website/docs/commands/apply.html.markdown rename to website/docs/cli/commands/apply.html.md diff --git a/website/docs/commands/console.html.markdown b/website/docs/cli/commands/console.html.md similarity index 100% rename from website/docs/commands/console.html.markdown rename to website/docs/cli/commands/console.html.md diff --git a/website/docs/commands/destroy.html.markdown b/website/docs/cli/commands/destroy.html.md similarity index 100% rename from website/docs/commands/destroy.html.markdown rename to website/docs/cli/commands/destroy.html.md diff --git a/website/docs/commands/env.html.markdown b/website/docs/cli/commands/env.html.md similarity index 100% rename from website/docs/commands/env.html.markdown rename to website/docs/cli/commands/env.html.md diff --git a/website/docs/commands/fmt.html.markdown b/website/docs/cli/commands/fmt.html.md similarity index 100% rename from website/docs/commands/fmt.html.markdown rename to website/docs/cli/commands/fmt.html.md diff --git a/website/docs/commands/force-unlock.html.markdown b/website/docs/cli/commands/force-unlock.html.md similarity index 100% rename from website/docs/commands/force-unlock.html.markdown rename to website/docs/cli/commands/force-unlock.html.md diff --git a/website/docs/commands/get.html.markdown b/website/docs/cli/commands/get.html.md similarity index 100% rename from website/docs/commands/get.html.markdown rename to website/docs/cli/commands/get.html.md diff --git a/website/docs/commands/graph.html.markdown b/website/docs/cli/commands/graph.html.md similarity index 100% rename from website/docs/commands/graph.html.markdown rename to website/docs/cli/commands/graph.html.md diff --git a/website/docs/commands/import.html.md b/website/docs/cli/commands/import.html.md similarity index 100% rename from website/docs/commands/import.html.md rename to website/docs/cli/commands/import.html.md diff --git a/website/docs/commands/index.html.markdown b/website/docs/cli/commands/index.html.md similarity index 100% rename from website/docs/commands/index.html.markdown rename to website/docs/cli/commands/index.html.md diff --git a/website/docs/commands/init.html.markdown b/website/docs/cli/commands/init.html.md similarity index 100% rename from website/docs/commands/init.html.markdown rename to website/docs/cli/commands/init.html.md diff --git a/website/docs/commands/login.html.markdown b/website/docs/cli/commands/login.html.md similarity index 100% rename from website/docs/commands/login.html.markdown rename to website/docs/cli/commands/login.html.md diff --git a/website/docs/commands/logout.html.markdown b/website/docs/cli/commands/logout.html.md similarity index 100% rename from website/docs/commands/logout.html.markdown rename to website/docs/cli/commands/logout.html.md diff --git a/website/docs/commands/output.html.markdown b/website/docs/cli/commands/output.html.md similarity index 100% rename from website/docs/commands/output.html.markdown rename to website/docs/cli/commands/output.html.md diff --git a/website/docs/commands/plan.html.markdown b/website/docs/cli/commands/plan.html.md similarity index 100% rename from website/docs/commands/plan.html.markdown rename to website/docs/cli/commands/plan.html.md diff --git a/website/docs/commands/providers.html.markdown b/website/docs/cli/commands/providers.html.md similarity index 100% rename from website/docs/commands/providers.html.markdown rename to website/docs/cli/commands/providers.html.md diff --git a/website/docs/commands/providers/lock.html.md b/website/docs/cli/commands/providers/lock.html.md similarity index 100% rename from website/docs/commands/providers/lock.html.md rename to website/docs/cli/commands/providers/lock.html.md diff --git a/website/docs/commands/providers/mirror.html.md b/website/docs/cli/commands/providers/mirror.html.md similarity index 100% rename from website/docs/commands/providers/mirror.html.md rename to website/docs/cli/commands/providers/mirror.html.md diff --git a/website/docs/commands/providers/schema.html.md b/website/docs/cli/commands/providers/schema.html.md similarity index 100% rename from website/docs/commands/providers/schema.html.md rename to website/docs/cli/commands/providers/schema.html.md diff --git a/website/docs/commands/push.html.markdown b/website/docs/cli/commands/push.html.md similarity index 100% rename from website/docs/commands/push.html.markdown rename to website/docs/cli/commands/push.html.md diff --git a/website/docs/commands/refresh.html.markdown b/website/docs/cli/commands/refresh.html.md similarity index 100% rename from website/docs/commands/refresh.html.markdown rename to website/docs/cli/commands/refresh.html.md diff --git a/website/docs/commands/show.html.markdown b/website/docs/cli/commands/show.html.md similarity index 100% rename from website/docs/commands/show.html.markdown rename to website/docs/cli/commands/show.html.md diff --git a/website/docs/commands/state/index.html.md b/website/docs/cli/commands/state/index.html.md similarity index 100% rename from website/docs/commands/state/index.html.md rename to website/docs/cli/commands/state/index.html.md diff --git a/website/docs/commands/state/list.html.md b/website/docs/cli/commands/state/list.html.md similarity index 100% rename from website/docs/commands/state/list.html.md rename to website/docs/cli/commands/state/list.html.md diff --git a/website/docs/commands/state/mv.html.md b/website/docs/cli/commands/state/mv.html.md similarity index 100% rename from website/docs/commands/state/mv.html.md rename to website/docs/cli/commands/state/mv.html.md diff --git a/website/docs/commands/state/pull.html.md b/website/docs/cli/commands/state/pull.html.md similarity index 100% rename from website/docs/commands/state/pull.html.md rename to website/docs/cli/commands/state/pull.html.md diff --git a/website/docs/commands/state/push.html.md b/website/docs/cli/commands/state/push.html.md similarity index 100% rename from website/docs/commands/state/push.html.md rename to website/docs/cli/commands/state/push.html.md diff --git a/website/docs/commands/state/replace-provider.html.md b/website/docs/cli/commands/state/replace-provider.html.md similarity index 100% rename from website/docs/commands/state/replace-provider.html.md rename to website/docs/cli/commands/state/replace-provider.html.md diff --git a/website/docs/commands/state/rm.html.md b/website/docs/cli/commands/state/rm.html.md similarity index 100% rename from website/docs/commands/state/rm.html.md rename to website/docs/cli/commands/state/rm.html.md diff --git a/website/docs/commands/state/show.html.md b/website/docs/cli/commands/state/show.html.md similarity index 100% rename from website/docs/commands/state/show.html.md rename to website/docs/cli/commands/state/show.html.md diff --git a/website/docs/commands/taint.html.markdown b/website/docs/cli/commands/taint.html.md similarity index 100% rename from website/docs/commands/taint.html.markdown rename to website/docs/cli/commands/taint.html.md diff --git a/website/docs/commands/untaint.html.markdown b/website/docs/cli/commands/untaint.html.md similarity index 100% rename from website/docs/commands/untaint.html.markdown rename to website/docs/cli/commands/untaint.html.md diff --git a/website/docs/commands/validate.html.markdown b/website/docs/cli/commands/validate.html.md similarity index 100% rename from website/docs/commands/validate.html.markdown rename to website/docs/cli/commands/validate.html.md diff --git a/website/docs/commands/version.html.markdown b/website/docs/cli/commands/version.html.md similarity index 100% rename from website/docs/commands/version.html.markdown rename to website/docs/cli/commands/version.html.md diff --git a/website/docs/commands/workspace/delete.html.md b/website/docs/cli/commands/workspace/delete.html.md similarity index 100% rename from website/docs/commands/workspace/delete.html.md rename to website/docs/cli/commands/workspace/delete.html.md diff --git a/website/docs/commands/workspace/index.html.md b/website/docs/cli/commands/workspace/index.html.md similarity index 100% rename from website/docs/commands/workspace/index.html.md rename to website/docs/cli/commands/workspace/index.html.md diff --git a/website/docs/commands/workspace/list.html.md b/website/docs/cli/commands/workspace/list.html.md similarity index 100% rename from website/docs/commands/workspace/list.html.md rename to website/docs/cli/commands/workspace/list.html.md diff --git a/website/docs/commands/workspace/new.html.md b/website/docs/cli/commands/workspace/new.html.md similarity index 100% rename from website/docs/commands/workspace/new.html.md rename to website/docs/cli/commands/workspace/new.html.md diff --git a/website/docs/commands/workspace/select.html.md b/website/docs/cli/commands/workspace/select.html.md similarity index 100% rename from website/docs/commands/workspace/select.html.md rename to website/docs/cli/commands/workspace/select.html.md diff --git a/website/docs/commands/workspace/show.html.md b/website/docs/cli/commands/workspace/show.html.md similarity index 100% rename from website/docs/commands/workspace/show.html.md rename to website/docs/cli/commands/workspace/show.html.md diff --git a/website/docs/commands/cli-config.html.markdown b/website/docs/cli/config/config-file.html.md similarity index 100% rename from website/docs/commands/cli-config.html.markdown rename to website/docs/cli/config/config-file.html.md diff --git a/website/docs/commands/environment-variables.html.md b/website/docs/cli/config/environment-variables.html.md similarity index 100% rename from website/docs/commands/environment-variables.html.md rename to website/docs/cli/config/environment-variables.html.md diff --git a/website/docs/import/importability.html.md b/website/docs/cli/import/importability.html.md similarity index 100% rename from website/docs/import/importability.html.md rename to website/docs/cli/import/importability.html.md diff --git a/website/docs/import/index.html.md b/website/docs/cli/import/index.html.md similarity index 100% rename from website/docs/import/index.html.md rename to website/docs/cli/import/index.html.md diff --git a/website/docs/import/usage.html.md b/website/docs/cli/import/usage.html.md similarity index 100% rename from website/docs/import/usage.html.md rename to website/docs/cli/import/usage.html.md diff --git a/website/docs/cli-index.html.md b/website/docs/cli/index.html.md similarity index 100% rename from website/docs/cli-index.html.md rename to website/docs/cli/index.html.md diff --git a/website/docs/plugins/signing.html.md b/website/docs/cli/plugins/signing.html.md similarity index 93% rename from website/docs/plugins/signing.html.md rename to website/docs/cli/plugins/signing.html.md index ad2d9b5f6..95c8e935f 100644 --- a/website/docs/plugins/signing.html.md +++ b/website/docs/cli/plugins/signing.html.md @@ -1,7 +1,6 @@ --- -layout: "registry" +layout: "docs" page_title: "Plugin Signing" -sidebar_current: "docs-plugins-signing" description: |- Terraform plugin signing trust levels --- @@ -15,7 +14,7 @@ description: |- Terraform providers installed from the Registry are cryptographically signed, and the signature is verified at time of installation. There are three types of provider signatures, each with different trust implications: * **Signed by HashiCorp** - are built, signed, and supported by HashiCorp. -* **Signed by Trusted Partners** - are built, signed, and supported by a third party. HashiCorp has +* **Signed by Trusted Partners** - are built, signed, and supported by a third party. HashiCorp has verified the ownership of the private key and we provide a chain of trust to the CLI to verify this programatically. * **Self-signed** - are built, signed, and supported by a third party. HashiCorp does not provide a diff --git a/website/docs/internals/resource-addressing.html.markdown b/website/docs/cli/state/resource-addressing.html.md similarity index 100% rename from website/docs/internals/resource-addressing.html.markdown rename to website/docs/cli/state/resource-addressing.html.md From d1e8537b33a02f78a7c888b787141843295cf2f8 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Tue, 19 Jan 2021 13:43:01 -0800 Subject: [PATCH 10/13] website: CLI: Update links to moved docs pages --- website/docs/cli/auth/index.html.md | 4 ++-- website/docs/cli/code/index.html.md | 10 +++++----- website/docs/cli/commands/apply.html.md | 6 +++--- website/docs/cli/commands/destroy.html.md | 4 ++-- website/docs/cli/commands/env.html.md | 2 +- website/docs/cli/commands/import.html.md | 4 ++-- website/docs/cli/commands/index.html.md | 4 ++-- website/docs/cli/commands/init.html.md | 10 +++++----- website/docs/cli/commands/login.html.md | 4 ++-- website/docs/cli/commands/logout.html.md | 2 +- website/docs/cli/commands/plan.html.md | 6 +++--- website/docs/cli/commands/providers/lock.html.md | 6 +++--- website/docs/cli/commands/providers/mirror.html.md | 2 +- website/docs/cli/commands/refresh.html.md | 2 +- website/docs/cli/commands/state/index.html.md | 2 +- website/docs/cli/commands/state/show.html.md | 2 +- website/docs/cli/commands/taint.html.md | 8 ++++---- website/docs/cli/commands/version.html.md | 2 +- website/docs/cli/config/config-file.html.md | 6 +++--- .../docs/cli/config/environment-variables.html.md | 2 +- website/docs/cli/config/index.html.md | 4 ++-- website/docs/cli/import/usage.html.md | 4 ++-- website/docs/cli/init/index.html.md | 2 +- website/docs/cli/inspect/index.html.md | 10 +++++----- website/docs/cli/plugins/index.html.md | 12 ++++++------ website/docs/cli/run/index.html.md | 6 +++--- website/docs/cli/state/index.html.md | 2 +- website/docs/cli/state/inspect.html.md | 6 +++--- website/docs/cli/state/move.html.md | 8 ++++---- website/docs/cli/state/recover.html.md | 6 +++--- website/docs/cli/state/taint.html.md | 4 ++-- website/docs/cli/workspaces/index.html.md | 8 ++++---- website/docs/commands/state/addressing.html.md | 4 ++-- .../configuration-0-11/environment-variables.html.md | 4 ++-- .../docs/configuration-0-11/interpolation.html.md | 2 +- website/docs/configuration-0-11/modules.html.md | 4 ++-- website/docs/configuration-0-11/outputs.html.md | 2 +- website/docs/configuration-0-11/providers.html.md | 6 +++--- .../configuration-0-11/terraform-enterprise.html.md | 6 +++--- website/docs/internals/credentials-helpers.html.md | 6 +++--- website/docs/internals/graph.html.md | 4 ++-- website/docs/internals/json-format.html.md | 2 +- website/docs/internals/login-protocol.html.markdown | 2 +- .../provider-network-mirror-protocol.html.md | 6 +++--- .../internals/provider-registry-protocol.html.md | 4 ++-- .../docs/internals/remote-service-discovery.html.md | 4 ++-- website/docs/language/dependency-lock.html.md | 8 ++++---- website/docs/language/expressions/index.html.md | 2 +- website/docs/language/functions/index.html.md | 2 +- website/docs/language/index.html.md | 2 +- website/docs/language/modules/develop/index.html.md | 4 ++-- website/docs/language/modules/sources.html.md | 2 +- website/docs/language/modules/syntax.html.md | 4 ++-- website/docs/language/providers/index.html.md | 2 +- website/docs/language/providers/requirements.html.md | 4 ++-- .../docs/language/settings/backends/index.html.md | 4 ++-- website/docs/language/settings/backends/pg.html.md | 2 +- .../docs/language/settings/backends/remote.html.md | 8 ++++---- website/docs/language/state/import.html.md | 2 +- website/docs/language/state/index.html.md | 8 ++++---- website/docs/language/state/locking.html.md | 2 +- website/docs/language/syntax/index.html.md | 2 +- website/docs/plugins/provider.html.md | 2 +- website/upgrade-guides/0-10.html.markdown | 6 +++--- website/upgrade-guides/0-12.html.markdown | 2 +- website/upgrade-guides/0-13.html.markdown | 10 +++++----- website/upgrade-guides/0-14.html.markdown | 6 +++--- 67 files changed, 150 insertions(+), 150 deletions(-) diff --git a/website/docs/cli/auth/index.html.md b/website/docs/cli/auth/index.html.md index 0400da546..794f23119 100644 --- a/website/docs/cli/auth/index.html.md +++ b/website/docs/cli/auth/index.html.md @@ -25,5 +25,5 @@ Terraform Cloud user account. For details, see: -- [The `terraform login` command](/docs/commands/login.html) -- [The `terraform logout` command](/docs/commands/logout.html) +- [The `terraform login` command](/docs/cli/commands/login.html) +- [The `terraform logout` command](/docs/cli/commands/logout.html) diff --git a/website/docs/cli/code/index.html.md b/website/docs/cli/code/index.html.md index 7c3c78a01..01dba636c 100644 --- a/website/docs/cli/code/index.html.md +++ b/website/docs/cli/code/index.html.md @@ -13,18 +13,18 @@ Terraform CLI includes several commands to make Terraform code more convenient to work with. Integrating these commands into your editing workflow can potentially save you time and effort. -- [The `terraform console` command](/docs/commands/console.html) starts an +- [The `terraform console` command](/docs/cli/commands/console.html) starts an interactive shell for evaluating Terraform [expressions](/docs/language/expressions/index.html), which can be a faster way to verify that a particular resource argument results in the value you expect. -- [The `terraform fmt` command](/docs/commands/fmt.html) rewrites Terraform +- [The `terraform fmt` command](/docs/cli/commands/fmt.html) rewrites Terraform configuration files to a canonical format and style, so you don't have to waste time making minor adjustments for readability and consistency. It works well as a pre-commit hook in your version control system. -- [The `terraform validate` command](/docs/commands/validate.html) validates the +- [The `terraform validate` command](/docs/cli/commands/validate.html) validates the syntax and arguments of the Terraform configuration files in a directory, including argument and attribute names and types for resources and modules. The `plan` and `apply` commands automatically validate a configuration before @@ -32,8 +32,8 @@ potentially save you time and effort. workflow, but it can be very useful as a pre-commit hook or as part of a continuous integration pipeline. -- [The `0.13upgrade` command](/docs/commands/0.13upgrade.html) and - [the `0.12upgrade` command](/docs/commands/0.12upgrade.html) can automatically +- [The `0.13upgrade` command](/docs/cli/commands/0.13upgrade.html) and + [the `0.12upgrade` command](/docs/cli/commands/0.12upgrade.html) can automatically modify the configuration files in a Terraform module to help deal with major syntax changes that occurred in the 0.13 and 0.12 releases of Terraform. Both of these commands are only available in the Terraform version they are diff --git a/website/docs/cli/commands/apply.html.md b/website/docs/cli/commands/apply.html.md index 31c5b7ad1..3e1430f33 100644 --- a/website/docs/cli/commands/apply.html.md +++ b/website/docs/cli/commands/apply.html.md @@ -66,9 +66,9 @@ The command-line flags are all optional. The list of available flags are: [remote state](/docs/language/state/remote.html) is used. * `-target=resource` - A [Resource - Address](/docs/internals/resource-addressing.html) to target. For more + Address](/docs/cli/state/resource-addressing.html) to target. For more information, see - [the targeting docs from `terraform plan`](/docs/commands/plan.html#resource-targeting). + [the targeting docs from `terraform plan`](/docs/cli/commands/plan.html#resource-targeting). * `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag can be set multiple times. Variable values are interpreted as @@ -100,6 +100,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/destroy.html.md b/website/docs/cli/commands/destroy.html.md index f07c357a4..dd490aa63 100644 --- a/website/docs/cli/commands/destroy.html.md +++ b/website/docs/cli/commands/destroy.html.md @@ -19,13 +19,13 @@ Infrastructure managed by Terraform will be destroyed. This will ask for confirmation before destroying. This command accepts all the arguments and options that the [apply -command](/docs/commands/apply.html) accepts, with the exception of a plan file +command](/docs/cli/commands/apply.html) accepts, with the exception of a plan file argument. If `-auto-approve` is set, then the destroy confirmation will not be shown. The `-target` flag, instead of affecting "dependencies" will instead also -destroy any resources that _depend on_ the target(s) specified. For more information, see [the targeting docs from `terraform plan`](/docs/commands/plan.html#resource-targeting). +destroy any resources that _depend on_ the target(s) specified. For more information, see [the targeting docs from `terraform plan`](/docs/cli/commands/plan.html#resource-targeting). The behavior of any `terraform destroy` command can be previewed at any time with an equivalent `terraform plan -destroy` command. diff --git a/website/docs/cli/commands/env.html.md b/website/docs/cli/commands/env.html.md index e1ec830e7..3d1183d29 100644 --- a/website/docs/cli/commands/env.html.md +++ b/website/docs/cli/commands/env.html.md @@ -9,5 +9,5 @@ description: |- # Command: env The `terraform env` command is deprecated. -[The `terraform workspace` command](/docs/commands/workspace/) +[The `terraform workspace` command](/docs/cli/commands/workspace/index.html) should be used instead. diff --git a/website/docs/cli/commands/import.html.md b/website/docs/cli/commands/import.html.md index 20e9372cc..1406404eb 100644 --- a/website/docs/cli/commands/import.html.md +++ b/website/docs/cli/commands/import.html.md @@ -11,7 +11,7 @@ description: |- > **Hands-on:** Try the [Import Terraform Configuration](https://learn.hashicorp.com/tutorials/terraform/state-import?in=terraform/state&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial on HashiCorp Learn. The `terraform import` command is used to -[import existing resources](/docs/import/index.html) +[import existing resources](/docs/cli/import/index.html) into Terraform. ## Usage @@ -21,7 +21,7 @@ Usage: `terraform import [options] ADDRESS ID` Import will find the existing resource from ID and import it into your Terraform state at the given ADDRESS. -ADDRESS must be a valid [resource address](/docs/internals/resource-addressing.html). +ADDRESS must be a valid [resource address](/docs/cli/state/resource-addressing.html). Because any resource address is valid, the import command can import resources into modules as well as directly into the root of your state. diff --git a/website/docs/cli/commands/index.html.md b/website/docs/cli/commands/index.html.md index 2374d71d8..d579a951c 100644 --- a/website/docs/cli/commands/index.html.md +++ b/website/docs/cli/commands/index.html.md @@ -101,7 +101,7 @@ will be read or written in the given directory instead. There are two exceptions where Terraform will use the original working directory even when you specify `-chdir=...`: -* Settings in the [CLI Configuration](cli-config.html) are not for a specific +* Settings in the [CLI Configuration](/docs/cli/config/config-file.html) are not for a specific subcommand and Terraform processes them before acting on the `-chdir` option. @@ -154,7 +154,7 @@ Checkpoint itself can be entirely disabled for all HashiCorp products by setting the environment variable `CHECKPOINT_DISABLE` to any non-empty value. Alternatively, settings in -[the CLI configuration file](/docs/commands/cli-config.html) can be used to +[the CLI configuration file](/docs/cli/config/config-file.html) can be used to disable checkpoint features. The following checkpoint-related settings are supported in this file: diff --git a/website/docs/cli/commands/init.html.md b/website/docs/cli/commands/init.html.md index ab0d81c46..21ef20470 100644 --- a/website/docs/cli/commands/init.html.md +++ b/website/docs/cli/commands/init.html.md @@ -123,7 +123,7 @@ third-party provider registry, `terraform init` will automatically find, download, and install the necessary provider plugins. If you cannot or do not wish to install providers from their origin registries, you can customize how Terraform installs providers using -[the provider installation settings in the CLI configuration](./cli-config.html#provider-installation). +[the provider installation settings in the CLI configuration](/docs/cli/config/config-file.html#provider-installation). For more information about specifying which providers are required for each of your modules, see [Provider Requirements](/docs/language/providers/requirements.html). @@ -145,15 +145,15 @@ You can modify `terraform init`'s plugin behavior with the following options: - `-get-plugins=false` — Skip plugin installation. -> Note: Since Terraform 0.13, this option has been superseded by the - [`provider_installation`](./cli-config.html#provider-installation) and - [`plugin_cache_dir`](./cli-config.html#plugin_cache_dir) settings. + [`provider_installation`](/docs/cli/config/config-file.html#provider-installation) and + [`plugin_cache_dir`](/docs/cli/config/config-file.html#plugin_cache_dir) settings. It should not be used in Terraform versions 0.13+, and this option was removed in Terraform 0.15. - `-plugin-dir=PATH` — Force plugin installation to read plugins _only_ from the specified directory, as if it had been configured as a `filesystem_mirror` in the CLI configuration. If you intend to routinely use a particular filesystem mirror then we recommend - [configuring Terraform's installation methods globally](./cli-config.html#provider-installation). + [configuring Terraform's installation methods globally](/docs/cli/config/config-file.html#provider-installation). You can use `-plugin-dir` as a one-time override for exceptional situations, such as if you are testing a local build of a provider plugin you are currently developing. @@ -187,6 +187,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/login.html.md b/website/docs/cli/commands/login.html.md index 085781f54..8af1ef7a4 100644 --- a/website/docs/cli/commands/login.html.md +++ b/website/docs/cli/commands/login.html.md @@ -15,7 +15,7 @@ API token for Terraform Cloud, Terraform Enterprise, or any other host that offe where it is possible to launch a web browser on the same host where Terraform is running. If you are running Terraform in an unattended automation scenario, you can -[configure credentials manually in the CLI configuration](https://www.terraform.io/docs/commands/cli-config.html#credentials). +[configure credentials manually in the CLI configuration](https://www.terraform.io/docs/cli/config/config-file.html#credentials). ## Usage @@ -34,7 +34,7 @@ not as desired. If you don't wish to store your API token in the default location, you can optionally configure a -[credentials helper program](cli-config.html#credentials-helpers) which knows +[credentials helper program](/docs/cli/config/config-file.html#credentials-helpers) which knows how to store and later retrieve credentials in some other system, such as your organization's existing secrets management system. diff --git a/website/docs/cli/commands/logout.html.md b/website/docs/cli/commands/logout.html.md index 644ff5171..15656fba9 100644 --- a/website/docs/cli/commands/logout.html.md +++ b/website/docs/cli/commands/logout.html.md @@ -26,5 +26,5 @@ the remote server, so it will remain valid until manually revoked. By default, Terraform will remove the token stored in plain text in a local CLI configuration file called `credentials.tfrc.json`. If you have configured a -[credentials helper program](cli-config.html#credentials-helpers), Terraform +[credentials helper program](/docs/cli/config/config-file.html#credentials-helpers), Terraform will use the helper's `forget` command to remove it. diff --git a/website/docs/cli/commands/plan.html.md b/website/docs/cli/commands/plan.html.md index 63d0937ca..647bedd34 100644 --- a/website/docs/cli/commands/plan.html.md +++ b/website/docs/cli/commands/plan.html.md @@ -73,7 +73,7 @@ The available options are: Ignored when [remote state](/docs/language/state/remote.html) is used. * `-target=resource` - A [Resource - Address](/docs/internals/resource-addressing.html) to target. This flag can + Address](/docs/cli/state/resource-addressing.html) to target. This flag can be used multiple times. See below for more information. * `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag @@ -93,7 +93,7 @@ The available options are: The `-target` option can be used to focus Terraform's attention on only a subset of resources. -[Resource Address](/docs/internals/resource-addressing.html) syntax is used +[Resource Address](/docs/cli/state/resource-addressing.html) syntax is used to specify the constraint. The resource address is interpreted as follows: * If the given address has a _resource spec_, only the specified resource @@ -150,6 +150,6 @@ current working directory. If your previous use of this legacy pattern was also relying on Terraform writing the `.terraform` subdirectory into the current working directory even though the root module directory was overridden, use -[the `TF_DATA_DIR` environment variable](environment-variables.html#tf_data_dir) +[the `TF_DATA_DIR` environment variable](/docs/cli/config/environment-variables.html#tf_data_dir) to direct Terraform to write the `.terraform` directory to a location other than the current working directory. diff --git a/website/docs/cli/commands/providers/lock.html.md b/website/docs/cli/commands/providers/lock.html.md index 345e591bd..b9a48fae7 100644 --- a/website/docs/cli/commands/providers/lock.html.md +++ b/website/docs/cli/commands/providers/lock.html.md @@ -15,11 +15,11 @@ order to write provider dependency information into The common way to update the dependency lock file is as a side-effect of normal provider installation during -[`terraform init`](../init.html), but there are several situations where that +[`terraform init`](/docs/cli/commands/init.html), but there are several situations where that automatic approach may not be sufficient: * If you are running Terraform in an environment that uses - [alternative provider installation methods](../cli-config.html#provider-installation), + [alternative provider installation methods](/docs/cli/config/config-file.html#provider-installation), such as filesystem or network mirrors, normal provider installation will not access the origin registry for a provider and therefore Terraform will not be able to populate all of the possible package checksums for the selected @@ -150,7 +150,7 @@ multiple times and specify a different subset of your providers each time. The `-fs-mirror` and `-net-mirror` options have the same meaning as `filesystem_mirror` and `network_mirror` blocks in -[the provider installation methods configuration](../cli-config.html#provider-installation), +[the provider installation methods configuration](/docs/cli/config/config-file.html#provider-installation), but specify only a single method in order to be explicit about where you intend to derive the package checksum information from. diff --git a/website/docs/cli/commands/providers/mirror.html.md b/website/docs/cli/commands/providers/mirror.html.md index 829508d2f..b0827837e 100644 --- a/website/docs/cli/commands/providers/mirror.html.md +++ b/website/docs/cli/commands/providers/mirror.html.md @@ -19,7 +19,7 @@ from provider registries as part of initializing the current working directory. Sometimes Terraform is running in an environment where that isn't possible, such as on an isolated network without access to the Terraform Registry. In that case, -[explicit installation method configuration](../cli-config.html#explicit-installation-method-configuration) +[explicit installation method configuration](/docs/cli/config/config-file.html#explicit-installation-method-configuration) allows you to configure Terraform, when running on a particular system, to consult only a local filesystem directory where you've created a local mirror of the necessary plugins, and to skip accessing the upstream registry at all. diff --git a/website/docs/cli/commands/refresh.html.md b/website/docs/cli/commands/refresh.html.md index c1ba75804..517b76f00 100644 --- a/website/docs/cli/commands/refresh.html.md +++ b/website/docs/cli/commands/refresh.html.md @@ -50,7 +50,7 @@ The `terraform refresh` command accepts the following options: [remote state](/docs/language/state/remote.html) is used. * `-target=resource` - A [Resource - Address](/docs/internals/resource-addressing.html) to target. Operation will + Address](/docs/cli/state/resource-addressing.html) to target. Operation will be limited to this resource and its dependencies. This flag can be used multiple times. diff --git a/website/docs/cli/commands/state/index.html.md b/website/docs/cli/commands/state/index.html.md index 31d74b43b..38e2028d9 100644 --- a/website/docs/cli/commands/state/index.html.md +++ b/website/docs/cli/commands/state/index.html.md @@ -35,7 +35,7 @@ written to disk and the CLI usage is the same as if it were local state. All `terraform state` subcommands that modify the state write backup files. The path of these backup file can be controlled with `-backup`. -Subcommands that are read-only (such as [list](/docs/commands/state/list.html)) +Subcommands that are read-only (such as [list](/docs/cli/commands/state/list.html)) do not write any backup files since they aren't modifying the state. Note that backups for state modification _can not be disabled_. Due to diff --git a/website/docs/cli/commands/state/show.html.md b/website/docs/cli/commands/state/show.html.md index d7d21dcc3..e64386ce7 100644 --- a/website/docs/cli/commands/state/show.html.md +++ b/website/docs/cli/commands/state/show.html.md @@ -30,7 +30,7 @@ The command-line flags are all optional. The list of available flags are: The output of `terraform state show` is intended for human consumption, not programmatic consumption. To extract state data for use in other software, use -[`terraform show -json`](../show.html#json-output) and decode the result +[`terraform show -json`](/docs/cli/commands/show.html#json-output) and decode the result using the documented structure. ## Example: Show a Resource diff --git a/website/docs/cli/commands/taint.html.md b/website/docs/cli/commands/taint.html.md index 5191e9699..9ef2982fa 100644 --- a/website/docs/cli/commands/taint.html.md +++ b/website/docs/cli/commands/taint.html.md @@ -14,9 +14,9 @@ as tainted, forcing it to be destroyed and recreated on the next apply. This command _will not_ modify infrastructure, but does modify the state file in order to mark a resource as tainted. Once a resource is marked as tainted, the next -[plan](/docs/commands/plan.html) will show that the resource will +[plan](/docs/cli/commands/plan.html) will show that the resource will be destroyed and recreated and the next -[apply](/docs/commands/apply.html) will implement this change. +[apply](/docs/cli/commands/apply.html) will implement this change. Forcing the recreation of a resource is useful when you want a certain side effect of recreation that is not visible in the attributes of a resource. @@ -28,7 +28,7 @@ Note that tainting a resource for recreation may affect resources that depend on the newly tainted resource. For example, a DNS resource that uses the IP address of a server may need to be modified to reflect the potentially new IP address of a tainted server. The -[plan command](/docs/commands/plan.html) will show this if this is +[plan command](/docs/cli/commands/plan.html) will show this if this is the case. ## Usage @@ -37,7 +37,7 @@ Usage: `terraform taint [options] address` The `address` argument is the address of the resource to mark as tainted. The address is in -[the resource address syntax](/docs/internals/resource-addressing.html) syntax, +[the resource address syntax](/docs/cli/state/resource-addressing.html) syntax, as shown in the output from other commands, such as: * `aws_instance.foo` diff --git a/website/docs/cli/commands/version.html.md b/website/docs/cli/commands/version.html.md index 5ee38419e..713bfb6e3 100644 --- a/website/docs/cli/commands/version.html.md +++ b/website/docs/cli/commands/version.html.md @@ -17,7 +17,7 @@ Usage: `terraform version [options]` With no additional arguments, `version` will display the version of Terraform, the platform it's installed on, installed providers, and the results of upgrade -and security checks [unless disabled](/docs/commands/index.html#upgrade-and-security-bulletin-checks). +and security checks [unless disabled](/docs/cli/commands/index.html#upgrade-and-security-bulletin-checks). This command has one optional flag: diff --git a/website/docs/cli/config/config-file.html.md b/website/docs/cli/config/config-file.html.md index 0f710bb10..97ba3a7d6 100644 --- a/website/docs/cli/config/config-file.html.md +++ b/website/docs/cli/config/config-file.html.md @@ -33,7 +33,7 @@ as just `terraform.rc`. Use `dir` from PowerShell or Command Prompt to confirm the filename. The location of the Terraform CLI configuration file can also be specified -using the `TF_CLI_CONFIG_FILE` [environment variable](/docs/commands/environment-variables.html). +using the `TF_CLI_CONFIG_FILE` [environment variable](/docs/cli/config/environment-variables.html). ## Configuration File Syntax @@ -60,7 +60,7 @@ The following settings can be set in the CLI configuration file: See [Credentials Helpers](#credentials-helpers) below for more information. - `disable_checkpoint` — when set to `true`, disables - [upgrade and security bulletin checks](/docs/commands/index.html#upgrade-and-security-bulletin-checks) + [upgrade and security bulletin checks](/docs/cli/commands/index.html#upgrade-and-security-bulletin-checks) that require reaching out to HashiCorp-provided network services. - `disable_checkpoint_signature` — when set to `true`, allows the upgrade and @@ -93,7 +93,7 @@ credentials "app.terraform.io" { } ``` -If you are running the Terraform CLI interactively on a computer with a web browser, you can use [the `terraform login` command](./login.html) +If you are running the Terraform CLI interactively on a computer with a web browser, you can use [the `terraform login` command](/docs/cli/commands/login.html) to get credentials and automatically save them in the CLI configuration. If not, you can manually write `credentials` blocks. diff --git a/website/docs/cli/config/environment-variables.html.md b/website/docs/cli/config/environment-variables.html.md index e2af8e0aa..891f8d231 100644 --- a/website/docs/cli/config/environment-variables.html.md +++ b/website/docs/cli/config/environment-variables.html.md @@ -145,7 +145,7 @@ export TF_REGISTRY_CLIENT_TIMEOUT=15 ## TF_CLI_CONFIG_FILE -The location of the [Terraform CLI configuration file](/docs/commands/cli-config.html). +The location of the [Terraform CLI configuration file](/docs/cli/config/config-file.html). ```shell export TF_CLI_CONFIG_FILE="$HOME/.terraformrc-custom" diff --git a/website/docs/cli/config/index.html.md b/website/docs/cli/config/index.html.md index deb63b59b..dbac33b53 100644 --- a/website/docs/cli/config/index.html.md +++ b/website/docs/cli/config/index.html.md @@ -14,9 +14,9 @@ most of the global settings relate to advanced or automated workflows, or unusual environmental conditions like running Terraform on an airgapped instance. -- The [CLI config file](/docs/commands/cli-config.html) configures provider +- The [CLI config file](/docs/cli/config/config-file.html) configures provider installation and security features. -- Several [environment variables](/docs/commands/environment-variables.html) can +- Several [environment variables](/docs/cli/config/environment-variables.html) can configure Terraform's inputs and outputs; this includes some alternate ways to provide information that is usually passed on the command line or read from the state of the shell. diff --git a/website/docs/cli/import/usage.html.md b/website/docs/cli/import/usage.html.md index e5bd85a17..4fdc5452d 100644 --- a/website/docs/cli/import/usage.html.md +++ b/website/docs/cli/import/usage.html.md @@ -57,7 +57,7 @@ Terraform state. It is also possible to import to resources in child modules, using their paths, and to single instances of a resource with `count` or `for_each` set. See -[_Resource Addressing_](/docs/internals/resource-addressing.html) for more +[_Resource Addressing_](/docs/cli/state/resource-addressing.html) for more details on how to specify a target resource. The syntax of the given ID is dependent on the resource type being imported. @@ -83,4 +83,4 @@ a `resource` block in configuration for each secondary resource. If this is not done, Terraform will plan to destroy the imported objects on the next run. If you want to rename or otherwise move the imported resources, the -[state management commands](/docs/commands/state/index.html) can be used. +[state management commands](/docs/cli/commands/state/index.html) can be used. diff --git a/website/docs/cli/init/index.html.md b/website/docs/cli/init/index.html.md index 11bb27649..ee6372b0f 100644 --- a/website/docs/cli/init/index.html.md +++ b/website/docs/cli/init/index.html.md @@ -47,7 +47,7 @@ plugins, and downloading modules. Under some conditions (usually when changing from one backend to another), it might ask the user for guidance or confirmation. -For details, see [the `terraform init` command](/docs/commands/init.html). +For details, see [the `terraform init` command](/docs/cli/commands/init.html). ## Reinitialization diff --git a/website/docs/cli/inspect/index.html.md b/website/docs/cli/inspect/index.html.md index 070842c69..f704c0398 100644 --- a/website/docs/cli/inspect/index.html.md +++ b/website/docs/cli/inspect/index.html.md @@ -15,19 +15,19 @@ Terraform CLI includes some commands for inspecting or transforming this data. You can use these to integrate other tools with Terraform's infrastructure data, or just to gain a deeper or more holistic understanding of your infrastructure. -- [The `terraform graph` command](/docs/commands/graph.html) creates a visual +- [The `terraform graph` command](/docs/cli/commands/graph.html) creates a visual representation of a configuration or a set of planned changes. -- [The `terraform output` command](/docs/commands/output.html) can get the +- [The `terraform output` command](/docs/cli/commands/output.html) can get the values for the top-level [output values](/docs/language/values/outputs.html) of a configuration, which are often helpful when making use of the infrastructure Terraform has provisioned. -- [The `terraform show` command](/docs/commands/show.html) can generate +- [The `terraform show` command](/docs/cli/commands/show.html) can generate human-readable versions of a state file or plan file, or generate machine-readable versions that can be integrated with other tools. -- [The `terraform state list` command](/docs/commands/state/list.html) can list +- [The `terraform state list` command](/docs/cli/commands/state/list.html) can list the resources being managed by the current working directory and workspace, providing a complete or filtered list. -- [The `terraform state show` command](/docs/commands/state/show.html) can print +- [The `terraform state show` command](/docs/cli/commands/state/show.html) can print all of the attributes of a given resource being managed by the current working directory and workspace, including generated read-only attributes like the unique ID assigned by the cloud provider. diff --git a/website/docs/cli/plugins/index.html.md b/website/docs/cli/plugins/index.html.md index f7424023c..c1ac5e1e6 100644 --- a/website/docs/cli/plugins/index.html.md +++ b/website/docs/cli/plugins/index.html.md @@ -30,29 +30,29 @@ environments. Terraform's configuration file includes options for caching downloaded plugins, or explicitly specifying a local or HTTPS mirror to install plugins from. For -more information, see [CLI Config File](/docs/commands/cli-config.html). +more information, see [CLI Config File](/docs/cli/config/config-file.html). ## Getting Plugin Information -Use the [`terraform providers`](/docs/commands/providers.html) command to get information +Use the [`terraform providers`](/docs/cli/commands/providers.html) command to get information about the providers required by the current working directory's configuration. -Use the [`terraform version`](/docs/commands/version.html) command (or +Use the [`terraform version`](/docs/cli/commands/version.html) command (or `terraform -version`) to show the specific provider versions installed for the current working directory. -Use the [`terraform providers schema`](/docs/commands/providers/schema.html) command to +Use the [`terraform providers schema`](/docs/cli/commands/providers/schema.html) command to get machine-readable information about the resources and configuration options offered by each provider. ## Managing Plugin Installation -Use the [`terraform providers mirror`](/docs/commands/providers/mirror.html) command to +Use the [`terraform providers mirror`](/docs/cli/commands/providers/mirror.html) command to download local copies of every provider required by the current working directory's configuration. This directory will use the nested directory layout that Terraform expects when installing plugins from a local source, so you can transfer it directly to an airgapped system that runs Terraform. -Use the [`terraform providers lock`](/docs/commands/providers/lock.html) command +Use the [`terraform providers lock`](/docs/cli/commands/providers/lock.html) command to update the lock file that Terraform uses to ensure predictable runs when using ambiguous provider version constraints. diff --git a/website/docs/cli/run/index.html.md b/website/docs/cli/run/index.html.md index c54c6d5a0..579c9d81b 100644 --- a/website/docs/cli/run/index.html.md +++ b/website/docs/cli/run/index.html.md @@ -38,7 +38,7 @@ resulting actions are as expected. However, `terraform plan` can also save its plan as a runnable artifact, which `terraform apply` can use to carry out those exact changes. -For details, see [the `terraform plan` command](/docs/commands/plan.html). +For details, see [the `terraform plan` command](/docs/cli/commands/plan.html). ## Applying @@ -54,7 +54,7 @@ running a new plan. You can use this to reliably perform an exact set of pre-approved changes, even if the configuration or the state of the real infrastructure has changed in the minutes since the original plan was created. -For details, see [the `terraform apply` command](/docs/commands/apply.html). +For details, see [the `terraform apply` command](/docs/cli/commands/apply.html). ## Destroying @@ -68,4 +68,4 @@ and then running an apply, except that it doesn't require editing the configuration. This is more convenient if you intend to provision similar resources at a later date. -For details, see [the `terraform destroy` command](/docs/commands/destroy.html). +For details, see [the `terraform destroy` command](/docs/cli/commands/destroy.html). diff --git a/website/docs/cli/state/index.html.md b/website/docs/cli/state/index.html.md index 63e7d0bd7..8448de795 100644 --- a/website/docs/cli/state/index.html.md +++ b/website/docs/cli/state/index.html.md @@ -21,7 +21,7 @@ Terraform CLI supports several workflows for interacting with state: - [Forcing Re-creation (Tainting)](/docs/cli/state/taint.html) - [Moving Resources](/docs/cli/state/move.html) - Importing Pre-existing Resources (documented in the - [Importing Infrastructure](/docs/import/index.html) section) + [Importing Infrastructure](/docs/cli/import/index.html) section) - [Disaster Recovery](/docs/cli/state/recover.html) ~> **Important:** Modifying state data outside a normal plan or apply can cause diff --git a/website/docs/cli/state/inspect.html.md b/website/docs/cli/state/inspect.html.md index eb9792236..53ccc6f95 100644 --- a/website/docs/cli/state/inspect.html.md +++ b/website/docs/cli/state/inspect.html.md @@ -8,14 +8,14 @@ page_title: "Inspecting State - Terraform CLI" Terraform includes some commands for reading and updating state without taking any other actions. -- [The `terraform state list` command](/docs/commands/state/list.html) +- [The `terraform state list` command](/docs/cli/commands/state/list.html) shows the resource addresses for every resource Terraform knows about in a configuration, optionally filtered by partial resource address. -- [The `terraform state show` command](/docs/commands/state/show.html) +- [The `terraform state show` command](/docs/cli/commands/state/show.html) displays detailed state data about one resource. -- [The `terraform refresh` command](/docs/commands/refresh.html) updates +- [The `terraform refresh` command](/docs/cli/commands/refresh.html) updates state data to match the real-world condition of the managed resources. This is done automatically during plans and applies, but not when interacting with state directly. diff --git a/website/docs/cli/state/move.html.md b/website/docs/cli/state/move.html.md index b4cd62d90..87bb7198d 100644 --- a/website/docs/cli/state/move.html.md +++ b/website/docs/cli/state/move.html.md @@ -6,7 +6,7 @@ page_title: "Moving Resources - Terraform CLI" # Moving Resources Terraform's state associates each real-world object with a configured resource -at a specific [resource address](/docs/internals/resource-addressing.html). This +at a specific [resource address](/docs/cli/state/resource-addressing.html). This is seamless when changing a resource's attributes, but Terraform will lose track of a resource if you change its name, move it to a different module, or change its provider. @@ -19,17 +19,17 @@ In cases where it's important to preserve an existing infrastructure object, you can explicitly tell Terraform to associate it with a different configured resource. -- [The `terraform state mv` command](/docs/commands/state/mv.html) changes +- [The `terraform state mv` command](/docs/cli/commands/state/mv.html) changes which resource address in your configuration is associated with a particular real-world object. Use this to preserve an object when renaming a resource, or when moving a resource into or out of a child module. -- [The `terraform state rm` command](/docs/commands/state/rm.html) tells +- [The `terraform state rm` command](/docs/cli/commands/state/rm.html) tells Terraform to stop managing a resource as part of the current working directory and workspace, _without_ destroying the corresponding real-world object. (You can later use `terraform import` to start managing that resource in a different workspace or a different Terraform configuration.) -- [The `terraform state replace-provider` command](/docs/commands/state/replace-provider.html) +- [The `terraform state replace-provider` command](/docs/cli/commands/state/replace-provider.html) transfers existing resources to a new provider without requiring them to be re-created. diff --git a/website/docs/cli/state/recover.html.md b/website/docs/cli/state/recover.html.md index a8e55f3f6..5b45b8f6f 100644 --- a/website/docs/cli/state/recover.html.md +++ b/website/docs/cli/state/recover.html.md @@ -9,7 +9,7 @@ If something has gone horribly wrong (possibly due to accidents when performing other state manipulation actions), you might need to take drastic actions with your state data. -- [The `terraform force-unlock` command](/docs/commands/force-unlock.html) can +- [The `terraform force-unlock` command](/docs/cli/commands/force-unlock.html) can override the protections Terraform uses to prevent two processes from modifying state at the same time. You might need this if a Terraform process (like a normal apply) is unexpectedly terminated (like by the complete @@ -17,8 +17,8 @@ your state data. state backend. Do not run this until you are completely certain what happened to the process that caused the lock to get stuck. -- [The `terraform state pull` command](/docs/commands/state/pull.html) and - [the `terraform state push` command](/docs/commands/state/push.html) can +- [The `terraform state pull` command](/docs/cli/commands/state/pull.html) and + [the `terraform state push` command](/docs/cli/commands/state/push.html) can directly read and write entire state files from and to the configured backend. You might need this for obtaining or restoring a state backup. diff --git a/website/docs/cli/state/taint.html.md b/website/docs/cli/state/taint.html.md index 7a9b89435..12162c36d 100644 --- a/website/docs/cli/state/taint.html.md +++ b/website/docs/cli/state/taint.html.md @@ -16,10 +16,10 @@ happen during creation; for example, a virtual machine that configures itself with `cloud-init` on startup might no longer meet your needs if the cloud-init configuration changes. -- [The `terraform taint` command](/docs/commands/taint.html) tells Terraform to +- [The `terraform taint` command](/docs/cli/commands/taint.html) tells Terraform to destroy and re-create a particular resource during the next apply, regardless of whether its resource arguments would normally require that. -- [The `terraform untaint` command](/docs/commands/untaint.html) undoes a +- [The `terraform untaint` command](/docs/cli/commands/untaint.html) undoes a previous taint, or can preserve a resource that was automatically tainted due to failed [provisioners](/docs/language/resources/provisioners/syntax.html). diff --git a/website/docs/cli/workspaces/index.html.md b/website/docs/cli/workspaces/index.html.md index aabce80f2..f6a76a0e6 100644 --- a/website/docs/cli/workspaces/index.html.md +++ b/website/docs/cli/workspaces/index.html.md @@ -17,11 +17,11 @@ resources with the same configuration. - Most Terraform commands (including [provisioning](/docs/cli/run/index.html) and [state manipulation](/docs/cli/state/index.html) commands) only interact with the currently selected workspace. -- Use [the `terraform workspace select` command](/docs/commands/workspace/select.html) +- Use [the `terraform workspace select` command](/docs/cli/commands/workspace/select.html) to change the currently selected workspace. -- Use the [`terraform workspace list`](/docs/commands/workspace/list.html), - [`terraform workspace new`](/docs/commands/workspace/new.html), and - [`terraform workspace delete`](/docs/commands/workspace/delete.html) commands +- Use the [`terraform workspace list`](/docs/cli/commands/workspace/list.html), + [`terraform workspace new`](/docs/cli/commands/workspace/new.html), and + [`terraform workspace delete`](/docs/cli/commands/workspace/delete.html) commands to manage the available workspaces in the current working directory. -> **Note:** Terraform Cloud and Terraform CLI both have features called diff --git a/website/docs/commands/state/addressing.html.md b/website/docs/commands/state/addressing.html.md index 323b58839..8de68b36f 100644 --- a/website/docs/commands/state/addressing.html.md +++ b/website/docs/commands/state/addressing.html.md @@ -9,7 +9,7 @@ description: |- # Resource Addressing The `terraform state` subcommands use -[standard address syntax](/docs/internals/resource-addressing.html) to refer +[standard address syntax](/docs/cli/state/resource-addressing.html) to refer to individual resources, resource instances, and modules. This is the same syntax used for the `-target` option to the `apply` and `plan` commands. @@ -17,4 +17,4 @@ Most state commands allow referring to individual resource instances, whole resources (which may have multiple instances if `count` or `for_each` is used), or even whole modules. -For more information on the syntax, see [Resource Addressing](/docs/internals/resource-addressing.html). +For more information on the syntax, see [Resource Addressing](/docs/cli/state/resource-addressing.html). diff --git a/website/docs/configuration-0-11/environment-variables.html.md b/website/docs/configuration-0-11/environment-variables.html.md index 85a5468ec..979980884 100644 --- a/website/docs/configuration-0-11/environment-variables.html.md +++ b/website/docs/configuration-0-11/environment-variables.html.md @@ -10,7 +10,7 @@ description: |- -> **Note:** This page is about Terraform 0.11 and earlier. For Terraform 0.12 and later, see -[Commands: Environment Variables](../commands/environment-variables.html). +[Commands: Environment Variables](/docs/cli/config/environment-variables.html). ## TF_LOG @@ -48,7 +48,7 @@ export TF_INPUT=0 ## TF_MODULE_DEPTH -When given a value, causes terraform commands to behave as if the `-module-depth=VALUE` flag was specified. By setting this to 0, for example, you enable commands such as [plan](/docs/commands/plan.html) and [graph](/docs/commands/graph.html) to display more compressed information. +When given a value, causes terraform commands to behave as if the `-module-depth=VALUE` flag was specified. By setting this to 0, for example, you enable commands such as [plan](/docs/cli/commands/plan.html) and [graph](/docs/cli/commands/graph.html) to display more compressed information. ```shell export TF_MODULE_DEPTH=0 diff --git a/website/docs/configuration-0-11/interpolation.html.md b/website/docs/configuration-0-11/interpolation.html.md index c095ae6ab..9ec65d8aa 100644 --- a/website/docs/configuration-0-11/interpolation.html.md +++ b/website/docs/configuration-0-11/interpolation.html.md @@ -560,7 +560,7 @@ Operator precedences is the standard mathematical order of operations: "${2 * (4 + 3) * 3}" # computes to 42 ``` -You can use the [terraform console](/docs/commands/console.html) command to +You can use the [terraform console](/docs/cli/commands/console.html) command to try the math operations. -> **Note:** Since Terraform allows hyphens in resource and variable names, diff --git a/website/docs/configuration-0-11/modules.html.md b/website/docs/configuration-0-11/modules.html.md index 552dc80c7..25f2984d7 100644 --- a/website/docs/configuration-0-11/modules.html.md +++ b/website/docs/configuration-0-11/modules.html.md @@ -386,7 +386,7 @@ giving each instance a unique name -- here `module "assets_bucket"` and Resources from child modules are prefixed with `module.` when displayed in plan output and elsewhere in the UI. For example, the `./publish_bucket` module contains `aws_s3_bucket.example`, and so the two -instances of this module produce S3 bucket resources with [_resource addresses_](/docs/internals/resource-addressing.html) +instances of this module produce S3 bucket resources with [_resource addresses_](/docs/cli/state/resource-addressing.html) `module.assets_bucket.aws_s3_bucket.example` and `module.media_bucket.aws_s3_bucket.example` respectively. These full addresses are used within the UI and on the command line, but are not valid within interpolation expressions due to the @@ -405,7 +405,7 @@ several regions or datacenters. ## Tainting resources within a module -The [taint command](/docs/commands/taint.html) can be used to _taint_ specific +The [taint command](/docs/cli/commands/taint.html) can be used to _taint_ specific resources within a module: ```shell diff --git a/website/docs/configuration-0-11/outputs.html.md b/website/docs/configuration-0-11/outputs.html.md index 1b9510605..cf9e8b434 100644 --- a/website/docs/configuration-0-11/outputs.html.md +++ b/website/docs/configuration-0-11/outputs.html.md @@ -14,7 +14,7 @@ and later, see Outputs define values that will be highlighted to the user when Terraform applies, and can be queried easily using the -[output command](/docs/commands/output.html). +[output command](/docs/cli/commands/output.html). Terraform knows a lot about the infrastructure it manages. Most resources have attributes associated with them, and diff --git a/website/docs/configuration-0-11/providers.html.md b/website/docs/configuration-0-11/providers.html.md index fbdc3e87e..2450f38e6 100644 --- a/website/docs/configuration-0-11/providers.html.md +++ b/website/docs/configuration-0-11/providers.html.md @@ -79,7 +79,7 @@ distributed by HashiCorp. See [Third-party Plugins](#third-party-plugins) below for installation instructions. For more information, see -[the `terraform init` command](/docs/commands/init.html). +[the `terraform init` command](/docs/cli/commands/init.html). ## Provider Versions @@ -118,7 +118,7 @@ provider "aws" { ``` This special argument applies to _all_ providers. -[`terraform providers`](/docs/commands/providers.html) can be used to +[`terraform providers`](/docs/cli/commands/providers.html) can be used to view the specified version constraints for all providers used in the current configuration. @@ -295,7 +295,7 @@ use of a local directory as a shared plugin cache, which then allows each distinct plugin binary to be downloaded only once. To enable the plugin cache, use the `plugin_cache_dir` setting in -[the CLI configuration file](https://www.terraform.io/docs/commands/cli-config.html). +[the CLI configuration file](https://www.terraform.io/docs/cli/config/config-file.html). For example: ```hcl diff --git a/website/docs/configuration-0-11/terraform-enterprise.html.md b/website/docs/configuration-0-11/terraform-enterprise.html.md index 1f68973c9..8c5ee7f38 100644 --- a/website/docs/configuration-0-11/terraform-enterprise.html.md +++ b/website/docs/configuration-0-11/terraform-enterprise.html.md @@ -13,7 +13,7 @@ feature that was removed in Terraform 0.12. ~> **Important:** The `terraform push` command is deprecated, and only works with the legacy version of Terraform Enterprise. In the current version of Terraform Cloud, you can upload configurations using the API. See [the docs about API-driven runs](/docs/cloud/run/api.html) for more details. -The [`terraform push` command](/docs/commands/push.html) uploads a configuration to a Terraform Enterprise (legacy) environment. The name of the environment (and the organization it's in) can be specified on the command line, or as part of the Terraform configuration in an `atlas` block. +The [`terraform push` command](/docs/cli/commands/push.html) uploads a configuration to a Terraform Enterprise (legacy) environment. The name of the environment (and the organization it's in) can be specified on the command line, or as part of the Terraform configuration in an `atlas` block. The `atlas` block does not configure remote state; it only configures the push command. For remote state, use a `terraform { backend "" {...} }` block. @@ -40,7 +40,7 @@ Enterprise**. While this transition is in progress, you may see references to ## Description The `atlas` block configures the settings when Terraform is -[pushed](/docs/commands/push.html) to Terraform Enterprise. Only one `atlas` block +[pushed](/docs/cli/commands/push.html) to Terraform Enterprise. Only one `atlas` block is allowed. Within the block (the `{ }`) is configuration for Atlas uploading. @@ -50,7 +50,7 @@ No keys are required, but the key typically set is `name`. to the nature of this configuration, interpolations are not possible. If you want to parameterize these settings, use the Atlas block to set defaults, then use the command-line flags of the -[push command](/docs/commands/push.html) to override. +[push command](/docs/cli/commands/push.html) to override. ## Syntax diff --git a/website/docs/internals/credentials-helpers.html.md b/website/docs/internals/credentials-helpers.html.md index c7572484e..8e8b71aa0 100644 --- a/website/docs/internals/credentials-helpers.html.md +++ b/website/docs/internals/credentials-helpers.html.md @@ -12,7 +12,7 @@ For Terraform-specific features that interact with remote network services, such as [module registries](/docs/registry/) and [remote operations](/docs/cloud/run/cli.html), Terraform by default looks for API credentials to use in these calls in -[the CLI configuration](/docs/commands/cli-config.html). +[the CLI configuration](/docs/cli/config/config-file.html). Credentials helpers offer an alternative approach that allows you to customize how Terraform obtains credentials using an external program, which can then @@ -20,7 +20,7 @@ directly access an existing secrets management system in your organization. This page is about how to write and install a credentials helper. To learn how to configure a credentials helper that was already installed, see -[the CLI config Credentials Helpers section](/docs/commands/cli-config.html#credentials-helpers). +[the CLI config Credentials Helpers section](/docs/cli/config/config-file.html#credentials-helpers). ## How Terraform finds Credentials Helpers @@ -57,7 +57,7 @@ The current set of verbs are: To represent credentials, the credentials helper protocol uses a JSON object whose contents correspond with the contents of -[`credentials` blocks in the CLI configuration](/docs/commands/cli-config.html#credentials). +[`credentials` blocks in the CLI configuration](/docs/cli/config/config-file.html#credentials). To represent an API token, the object contains a property called "token" whose value is the token string: diff --git a/website/docs/internals/graph.html.md b/website/docs/internals/graph.html.md index e2de628f5..56ec892fa 100644 --- a/website/docs/internals/graph.html.md +++ b/website/docs/internals/graph.html.md @@ -108,8 +108,8 @@ The amount of parallelism is limited using a semaphore to prevent too many concurrent operations from overwhelming the resources of the machine running Terraform. By default, up to 10 nodes in the graph will be processed concurrently. This number can be set using the `-parallelism` flag on the -[plan](/docs/commands/plan.html), [apply](/docs/commands/apply.html), and -[destroy](/docs/commands/destroy.html) commands. +[plan](/docs/cli/commands/plan.html), [apply](/docs/cli/commands/apply.html), and +[destroy](/docs/cli/commands/destroy.html) commands. Setting `-parallelism` is considered an advanced operation and should not be necessary for normal usage of Terraform. It may be helpful in certain special diff --git a/website/docs/internals/json-format.html.md b/website/docs/internals/json-format.html.md index 9420f2b00..88d3e0e75 100644 --- a/website/docs/internals/json-format.html.md +++ b/website/docs/internals/json-format.html.md @@ -14,7 +14,7 @@ When Terraform plans to make changes, it prints a human-readable summary to the Since the format of plan files isn't suited for use with external tools (and likely never will be), Terraform can output a machine-readable JSON representation of a plan file's changes. It can also convert state files to the same format, to simplify data loading and provide better long-term compatibility. -Use `terraform show -json ` to generate a JSON representation of a plan or state file. See [the `terraform show` documentation](/docs/commands/show.html) for more details. +Use `terraform show -json ` to generate a JSON representation of a plan or state file. See [the `terraform show` documentation](/docs/cli/commands/show.html) for more details. -> **Note:** The output includes a `format_version` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. diff --git a/website/docs/internals/login-protocol.html.markdown b/website/docs/internals/login-protocol.html.markdown index 560a471be..59e3a39a3 100644 --- a/website/docs/internals/login-protocol.html.markdown +++ b/website/docs/internals/login-protocol.html.markdown @@ -9,7 +9,7 @@ description: |- # Server-side Login Protocol ~> **Note:** You don't need to read these docs to _use_ -[`terraform login`](/docs/commands/login.html). The information below is for +[`terraform login`](/docs/cli/commands/login.html). The information below is for anyone intending to implement the server side of `terraform login` in order to offer Terraform-native services in a third-party system. diff --git a/website/docs/internals/provider-network-mirror-protocol.html.md b/website/docs/internals/provider-network-mirror-protocol.html.md index 0afe196bb..9520f8298 100644 --- a/website/docs/internals/provider-network-mirror-protocol.html.md +++ b/website/docs/internals/provider-network-mirror-protocol.html.md @@ -18,7 +18,7 @@ implement to provide an alternative installation source for Terraform providers, regardless of their origin registries. Terraform uses network mirrors only if you activate them explicitly in -[the CLI configuration's `provider_installation` block](/docs/commands/cli-config.html#provider-installation). +[the CLI configuration's `provider_installation` block](/docs/cli/config/config-file.html#provider-installation). When enabled, a network mirror can serve providers belonging to any registry hostname, which can allow an organization to serve all of the Terraform providers they intend to use from an internal server, rather than from each @@ -96,7 +96,7 @@ base URL from the above CLI configuration example. ### Authentication If the CLI configuration includes -[credentials](/docs/commands/cli-config.html#credentials) for the hostname +[credentials](/docs/cli/config/config-file.html#credentials) for the hostname given in the network mirror base URL, Terraform will include those credentials in its requests for operations described below. @@ -264,7 +264,7 @@ in the appropriate nested subdirectories, and ensure that your system is configured to serve `.json` files with the `application/json` media type. As a convenience, Terraform CLI includes -[the `terraform providers mirror` subcommand](https://www.terraform.io/docs/commands/providers/mirror.html), +[the `terraform providers mirror` subcommand](https://www.terraform.io/docs/cli/commands/providers/mirror.html), which will analyze the current configuration for the providers it requires, download the packages for those providers from their origin registries, and place them into a local directory suitable for use as a mirror. diff --git a/website/docs/internals/provider-registry-protocol.html.md b/website/docs/internals/provider-registry-protocol.html.md index b81dead37..8dd4c543e 100644 --- a/website/docs/internals/provider-registry-protocol.html.md +++ b/website/docs/internals/provider-registry-protocol.html.md @@ -42,7 +42,7 @@ where: * `hostname` is the registry host that the provider is considered to have originated from, and the default location Terraform will consult for information about the provider - [unless overridden in the CLI configuration](/docs/commands/cli-config.html#provider-installation). + [unless overridden in the CLI configuration](/docs/cli/config/config-file.html#provider-installation). * `namespace` is the name of a namespace, unique on a particular hostname, that can contain one or more providers that are somehow related. On the public Terraform Registry the "namespace" represents the organization that is @@ -78,7 +78,7 @@ to see it as an entirely separate provider that will _not_ be usable by modules that declare a dependency on `hashicorp/azurerm`. If your goal is to create an alternative local distribution source for an existing provider -- that is, a _mirror_ of the provider -- refer to -[the provider installation method configuration](/docs/commands/cli-config.html#provider-installation) +[the provider installation method configuration](/docs/cli/config/config-file.html#provider-installation) instead. ## Provider Versions diff --git a/website/docs/internals/remote-service-discovery.html.md b/website/docs/internals/remote-service-discovery.html.md index 4ae3dfc8d..f82617e7a 100644 --- a/website/docs/internals/remote-service-discovery.html.md +++ b/website/docs/internals/remote-service-discovery.html.md @@ -85,14 +85,14 @@ version 1 of the module registry protocol: At present, the following service identifiers are in use: -* `login.v1`: [login protocol version 1](/docs/commands/login.html) +* `login.v1`: [login protocol version 1](/docs/cli/commands/login.html) * `modules.v1`: [module registry API version 1](module-registry-protocol.html) * `providers.v1`: [provider registry API version 1](provider-registry-protocol.html) ## Authentication If credentials for the given hostname are available in -[the CLI config](/docs/commands/cli-config.html) then they will be included +[the CLI config](/docs/cli/config/config-file.html) then they will be included in the request for the discovery document. The credentials may also be provided to endpoints declared in the discovery diff --git a/website/docs/language/dependency-lock.html.md b/website/docs/language/dependency-lock.html.md index c7242b7df..4f30a68ce 100644 --- a/website/docs/language/dependency-lock.html.md +++ b/website/docs/language/dependency-lock.html.md @@ -51,7 +51,7 @@ to signify that it is a lock file for various items that Terraform caches in the `.terraform` subdirectory of your working directory. Terraform automatically creates or updates the dependency lock file each time -you run [the `terraform init` command](/docs/commands/init.html). You should +you run [the `terraform init` command](/docs/cli/commands/init.html). You should include this file in your version control repository so that you can discuss potential changes to your external dependencies via code review, just as you would discuss potential changes to your configuration itself. @@ -139,7 +139,7 @@ There are two special considerations with the "trust on first use" model: To avoid this problem you can pre-populate checksums for a variety of different platforms in your lock file using - [the `terraform providers lock` command](/docs/commands/providers/lock.html), + [the `terraform providers lock` command](/docs/cli/commands/providers/lock.html), which will then allow future calls to `terraform init` to verify that the packages available in your chosen mirror match the official packages from the provider's origin registry. @@ -304,7 +304,7 @@ The two hashing schemes currently supported are: packages indexed in the origin registry. This is an effective scheme for verifying the official release packages when installed from a registry, but it's not suitable for verifying packages that come from other - [provider installation methods](/docs/commands/cli-config.html#provider-installation), + [provider installation methods](/docs/cli/config/config-file.html#provider-installation), such as filesystem mirrors using the unpacked directory layout. * `h1:`: a mnemonic for "hash scheme 1", which is the current preferred hashing @@ -345,7 +345,7 @@ your configuration on new target platforms, or if you are installing providers from a mirror that therefore can't provide official signed checksums, you can ask Terraform to pre-populate hashes for a chosen set of platforms using -[the `terraform providers lock` command](/docs/commands/providers/lock.html): +[the `terraform providers lock` command](/docs/cli/commands/providers/lock.html): ``` terraform providers lock \ diff --git a/website/docs/language/expressions/index.html.md b/website/docs/language/expressions/index.html.md index ae98e9f67..5a6a18a0f 100644 --- a/website/docs/language/expressions/index.html.md +++ b/website/docs/language/expressions/index.html.md @@ -22,7 +22,7 @@ expressions. You can experiment with the behavior of Terraform's expressions from the Terraform expression console, by running -[the `terraform console` command](/docs/commands/console.html). +[the `terraform console` command](/docs/cli/commands/console.html). The other pages in this section describe the features of Terraform's expression syntax. diff --git a/website/docs/language/functions/index.html.md b/website/docs/language/functions/index.html.md index 2770bdaef..f062b32a7 100644 --- a/website/docs/language/functions/index.html.md +++ b/website/docs/language/functions/index.html.md @@ -30,7 +30,7 @@ for this section includes a list of all of the available built-in functions. You can experiment with the behavior of Terraform's built-in functions from the Terraform expression console, by running -[the `terraform console` command](/docs/commands/console.html): +[the `terraform console` command](/docs/cli/commands/console.html): ``` > max(5, 12, 9) diff --git a/website/docs/language/index.html.md b/website/docs/language/index.html.md index 40620aa0f..49067f802 100644 --- a/website/docs/language/index.html.md +++ b/website/docs/language/index.html.md @@ -6,7 +6,7 @@ page_title: "Overview - Configuration Language" # Terraform Language Documentation This is the documentation for Terraform's configuration language. It is relevant -to users of [Terraform CLI](/docs/cli-index.html), +to users of [Terraform CLI](/docs/cli/index.html), [Terraform Cloud](/docs/cloud/index.html), and [Terraform Enterprise](/docs/enterprise/index.html). diff --git a/website/docs/language/modules/develop/index.html.md b/website/docs/language/modules/develop/index.html.md index c2c10d06c..5e71edd59 100644 --- a/website/docs/language/modules/develop/index.html.md +++ b/website/docs/language/modules/develop/index.html.md @@ -15,8 +15,8 @@ Modules can be used to create lightweight abstractions, so that you can describe your infrastructure in terms of its architecture, rather than directly in terms of physical objects. -The `.tf` files in your working directory when you run [`terraform plan`](/docs/commands/plan.html) -or [`terraform apply`](/docs/commands/apply.html) together form the _root_ +The `.tf` files in your working directory when you run [`terraform plan`](/docs/cli/commands/plan.html) +or [`terraform apply`](/docs/cli/commands/apply.html) together form the _root_ module. That module may [call other modules](/docs/language/modules/syntax.html#calling-a-child-module) and connect them together by passing output values from one to input values of another. diff --git a/website/docs/language/modules/sources.html.md b/website/docs/language/modules/sources.html.md index 294d1590d..c8e232909 100644 --- a/website/docs/language/modules/sources.html.md +++ b/website/docs/language/modules/sources.html.md @@ -129,7 +129,7 @@ You can learn more about the registry at the [Terraform Registry documentation](/docs/registry/modules/use.html#using-modules). To access modules from a private registry, you may need to configure an access -token [in the CLI config](/docs/commands/cli-config.html#credentials). Use the +token [in the CLI config](/docs/cli/config/config-file.html#credentials). Use the same hostname as used in the module source string. For a private registry within Terraform Cloud, use the same authentication token as you would use with the Enterprise API or command-line clients. diff --git a/website/docs/language/modules/syntax.html.md b/website/docs/language/modules/syntax.html.md index f2616210a..9bbf78d9f 100644 --- a/website/docs/language/modules/syntax.html.md +++ b/website/docs/language/modules/syntax.html.md @@ -168,7 +168,7 @@ after moving code across modules to ensure that no resources are deleted by surprise. If you want to make sure an existing resource is preserved, use -[the `terraform state mv` command](/docs/commands/state/mv.html) to inform +[the `terraform state mv` command](/docs/cli/commands/state/mv.html) to inform Terraform that it has moved to a different module. When passing resource addresses to `terraform state mv`, resources within child @@ -186,7 +186,7 @@ elsewhere in your configuration. ## Tainting resources within a module -The [taint command](/docs/commands/taint.html) can be used to _taint_ specific +The [taint command](/docs/cli/commands/taint.html) can be used to _taint_ specific resources within a module: ```shell diff --git a/website/docs/language/providers/index.html.md b/website/docs/language/providers/index.html.md index f9c183bd5..44f830101 100644 --- a/website/docs/language/providers/index.html.md +++ b/website/docs/language/providers/index.html.md @@ -60,7 +60,7 @@ about it in your configuration. See the following pages for details: To save time and bandwidth, Terraform CLI supports an optional plugin cache. You can enable the cache using the `plugin_cache_dir` setting in - [the CLI configuration file](/docs/commands/cli-config.html). + [the CLI configuration file](/docs/cli/config/config-file.html). To ensure Terraform always installs the same provider versions for a given configuration, you can use Terraform CLI to create a diff --git a/website/docs/language/providers/requirements.html.md b/website/docs/language/providers/requirements.html.md index a1bf72874..128192432 100644 --- a/website/docs/language/providers/requirements.html.md +++ b/website/docs/language/providers/requirements.html.md @@ -303,7 +303,7 @@ registry, by implementing Running an additional service just to distribute a single provider internally may be undesirable, so Terraform also supports -[other provider installation methods](/docs/commands/cli-config.html#provider-installation), +[other provider installation methods](/docs/cli/config/config-file.html#provider-installation), including placing provider plugins directly in specific directories in the local filesystem, via _filesystem mirrors_. @@ -332,7 +332,7 @@ terraform { To make version 1.0.0 of this provider available for installation from the local filesystem, choose one of the -[implied local mirror directories](/docs/commands/cli-config.html#implied-local-mirror-directories) +[implied local mirror directories](/docs/cli/config/config-file.html#implied-local-mirror-directories) and create a directory structure under it like this: ``` diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.html.md index b7d708c8a..2e501e0f2 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.html.md @@ -29,14 +29,14 @@ this section document how to configure and use backends. ## Where Backends are Used -Backend configuration is only used by [Terraform CLI](/docs/cli-index.html). +Backend configuration is only used by [Terraform CLI](/docs/cli/index.html). Terraform Cloud and Terraform Enterprise always use their own state storage when performing Terraform runs, so they ignore any backend block in the configuration. But since it's common to [use Terraform CLI alongside Terraform Cloud](/docs/cloud/run/cli.html) -(and since certain state operations, like [tainting](/docs/commands/taint.html), +(and since certain state operations, like [tainting](/docs/cli/commands/taint.html), can only be performed on the CLI), we recommend that Terraform Cloud users include a backend block in their configurations and configure the `remote` backend to use the relevant Terraform Cloud workspace(s). diff --git a/website/docs/language/settings/backends/pg.html.md b/website/docs/language/settings/backends/pg.html.md index ba1925c1b..362443cfb 100644 --- a/website/docs/language/settings/backends/pg.html.md +++ b/website/docs/language/settings/backends/pg.html.md @@ -85,7 +85,7 @@ This backend creates one table **states** in the automatically-managed Postgres The table is keyed by the [workspace](/docs/language/state/workspaces.html) name. If workspaces are not in use, the name `default` is used. -Locking is supported using [Postgres advisory locks](https://www.postgresql.org/docs/9.5/explicit-locking.html#ADVISORY-LOCKS). [`force-unlock`](https://www.terraform.io/docs/commands/force-unlock.html) is not supported, because these database-native locks will automatically unlock when the session is aborted or the connection fails. To see outstanding locks in a Postgres server, use the [`pg_locks` system view](https://www.postgresql.org/docs/9.5/view-pg-locks.html). +Locking is supported using [Postgres advisory locks](https://www.postgresql.org/docs/9.5/explicit-locking.html#ADVISORY-LOCKS). [`force-unlock`](https://www.terraform.io/docs/cli/commands/force-unlock.html) is not supported, because these database-native locks will automatically unlock when the session is aborted or the connection fails. To see outstanding locks in a Postgres server, use the [`pg_locks` system view](https://www.postgresql.org/docs/9.5/view-pg-locks.html). The **states** table contains: diff --git a/website/docs/language/settings/backends/remote.html.md b/website/docs/language/settings/backends/remote.html.md index 6f2e78b05..83350eae9 100644 --- a/website/docs/language/settings/backends/remote.html.md +++ b/website/docs/language/settings/backends/remote.html.md @@ -94,8 +94,8 @@ running any remote operations against them. ## Example Configurations -> **Note:** We recommend omitting the token from the configuration, and instead using - [`terraform login`](/docs/commands/login.html) or manually configuring - `credentials` in the [CLI config file](/docs/commands/cli-config.html#credentials). + [`terraform login`](/docs/cli/commands/login.html) or manually configuring + `credentials` in the [CLI config file](/docs/cli/config/config-file.html#credentials). ### Basic Configuration @@ -177,9 +177,9 @@ The following configuration options are supported: targeted workspace(s). * `token` - (Optional) The token used to authenticate with the remote backend. We recommend omitting the token from the configuration, and instead using - [`terraform login`](/docs/commands/login.html) or manually configuring + [`terraform login`](/docs/cli/commands/login.html) or manually configuring `credentials` in the - [CLI config file](/docs/commands/cli-config.html#credentials). + [CLI config file](/docs/cli/config/config-file.html#credentials). * `workspaces` - (Required) A block specifying which remote workspace(s) to use. The `workspaces` block supports the following keys: diff --git a/website/docs/language/state/import.html.md b/website/docs/language/state/import.html.md index a71d68d5b..1334269e9 100644 --- a/website/docs/language/state/import.html.md +++ b/website/docs/language/state/import.html.md @@ -12,4 +12,4 @@ Terraform is able to import existing infrastructure. This allows you take resources you've created by some other means and bring it under Terraform management. To learn more about this, please visit the -[pages dedicated to import](/docs/import/index.html). +[pages dedicated to import](/docs/cli/import/index.html). diff --git a/website/docs/language/state/index.html.md b/website/docs/language/state/index.html.md index f14444a0d..071cee81e 100644 --- a/website/docs/language/state/index.html.md +++ b/website/docs/language/state/index.html.md @@ -18,7 +18,7 @@ but it can also be stored remotely, which works better in a team environment. Terraform uses this local state to create plans and make changes to your infrastructure. Prior to any operation, Terraform does a -[refresh](/docs/commands/refresh.html) to update the state with the +[refresh](/docs/cli/commands/refresh.html) to update the state with the real infrastructure. The primary purpose of Terraform state is to store bindings between objects in @@ -35,7 +35,7 @@ function without state, please see the page [state purpose](/docs/language/state While the format of the state files are just JSON, direct file editing of the state is discouraged. Terraform provides the -[terraform state](/docs/commands/state/index.html) command to perform +[terraform state](/docs/cli/commands/state/index.html) command to perform basic modifications of the state using the CLI. The CLI usage and output of the state commands is structured to be @@ -68,10 +68,10 @@ in new versions. Alternatively, there are several integration points which produce JSON output that is specifically intended for consumption by external software: -* [The `terraform output` command](/docs/commands/output.html) +* [The `terraform output` command](/docs/cli/commands/output.html) has a `-json` option, for obtaining either the full set of root module output values or a specific named output value from the latest state snapshot. -* [The `terraform show` command](/docs/commands/show.html) has a `-json` +* [The `terraform show` command](/docs/cli/commands/show.html) has a `-json` option for inspecting the latest state snapshot in full, and also for inspecting saved plan files which include a copy of the prior state at the time the plan was made. diff --git a/website/docs/language/state/locking.html.md b/website/docs/language/state/locking.html.md index 668f4112b..739a4b8c4 100644 --- a/website/docs/language/state/locking.html.md +++ b/website/docs/language/state/locking.html.md @@ -27,7 +27,7 @@ includes details on whether it supports locking or not. ## Force Unlock -Terraform has a [force-unlock command](/docs/commands/force-unlock.html) +Terraform has a [force-unlock command](/docs/cli/commands/force-unlock.html) to manually unlock the state if unlocking failed. **Be very careful with this command.** If you unlock the state when someone diff --git a/website/docs/language/syntax/index.html.md b/website/docs/language/syntax/index.html.md index cdca545ee..83de5faaa 100644 --- a/website/docs/language/syntax/index.html.md +++ b/website/docs/language/syntax/index.html.md @@ -18,4 +18,4 @@ section offer a more abstract view of the Terraform language. don't have a readily available HCL library. - [Style Conventions](/docs/language/syntax/style.html) documents some commonly accepted formatting guidelines for Terraform code. These conventions can be - enforced automatically with [`terraform fmt`](/docs/commands/fmt.html). + enforced automatically with [`terraform fmt`](/docs/cli/commands/fmt.html). diff --git a/website/docs/plugins/provider.html.md b/website/docs/plugins/provider.html.md index 9b5c04b6d..de2c7ce1a 100644 --- a/website/docs/plugins/provider.html.md +++ b/website/docs/plugins/provider.html.md @@ -186,7 +186,7 @@ structure. This structure has the following fields: you may keep that field nil. * `Importer` - If this is non-nil, then this resource is - [importable](/docs/import/importability.html). It is recommended to + [importable](/docs/cli/import/importability.html). It is recommended to implement this. The CRUD operations in more detail, along with their contracts: diff --git a/website/upgrade-guides/0-10.html.markdown b/website/upgrade-guides/0-10.html.markdown index a2a755f2f..e7368b8f1 100644 --- a/website/upgrade-guides/0-10.html.markdown +++ b/website/upgrade-guides/0-10.html.markdown @@ -28,7 +28,7 @@ in the navigation) if you are upgrading directly from an earlier version. As of v0.10, provider plugins are no longer included in the main Terraform distribution. Instead, they are distributed separately and installed automatically by -[the `terraform init` command](/docs/commands/init.html). +[the `terraform init` command](/docs/cli/commands/init.html). In the long run, this new approach should be beneficial to anyone who wishes to upgrade a specific provider to get new functionality without also @@ -104,9 +104,9 @@ For example, if `module.example` contains a module itself, called `module.example` _and_ `module.example.module.examplechild`. This also applies to other Terraform features that use -[resource addressing](/docs/internals/resource-addressing.html) syntax. +[resource addressing](/docs/cli/state/resource-addressing.html) syntax. This includes some of the subcommands of -[`terraform state`](/docs/commands/state/index.html). +[`terraform state`](/docs/cli/commands/state/index.html). **Action:** If running Terraform with `-target` in automation, review usage to ensure that selecting additional resources in child modules will not have diff --git a/website/upgrade-guides/0-12.html.markdown b/website/upgrade-guides/0-12.html.markdown index e165bc54d..8c72aa1ee 100644 --- a/website/upgrade-guides/0-12.html.markdown +++ b/website/upgrade-guides/0-12.html.markdown @@ -16,7 +16,7 @@ to cover the most common upgrade concerns and issues. For most users, upgrading configuration should be completely automatic. Some simple configurations will require no changes at all, and most other configurations can be prepared by running -[the automatic upgrade tool](/docs/commands/0.12upgrade.html). Please read on +[the automatic upgrade tool](/docs/cli/commands/0.12upgrade.html). Please read on for more information and recommendations on the upgrade process. -> If you are a developer maintaining a provider plugin, please see diff --git a/website/upgrade-guides/0-13.html.markdown b/website/upgrade-guides/0-13.html.markdown index b763f6733..5adb45b31 100644 --- a/website/upgrade-guides/0-13.html.markdown +++ b/website/upgrade-guides/0-13.html.markdown @@ -117,7 +117,7 @@ following command: As mentioned in the error message, Terraform v0.13 includes an automatic upgrade command -[`terraform 0.13upgrade`](/docs/commands/0.13upgrade.html) +[`terraform 0.13upgrade`](/docs/cli/commands/0.13upgrade.html) that is able to automatically generate source addresses for unlabelled providers by consulting the same lookup table that was previously used for Terraform v0.12 provider installation. This command will automatically modify @@ -140,7 +140,7 @@ version constraint for Terraform v0.13 or later, which you can weaken to Each module must declare its own set of provider requirements, so if you have a configuration which calls other modules then you'll need to run this upgrade command for each module separately. -[The `terraform 0.13upgrade documentation`](/docs/commands/0.13upgrade.html) +[The `terraform 0.13upgrade documentation`](/docs/cli/commands/0.13upgrade.html) includes an example of running the upgrade process across all directories under a particular prefix that contain `.tf` files using some common Unix command line tools, which may be useful if you want to upgrade all modules in a single @@ -149,7 +149,7 @@ repository at once. After you've added explicit provider source addresses to your configuration, run `terraform init` again to re-run the provider installer. --> **Action:** Either run [`terraform 0.13upgrade`](/docs/commands/0.13upgrade.html) for each of your modules, or manually update the provider declarations to use explicit source addresses. +-> **Action:** Either run [`terraform 0.13upgrade`](/docs/cli/commands/0.13upgrade.html) for each of your modules, or manually update the provider declarations to use explicit source addresses. The upgrade tool described above only updates references in your configuration. The Terraform state also includes references to provider configurations which @@ -232,12 +232,12 @@ Terraform under: Terraform v0.13 introduces some additional options for customizing where Terraform looks for providers in the local filesystem. For more information on -those new options, see [Provider Installation](/docs/commands/cli-config.html#provider-installation). +those new options, see [Provider Installation](/docs/cli/config/config-file.html#provider-installation). If you use only providers that are automatically installable from Terraform provider registries but still want to avoid Terraform re-downloading them from registries each time, Terraform v0.13 includes -[the `terraform providers mirror` command](/docs/commands/providers/mirror.html) +[the `terraform providers mirror` command](/docs/cli/commands/providers/mirror.html) which you can use to automatically populate a local directory based on the requirements of the current configuration file: diff --git a/website/upgrade-guides/0-14.html.markdown b/website/upgrade-guides/0-14.html.markdown index b27ebcf3b..714297d90 100644 --- a/website/upgrade-guides/0-14.html.markdown +++ b/website/upgrade-guides/0-14.html.markdown @@ -159,7 +159,7 @@ network mirrors: across a mixture of platforms then, in addition to making sure that your mirrors include packages for all of the necessary platforms, you may choose to use - [the new `terraform providers lock` command](/docs/commands/providers/lock.html) + [the new `terraform providers lock` command](/docs/cli/commands/providers/lock.html) to pre-enter the required lock file entries for all of the platforms you intend to use. @@ -265,9 +265,9 @@ Cloud in particular that this approach was previously mis-documented. If you aren't intending to upload the provider plugin to Terraform Cloud as part of your configuration, we recommend instead installing to one of -[the other implied mirror directories](/docs/commands/cli-config.html#implied-local-mirror-directories), +[the other implied mirror directories](/docs/cli/config/config-file.html#implied-local-mirror-directories), or you can explicitly configure some -[custom provider installation methods](/docs/commands/cli-config.html#provider-installation) +[custom provider installation methods](/docs/cli/config/config-file.html#provider-installation) if your needs are more complicated. ## Concise Terraform Plan Output From a60120477c0ebe37505e5ce00f28cb11edcf11eb Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Tue, 19 Jan 2021 13:53:40 -0800 Subject: [PATCH 11/13] Update links to CLI docs in code comments, messages, and readme --- README.md | 2 +- command/import.go | 2 +- command/init.go | 4 ++-- commands.go | 2 +- docs/README.md | 2 +- help.go | 2 +- internal/legacy/terraform/resource_address.go | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 900577641..c14a3fef4 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Show off your Terraform knowledge by passing a certification exam. Visit the [ce 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](https://github.com/terraform-providers) on GitHub. Instructions for developing each provider are in the associated README file. For more information, see [the provider development overview](https://www.terraform.io/docs/plugins/provider.html). +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](https://registry.terraform.io). HashiCorp develops some providers, and others are developed by other organizations. For more information, see [Extending Terraform](https://www.terraform.io/docs/extend/index.html). To learn more about compiling Terraform and contributing suggested changes, please refer to [the contributing guide](.github/CONTRIBUTING.md). diff --git a/command/import.go b/command/import.go index 5623141f4..d58960d0b 100644 --- a/command/import.go +++ b/command/import.go @@ -343,7 +343,7 @@ func (c *ImportCommand) Synopsis() string { } const importCommandInvalidAddressReference = `For information on valid syntax, see: -https://www.terraform.io/docs/internals/resource-addressing.html` +https://www.terraform.io/docs/cli/state/resource-addressing.html` const importCommandMissingResourceFmt = `[reset][bold][red]Error:[reset][bold] resource address %q does not exist in the configuration.[reset] diff --git a/command/init.go b/command/init.go index 9b6f7dd0a..14a86dc1b 100644 --- a/command/init.go +++ b/command/init.go @@ -714,7 +714,7 @@ func (c *InitCommand) getProviders(config *configs.Config, state *states.State, if thirdPartySigned { c.Ui.Info(fmt.Sprintf("\nPartner and community providers are signed by their developers.\n" + "If you'd like to know more about provider signing, you can read about it here:\n" + - "https://www.terraform.io/docs/plugins/signing.html")) + "https://www.terraform.io/docs/cli/plugins/signing.html")) } }, HashPackageFailure: func(provider addrs.Provider, version getproviders.Version, err error) { @@ -968,7 +968,7 @@ Options: -no-color If specified, output won't contain any color. -plugin-dir Directory containing plugin binaries. This overrides all - default search paths for plugins, and prevents the + default search paths for plugins, and prevents the automatic installation of plugins. This flag can be used multiple times. diff --git a/commands.go b/commands.go index 569c3e8ed..7c692bd65 100644 --- a/commands.go +++ b/commands.go @@ -103,7 +103,7 @@ func initCommands( // The command list is included in the terraform -help // output, which is in turn included in the docs at - // website/docs/commands/index.html.markdown; if you + // website/docs/cli/commands/index.html.markdown; if you // add, remove or reclassify commands then consider updating // that to match. diff --git a/docs/README.md b/docs/README.md index 76e365990..2ed0af4b4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ This directory contains some documentation about the Terraform Core codebase, aimed at readers who are interested in making code contributions. If you're looking for information on _using_ Terraform, please instead refer -to [the main Terraform CLI documentation](https://www.terraform.io/docs/cli-index.html). +to [the main Terraform CLI documentation](https://www.terraform.io/docs/cli/index.html). ## Terraform Core Architecture Documents diff --git a/help.go b/help.go index 64eb03273..16bc32095 100644 --- a/help.go +++ b/help.go @@ -41,7 +41,7 @@ func helpFunc(commands map[string]cli.CommandFactory) string { sort.Strings(otherCommands) // The output produced by this is included in the docs at - // website/source/docs/commands/index.html.markdown; if you + // website/source/docs/cli/commands/index.html.markdown; if you // change this then consider updating that to match. helpText := fmt.Sprintf(` Usage: terraform [global options] [args] diff --git a/internal/legacy/terraform/resource_address.go b/internal/legacy/terraform/resource_address.go index 4acf122b3..39dc7c30c 100644 --- a/internal/legacy/terraform/resource_address.go +++ b/internal/legacy/terraform/resource_address.go @@ -92,7 +92,7 @@ func (r *ResourceAddress) String() string { // HasResourceSpec returns true if the address has a resource spec, as // defined in the documentation: -// https://www.terraform.io/docs/internals/resource-addressing.html +// https://www.terraform.io/docs/cli/state/resource-addressing.html // In particular, this returns false if the address contains only // a module path, thus addressing the entire module. func (r *ResourceAddress) HasResourceSpec() bool { From 33d2d9abb562d5ff3e27e1d1dc954f86b30cf924 Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Tue, 19 Jan 2021 14:51:44 -0800 Subject: [PATCH 12/13] website: CLI: Remove several ghost pages, update old links - /docs/plugins/* - /docs/commands/state/addressing.html These were redundant pages. --- website/docs/cli/commands/state/list.html.md | 2 +- website/docs/cli/commands/state/mv.html.md | 2 +- website/docs/cli/commands/state/rm.html.md | 2 +- website/docs/cli/commands/state/show.html.md | 2 +- website/docs/cli/import/importability.html.md | 4 +- .../docs/commands/state/addressing.html.md | 20 -- website/docs/plugins/basics.html.md | 98 ------ website/docs/plugins/index.html.md | 24 -- website/docs/plugins/provider.html.md | 308 ------------------ 9 files changed, 6 insertions(+), 456 deletions(-) delete mode 100644 website/docs/commands/state/addressing.html.md delete mode 100644 website/docs/plugins/basics.html.md delete mode 100644 website/docs/plugins/index.html.md delete mode 100644 website/docs/plugins/provider.html.md diff --git a/website/docs/cli/commands/state/list.html.md b/website/docs/cli/commands/state/list.html.md index 80210ac17..a7b78c94b 100644 --- a/website/docs/cli/commands/state/list.html.md +++ b/website/docs/cli/commands/state/list.html.md @@ -25,7 +25,7 @@ within modules are listed last. For complex infrastructures, the state can contain thousands of resources. To filter these, provide one or more patterns to the command. Patterns are -in [resource addressing format](/docs/commands/state/addressing.html). +in [resource addressing format](/docs/cli/state/resource-addressing.html). The command-line flags are all optional. The list of available flags are: diff --git a/website/docs/cli/commands/state/mv.html.md b/website/docs/cli/commands/state/mv.html.md index ecfc64d16..66fcbb764 100644 --- a/website/docs/cli/commands/state/mv.html.md +++ b/website/docs/cli/commands/state/mv.html.md @@ -36,7 +36,7 @@ for each state file. This command requires a source and destination address of the item to move. Addresses are -in [resource addressing format](/docs/commands/state/addressing.html). +in [resource addressing format](/docs/cli/state/resource-addressing.html). The command-line flags are all optional. The list of available flags are: diff --git a/website/docs/cli/commands/state/rm.html.md b/website/docs/cli/commands/state/rm.html.md index d3a84a0d0..556a99d58 100644 --- a/website/docs/cli/commands/state/rm.html.md +++ b/website/docs/cli/commands/state/rm.html.md @@ -39,7 +39,7 @@ of this command, backups are required. This command requires one or more addresses that point to a resources in the state. Addresses are -in [resource addressing format](/docs/commands/state/addressing.html). +in [resource addressing format](/docs/cli/state/resource-addressing.html). The command-line flags are all optional. The list of available flags are: diff --git a/website/docs/cli/commands/state/show.html.md b/website/docs/cli/commands/state/show.html.md index e64386ce7..2c665ba64 100644 --- a/website/docs/cli/commands/state/show.html.md +++ b/website/docs/cli/commands/state/show.html.md @@ -21,7 +21,7 @@ state file that matches the given address. This command requires an address that points to a single resource in the state. Addresses are -in [resource addressing format](/docs/commands/state/addressing.html). +in [resource addressing format](/docs/cli/state/resource-addressing.html). The command-line flags are all optional. The list of available flags are: diff --git a/website/docs/cli/import/importability.html.md b/website/docs/cli/import/importability.html.md index dde7cb682..79d78d90a 100644 --- a/website/docs/cli/import/importability.html.md +++ b/website/docs/cli/import/importability.html.md @@ -20,5 +20,5 @@ Converting a resource to be importable is also relatively simple, so if you're interested in contributing that functionality, the Terraform team would be grateful. -To make a resource importable, please see the -[plugin documentation on writing a resource](/docs/plugins/provider.html). +To make a resource importable, please see +[Extending Terraform: Resources — Import](/docs/extend/resources/import.html). diff --git a/website/docs/commands/state/addressing.html.md b/website/docs/commands/state/addressing.html.md deleted file mode 100644 index 8de68b36f..000000000 --- a/website/docs/commands/state/addressing.html.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: "docs" -page_title: "Command: state resource addressing" -sidebar_current: "docs-commands-state-address" -description: |- - The `terraform state` command is used for advanced state management. ---- - -# Resource Addressing - -The `terraform state` subcommands use -[standard address syntax](/docs/cli/state/resource-addressing.html) to refer -to individual resources, resource instances, and modules. This is the same -syntax used for the `-target` option to the `apply` and `plan` commands. - -Most state commands allow referring to individual resource instances, whole -resources (which may have multiple instances if `count` or `for_each` is used), -or even whole modules. - -For more information on the syntax, see [Resource Addressing](/docs/cli/state/resource-addressing.html). diff --git a/website/docs/plugins/basics.html.md b/website/docs/plugins/basics.html.md deleted file mode 100644 index 926977262..000000000 --- a/website/docs/plugins/basics.html.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -layout: "extend" -page_title: "Plugin Basics" -sidebar_current: "docs-plugins-basics" -description: |- - This page documents the basics of how the plugin system in Terraform works, and how to setup a basic development environment for plugin development if you're writing a Terraform plugin. ---- - -# Plugin Basics - -~> **Advanced topic!** Plugin development is a highly advanced -topic in Terraform, and is not required knowledge for day-to-day usage. -If you don't plan on writing any plugins, this section of the documentation is -not necessary to read. For general use of Terraform, please see -[Intro to Terraform](/intro/index.html) or the -[Terraform: Get Started](https://learn.hashicorp.com/collections/terraform/aws-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) -collection on HashiCorp Learn. - -This page documents the basics of how the plugin system in Terraform -works, and how to setup a basic development environment for plugin development -if you're writing a Terraform plugin. - -## How it Works - -Terraform providers and provisioners are provided via plugins. Each plugin -exposes an implementation for a specific service, such as AWS, or provisioner, -such as bash. Plugins are executed as a separate process and communicate with -the main Terraform binary over an RPC interface. - -The code within the binaries must adhere to certain interfaces. -The network communication and RPC is handled automatically by higher-level -Terraform libraries. The exact interface to implement is documented -in its respective documentation section. - -## Installing Plugins - -The [provider plugins distributed by HashiCorp](/docs/providers/index.html) are -automatically installed by `terraform init`. Third-party plugins (both -providers and provisioners) can be manually installed into the user plugins -directory, located at `%APPDATA%\terraform.d\plugins` on Windows and -`~/.terraform.d/plugins` on other systems. - -For more information, see: - -- [Configuring Providers](/docs/language/providers/configuration.html) - -For developer-centric documentation, see: - -- [How Terraform Works: Plugin Discovery](/docs/extend/how-terraform-works.html#discovery) - -## Developing a Plugin - -Developing a plugin is simple. The only knowledge necessary to write -a plugin is basic command-line skills and basic knowledge of the -[Go programming language](http://golang.org). - --> **Note:** A common pitfall is not properly setting up a -$GOPATH. This can lead to strange errors. You can read more about -this [here](https://golang.org/doc/code.html) to familiarize -yourself. - -Create a new Go project somewhere in your `$GOPATH`. If you're a -GitHub user, we recommend creating the project in the directory -`$GOPATH/src/github.com/USERNAME/terraform-NAME`, where `USERNAME` -is your GitHub username and `NAME` is the name of the plugin you're -developing. This structure is what Go expects and simplifies things down -the road. - -The `NAME` should either begin with `provider-` or `provisioner-`, -depending on what kind of plugin it will be. The repository name will, -by default, be the name of the binary produced by `go install` for -your plugin package. - -With the package directory made, create a `main.go` file. This project will -be a binary so the package is "main": - -```golang -package main - -import ( - "github.com/hashicorp/terraform/plugin" -) - -func main() { - plugin.Serve(new(MyPlugin)) -} -``` - -The name `MyPlugin` is a placeholder for the struct type that represents -your plugin's implementation. This must implement either -`terraform.ResourceProvider` or `terraform.ResourceProvisioner`, depending -on the plugin type. - -To test your plugin, the easiest method is to copy your `terraform` binary -to `$GOPATH/bin` and ensure that this copy is the one being used for testing. -`terraform init` will search for plugins within the same directory as the -`terraform` binary, and `$GOPATH/bin` is the directory into which `go install` -will place the plugin executable. diff --git a/website/docs/plugins/index.html.md b/website/docs/plugins/index.html.md deleted file mode 100644 index 97ceeff08..000000000 --- a/website/docs/plugins/index.html.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: "extend" -page_title: "Plugins" -sidebar_current: "docs-plugins" -description: |- - Terraform is built on a plugin-based architecture. All providers and provisioners that are used in Terraform configurations are plugins, even the core types such as AWS and Heroku. Users of Terraform are able to write new plugins in order to support new functionality in Terraform. ---- - -# Plugins - -Terraform is built on a plugin-based architecture. All providers and -provisioners that are used in Terraform configurations are plugins, even -the core types such as AWS and Heroku. Users of Terraform are able to -write new plugins in order to support new functionality in Terraform. - -This section of the documentation gives a high-level overview of how -to write plugins for Terraform. It does not hold your hand through the -process, however, and expects a relatively high level of understanding -of Go, provider semantics, Unix, etc. - -~> **Advanced topic!** Plugin development is a highly advanced -topic in Terraform, and is not required knowledge for day-to-day usage. -If you don't plan on writing any plugins, we recommend not reading -this section of the documentation. diff --git a/website/docs/plugins/provider.html.md b/website/docs/plugins/provider.html.md deleted file mode 100644 index de2c7ce1a..000000000 --- a/website/docs/plugins/provider.html.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -layout: "extend" -page_title: "Provider Plugins" -sidebar_current: "docs-plugins-provider" -description: |- - A provider in Terraform is responsible for the lifecycle of a resource: create, read, update, delete. An example of a provider is AWS, which can manage resources of type `aws_instance`, `aws_eip`, `aws_elb`, etc. ---- - -# Provider Plugins - -~> **Advanced topic!** Plugin development is a highly advanced -topic in Terraform, and is not required knowledge for day-to-day usage. -If you don't plan on writing any plugins, this section of the documentation is -not necessary to read. For general use of Terraform, please see -[Intro to Terraform](/intro/index.html) or the -[Terraform: Get Started](https://learn.hashicorp.com/collections/terraform/aws-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) -collection on HashiCorp Learn. - -> **Hands-on:** Try the [Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) collection on HashiCorp Learn. - -A provider in Terraform is responsible for the lifecycle of a resource: -create, read, update, delete. An example of a provider is AWS, which -can manage resources of type `aws_instance`, `aws_eip`, `aws_elb`, etc. - -The primary reasons to care about provider plugins are: - - * You want to add a new resource type to an existing provider. - - * You want to write a completely new provider for managing resource - types in a system not yet supported. - - * You want to write a completely new provider for custom, internal - systems such as a private inventory management system. - -If you're interested in provider development, then read on. The remainder -of this page will assume you're familiar with -[plugin basics](/docs/plugins/basics.html) and that you already have -a basic development environment setup. - -## Provider Plugin Codebases - -Provider plugins live outside of the Terraform core codebase in their own -source code repositories, and are typically published in a provider registry -such as [the public Terraform Registry](https://registry.terraform.io/). - -When developing a provider plugin, it is recommended to use a common `GOPATH` -that includes both the core Terraform repository and the repositories of any -providers being changed. This makes it easier to use a locally-built -`terraform` executable and a set of locally-built provider plugins together -without further configuration. - -For example, to download both Terraform and the `template` provider into -`GOPATH`: - -``` -$ go get github.com/hashicorp/terraform -$ go get github.com/terraform-providers/terraform-provider-template -``` - -These two packages are both "main" packages that can be built into separate -executables with `go install`: - -``` -$ go install github.com/hashicorp/terraform -$ go install github.com/terraform-providers/terraform-provider-template -``` - -After running the above commands, both Terraform core and the `template` -provider will both be installed in the current `GOPATH` and `$GOPATH/bin` -will contain both `terraform` and `terraform-provider-template` executables. -This `terraform` executable will find and use the `template` provider plugin -alongside it in the `bin` directory in preference to downloading and installing -an official release. - -When constructing a new provider from scratch, it's recommended to follow -a similar repository structure as for the existing providers, with the main -package in the repository root and a library package in a subdirectory named -after the provider. For more information, see the -[Call APIs with Terraform Providers](https://learn.hashicorp.com/collections/terraform/providers?utm_source=WEBSITE/docs/extend/writing-custom-providers.htmlutm_medium=WEB_IO/docs/extend/writing-custom-providers.htmlutm_offer=ARTICLE_PAGE/docs/extend/writing-custom-providers.htmlutm_content=DOCS) collection on HashiCorp Learn. - -When making changes only to files within the provider repository, it is _not_ -necessary to re-build the main Terraform executable. Note that some packages -from the Terraform repository are used as library dependencies by providers, -such as `github.com/hashicorp/terraform/helper/schema`; it is recommended to -use `govendor` to create a local vendor copy of the relevant packages in the -provider repository, as can be seen in the repositories within the -`terraform-providers` GitHub organization. - -## Low-Level Interface - -The interface you must implement for providers is -[ResourceProvider](https://github.com/hashicorp/terraform/blob/master/terraform/resource_provider.go). - -This interface is extremely low level, however, and we don't recommend -you implement it directly. Implementing the interface directly is error -prone, complicated, and difficult. - -Instead, we've developed some higher level libraries to help you out -with developing providers. These are the same libraries we use in our -own core providers. - -## helper/schema - -The `helper/schema` package in the plugin SDK is a framework designed to allow -building providers at a higher level of abstraction than the raw plugin protocol -that Terraform expects. This is the same library we've used to build most -of the official providers. - -For more information on `helper/schema`, see -[the `helper/schema` package reference documentation](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/helper/schema). - -## Provider - -The first thing to do in your plugin is to create the -[schema.Provider](https://godoc.org/github.com/hashicorp/terraform/helper/schema#Provider) structure. -This structure implements the `ResourceProvider` interface. We -recommend creating this structure in a function to make testing easier -later. Example: - -```golang -func Provider() *schema.Provider { - return &schema.Provider{ - ... - } -} -``` - -Within the `schema.Provider`, you should initialize all the fields. They -are documented within the godoc, but a brief overview is here as well: - - * `Schema` - This is the configuration schema for the provider itself. - You should define any API keys, etc. here. Schemas are covered below. - - * `ResourcesMap` - The map of resources that this provider supports. - All keys are resource names and the values are the - [schema.Resource](https://godoc.org/github.com/hashicorp/terraform/helper/schema#Resource) structures implementing this resource. - - * `ConfigureFunc` - This function callback is used to configure the - provider. This function should do things such as initialize any API - clients, validate API keys, etc. The `interface{}` return value of - this function is the `meta` parameter that will be passed into all - resource [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) - functions. In general, the returned value is a configuration structure - or a client. - -As part of the unit tests, you should call `InternalValidate`. This is used -to verify the structure of the provider and all of the resources, and reports -an error if it is invalid. An example test is shown below: - -```golang -func TestProvider(t *testing.T) { - if err := Provider().(*schema.Provider).InternalValidate(); err != nil { - t.Fatalf("err: %s", err) - } -} -``` - -Having this unit test will catch a lot of beginner mistakes as you build -your provider. - -## Resources - -Next, you'll want to create the resources that the provider can manage. -These resources are put into the `ResourcesMap` field of the provider -structure. Again, we recommend creating functions to instantiate these. -An example is shown below. - -```golang -func resourceComputeAddress() *schema.Resource { - return &schema.Resource { - ... - } -} -``` - -Resources are described using the -[schema.Resource](https://godoc.org/github.com/hashicorp/terraform/helper/schema#Resource) -structure. This structure has the following fields: - - * `Schema` - The configuration schema for this resource. Schemas are - covered in more detail below. - - * `Create`, `Read`, `Update`, and `Delete` - These are the callback - functions that implement CRUD operations for the resource. The only - optional field is `Update`. If your resource doesn't support update, then - you may keep that field nil. - - * `Importer` - If this is non-nil, then this resource is - [importable](/docs/cli/import/importability.html). It is recommended to - implement this. - -The CRUD operations in more detail, along with their contracts: - - * `Create` - This is called to create a new instance of the resource. - Terraform guarantees that an existing ID is not set on the resource - data. That is, you're working with a new resource. Therefore, you are - responsible for calling `SetId` on your `schema.ResourceData` using a - value suitable for your resource. This ensures whatever resource - state you set on `schema.ResourceData` will be persisted in local state. - If you neglect to `SetId`, no resource state will be persisted. - - * `Read` - This is called to resync the local state with the remote state. - Terraform guarantees that an existing ID will be set. This ID should be - used to look up the resource. Any remote data should be updated into - the local data. **No changes to the remote resource are to be made.** - If the resource is no longer present, calling `SetId` - with an empty string will signal its removal. - - * `Update` - This is called to update properties of an existing resource. - Terraform guarantees that an existing ID will be set. Additionally, - the only changed attributes are guaranteed to be those that support - update, as specified by the schema. Be careful to read about partial - states below. - - * `Delete` - This is called to delete the resource. Terraform guarantees - an existing ID will be set. - - * `Exists` - This is called to verify a resource still exists. It is - called prior to `Read`, and lowers the burden of `Read` to be able - to assume the resource exists. `false` should be returned if - the resources is no longer present, which has the same effect - as calling `SetId("")` from `Read` (i.e. removal of the resource data - from state). - -## Schemas - -Both providers and resources require a schema to be specified. The schema -is used to define the structure of the configuration, the types, etc. It is -very important to get correct. - -In both provider and resource, the schema is a `map[string]*schema.Schema`. -The key of this map is the configuration key, and the value is a schema for -the value of that key. - -Schemas are incredibly powerful, so this documentation page won't attempt -to cover the full power of them. Instead, the API docs should be referenced -which cover all available settings. - -We recommend viewing schemas of existing or similar providers to learn -best practices. A good starting place is the -[core Terraform providers](https://github.com/terraform-providers). - -## Resource Data - -The parameter to provider configuration as well as all the CRUD operations -on a resource is a -[schema.ResourceData](https://godoc.org/github.com/hashicorp/terraform/helper/schema#ResourceData). -This structure is used to query configurations as well as to set information -about the resource such as its ID, connection information, and computed -attributes. - -The API documentation covers ResourceData well, as well as the core providers -in Terraform. - -**Partial state** deserves a special mention. Occasionally in Terraform, create or -update operations are not atomic; they can fail halfway through. As an example, -when creating an AWS security group, creating the group may succeed, -but creating all the initial rules may fail. In this case, it is incredibly -important that Terraform record the correct _partial state_ so that a -subsequent `terraform apply` fixes this resource. - -Most of the time, partial state is not required. When it is, it must be -specifically enabled. An example is shown below: - -```golang -func resourceUpdate(d *schema.ResourceData, meta interface{}) error { - // Enable partial state mode - d.Partial(true) - - if d.HasChange("tags") { - // If an error occurs, return with an error, - // we didn't finish updating - if err := updateTags(d, meta); err != nil { - return err - } - - d.SetPartial("tags") - } - - if d.HasChange("name") { - if err := updateName(d, meta); err != nil { - return err - } - - d.SetPartial("name") - } - - // We succeeded, disable partial mode - d.Partial(false) - - return nil -} -``` - -In the example above, it is possible that setting the `tags` succeeds, -but setting the `name` fails. In this scenario, we want to make sure -that only the state of the `tags` is updated. To do this the -`Partial` and `SetPartial` functions are used. - -`Partial` toggles partial-state mode. When disabled, all changes are merged -into the state upon result of the operation. When enabled, only changes -enabled with `SetPartial` are merged in. - -`SetPartial` tells Terraform what state changes to adopt upon completion -of an operation. You should call `SetPartial` with every key that is safe -to merge into the state. The parameter to `SetPartial` is a prefix, so -if you have a nested structure and want to accept the whole thing, -you can just specify the prefix. From 4e4f6b3f42659f9caeb07de90c042b01c9dbce0f Mon Sep 17 00:00:00 2001 From: Nick Fagerlund Date: Thu, 21 Jan 2021 21:00:34 -0800 Subject: [PATCH 13/13] website: Restore note about standard vs. enhanced backends --- website/docs/language/settings/backends/index.html.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/website/docs/language/settings/backends/index.html.md b/website/docs/language/settings/backends/index.html.md index 2e501e0f2..6e477c5ef 100644 --- a/website/docs/language/settings/backends/index.html.md +++ b/website/docs/language/settings/backends/index.html.md @@ -98,3 +98,13 @@ target Terraform Cloud workspace determine whether operations run remotely or locally. If local operations are configured, Terraform uses the `remote` backend for state and the `local` backend for operations, like with the other state backends. + +### Backend Types + +Terraform's backends are divided into two main types, according to how they +handle state and operations: + +- **Enhanced** backends can both store state and perform operations. There are + only two enhanced backends: `local` and `remote`. +- **Standard** backends only store state, and rely on the `local` backend for + performing operations.