IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2025-01-11 00:22:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Correct docs for terraform block (#633)

Browse Source
This commit is contained in:
Serdar Dalgıç 2023-10-03 14:50:56 +02:00 committed by GitHub
parent 0c1cf4d1ef
commit 267a595c94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/docs/language/expressions/version-constraints.mdx
View File

@ -12,7 +12,7 @@ constraint. Version constraints are used when configuring:
- [Modules](/docs/language/modules)
- [Provider requirements](/docs/language/providers/requirements)
- [The `required_version` setting](/docs/language/settings#specifying-a-required-tofu-version) in the `tofu` block.
- [The `required_version` setting](/docs/language/settings#specifying-a-required-tofu-version) in the `terraform` block.
## Version Constraint Syntax

2
website/docs/language/settings/backends/configuration.mdx
View File

@ -24,7 +24,7 @@ You do not need to configure a backend when using TACOS (TF Automation and Colla
it automatically manages state in the workspaces associated with your configuration. If your configuration includes a [`cloud` block](/docs/language/settings/tf-cloud), it cannot include a `backend` block.
To configure a backend, add a nested `backend` block within the top-level
`tofu` block. The following example configures the `remote` backend.
`terraform` block. The following example configures the `remote` backend.
```hcl
terraform {

23
website/docs/language/settings/index.mdx
View File

@ -1,19 +1,26 @@
---
description: >-
The tofu block allows you to configure OpenTofu behavior, including the
The terraform block allows you to configure OpenTofu behavior, including the
OpenTofu version, backend, integration with TACOS (TF Automation and Collaboration Software),
and required providers.
---
# OpenTofu Settings
The special `tofu` configuration block type is used to configure some
The special `terraform` configuration block type is used to configure some
behaviors of OpenTofu itself, such as requiring a minimum OpenTofu version to
apply your configuration.
## OpenTofu Block Syntax
:::note
As a part of [OpenTofu v1.x Compatibility Promises](/docs/language/v1-compatibility-promises),
the `terraform` block stays as-is. A `tofu` block may be introduced in the future, but it doesn't
exist yet.
:::
OpenTofu settings are gathered together into `tofu` blocks:
## OpenTofu `terraform` Block Syntax
OpenTofu settings are gathered together into `terraform` blocks:
```hcl
terraform {
@ -21,12 +28,12 @@ terraform {
}
```
Each `tofu` block can contain a number of settings related to OpenTofu's
behavior. Within a `tofu` block, only constant values can be used;
Each `terraform` block can contain a number of settings related to OpenTofu's
behavior. Within a `terraform` block, only constant values can be used;
arguments may not refer to named objects such as resources, input variables,
etc, and may not use any of the OpenTofu language built-in functions.
The various options supported within a `tofu` block are described in the
The various options supported within a `terraform` block are described in the
following sections.
## Configuring an OpenTofu Backend
@ -116,7 +123,7 @@ if any, are available in a particular OpenTofu release.
## Passing Metadata to Providers
The `tofu` block can have a nested `provider_meta` block for each
The `terraform` block can have a nested `provider_meta` block for each
provider a module is using, if the provider defines a schema for it. This
allows the provider to receive module-specific information, and is primarily
intended for modules distributed by the same vendor as the associated provider.