From dcdb638d149fed875cb47edc8f80459785640a80 Mon Sep 17 00:00:00 2001 From: Kunal Singh <109537406+iKunal-Singh@users.noreply.github.com> Date: Sat, 11 Mar 2023 11:52:05 +0530 Subject: [PATCH 01/16] Update apply.mdx --- website/docs/cli/commands/apply.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/cli/commands/apply.mdx b/website/docs/cli/commands/apply.mdx index 641b09eba0..f16e8988ae 100644 --- a/website/docs/cli/commands/apply.mdx +++ b/website/docs/cli/commands/apply.mdx @@ -10,7 +10,7 @@ description: >- The `terraform apply` command executes the actions proposed in a Terraform plan. -> **Hands On:** Try the [Apply Terraform Configuration](/terraform/tutorials/cli/apply?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial to learn how Terraform applies a configuration, how Terraform recovers from errors during apply, and common ways to use this command. +> **Hands On:** Try the [Apply Terraform Configuration](/terraform/tutorials/cli/apply?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial to learn how Terraform applies a configuration, how Terraform recovers from errors during apply and common ways to use this command. ## Usage @@ -48,8 +48,8 @@ Without a saved plan file, `terraform apply` supports all planning modes and pla The following options change how the apply command executes and reports on the apply operation. -- `-auto-approve` - Skips interactive approval of plan before applying. This - option is ignored when you pass a previously-saved plan file, because +- `-auto-approve` - Skips interactive approval of the plan before applying. This + option is ignored when you pass a previously-saved plan file because Terraform considers you passing the plan file as the approval and so will never prompt in that case. @@ -86,7 +86,7 @@ The following options change how the apply command executes and reports on the a if you are running Terraform in a context where its output will be rendered by a system that cannot interpret terminal formatting. -- `-parallelism=n` - Limit the number of concurrent operation as Terraform +- `-parallelism=n` - Limit the number of concurrent operations as Terraform [walks the graph](/terraform/internals/graph#walking-the-graph). Defaults to 10\. From 79244d1ee14d56cff2dd1bc15890f6bc0ea0852a Mon Sep 17 00:00:00 2001 From: Kunal Singh <109537406+iKunal-Singh@users.noreply.github.com> Date: Sat, 11 Mar 2023 11:58:53 +0530 Subject: [PATCH 02/16] Update login.mdx --- website/docs/cli/commands/login.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/login.mdx b/website/docs/cli/commands/login.mdx index 96f4e35ea4..4a2b3eda04 100644 --- a/website/docs/cli/commands/login.mdx +++ b/website/docs/cli/commands/login.mdx @@ -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](/terraform/cli/config/config-file#credentials-helpers) which knows +[credentials helper program](/terraform/cli/config/config-file#credentials-helpers) that knows how to store and later retrieve credentials in some other system, such as your organization's existing secrets management system. From 7925a2e63691dd02d992725d8dd6c36faed6367c Mon Sep 17 00:00:00 2001 From: Kunal Singh <109537406+iKunal-Singh@users.noreply.github.com> Date: Sat, 11 Mar 2023 13:03:10 +0530 Subject: [PATCH 03/16] Update validate.mdx --- website/docs/cli/commands/validate.mdx | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/website/docs/cli/commands/validate.mdx b/website/docs/cli/commands/validate.mdx index 1ae22f36b1..1a74bb5f54 100644 --- a/website/docs/cli/commands/validate.mdx +++ b/website/docs/cli/commands/validate.mdx @@ -17,7 +17,7 @@ existing state. It is thus primarily useful for general verification of reusable modules, including correctness of attribute names and value types. It is safe to run this command automatically, for example as a post-save -check in a text editor or as a test step for a re-usable module in a CI +check in a text editor or as a test step for a reusable module in a CI system. Validation requires an initialized working directory with any referenced plugins and modules installed. To initialize a working directory for validation without accessing any configured backend, use: @@ -26,7 +26,7 @@ Validation requires an initialized working directory with any referenced plugins $ terraform init -backend=false ``` -To verify configuration in the context of a particular run (a particular +To verify the configuration in the context of a particular run (a particular target workspace, input variable values, etc), use the `terraform plan` command instead, which includes an implied validation check. @@ -107,7 +107,7 @@ The nested objects in `diagnostics` have the following properties: Summaries are typically short, single sentences, but can sometimes be longer as a result of returning errors from subsystems that are not designed to - return full diagnostics, where the entire error message therefore becomes the + return full diagnostics, where the entire error message, therefore, becomes the summary. In those cases, the summary might include newline characters which a renderer should honor when presenting the message visually to a user. @@ -119,7 +119,7 @@ The nested objects in `diagnostics` have the following properties: reference. Detail messages are often multiple paragraphs and possibly interspersed with - non-paragraph lines, so tools which aim to present detail messages to the + non-paragraph lines, so tools that aim to present detailed messages to the user should distinguish between lines without leading spaces, treating them as paragraphs, and lines with leading spaces, treating them as preformatted text. Renderers should then soft-wrap the paragraphs to fit the width of the @@ -127,16 +127,16 @@ The nested objects in `diagnostics` have the following properties: Some Terraform detail messages contain an approximation of bullet lists using ASCII characters to mark the bullets. This is not a - contractural formatting convention, so renderers should avoid depending on + contractual formatting convention, so renderers should avoid depending on it and should instead treat those lines as either paragraphs or preformatted - text. Future versions of this format may define additional rules for other text conventions, but will maintain backward compatibility. + text. Future versions of this format may define additional rules for other text conventions but will maintain backward compatibility. - `range` (object): An optional object referencing a portion of the configuration source code that the diagnostic message relates to. For errors, this will typically indicate the bounds of the specific block header, attribute, or expression which was detected as invalid. - A source range is an object with a property `filename` which gives the + A source range is an object with a property `filename` that gives the filename as a relative path from the current working directory, and then two properties `start` and `end` which are both themselves objects describing source positions, as described below. @@ -152,7 +152,7 @@ The nested objects in `diagnostics` have the following properties: - `context` (string): An optional summary of the root context of the diagnostic. For example, this might be the resource block containing the - expression which triggered the diagnostic. For some diagnostics this + expression which triggered the diagnostic. For some diagnostics, this information is not available, and then this property will be `null`. - `code` (string): A snippet of Terraform configuration including the @@ -197,7 +197,7 @@ interpretation only. ### Expression Value -An expression value object gives additional information about a value which is +An expression value object gives additional information about a value that is part of the expression which triggered the diagnostic. This is especially useful when using `for_each` or similar constructs, in order to identify exactly which values are responsible for an error. The object has two properties: From fa4af0392fbb28429ee30dcb48928041fe21d94d Mon Sep 17 00:00:00 2001 From: Kunal Singh <109537406+iKunal-Singh@users.noreply.github.com> Date: Sat, 11 Mar 2023 13:52:12 +0530 Subject: [PATCH 04/16] Update graph.mdx --- website/docs/cli/commands/graph.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/graph.mdx b/website/docs/cli/commands/graph.mdx index 969c6e5dbe..3d7edeeac4 100644 --- a/website/docs/cli/commands/graph.mdx +++ b/website/docs/cli/commands/graph.mdx @@ -38,7 +38,7 @@ Options: This helps when diagnosing cycle errors. * `-type=plan` - Type of graph to output. Can be: `plan`, `plan-destroy`, `apply`, - `validate`, `input`, `refresh`. + `validate`, `input`, or `refresh`. * `-module-depth=n` - (deprecated) In prior versions of Terraform, specified the depth of modules to show in the output. From a5b31494435355c441e015ebfb209dee3d7f48eb Mon Sep 17 00:00:00 2001 From: Kunal Singh <109537406+iKunal-Singh@users.noreply.github.com> Date: Sat, 11 Mar 2023 13:56:35 +0530 Subject: [PATCH 05/16] Update list.mdx --- website/docs/cli/commands/state/list.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/state/list.mdx b/website/docs/cli/commands/state/list.mdx index 8471fbe89a..f3879ab6b6 100644 --- a/website/docs/cli/commands/state/list.mdx +++ b/website/docs/cli/commands/state/list.mdx @@ -18,7 +18,7 @@ The command will list all resources in the state file matching the given addresses (if any). If no addresses are given, all resources are listed. The resources listed are sorted according to module depth order followed -by alphabetical. This means that resources that are in your immediate +alphabetically. This means that resources that are in your immediate configuration are listed first, and resources that are more deeply nested within modules are listed last. From a55efe0122004a5244538f62c2fb78c2c182feaf Mon Sep 17 00:00:00 2001 From: Kunal Singh <109537406+iKunal-Singh@users.noreply.github.com> Date: Sat, 11 Mar 2023 14:02:26 +0530 Subject: [PATCH 06/16] Update import.mdx --- website/docs/cli/commands/import.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/cli/commands/import.mdx b/website/docs/cli/commands/import.mdx index f9ffd3de77..6d2da9172b 100644 --- a/website/docs/cli/commands/import.mdx +++ b/website/docs/cli/commands/import.mdx @@ -52,7 +52,7 @@ The command-line flags are all optional. The following flags are available: - `-no-color` - If specified, output won't contain any color. -- `-parallelism=n` - Limit the number of concurrent operation as Terraform +- `-parallelism=n` - Limit the number of concurrent operations as Terraform [walks the graph](/terraform/internals/graph#walking-the-graph). Defaults to 10. @@ -67,7 +67,7 @@ The command-line flags are all optional. The following flags are available: - `-var-file=foo` - Set variables in the Terraform configuration from a [variable file](/terraform/language/values/variables#variable-definitions-tfvars-files). If - a `terraform.tfvars` or any `.auto.tfvars` files are present in the current + `terraform.tfvars` or any `.auto.tfvars` files are present in the current directory, they will be automatically loaded. `terraform.tfvars` is loaded first and the `.auto.tfvars` files after in alphabetical order. Any files specified by `-var-file` override any values set automatically from files in From f09870e7b04a25f79e02e53687721cab9e7d663e Mon Sep 17 00:00:00 2001 From: Kunal Singh <109537406+iKunal-Singh@users.noreply.github.com> Date: Sat, 11 Mar 2023 14:05:53 +0530 Subject: [PATCH 07/16] Update usage.mdx --- website/docs/cli/import/usage.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/cli/import/usage.mdx b/website/docs/cli/import/usage.mdx index f5d95be0f6..e8bf076c4e 100644 --- a/website/docs/cli/import/usage.mdx +++ b/website/docs/cli/import/usage.mdx @@ -46,7 +46,7 @@ $ terraform import aws_instance.example i-abcd1234 This command locates the AWS EC2 instance with ID `i-abcd1234`. Then it attaches the existing settings of the instance, as described by the EC2 API, to the -name `aws_instance.example` of a module. In this example the module path +name `aws_instance.example` of a module. In this example, the module path implies that the root module is used. Finally, the mapping is saved in the Terraform state. @@ -73,8 +73,8 @@ multiple resources are imported. For example, an AWS network ACL imports an `aws_network_acl` but also one `aws_network_acl_rule` for each rule. In this scenario, the secondary resources will not already exist in -configuration, so it is necessary to consult the import output and create -a `resource` block in configuration for each secondary resource. If this is +the configuration, so it is necessary to consult the import output and create +a `resource` block in the 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 From c4119650e0bb8ea7856ece2f42ddf73ea164aed3 Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:05 -0700 Subject: [PATCH 08/16] Update website/docs/cli/commands/apply.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/apply.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/apply.mdx b/website/docs/cli/commands/apply.mdx index f16e8988ae..20d98a8457 100644 --- a/website/docs/cli/commands/apply.mdx +++ b/website/docs/cli/commands/apply.mdx @@ -10,7 +10,7 @@ description: >- The `terraform apply` command executes the actions proposed in a Terraform plan. -> **Hands On:** Try the [Apply Terraform Configuration](/terraform/tutorials/cli/apply?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial to learn how Terraform applies a configuration, how Terraform recovers from errors during apply and common ways to use this command. +> **Hands On:** Try the [Apply Terraform Configuration](/terraform/tutorials/cli/apply?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial to learn how Terraform applies a configuration, how Terraform recovers from errors during apply, and common ways to use this command. ## Usage From 3805c64c98879fc15fcc09294131fdfea40ac2d4 Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:10 -0700 Subject: [PATCH 09/16] Update website/docs/cli/commands/apply.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/apply.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/cli/commands/apply.mdx b/website/docs/cli/commands/apply.mdx index 20d98a8457..4adaca17a0 100644 --- a/website/docs/cli/commands/apply.mdx +++ b/website/docs/cli/commands/apply.mdx @@ -48,8 +48,8 @@ Without a saved plan file, `terraform apply` supports all planning modes and pla The following options change how the apply command executes and reports on the apply operation. -- `-auto-approve` - Skips interactive approval of the plan before applying. This - option is ignored when you pass a previously-saved plan file because +- `-auto-approve` - Skips interactive approval of the plan before applying. Terraform ignores this + option when you pass a previously-saved plan file. This is because Terraform considers you passing the plan file as the approval and so will never prompt in that case. From eff747519121fec989428a99c92918ea7253088c Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:15 -0700 Subject: [PATCH 10/16] Update website/docs/cli/commands/apply.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/apply.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/docs/cli/commands/apply.mdx b/website/docs/cli/commands/apply.mdx index 4adaca17a0..d5ed5dcbaf 100644 --- a/website/docs/cli/commands/apply.mdx +++ b/website/docs/cli/commands/apply.mdx @@ -50,8 +50,7 @@ The following options change how the apply command executes and reports on the a - `-auto-approve` - Skips interactive approval of the plan before applying. Terraform ignores this option when you pass a previously-saved plan file. This is because - Terraform considers you passing the plan file as the approval and so - will never prompt in that case. + Terraform interprets the act of passing the plan file as the approval. - `-compact-warnings` - Shows any warning messages in a compact form which includes only the summary messages, unless the warnings are accompanied by From de3b2db03b886e9f5289224da4c191f53f53f23c Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:21 -0700 Subject: [PATCH 11/16] Update website/docs/cli/commands/graph.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/graph.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/graph.mdx b/website/docs/cli/commands/graph.mdx index 3d7edeeac4..1ae2c929c4 100644 --- a/website/docs/cli/commands/graph.mdx +++ b/website/docs/cli/commands/graph.mdx @@ -37,7 +37,7 @@ Options: * `-draw-cycles` - Highlight any cycles in the graph with colored edges. This helps when diagnosing cycle errors. -* `-type=plan` - Type of graph to output. Can be: `plan`, `plan-destroy`, `apply`, +* `-type=plan` - Type of graph to output. You can specify one of the following values: `plan`, `plan-destroy`, `apply`, `validate`, `input`, or `refresh`. * `-module-depth=n` - (deprecated) In prior versions of Terraform, specified the From f9a45cb05d15cbbd831f20c687891a9db98e09c1 Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:25 -0700 Subject: [PATCH 12/16] Update website/docs/cli/commands/import.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/import.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/import.mdx b/website/docs/cli/commands/import.mdx index 6d2da9172b..d15290ed27 100644 --- a/website/docs/cli/commands/import.mdx +++ b/website/docs/cli/commands/import.mdx @@ -68,7 +68,7 @@ The command-line flags are all optional. The following flags are available: - `-var-file=foo` - Set variables in the Terraform configuration from a [variable file](/terraform/language/values/variables#variable-definitions-tfvars-files). If `terraform.tfvars` or any `.auto.tfvars` files are present in the current - directory, they will be automatically loaded. `terraform.tfvars` is loaded + directory, they are automatically loaded. Terraform loads `terraform.tfvars` first and the `.auto.tfvars` files after in alphabetical order. Any files specified by `-var-file` override any values set automatically from files in the working directory. This flag can be used multiple times. This is only From adbc548fe7a7d4004de867796827f95ffd3e870d Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:30 -0700 Subject: [PATCH 13/16] Update website/docs/cli/commands/login.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/login.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/login.mdx b/website/docs/cli/commands/login.mdx index 4a2b3eda04..5ad80c9e33 100644 --- a/website/docs/cli/commands/login.mdx +++ b/website/docs/cli/commands/login.mdx @@ -32,7 +32,7 @@ local CLI configuration file called `credentials.tfrc.json`. When you run the API token and give you a chance to cancel if the current configuration is not as desired. -If you don't wish to store your API token in the default location, you can +If you do not wish to store your API token in the default location, you can optionally configure a [credentials helper program](/terraform/cli/config/config-file#credentials-helpers) that knows how to store and later retrieve credentials in some other system, such as From 39b0c17fd488f8f89b0e4ba643b713200ec55899 Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:43 -0700 Subject: [PATCH 14/16] Update website/docs/cli/commands/validate.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/validate.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/validate.mdx b/website/docs/cli/commands/validate.mdx index 1a74bb5f54..10a06d7c14 100644 --- a/website/docs/cli/commands/validate.mdx +++ b/website/docs/cli/commands/validate.mdx @@ -152,7 +152,7 @@ The nested objects in `diagnostics` have the following properties: - `context` (string): An optional summary of the root context of the diagnostic. For example, this might be the resource block containing the - expression which triggered the diagnostic. For some diagnostics, this + expression that triggered the diagnostic. For some diagnostics, this information is not available, and then this property will be `null`. - `code` (string): A snippet of Terraform configuration including the From 3adc364ec17c4b813ed7be9e3174a22d57167a94 Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:48 -0700 Subject: [PATCH 15/16] Update website/docs/cli/commands/validate.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/validate.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/validate.mdx b/website/docs/cli/commands/validate.mdx index 10a06d7c14..852365d9c9 100644 --- a/website/docs/cli/commands/validate.mdx +++ b/website/docs/cli/commands/validate.mdx @@ -129,7 +129,7 @@ The nested objects in `diagnostics` have the following properties: lists using ASCII characters to mark the bullets. This is not a contractual formatting convention, so renderers should avoid depending on it and should instead treat those lines as either paragraphs or preformatted - text. Future versions of this format may define additional rules for other text conventions but will maintain backward compatibility. + text. - `range` (object): An optional object referencing a portion of the configuration source code that the diagnostic message relates to. For errors, this will From ce7af957be75b90bc009fc38bfbe263ebb857134 Mon Sep 17 00:00:00 2001 From: Craig Wright Date: Thu, 25 Jul 2024 15:53:54 -0700 Subject: [PATCH 16/16] Update website/docs/cli/commands/validate.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/docs/cli/commands/validate.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/cli/commands/validate.mdx b/website/docs/cli/commands/validate.mdx index 852365d9c9..e9e78f6859 100644 --- a/website/docs/cli/commands/validate.mdx +++ b/website/docs/cli/commands/validate.mdx @@ -107,7 +107,7 @@ The nested objects in `diagnostics` have the following properties: Summaries are typically short, single sentences, but can sometimes be longer as a result of returning errors from subsystems that are not designed to - return full diagnostics, where the entire error message, therefore, becomes the + return full diagnostics, where the entire error message becomes the summary. In those cases, the summary might include newline characters which a renderer should honor when presenting the message visually to a user.