Skip to content

Commit 452f143

Browse files
authored
Splitting up the "Set configuration parameters" page (#1170)
1 parent 3f756be commit 452f143

File tree

49 files changed

+1131
-781
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1131
-781
lines changed

content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/permissions/workspace.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Allows users to read, queue, and comment on Terraform plans in a workspace. Regu
121121

122122
### Apply <a id="run-apply"></a>
123123

124-
Allows users to read, plan, approve, and apply Terraform plans. Granting this permission allows team members to change real infrastructure.
124+
Allows users to read, plan, approve, and apply Terraform plans. Granting this permission allows team members to change real infrastructure.
125125

126126
## Variable access
127127

@@ -142,7 +142,7 @@ Allows users to view the values of Terraform variables and environment variables
142142

143143
### Read and write <a id="variable-read-write"></a>
144144

145-
Allows users to read and edit the values of variables in the workspace.
145+
Allows users to read and edit the values of variables in the workspace.
146146

147147

148148
## State access
@@ -162,13 +162,13 @@ No access is granted to the state file from the workspace.
162162

163163
### Read outputs only <a id="state-read-outputs"></a>
164164

165-
Allows users to access values in the workspace's most recent Terraform state that have been explicitly marked as public outputs. Refer to [Define outputs to expose module data](/terraform/language/parameterize#define-outputs-to-expose-module-data) to learn more.
165+
Allows users to access values in the workspace's most recent Terraform state that have been explicitly marked as public outputs. Refer to [Define outputs to expose module data](/terraform/language/values/outputs#define-outputs-to-expose-module-data) to learn more.
166166

167167
Configuration authors often use output values to interface with other workspaces that manage loosely-coupled collections of infrastructure. Making output values readable lets people who have no direct responsibility for the managed infrastructure in one workspace still indirectly use some of its functions in their workspaces.
168168

169169
This permission is required to use the following features:
170170

171-
- Call the [`/state-versions` API endpoint](/terraform/cloud-docs/api-docs/state-version-outputs)
171+
- Call the [`/state-versions` API endpoint](/terraform/cloud-docs/api-docs/state-version-outputs)
172172
- Run the [`terraform output` command](/terraform/cli/commands/output)
173173
- Use the [`terraform_remote_state` data source](/terraform/language/state/remote-state-data) against the workspace.
174174

@@ -178,7 +178,7 @@ Allows users to read complete state files from the workspace. State files are us
178178

179179
### Read and write <a id="state-read-write"></a>
180180

181-
Allows users to read and directly create new state versions in the workspace. This permission is required for performing local runs when the workspace's execution mode is set to **Local**.
181+
Allows users to read and directly create new state versions in the workspace. This permission is required for performing local runs when the workspace's execution mode is set to **Local**.
182182

183183
This permission is also required to use any of the [Terraform CLI's state manipulation and maintenance commands](/terraform/cli/state) against this workspace, including `terraform import`, `terraform taint`, and the various `terraform state` subcommands.
184184

content/terraform-docs-common/redirects.jsonc

Lines changed: 3 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -553,70 +553,6 @@
553553
"destination": "/terraform/language/v:version/checks",
554554
"permanent": true
555555
},
556-
// values → parameterize
557-
{
558-
"source": "/terraform/language/values",
559-
"destination": "/terraform/language/parameterize",
560-
"permanent": true
561-
},
562-
{
563-
"source": "/terraform/language/v:version(1\\.(?:[1-9]|1[01])\\.x)/parameterize",
564-
"destination": "/terraform/language/v:version/values",
565-
"permanent": true
566-
},
567-
{
568-
"source": "/terraform/language/v:version((?:1\\.(?:1[2-9]|[2-9]\\d)|[2-9]\\d*\\.\\d+)\\.x)/values",
569-
"destination": "/terraform/language/v:version/parameterize",
570-
"permanent": true
571-
},
572-
// values/locals → block/locals
573-
{
574-
"source": "/terraform/language/values/locals",
575-
"destination": "/terraform/language/block/locals",
576-
"permanent": true
577-
},
578-
{
579-
"source": "/terraform/language/v:version(1\\.(?:[1-9]|1[01])\\.x)/block/locals",
580-
"destination": "/terraform/language/v:version/values/locals",
581-
"permanent": true
582-
},
583-
{
584-
"source": "/terraform/language/v:version((?:1\\.(?:1[2-9]|[2-9]\\d)|[2-9]\\d*\\.\\d+)\\.x)/values/locals",
585-
"destination": "/terraform/language/v:version/block/locals",
586-
"permanent": true
587-
},
588-
// values/variables → block/variable
589-
{
590-
"source": "/terraform/language/values/variables",
591-
"destination": "/terraform/language/block/variable",
592-
"permanent": true
593-
},
594-
{
595-
"source": "/terraform/language/v:version(1\\.(?:[1-9]|1[01])\\.x)/block/variable",
596-
"destination": "/terraform/language/v:version/values/variables",
597-
"permanent": true
598-
},
599-
{
600-
"source": "/terraform/language/v:version((?:1\\.(?:1[2-9]|[2-9]\\d)|[2-9]\\d*\\.\\d+)\\.x)/values/variables",
601-
"destination": "/terraform/language/v:version/block/variable",
602-
"permanent": true
603-
},
604-
// values/outputs → block/output
605-
{
606-
"source": "/terraform/language/values/outputs",
607-
"destination": "/terraform/language/block/output",
608-
"permanent": true
609-
},
610-
{
611-
"source": "/terraform/language/v:version(1\\.(?:[1-9]|1[01])\\.x)/block/output",
612-
"destination": "/terraform/language/v:version/values/outputs",
613-
"permanent": true
614-
},
615-
{
616-
"source": "/terraform/language/v:version((?:1\\.(?:1[2-9]|[2-9]\\d)|[2-9]\\d*\\.\\d+)\\.x)/values/outputs",
617-
"destination": "/terraform/language/v:version/block/output",
618-
"permanent": true
619-
},
620556
// /terraform → block/terraform
621557
{
622558
"source": "/terraform/language/terraform",
@@ -650,19 +586,19 @@
650586
"permanent": true
651587
},
652588
// redir for /data block older than 1.11
653-
{
589+
{
654590
"source": "/terraform/language/v:version(1\\.(?:[1-9]|1[01])\\.x)/block/data",
655591
"destination": "/terraform/language/v:version/data-sources",
656592
"permanent": true
657593
},
658594
// redir for /removed block older than 1.11
659-
{
595+
{
660596
"source": "/terraform/language/v:version(1\\.(?:[1-9]|1[01])\\.x)/block/removed",
661597
"destination": "/terraform/language/v:version/resources/syntax#removing-resources",
662598
"permanent": true
663599
},
664600
// redir for /import block older than 1.11
665-
{
601+
{
666602
"source": "/terraform/language/v:version(1\\.(?:[1-9]|1[01])\\.x)/block/import",
667603
"destination": "/terraform/language/v:version/import ",
668604
"permanent": true

content/terraform-enterprise/1.1.x/docs/enterprise/users-teams-organizations/permissions/workspace.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Allows users to read, queue, and comment on Terraform plans in a workspace. Regu
113113

114114
### Apply <a id="run-apply"></a>
115115

116-
Allows users to read, plan, approve, and apply Terraform plans. Granting this permission allows team members to change real infrastructure.
116+
Allows users to read, plan, approve, and apply Terraform plans. Granting this permission allows team members to change real infrastructure.
117117

118118
## Variable access
119119

@@ -135,7 +135,7 @@ Allows users to view the values of Terraform variables and environment variables
135135

136136
### Read and write <a id="variable-read-write"></a>
137137

138-
Allows users to read and edit the values of variables in the workspace.
138+
Allows users to read and edit the values of variables in the workspace.
139139

140140
## State access
141141

@@ -154,13 +154,13 @@ No access is granted to the state file from the workspace.
154154

155155
### Read outputs only <a id="state-read-outputs"></a>
156156

157-
Allows users to access values in the workspace's most recent Terraform state that have been explicitly marked as public outputs. Refer to [Define outputs to expose module data](/terraform/language/parameterize#define-outputs-to-expose-module-data) to learn more.
157+
Allows users to access values in the workspace's most recent Terraform state that have been explicitly marked as public outputs. Refer to [Define outputs to expose module data](/terraform/language/values/outputs#define-outputs-to-expose-module-data) to learn more.
158158

159159
Configuration authors often use output values to interface with other workspaces that manage loosely-coupled collections of infrastructure. Making output values readable lets people who have no direct responsibility for the managed infrastructure in one workspace still indirectly use some of its functions in their workspaces.
160160

161161
This permission is required to use the following features:
162162

163-
- Call the [`/state-versions` API endpoint](/terraform/enterprise/api-docs/state-version-outputs)
163+
- Call the [`/state-versions` API endpoint](/terraform/enterprise/api-docs/state-version-outputs)
164164
- Run the [`terraform output` command](/terraform/cli/commands/output)
165165
- Use the [`terraform_remote_state` data source](/terraform/language/state/remote-state-data) against the workspace.
166166

@@ -170,7 +170,7 @@ Allows users to read complete state files from the workspace. State files are us
170170

171171
### Read and write <a id="state-read-write"></a>
172172

173-
Allows users to read and directly create new state versions in the workspace. This permission is required for performing local runs when the workspace's execution mode is set to **Local**.
173+
Allows users to read and directly create new state versions in the workspace. This permission is required for performing local runs when the workspace's execution mode is set to **Local**.
174174

175175
This permission is also required to use any of the [Terraform CLI's state manipulation and maintenance commands](/terraform/cli/state) against this workspace, including `terraform import`, `terraform taint`, and the various `terraform state` subcommands.
176176

content/terraform/v1.12.x/data/language-nav-data.json

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,26 @@
5656
]
5757
},
5858
{
59-
"title": "Set configuration parameters",
60-
"path": "parameterize",
61-
"alias": "variables, outputs, locals"
59+
"title": "Manage values in modules",
60+
"alias": "variables, outputs, locals",
61+
"routes": [
62+
{
63+
"title": "Overview",
64+
"path": "values"
65+
},
66+
{
67+
"title": "Use variables",
68+
"path": "values/variables"
69+
},
70+
{
71+
"title": "Use locals",
72+
"path": "values/locals"
73+
},
74+
{
75+
"title": "Use outputs",
76+
"path": "values/outputs"
77+
}
78+
]
6279
},
6380
{
6481
"title": "Manage sensitive data",

content/terraform/v1.12.x/docs/cli/commands/import.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The command-line flags are all optional. The following flags are available:
6868
[literal expressions](/terraform/language/expressions/types) in the
6969
Terraform language, so list and map values can be specified via this flag.
7070
- `-var-file=foo` - Set variables in the Terraform configuration from
71-
a [variable file](/terraform/language/parameterize#variable-definition-files). If
71+
a [variable file](/terraform/language/values/variables#variable-definition-files). If
7272
`terraform.tfvars` or any `.auto.tfvars` files are present in the current
7373
directory, they are automatically loaded. Terraform loads `terraform.tfvars`
7474
first and the `.auto.tfvars` files after in alphabetical order. Any files

content/terraform/v1.12.x/docs/cli/commands/plan.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,11 +145,11 @@ In addition to alternate [planning modes](#planning-modes), there are several op
145145
- `-var-file=FILENAME` - Sets values for potentially many
146146
[input variables](/terraform/language/block/variable) declared in the
147147
root module of the configuration, using definitions from a
148-
[`.tfvars` file](/terraform/language/parameterize#variable-definition-files).
148+
[`.tfvars` file](/terraform/language/values/variables#variable-definition-files).
149149
Use this option multiple times to include values from more than one file.
150150
There are several other ways to set values for input variables in the root
151151
module, aside from the `-var` and `-var-file` options. Refer to
152-
[Assign values to input variables](/terraform/language/parameterize#assign-values-to-input-variables) for more information.
152+
[Assign values to input variables](/terraform/language/values/variables#assign-values-to-input-variables) for more information.
153153

154154
### Input Variables on the Command Line
155155

@@ -223,7 +223,7 @@ terraform plan -var "name=[\"a\", \"b\", \"c\"]"
223223
Similar constraints apply when setting input variables using environment
224224
variables. For more information on the various methods for setting root module
225225
input variables, see
226-
[Assign values to input variables](/terraform/language/parameterize#assign-values-to-input-variables).
226+
[Assign values to input variables](/terraform/language/values/variables#assign-values-to-input-variables).
227227

228228
### Resource Targeting
229229

content/terraform/v1.12.x/docs/cli/config/environment-variables.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export TF_VAR_alist='[1,2,3]'
6161
export TF_VAR_amap='{ foo = "bar", baz = "qux" }'
6262
```
6363

64-
For more on how to use `TF_VAR_name` in context, refer to [Environment variables](/terraform/language/parameterize#environment-variables).
64+
For more on how to use `TF_VAR_name` in context, refer to [Environment variables](/terraform/language/values/variables#environment-variables).
6565

6666
## TF_CLI_ARGS and TF_CLI_ARGS_name
6767

content/terraform/v1.12.x/docs/language/block/locals.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The `locals` block is similar to function-scoped variables in other programming
1515

1616
You can define local values in any module. Local values can be any valid Terraform expression, and can reference variables, resource attributes, function outputs, or other local values to transform or combine data.
1717

18-
To learn more about using `locals` blocks in your configurations, refer to [Define locals to reuse expressions](/terraform/language/parameterize#define-locals-to-reuse-expressions).
18+
To learn more about using `locals` blocks in your configurations, refer to [Use locals to reuse expressions](/terraform/language/values/locals).
1919

2020
## Configuration model
2121

content/terraform/v1.12.x/docs/language/block/output.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The value of an `output` block is similar to a return value in other programming
2020

2121
In HCP Terraform, your `output` block values appear in the UI after Terraform applies your configuration. You can [mark outputs as sensitive in HCP Terraform](/terraform/cloud-docs/workspaces/variables/managing-variables#sensitive-values) to hide their values in the UI and in API responses.
2222

23-
To learn more about using `output` blocks, refer to [Define outputs to expose module data](/terraform/language/parameterize#define-outputs-to-expose-module-data).
23+
To learn more about using `output` blocks, refer to [Use outputs to expose module data](/terraform/language/values/outputs).
2424

2525
## Configuration model
2626

content/terraform/v1.12.x/docs/language/block/variable.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Use variables to parameterize your configuration, making your modul
55

66
# `variable` block reference
77

8-
Use the `variable` block to parameterize your configuration, making your modules dynamic, reusable, and flexible by letting them customize behavior with different values at run time.
8+
Use the `variable` block to parameterize your configuration so that module consumers can pass custom values into the configuration at runtime.
99

1010
> **Hands-on:** Try the [Customize Terraform Configuration with Variables](/terraform/tutorials/configuration-language/variables) tutorial.
1111
@@ -17,7 +17,7 @@ You can define variables in root modules, or in child modules:
1717
- In the root modules, you can set variable values using CLI options, environment variables, variable definition files, or through an HCP Terraform workspace.
1818
- In child modules, the parent module passes values to child modules as arguments to the `module` block.
1919

20-
To learn more about the different ways to use and set values for variables, refer to [Define module input arguments with variables](/terraform/language/parameterize#define-module-input-arguments-with-variables).
20+
To learn more about the different ways to use and set values for variables, refer to [Use variables to input module arguments](/terraform/language/values/variables).
2121

2222
## Configuration model
2323

0 commit comments

Comments
 (0)