From 8cda034e2bd843673bc3f0db0aaaffd779996e6c Mon Sep 17 00:00:00 2001 From: Leah Bush Date: Wed, 28 May 2025 14:41:15 -0500 Subject: [PATCH] chore: add UDR notes to each mdx file --- website/README.md | 3 +++ website/docs/cli/auth/index.mdx | 3 +++ website/docs/cli/cloud/command-line-arguments.mdx | 3 +++ website/docs/cli/cloud/index.mdx | 3 +++ website/docs/cli/cloud/settings.mdx | 3 +++ website/docs/cli/code/index.mdx | 3 +++ website/docs/cli/commands/0.12upgrade.mdx | 3 +++ website/docs/cli/commands/0.13upgrade.mdx | 3 +++ website/docs/cli/commands/apply.mdx | 3 +++ website/docs/cli/commands/console.mdx | 3 +++ website/docs/cli/commands/destroy.mdx | 3 +++ website/docs/cli/commands/fmt.mdx | 3 +++ website/docs/cli/commands/force-unlock.mdx | 3 +++ website/docs/cli/commands/get.mdx | 3 +++ website/docs/cli/commands/graph.mdx | 3 +++ website/docs/cli/commands/import.mdx | 3 +++ website/docs/cli/commands/index.mdx | 3 +++ website/docs/cli/commands/init.mdx | 3 +++ website/docs/cli/commands/login.mdx | 3 +++ website/docs/cli/commands/logout.mdx | 3 +++ website/docs/cli/commands/modules.mdx | 3 +++ website/docs/cli/commands/output.mdx | 3 +++ website/docs/cli/commands/plan.mdx | 3 +++ website/docs/cli/commands/providers.mdx | 3 +++ website/docs/cli/commands/providers/lock.mdx | 3 +++ website/docs/cli/commands/providers/mirror.mdx | 3 +++ website/docs/cli/commands/providers/schema.mdx | 3 +++ website/docs/cli/commands/refresh.mdx | 3 +++ website/docs/cli/commands/show.mdx | 3 +++ website/docs/cli/commands/state/index.mdx | 3 +++ website/docs/cli/commands/state/list.mdx | 3 +++ website/docs/cli/commands/state/mv.mdx | 3 +++ website/docs/cli/commands/state/pull.mdx | 3 +++ website/docs/cli/commands/state/push.mdx | 3 +++ website/docs/cli/commands/state/replace-provider.mdx | 3 +++ website/docs/cli/commands/state/rm.mdx | 3 +++ website/docs/cli/commands/state/show.mdx | 3 +++ website/docs/cli/commands/taint.mdx | 3 +++ website/docs/cli/commands/test.mdx | 3 +++ website/docs/cli/commands/untaint.mdx | 3 +++ website/docs/cli/commands/validate.mdx | 3 +++ website/docs/cli/commands/version.mdx | 3 +++ website/docs/cli/commands/workspace/delete.mdx | 3 +++ website/docs/cli/commands/workspace/index.mdx | 3 +++ website/docs/cli/commands/workspace/list.mdx | 3 +++ website/docs/cli/commands/workspace/new.mdx | 3 +++ website/docs/cli/commands/workspace/select.mdx | 3 +++ website/docs/cli/commands/workspace/show.mdx | 3 +++ website/docs/cli/config/config-file.mdx | 3 +++ website/docs/cli/config/environment-variables.mdx | 3 +++ website/docs/cli/config/index.mdx | 3 +++ website/docs/cli/import/index.mdx | 3 +++ website/docs/cli/import/usage.mdx | 3 +++ website/docs/cli/index.mdx | 3 +++ website/docs/cli/init/index.mdx | 3 +++ website/docs/cli/inspect/index.mdx | 3 +++ website/docs/cli/plugins/index.mdx | 3 +++ website/docs/cli/plugins/signing.mdx | 3 +++ website/docs/cli/run/index.mdx | 3 +++ website/docs/cli/state/index.mdx | 3 +++ website/docs/cli/state/inspect.mdx | 3 +++ website/docs/cli/state/move.mdx | 3 +++ website/docs/cli/state/recover.mdx | 3 +++ website/docs/cli/state/resource-addressing.mdx | 3 +++ website/docs/cli/state/taint.mdx | 3 +++ website/docs/cli/test/index.mdx | 3 +++ website/docs/cli/workspaces/index.mdx | 3 +++ website/docs/internals/archiving.mdx | 3 +++ website/docs/internals/credentials-helpers.mdx | 3 +++ website/docs/internals/debugging.mdx | 3 +++ website/docs/internals/functions-meta.mdx | 3 +++ website/docs/internals/graph.mdx | 3 +++ website/docs/internals/index.mdx | 3 +++ website/docs/internals/json-format.mdx | 3 +++ website/docs/internals/login-protocol.mdx | 3 +++ website/docs/internals/machine-readable-ui.mdx | 3 +++ website/docs/internals/module-registry-protocol.mdx | 3 +++ website/docs/internals/provider-meta.mdx | 3 +++ website/docs/internals/provider-network-mirror-protocol.mdx | 3 +++ website/docs/internals/provider-registry-protocol.mdx | 3 +++ website/docs/internals/remote-service-discovery.mdx | 3 +++ website/docs/intro/core-workflow.mdx | 3 +++ website/docs/intro/index.mdx | 3 +++ website/docs/intro/phases/adopt.mdx | 3 +++ website/docs/intro/phases/collaborate.mdx | 3 +++ website/docs/intro/phases/govern.mdx | 3 +++ website/docs/intro/phases/index.mdx | 3 +++ website/docs/intro/phases/scale.mdx | 3 +++ website/docs/intro/terraform-editions.mdx | 3 +++ website/docs/intro/use-cases.mdx | 3 +++ website/docs/intro/vs/boto.mdx | 3 +++ website/docs/intro/vs/chef-puppet.mdx | 3 +++ website/docs/intro/vs/cloudformation.mdx | 3 +++ website/docs/intro/vs/custom.mdx | 3 +++ website/docs/intro/vs/index.mdx | 3 +++ website/docs/language/attr-as-blocks.mdx | 3 +++ website/docs/language/backend/azurerm.mdx | 3 +++ website/docs/language/backend/consul.mdx | 3 +++ website/docs/language/backend/cos.mdx | 3 +++ website/docs/language/backend/gcs.mdx | 3 +++ website/docs/language/backend/http.mdx | 3 +++ website/docs/language/backend/index.mdx | 3 +++ website/docs/language/backend/kubernetes.mdx | 3 +++ website/docs/language/backend/local.mdx | 3 +++ website/docs/language/backend/oci.mdx | 3 +++ website/docs/language/backend/oss.mdx | 3 +++ website/docs/language/backend/pg.mdx | 3 +++ website/docs/language/backend/remote.mdx | 3 +++ website/docs/language/backend/s3.mdx | 3 +++ website/docs/language/checks/index.mdx | 3 +++ website/docs/language/data-sources/index.mdx | 3 +++ website/docs/language/expressions/conditionals.mdx | 3 +++ website/docs/language/expressions/custom-conditions.mdx | 3 +++ website/docs/language/expressions/dynamic-blocks.mdx | 3 +++ website/docs/language/expressions/for.mdx | 3 +++ website/docs/language/expressions/function-calls.mdx | 3 +++ website/docs/language/expressions/index.mdx | 3 +++ website/docs/language/expressions/operators.mdx | 3 +++ website/docs/language/expressions/references.mdx | 3 +++ website/docs/language/expressions/splat.mdx | 3 +++ website/docs/language/expressions/strings.mdx | 3 +++ website/docs/language/expressions/type-constraints.mdx | 3 +++ website/docs/language/expressions/types.mdx | 3 +++ website/docs/language/expressions/version-constraints.mdx | 3 +++ website/docs/language/files/dependency-lock.mdx | 3 +++ website/docs/language/files/index.mdx | 3 +++ website/docs/language/files/override.mdx | 3 +++ website/docs/language/files/tests.mdx | 3 +++ website/docs/language/functions/abs.mdx | 3 +++ website/docs/language/functions/abspath.mdx | 3 +++ website/docs/language/functions/alltrue.mdx | 3 +++ website/docs/language/functions/anytrue.mdx | 3 +++ website/docs/language/functions/base64decode.mdx | 3 +++ website/docs/language/functions/base64encode.mdx | 3 +++ website/docs/language/functions/base64gzip.mdx | 3 +++ website/docs/language/functions/base64sha256.mdx | 3 +++ website/docs/language/functions/base64sha512.mdx | 3 +++ website/docs/language/functions/basename.mdx | 3 +++ website/docs/language/functions/bcrypt.mdx | 3 +++ website/docs/language/functions/can.mdx | 3 +++ website/docs/language/functions/ceil.mdx | 3 +++ website/docs/language/functions/chomp.mdx | 3 +++ website/docs/language/functions/chunklist.mdx | 3 +++ website/docs/language/functions/cidrhost.mdx | 3 +++ website/docs/language/functions/cidrnetmask.mdx | 3 +++ website/docs/language/functions/cidrsubnet.mdx | 3 +++ website/docs/language/functions/cidrsubnets.mdx | 3 +++ website/docs/language/functions/coalesce.mdx | 3 +++ website/docs/language/functions/coalescelist.mdx | 3 +++ website/docs/language/functions/compact.mdx | 3 +++ website/docs/language/functions/concat.mdx | 3 +++ website/docs/language/functions/contains.mdx | 3 +++ website/docs/language/functions/csvdecode.mdx | 3 +++ website/docs/language/functions/dirname.mdx | 3 +++ website/docs/language/functions/distinct.mdx | 3 +++ website/docs/language/functions/element.mdx | 3 +++ website/docs/language/functions/endswith.mdx | 3 +++ website/docs/language/functions/ephemeralasnull.mdx | 3 +++ website/docs/language/functions/file.mdx | 3 +++ website/docs/language/functions/filebase64.mdx | 3 +++ website/docs/language/functions/filebase64sha256.mdx | 3 +++ website/docs/language/functions/filebase64sha512.mdx | 3 +++ website/docs/language/functions/fileexists.mdx | 3 +++ website/docs/language/functions/filemd5.mdx | 3 +++ website/docs/language/functions/fileset.mdx | 3 +++ website/docs/language/functions/filesha1.mdx | 3 +++ website/docs/language/functions/filesha256.mdx | 3 +++ website/docs/language/functions/filesha512.mdx | 3 +++ website/docs/language/functions/flatten.mdx | 3 +++ website/docs/language/functions/floor.mdx | 3 +++ website/docs/language/functions/format.mdx | 3 +++ website/docs/language/functions/formatdate.mdx | 3 +++ website/docs/language/functions/formatlist.mdx | 3 +++ website/docs/language/functions/indent.mdx | 3 +++ website/docs/language/functions/index.mdx | 3 +++ website/docs/language/functions/index_function.mdx | 3 +++ website/docs/language/functions/issensitive.mdx | 3 +++ website/docs/language/functions/join.mdx | 3 +++ website/docs/language/functions/jsondecode.mdx | 3 +++ website/docs/language/functions/jsonencode.mdx | 3 +++ website/docs/language/functions/keys.mdx | 3 +++ website/docs/language/functions/length.mdx | 3 +++ website/docs/language/functions/list.mdx | 3 +++ website/docs/language/functions/log.mdx | 3 +++ website/docs/language/functions/lookup.mdx | 3 +++ website/docs/language/functions/lower.mdx | 3 +++ website/docs/language/functions/map.mdx | 3 +++ website/docs/language/functions/matchkeys.mdx | 3 +++ website/docs/language/functions/max.mdx | 3 +++ website/docs/language/functions/md5.mdx | 3 +++ website/docs/language/functions/merge.mdx | 3 +++ website/docs/language/functions/min.mdx | 3 +++ website/docs/language/functions/nonsensitive.mdx | 3 +++ website/docs/language/functions/one.mdx | 3 +++ website/docs/language/functions/parseint.mdx | 3 +++ website/docs/language/functions/pathexpand.mdx | 3 +++ website/docs/language/functions/plantimestamp.mdx | 3 +++ website/docs/language/functions/pow.mdx | 3 +++ website/docs/language/functions/range.mdx | 3 +++ website/docs/language/functions/regex.mdx | 3 +++ website/docs/language/functions/regexall.mdx | 3 +++ website/docs/language/functions/replace.mdx | 3 +++ website/docs/language/functions/reverse.mdx | 3 +++ website/docs/language/functions/rsadecrypt.mdx | 3 +++ website/docs/language/functions/sensitive.mdx | 3 +++ website/docs/language/functions/setintersection.mdx | 3 +++ website/docs/language/functions/setproduct.mdx | 3 +++ website/docs/language/functions/setsubtract.mdx | 3 +++ website/docs/language/functions/setunion.mdx | 3 +++ website/docs/language/functions/sha1.mdx | 3 +++ website/docs/language/functions/sha256.mdx | 3 +++ website/docs/language/functions/sha512.mdx | 3 +++ website/docs/language/functions/signum.mdx | 3 +++ website/docs/language/functions/slice.mdx | 3 +++ website/docs/language/functions/sort.mdx | 3 +++ website/docs/language/functions/split.mdx | 3 +++ website/docs/language/functions/startswith.mdx | 3 +++ website/docs/language/functions/strcontains.mdx | 3 +++ website/docs/language/functions/strrev.mdx | 3 +++ website/docs/language/functions/substr.mdx | 3 +++ website/docs/language/functions/sum.mdx | 3 +++ website/docs/language/functions/templatefile.mdx | 3 +++ website/docs/language/functions/templatestring.mdx | 3 +++ website/docs/language/functions/terraform-applying.mdx | 3 +++ website/docs/language/functions/terraform-decode_tfvars.mdx | 3 +++ website/docs/language/functions/terraform-encode_expr.mdx | 3 +++ website/docs/language/functions/terraform-encode_tfvars.mdx | 3 +++ website/docs/language/functions/textdecodebase64.mdx | 3 +++ website/docs/language/functions/textencodebase64.mdx | 3 +++ website/docs/language/functions/timeadd.mdx | 3 +++ website/docs/language/functions/timecmp.mdx | 3 +++ website/docs/language/functions/timestamp.mdx | 3 +++ website/docs/language/functions/title.mdx | 3 +++ website/docs/language/functions/tobool.mdx | 3 +++ website/docs/language/functions/tolist.mdx | 3 +++ website/docs/language/functions/tomap.mdx | 3 +++ website/docs/language/functions/tonumber.mdx | 3 +++ website/docs/language/functions/toset.mdx | 3 +++ website/docs/language/functions/tostring.mdx | 3 +++ website/docs/language/functions/transpose.mdx | 3 +++ website/docs/language/functions/trim.mdx | 3 +++ website/docs/language/functions/trimprefix.mdx | 3 +++ website/docs/language/functions/trimspace.mdx | 3 +++ website/docs/language/functions/trimsuffix.mdx | 3 +++ website/docs/language/functions/try.mdx | 3 +++ website/docs/language/functions/type.mdx | 3 +++ website/docs/language/functions/upper.mdx | 3 +++ website/docs/language/functions/urlencode.mdx | 3 +++ website/docs/language/functions/uuid.mdx | 3 +++ website/docs/language/functions/uuidv5.mdx | 3 +++ website/docs/language/functions/values.mdx | 3 +++ website/docs/language/functions/yamldecode.mdx | 3 +++ website/docs/language/functions/yamlencode.mdx | 3 +++ website/docs/language/functions/zipmap.mdx | 3 +++ website/docs/language/import/generating-configuration.mdx | 3 +++ website/docs/language/import/index.mdx | 3 +++ website/docs/language/index.mdx | 3 +++ website/docs/language/meta-arguments/count.mdx | 3 +++ website/docs/language/meta-arguments/depends_on.mdx | 3 +++ website/docs/language/meta-arguments/for_each.mdx | 3 +++ website/docs/language/meta-arguments/lifecycle.mdx | 3 +++ website/docs/language/meta-arguments/module-providers.mdx | 3 +++ website/docs/language/meta-arguments/resource-provider.mdx | 3 +++ website/docs/language/modules/develop/composition.mdx | 3 +++ website/docs/language/modules/develop/index.mdx | 3 +++ website/docs/language/modules/develop/providers.mdx | 3 +++ website/docs/language/modules/develop/publish.mdx | 3 +++ website/docs/language/modules/develop/refactoring.mdx | 3 +++ website/docs/language/modules/develop/structure.mdx | 3 +++ website/docs/language/modules/index.mdx | 3 +++ website/docs/language/modules/sources.mdx | 3 +++ website/docs/language/modules/syntax.mdx | 3 +++ website/docs/language/moved.mdx | 3 +++ website/docs/language/providers/configuration.mdx | 3 +++ website/docs/language/providers/index.mdx | 3 +++ website/docs/language/providers/requirements.mdx | 3 +++ website/docs/language/resources/behavior.mdx | 3 +++ website/docs/language/resources/ephemeral/index.mdx | 3 +++ website/docs/language/resources/ephemeral/reference.mdx | 3 +++ website/docs/language/resources/ephemeral/write-only.mdx | 3 +++ website/docs/language/resources/index.mdx | 3 +++ website/docs/language/resources/provisioners/connection.mdx | 3 +++ website/docs/language/resources/provisioners/file.mdx | 3 +++ website/docs/language/resources/provisioners/local-exec.mdx | 3 +++ website/docs/language/resources/provisioners/null_resource.mdx | 3 +++ website/docs/language/resources/provisioners/remote-exec.mdx | 3 +++ website/docs/language/resources/provisioners/syntax.mdx | 3 +++ website/docs/language/resources/syntax.mdx | 3 +++ website/docs/language/resources/terraform-data.mdx | 3 +++ website/docs/language/stacks/create/config.mdx | 3 +++ website/docs/language/stacks/create/declare-providers.mdx | 3 +++ website/docs/language/stacks/deploy/authenticate.mdx | 3 +++ website/docs/language/stacks/deploy/conditions.mdx | 3 +++ website/docs/language/stacks/deploy/config.mdx | 3 +++ website/docs/language/stacks/deploy/pass-data.mdx | 3 +++ website/docs/language/stacks/design.mdx | 3 +++ website/docs/language/stacks/index.mdx | 3 +++ website/docs/language/stacks/reference/tfdeploy.mdx | 3 +++ website/docs/language/stacks/reference/tfstack.mdx | 3 +++ website/docs/language/stacks/reference/tfstacks-cli.mdx | 3 +++ website/docs/language/stacks/use-cases.mdx | 3 +++ website/docs/language/state/backends.mdx | 3 +++ website/docs/language/state/import.mdx | 3 +++ website/docs/language/state/index.mdx | 3 +++ website/docs/language/state/locking.mdx | 3 +++ website/docs/language/state/purpose.mdx | 3 +++ website/docs/language/state/refactor.mdx | 3 +++ website/docs/language/state/remote-state-data.mdx | 3 +++ website/docs/language/state/remote.mdx | 3 +++ website/docs/language/state/sensitive-data.mdx | 3 +++ website/docs/language/state/workspaces.mdx | 3 +++ website/docs/language/style.mdx | 3 +++ website/docs/language/syntax/configuration.mdx | 3 +++ website/docs/language/syntax/index.mdx | 3 +++ website/docs/language/syntax/json.mdx | 3 +++ website/docs/language/terraform.mdx | 3 +++ website/docs/language/tests/index.mdx | 3 +++ website/docs/language/tests/mocking.mdx | 3 +++ website/docs/language/upgrade-guides/index.mdx | 3 +++ website/docs/language/v1-compatibility-promises.mdx | 3 +++ website/docs/language/values/index.mdx | 3 +++ website/docs/language/values/locals.mdx | 3 +++ website/docs/language/values/outputs.mdx | 3 +++ website/docs/language/values/variables.mdx | 3 +++ 324 files changed, 972 insertions(+) diff --git a/website/README.md b/website/README.md index dc5932ec63..bae4ec2e59 100644 --- a/website/README.md +++ b/website/README.md @@ -1,5 +1,8 @@ # Terraform Documentation +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + This directory contains the portions of [the Terraform website](https://www.terraform.io/) that pertain to the core functionality, excluding providers and the overall configuration. The website uses the files in this directory in conjunction with diff --git a/website/docs/cli/auth/index.mdx b/website/docs/cli/auth/index.mdx index dc783d43a7..59b00999e1 100644 --- a/website/docs/cli/auth/index.mdx +++ b/website/docs/cli/auth/index.mdx @@ -5,6 +5,9 @@ description: >- an API token for your HCP Terraform or Terraform Enterprise account. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Get an API token for HCP Terraform and Terraform Enterprise This topic describes how to use the `terraform login` and `terraform logout` to authenticate with HCP Terraform and Terraform Enterprise. diff --git a/website/docs/cli/cloud/command-line-arguments.mdx b/website/docs/cli/cloud/command-line-arguments.mdx index 8483a8adf2..56de1622a5 100644 --- a/website/docs/cli/cloud/command-line-arguments.mdx +++ b/website/docs/cli/cloud/command-line-arguments.mdx @@ -3,6 +3,9 @@ page_title: -ignore-remote-version reference description: Use the -ignore-remote-version flag to override CLI-driven commands for HCP Terraform runs. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `-ignore-remote-version` reference When your configuration includes a `cloud` block, commands that diff --git a/website/docs/cli/cloud/index.mdx b/website/docs/cli/cloud/index.mdx index a8c93cb532..d115a3927c 100644 --- a/website/docs/cli/cloud/index.mdx +++ b/website/docs/cli/cloud/index.mdx @@ -4,6 +4,9 @@ description: >- Learn how to use HCP Terraform and Terraform Enterprise on the command line with the Terraform CLI. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Use HCP Terraform with the Terraform CLI The Terraform CLI integration with HCP Terraform lets you use HCP Terraform and Terraform Enterprise on the command line. In the documentation HCP Terraform instructions also apply to Terraform Enterprise, except where explicitly stated. diff --git a/website/docs/cli/cloud/settings.mdx b/website/docs/cli/cloud/settings.mdx index 24f3229333..f1b5e6f93e 100644 --- a/website/docs/cli/cloud/settings.mdx +++ b/website/docs/cli/cloud/settings.mdx @@ -4,6 +4,9 @@ description: >- Learn how to configure the Terraform CLI to connect to HCP Terraform. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Connect to HCP Terraform This topic describes how to connect the Terraform CLI to HCP Terraform. Integrating the CLI with HCP Terraform enables the CLI to act as a client for CLI-drive workflows. Refer to [CLI-driven Run Workflow](/terraform/cloud-docs/run/cli) for additional information. diff --git a/website/docs/cli/code/index.mdx b/website/docs/cli/code/index.mdx index 2863c9d4a7..639ebe859c 100644 --- a/website/docs/cli/code/index.mdx +++ b/website/docs/cli/code/index.mdx @@ -3,6 +3,9 @@ page_title: Format and validate Terraform configuration using the Terraform CLI description: Learn about the Terraform commands that validate, format, and upgrade code written in HCL. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Write and modify Terrafrom configuration from the CLI This topic provides an overview of the Terraform CLI commands you can use to develop, format, and validate your Terraform configuration. diff --git a/website/docs/cli/commands/0.12upgrade.mdx b/website/docs/cli/commands/0.12upgrade.mdx index ef4cebb75e..f5b918009f 100644 --- a/website/docs/cli/commands/0.12upgrade.mdx +++ b/website/docs/cli/commands/0.12upgrade.mdx @@ -5,6 +5,9 @@ description: >- Terraform 0.12 compatibility. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform 0.12upgrade` command The `terraform 0.12upgrade` command applies several automatic upgrade rules to diff --git a/website/docs/cli/commands/0.13upgrade.mdx b/website/docs/cli/commands/0.13upgrade.mdx index 0cc459b42b..0c66df1a37 100644 --- a/website/docs/cli/commands/0.13upgrade.mdx +++ b/website/docs/cli/commands/0.13upgrade.mdx @@ -5,6 +5,9 @@ description: >- provider source features from Terraform 0.13. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform 0.13upgrade` command The `terraform 0.13upgrade` command updates existing configuration to add an diff --git a/website/docs/cli/commands/apply.mdx b/website/docs/cli/commands/apply.mdx index 2c2abe1489..976e3066ea 100644 --- a/website/docs/cli/commands/apply.mdx +++ b/website/docs/cli/commands/apply.mdx @@ -4,6 +4,9 @@ description: The `terraform apply` command executes the actions proposed in a Te to create, update, or destroy infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform apply` command The `terraform apply` command executes the actions proposed in a Terraform diff --git a/website/docs/cli/commands/console.mdx b/website/docs/cli/commands/console.mdx index f740b2e6d5..228b5be797 100644 --- a/website/docs/cli/commands/console.mdx +++ b/website/docs/cli/commands/console.mdx @@ -5,6 +5,9 @@ description: >- expressions. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform console` command The `terraform console` command opens an interactive console for diff --git a/website/docs/cli/commands/destroy.mdx b/website/docs/cli/commands/destroy.mdx index 14a2b01a36..d22ae0ea83 100644 --- a/website/docs/cli/commands/destroy.mdx +++ b/website/docs/cli/commands/destroy.mdx @@ -5,6 +5,9 @@ description: >- configuration. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform destroy` command The `terraform destroy` command deprovisions all objects managed by a Terraform configuration. diff --git a/website/docs/cli/commands/fmt.mdx b/website/docs/cli/commands/fmt.mdx index 871f800eb5..aad793f3d6 100644 --- a/website/docs/cli/commands/fmt.mdx +++ b/website/docs/cli/commands/fmt.mdx @@ -5,6 +5,9 @@ description: >- and style. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform fmt` command The `terraform fmt` command formats Terraform configuration file contents so that it matches the canonical format and style. This command applies a subset of diff --git a/website/docs/cli/commands/force-unlock.mdx b/website/docs/cli/commands/force-unlock.mdx index b26eb3e1b8..09b6351929 100644 --- a/website/docs/cli/commands/force-unlock.mdx +++ b/website/docs/cli/commands/force-unlock.mdx @@ -5,6 +5,9 @@ description: >- does not modify your infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform force-unlock` command This topic provides reference information about the `terraform force-unlock` command. This command manually unlocks the state for the defined configuration. diff --git a/website/docs/cli/commands/get.mdx b/website/docs/cli/commands/get.mdx index 9b0254331c..7fb10d1182 100644 --- a/website/docs/cli/commands/get.mdx +++ b/website/docs/cli/commands/get.mdx @@ -3,6 +3,9 @@ page_title: terraform get command reference description: The `terraform get` command downloads and updates modules. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform get` command Run the `terraform get` command to download and update diff --git a/website/docs/cli/commands/graph.mdx b/website/docs/cli/commands/graph.mdx index 12a471977f..4ef4a40613 100644 --- a/website/docs/cli/commands/graph.mdx +++ b/website/docs/cli/commands/graph.mdx @@ -5,6 +5,9 @@ description: >- configuration or execution plan that you can use to generate charts. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform graph` command The `terraform graph` command generates a visual representation of a configuration or execution plan that you can use to generate charts. This command uses the DOT language generate graphs. Refer to the [GraphViz documentation](https://graphviz.org/doc/info/lang.html) for additional information. diff --git a/website/docs/cli/commands/import.mdx b/website/docs/cli/commands/import.mdx index c3097e7394..edfe5ff8ce 100644 --- a/website/docs/cli/commands/import.mdx +++ b/website/docs/cli/commands/import.mdx @@ -3,6 +3,9 @@ page_title: terraform import command reference description: The `terraform import` command imports existing resources into Terraform state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform import` command reference The `terraform import` command imports existing resources into Terraform. Refer to [Import](/terraform/cli/import) for additional information. diff --git a/website/docs/cli/commands/index.mdx b/website/docs/cli/commands/index.mdx index 3dfffc566c..2dae37b9f7 100644 --- a/website/docs/cli/commands/index.mdx +++ b/website/docs/cli/commands/index.mdx @@ -3,6 +3,9 @@ page_title: Terraform CLI overview description: The Terrafrom CLI includes commands for provisioning infrastructure as code and managing the infrastructure lifecycle. Learn about Terraform CLI features. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform CLI Overview This topic provides an overview of the Terraform command line interface. diff --git a/website/docs/cli/commands/init.mdx b/website/docs/cli/commands/init.mdx index 08604186b8..5c1fa1b39d 100644 --- a/website/docs/cli/commands/init.mdx +++ b/website/docs/cli/commands/init.mdx @@ -5,6 +5,9 @@ description: >- configuration files and installs plugins for required providers. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform init` command The `terraform init` command initializes a working directory diff --git a/website/docs/cli/commands/login.mdx b/website/docs/cli/commands/login.mdx index 9a4cb535a7..4c1ee3b2f8 100644 --- a/website/docs/cli/commands/login.mdx +++ b/website/docs/cli/commands/login.mdx @@ -5,6 +5,9 @@ description: >- offers Terraform services. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform login` command The `terraform login` command obtains an API token for HCP Terraform, Terraform Enterprise, or other host that diff --git a/website/docs/cli/commands/logout.mdx b/website/docs/cli/commands/logout.mdx index 8351a6a232..a98990f18b 100644 --- a/website/docs/cli/commands/logout.mdx +++ b/website/docs/cli/commands/logout.mdx @@ -5,6 +5,9 @@ description: >- login command. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform logout` command This topic provides reference information about the `terraform logout` command. diff --git a/website/docs/cli/commands/modules.mdx b/website/docs/cli/commands/modules.mdx index 2039a3bce9..607c954c76 100644 --- a/website/docs/cli/commands/modules.mdx +++ b/website/docs/cli/commands/modules.mdx @@ -5,6 +5,9 @@ description: >- modules in Terraform configuration. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Command: modules The `terraform modules` command provides a holistic view of all Terraform modules diff --git a/website/docs/cli/commands/output.mdx b/website/docs/cli/commands/output.mdx index cfaa719704..59692078b8 100644 --- a/website/docs/cli/commands/output.mdx +++ b/website/docs/cli/commands/output.mdx @@ -4,6 +4,9 @@ description: >- The `terraform output` command extracts the value of an output variable from the state file. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform output` command The `terraform output` command extracts the value of an output variable from the state file. diff --git a/website/docs/cli/commands/plan.mdx b/website/docs/cli/commands/plan.mdx index 4354cfacdc..6c563c37c5 100644 --- a/website/docs/cli/commands/plan.mdx +++ b/website/docs/cli/commands/plan.mdx @@ -5,6 +5,9 @@ description: >- changes that Terraform will make to your infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform plan` command The `terraform plan` command creates an execution plan, which lets you preview diff --git a/website/docs/cli/commands/providers.mdx b/website/docs/cli/commands/providers.mdx index c1a2f33158..2dbda74708 100644 --- a/website/docs/cli/commands/providers.mdx +++ b/website/docs/cli/commands/providers.mdx @@ -5,6 +5,9 @@ description: >- required in the current configuration. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Command: providers The `terraform providers` command shows information about the diff --git a/website/docs/cli/commands/providers/lock.mdx b/website/docs/cli/commands/providers/lock.mdx index 4ea85060ab..dc360b7b66 100644 --- a/website/docs/cli/commands/providers/lock.mdx +++ b/website/docs/cli/commands/providers/lock.mdx @@ -5,6 +5,9 @@ description: |- to the dependency lock file without initializing the referenced providers. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform providers lock` command The `terraform providers lock` adds new provider selection information to the dependency lock file without initializing the referenced providers. diff --git a/website/docs/cli/commands/providers/mirror.mdx b/website/docs/cli/commands/providers/mirror.mdx index 0ef8bc47cb..555adfffd9 100644 --- a/website/docs/cli/commands/providers/mirror.mdx +++ b/website/docs/cli/commands/providers/mirror.mdx @@ -6,6 +6,9 @@ description: |- filesystem. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform providers mirror` command The `terraform providers mirror` command downloads the providers required diff --git a/website/docs/cli/commands/providers/schema.mdx b/website/docs/cli/commands/providers/schema.mdx index af0cf6eb3a..bbf51c264b 100644 --- a/website/docs/cli/commands/providers/schema.mdx +++ b/website/docs/cli/commands/providers/schema.mdx @@ -4,6 +4,9 @@ description: >- The `terraform providers schema` command prints detailed schemas for the providers declared in the configuration. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform providers schema` command The `terraform providers schema` command print detailed schemas for the providers used in the current configuration. diff --git a/website/docs/cli/commands/refresh.mdx b/website/docs/cli/commands/refresh.mdx index d58b385f7b..1f5cc4a185 100644 --- a/website/docs/cli/commands/refresh.mdx +++ b/website/docs/cli/commands/refresh.mdx @@ -5,6 +5,9 @@ description: |- remote objects and updates the Terraform state to match. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform refresh` command The `terraform refresh` command reads the current settings from all managed diff --git a/website/docs/cli/commands/show.mdx b/website/docs/cli/commands/show.mdx index cee62369cf..5a8ff767b0 100644 --- a/website/docs/cli/commands/show.mdx +++ b/website/docs/cli/commands/show.mdx @@ -3,6 +3,9 @@ page_title: terraform show command reference description: The `terraform show` command provides human-readable output from a state or plan file. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform show` command The `terraform show` command provides human-readable output diff --git a/website/docs/cli/commands/state/index.mdx b/website/docs/cli/commands/state/index.mdx index 0ba25c3bab..11f677b2b9 100644 --- a/website/docs/cli/commands/state/index.mdx +++ b/website/docs/cli/commands/state/index.mdx @@ -3,6 +3,9 @@ page_title: terraform state commands reference description: The `terraform state` group of commands enable advanced Terraform state management. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform state` commands The `terraform state` commands enable advanced state management. diff --git a/website/docs/cli/commands/state/list.mdx b/website/docs/cli/commands/state/list.mdx index b3b429e8e0..f981dde4d9 100644 --- a/website/docs/cli/commands/state/list.mdx +++ b/website/docs/cli/commands/state/list.mdx @@ -5,6 +5,9 @@ description: >- state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform state list` command The `terraform state list` command lists resources within a diff --git a/website/docs/cli/commands/state/mv.mdx b/website/docs/cli/commands/state/mv.mdx index 4c29c01572..0f38e89739 100644 --- a/website/docs/cli/commands/state/mv.mdx +++ b/website/docs/cli/commands/state/mv.mdx @@ -4,6 +4,9 @@ description: >- The `terraform state mv` command changes bindings in Terraform state so that existing remote objects bind to new resource instances. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform state mv` command The `terraform state mv` command changes bindings in Terraform state so that existing remote objects bind to new resource instances. diff --git a/website/docs/cli/commands/state/pull.mdx b/website/docs/cli/commands/state/pull.mdx index 839b3d85b3..69a46f442f 100644 --- a/website/docs/cli/commands/state/pull.mdx +++ b/website/docs/cli/commands/state/pull.mdx @@ -4,6 +4,9 @@ description: >- The `terraform state pull` command downloads and outputs state information from a remote state or local state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform state pull` command The `terraform state pull` downloads and outputs state information from a [remote state](/terraform/language/state/remote) or local state. diff --git a/website/docs/cli/commands/state/push.mdx b/website/docs/cli/commands/state/push.mdx index 5acf7962ae..231da6b610 100644 --- a/website/docs/cli/commands/state/push.mdx +++ b/website/docs/cli/commands/state/push.mdx @@ -3,6 +3,9 @@ page_title: terraform state push command reference description: The `terraform state push` command uploads a state file to the Terraform state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform state push` command The `terraform state push` command uploads a local state file to [remote state](/terraform/language/state/remote) or a local state. We only recommend using this command when you must manually modify the remote state. diff --git a/website/docs/cli/commands/state/replace-provider.mdx b/website/docs/cli/commands/state/replace-provider.mdx index 690277a049..c54c50ef01 100644 --- a/website/docs/cli/commands/state/replace-provider.mdx +++ b/website/docs/cli/commands/state/replace-provider.mdx @@ -5,6 +5,9 @@ description: >- resources in the Terraform state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform state replace-provider` command The `terraform state replace-provider` command replaces the provider diff --git a/website/docs/cli/commands/state/rm.mdx b/website/docs/cli/commands/state/rm.mdx index 92cd4ad36c..67476bae67 100644 --- a/website/docs/cli/commands/state/rm.mdx +++ b/website/docs/cli/commands/state/rm.mdx @@ -4,6 +4,9 @@ description: >- The `terraform state rm` command removes bindings between resource instances defined in the Terraform configuration and corresponding remote objects. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform state rm` command The `terraform state rm` command removes the binding to an existing remote object without first destroying it. The remote object continues diff --git a/website/docs/cli/commands/state/show.mdx b/website/docs/cli/commands/state/show.mdx index 30c9036d32..3c48e237a6 100644 --- a/website/docs/cli/commands/state/show.mdx +++ b/website/docs/cli/commands/state/show.mdx @@ -5,6 +5,9 @@ description: >- resource in the Terraform state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform state show` command The `terraform state show` command shows the attributes of a diff --git a/website/docs/cli/commands/taint.mdx b/website/docs/cli/commands/taint.mdx index eede6b8d18..f069059c18 100644 --- a/website/docs/cli/commands/taint.mdx +++ b/website/docs/cli/commands/taint.mdx @@ -4,6 +4,9 @@ description: |- The `terraform taint` command marks specified objects in the Terraform state as tainted. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform taint` command The `terraform taint` command marks specified objects in the Terraform state as tainted. Use the `terraform taint` command when objects become degraded or damaged. Terraform prompts you to replace the tainted objects in the next plan you create. diff --git a/website/docs/cli/commands/test.mdx b/website/docs/cli/commands/test.mdx index 1e1e2bed7a..106f4660c2 100644 --- a/website/docs/cli/commands/test.mdx +++ b/website/docs/cli/commands/test.mdx @@ -4,6 +4,9 @@ description: >- The `terraform test` command loads and executes Terraform testing files. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform test` command The `terraform test` command loads and exectures Terraform testing files. diff --git a/website/docs/cli/commands/untaint.mdx b/website/docs/cli/commands/untaint.mdx index bd2163ae39..6adbdd420e 100644 --- a/website/docs/cli/commands/untaint.mdx +++ b/website/docs/cli/commands/untaint.mdx @@ -4,6 +4,9 @@ description: |- The `terraform untaint` command removes the `tainted` status from infrastructure objects tracked in the Terraform state data. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform untaint` command This topic provides reference information about the `terraform untaint` command. diff --git a/website/docs/cli/commands/validate.mdx b/website/docs/cli/commands/validate.mdx index 962875f0fa..1f9fb1f01b 100644 --- a/website/docs/cli/commands/validate.mdx +++ b/website/docs/cli/commands/validate.mdx @@ -4,6 +4,9 @@ description: >- The `terraform validate` command validates the syntax of Terraform configuration files in a directory. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform validate` command The `terraform validate` command validates the configuration files in a diff --git a/website/docs/cli/commands/version.mdx b/website/docs/cli/commands/version.mdx index d2f0d3a4e8..8199c53ac3 100644 --- a/website/docs/cli/commands/version.mdx +++ b/website/docs/cli/commands/version.mdx @@ -5,6 +5,9 @@ description: >- of all installed plugins. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform version` command The `terraform version` command prints the current version of the Terraform binary and all diff --git a/website/docs/cli/commands/workspace/delete.mdx b/website/docs/cli/commands/workspace/delete.mdx index 4b4f3f3c6c..9a4158a257 100644 --- a/website/docs/cli/commands/workspace/delete.mdx +++ b/website/docs/cli/commands/workspace/delete.mdx @@ -3,6 +3,9 @@ page_title: terraform workspace delete command reference description: The terraform workspace delete command deletes the specified workspace. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform workspace delete` command The `terraform workspace delete` command deletes the specified workspace. diff --git a/website/docs/cli/commands/workspace/index.mdx b/website/docs/cli/commands/workspace/index.mdx index c7d3dba497..e559a2c238 100644 --- a/website/docs/cli/commands/workspace/index.mdx +++ b/website/docs/cli/commands/workspace/index.mdx @@ -3,6 +3,9 @@ page_title: terraform workspace command reference description: The terraform workspace command helps you manage workspaces. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform workspace` command The `terraform workspace` command group helps you manage [workspaces](/terraform/language/state/workspaces). diff --git a/website/docs/cli/commands/workspace/list.mdx b/website/docs/cli/commands/workspace/list.mdx index 74a0b266e2..ffc08b4a63 100644 --- a/website/docs/cli/commands/workspace/list.mdx +++ b/website/docs/cli/commands/workspace/list.mdx @@ -3,6 +3,9 @@ page_title: terraform workspace list command reference description: The terraform workspace list command lists all existing workspaces. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform workspace list` command The `terraform workspace list` command lists all existing workspaces. diff --git a/website/docs/cli/commands/workspace/new.mdx b/website/docs/cli/commands/workspace/new.mdx index 5b07fae6de..51c18ff781 100644 --- a/website/docs/cli/commands/workspace/new.mdx +++ b/website/docs/cli/commands/workspace/new.mdx @@ -3,6 +3,9 @@ page_title: terraform workspace new command reference description: The terraform workspace new command creates a new workspace with the specified name. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform workspace new` command The `terraform workspace new` command is used to create a new workspace. diff --git a/website/docs/cli/commands/workspace/select.mdx b/website/docs/cli/commands/workspace/select.mdx index 17816e23be..da3ce8d3da 100644 --- a/website/docs/cli/commands/workspace/select.mdx +++ b/website/docs/cli/commands/workspace/select.mdx @@ -3,6 +3,9 @@ page_title: terraform workspace select` command reference description: The terraform workspace select command selects a workspace. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform workspace select` command The `terraform workspace select` selects a different workspace to use for further operations. diff --git a/website/docs/cli/commands/workspace/show.mdx b/website/docs/cli/commands/workspace/show.mdx index 548573ebba..29fa78646d 100644 --- a/website/docs/cli/commands/workspace/show.mdx +++ b/website/docs/cli/commands/workspace/show.mdx @@ -3,6 +3,9 @@ page_title: terraform workspace show command reference description: The terraform workspace show command outputs the current workspace. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform workspace show` command The `terraform workspace show` command outputs the current workspace. diff --git a/website/docs/cli/config/config-file.mdx b/website/docs/cli/config/config-file.mdx index bbf7200792..94c8df96ef 100644 --- a/website/docs/cli/config/config-file.mdx +++ b/website/docs/cli/config/config-file.mdx @@ -4,6 +4,9 @@ description: >- Learn how to create a `.terraformrc` or `terraform.rc` file to define Terraform CLI settings, including credentials, plugin caching, and provider installation. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Create a Terraform CLI configuration file This topic describes how create a configuration file to customize the behavior of the Terraform CLI. diff --git a/website/docs/cli/config/environment-variables.mdx b/website/docs/cli/config/environment-variables.mdx index 70144c6fde..b2cb218dea 100644 --- a/website/docs/cli/config/environment-variables.mdx +++ b/website/docs/cli/config/environment-variables.mdx @@ -5,6 +5,9 @@ description: >- Learn about the Terraform CLI environment variables. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform CLI environment variables reference This topic contains reference information about the environment variables you can use with the Terraform CLI. diff --git a/website/docs/cli/config/index.mdx b/website/docs/cli/config/index.mdx index e329f751bd..b496d3db93 100644 --- a/website/docs/cli/config/index.mdx +++ b/website/docs/cli/config/index.mdx @@ -4,6 +4,9 @@ description: >- The CLI configuration file and supported Terraform environment variables let you customize Terraform CLI behavior. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform CLI configuration overview You can configure the Terraform CLI in global settings, which are separate diff --git a/website/docs/cli/import/index.mdx b/website/docs/cli/import/index.mdx index 6d1e7b13a3..d327bcd7ea 100644 --- a/website/docs/cli/import/index.mdx +++ b/website/docs/cli/import/index.mdx @@ -4,6 +4,9 @@ description: >- Terraform lets you import existing infrastructure into state so that you can begin managing your infrastructure as code. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Import existing resources overview This topic provides an overview of the Terraform commands that let you import existing infrastructure resources so that you can manage them with Terraform. diff --git a/website/docs/cli/import/usage.mdx b/website/docs/cli/import/usage.mdx index ea9ddc2def..1f0bb53dc4 100644 --- a/website/docs/cli/import/usage.mdx +++ b/website/docs/cli/import/usage.mdx @@ -3,6 +3,9 @@ page_title: Import existing resources description: Learn now to use the `terraform import` command to import existing infrastructure resources. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Import existing resources This topic describes how to use the `terraform import` command to import existing infrastructure resources so that you can manage them as code. diff --git a/website/docs/cli/index.mdx b/website/docs/cli/index.mdx index 18bc093082..da02db7857 100644 --- a/website/docs/cli/index.mdx +++ b/website/docs/cli/index.mdx @@ -5,6 +5,9 @@ description: >- with HCP Terraform or Terraform Enterprise. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform CLI Documentation > **Hands-on:** Try the [Terraform: Get Started](/terraform/tutorials/aws-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorials. diff --git a/website/docs/cli/init/index.mdx b/website/docs/cli/init/index.mdx index f91c7c0897..4616ce9855 100644 --- a/website/docs/cli/init/index.mdx +++ b/website/docs/cli/init/index.mdx @@ -4,6 +4,9 @@ description: >- Learn how to initialize the working directory with the terraform init command, which installs plugins and modules defined in the configuration and retrieves state data. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Initialize the Working Directory Terraform expects to be invoked from a working directory that contains diff --git a/website/docs/cli/inspect/index.mdx b/website/docs/cli/inspect/index.mdx index cd323c1724..26083ca304 100644 --- a/website/docs/cli/inspect/index.mdx +++ b/website/docs/cli/inspect/index.mdx @@ -5,6 +5,9 @@ description: >- to understand your infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Inspect Infrastructure Commands Overview Terraform configurations and state data include some highly structured diff --git a/website/docs/cli/plugins/index.mdx b/website/docs/cli/plugins/index.mdx index 82f8bb3203..ac46e366a2 100644 --- a/website/docs/cli/plugins/index.mdx +++ b/website/docs/cli/plugins/index.mdx @@ -4,6 +4,9 @@ description: >- Providers are types of plugins for Terraform that manage infrastructure resources. Learn about managing plugins using the Terraform CLI. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Manage plugins overview This topic provides an overview of the how to manage plugins that Terraform relies on to manage various types diff --git a/website/docs/cli/plugins/signing.mdx b/website/docs/cli/plugins/signing.mdx index bb2e69e92d..7c623d0e46 100644 --- a/website/docs/cli/plugins/signing.mdx +++ b/website/docs/cli/plugins/signing.mdx @@ -4,6 +4,9 @@ description: >- Signatures help you determine the authenticity of the plugins you want to install. Learn about the types of signatures providers can have on the Terraform registry. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Plugin signatures diff --git a/website/docs/cli/run/index.mdx b/website/docs/cli/run/index.mdx index bc57c38cd6..42bbb4cd74 100644 --- a/website/docs/cli/run/index.mdx +++ b/website/docs/cli/run/index.mdx @@ -3,6 +3,9 @@ page_title: Terraform workflow for provisioning infrastructure description: Learn how to use the Terraform CLI to provision infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform workflow for provisioning infrastructure This topic provides overview information about the Terraform workflow for provisioning infrastructure using the Terraform CLI. diff --git a/website/docs/cli/state/index.mdx b/website/docs/cli/state/index.mdx index 1e419491d8..cfc71c711a 100644 --- a/website/docs/cli/state/index.mdx +++ b/website/docs/cli/state/index.mdx @@ -4,6 +4,9 @@ description: >- State data is the record of how real-world objects map to resources in the Terraform configuration. Learn how to manually update with state data. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Update Terraform state manually overview This topic provides overview information about how to manually update state in Terraform. diff --git a/website/docs/cli/state/inspect.mdx b/website/docs/cli/state/inspect.mdx index 74f200ca50..59efdee451 100644 --- a/website/docs/cli/state/inspect.mdx +++ b/website/docs/cli/state/inspect.mdx @@ -3,6 +3,9 @@ page_title: Inspect Terraform state description: The `terraform state` group of commands help you inspect Terraform state. Learn how inspecting Terraform state can help you read and update state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Inspect Terraform State Overview Terraform includes some commands for reading and updating state without taking diff --git a/website/docs/cli/state/move.mdx b/website/docs/cli/state/move.mdx index 252184d103..1c6aeb1a2e 100644 --- a/website/docs/cli/state/move.mdx +++ b/website/docs/cli/state/move.mdx @@ -4,6 +4,9 @@ description: >- Terraform state commands can move and remove resources and transfer existing resources to a different provider. Learn how about changing or moving resources. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Move Resources Terraform's state associates each real-world object with a configured resource diff --git a/website/docs/cli/state/recover.mdx b/website/docs/cli/state/recover.mdx index 8189731d88..a111c2b42e 100644 --- a/website/docs/cli/state/recover.mdx +++ b/website/docs/cli/state/recover.mdx @@ -4,6 +4,9 @@ description: >- Learn how to restore state backups and override Terraform state protections to fix state errors with the Terraform CLI. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Recover state from backup overview This topic provides overview information about recovering Terraform state from a backup after a disaster, such as an accident when performing diff --git a/website/docs/cli/state/resource-addressing.mdx b/website/docs/cli/state/resource-addressing.mdx index 04e4b756de..5c4a406414 100644 --- a/website/docs/cli/state/resource-addressing.mdx +++ b/website/docs/cli/state/resource-addressing.mdx @@ -3,6 +3,9 @@ page_title: Resource address reference description: Use the resource address to reference specific instances of resources elsewhere in the configuration. Learn how Terraform creates addresses for resources. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Resource Address Reference This topic provides reference information about resource addresses in Terraform. diff --git a/website/docs/cli/state/taint.mdx b/website/docs/cli/state/taint.mdx index cb3e06d7dc..489044663e 100644 --- a/website/docs/cli/state/taint.mdx +++ b/website/docs/cli/state/taint.mdx @@ -3,6 +3,9 @@ page_title: Recreate resources description: The -replace flag and taint command help you replace infrastructure objects. Learn how the -replace flag and taint command can help you recreate resources. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Recreate resources overview This topic provides an overview of how to recreate resources in Terraform. diff --git a/website/docs/cli/test/index.mdx b/website/docs/cli/test/index.mdx index 08177edce9..6866c53d9d 100644 --- a/website/docs/cli/test/index.mdx +++ b/website/docs/cli/test/index.mdx @@ -5,6 +5,9 @@ description: >- correctness in your infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Testing features in Terraform overview This topic provides an overview of the testing features in Terraform to help you validate your infrastructure. diff --git a/website/docs/cli/workspaces/index.mdx b/website/docs/cli/workspaces/index.mdx index 3baca17bd4..231fe5a5b9 100644 --- a/website/docs/cli/workspaces/index.mdx +++ b/website/docs/cli/workspaces/index.mdx @@ -4,6 +4,9 @@ description: >- Workspaces are separate instances of Terraform state data. Learn commands for managing workspaces. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Manage Workspaces Overview Workspaces in the Terraform CLI refer to separate instances of [state data](/terraform/language/state) inside the same Terraform working directory. They are distinctly different from [workspaces in HCP Terraform](/terraform/cloud-docs/workspaces), which each have their own Terraform configuration and function as separate working directories. diff --git a/website/docs/internals/archiving.mdx b/website/docs/internals/archiving.mdx index 2a10ec2d3f..678323b027 100644 --- a/website/docs/internals/archiving.mdx +++ b/website/docs/internals/archiving.mdx @@ -6,6 +6,9 @@ description: >- reduce confusion for users and developers. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + diff --git a/website/docs/internals/credentials-helpers.mdx b/website/docs/internals/credentials-helpers.mdx index a65d63921b..81a261c58f 100644 --- a/website/docs/internals/credentials-helpers.mdx +++ b/website/docs/internals/credentials-helpers.mdx @@ -5,6 +5,9 @@ description: >- API tokens for remote Terraform services. Learn how to create credentials helpers. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Create Credentials Helpers This topic describes how to write and install a credentials helper so that you can customize how Terraform obtains credentials. To learn diff --git a/website/docs/internals/debugging.mdx b/website/docs/internals/debugging.mdx index 31e9ba4d75..485ae4507b 100644 --- a/website/docs/internals/debugging.mdx +++ b/website/docs/internals/debugging.mdx @@ -4,6 +4,9 @@ description: >- Enable Terraform to generate logs so that you can debug unexpected behaviors. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Enable Terraform logs This topic describes how to enable Terraform logs so that you can debug unexpected behaviors. diff --git a/website/docs/internals/functions-meta.mdx b/website/docs/internals/functions-meta.mdx index b227843f72..161ff8937d 100644 --- a/website/docs/internals/functions-meta.mdx +++ b/website/docs/internals/functions-meta.mdx @@ -5,6 +5,9 @@ description: >- functions available in the current Terraform version. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform metadata functions` command The `terraform metadata functions` command prints signatures for the functions available in the current Terraform version. diff --git a/website/docs/internals/graph.mdx b/website/docs/internals/graph.mdx index 087be693da..4aadb8ebd0 100644 --- a/website/docs/internals/graph.mdx +++ b/website/docs/internals/graph.mdx @@ -5,6 +5,9 @@ description: >- uses the graph to generate plans, refresh state, perform other operations. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Dependency Graph This topic explains the dependency graph Terraform builds from Terraform configurations. This is an advanced topic and not required to understand how to use Terraform. diff --git a/website/docs/internals/index.mdx b/website/docs/internals/index.mdx index f025c4b7d0..93abd83509 100644 --- a/website/docs/internals/index.mdx +++ b/website/docs/internals/index.mdx @@ -4,6 +4,9 @@ description: >- Learn about internal Terraform processes, such as generating the resource dependency graph. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform internals overview This topic provides overview information about the internals of Terraform. diff --git a/website/docs/internals/json-format.mdx b/website/docs/internals/json-format.mdx index 815f89afab..1877bcb85e 100644 --- a/website/docs/internals/json-format.mdx +++ b/website/docs/internals/json-format.mdx @@ -4,6 +4,9 @@ description: >- Learn how to configure Terraform to print JSON-formatted details about state, configuration, and proposed infrastructure plans. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # JSON Output Format Overview This topic provides overview information about the JSON output Terraform prints to the terminal. diff --git a/website/docs/internals/login-protocol.mdx b/website/docs/internals/login-protocol.mdx index c3394866de..9b447b06cb 100644 --- a/website/docs/internals/login-protocol.mdx +++ b/website/docs/internals/login-protocol.mdx @@ -4,6 +4,9 @@ description: >- The login protocol authenticates Terraform against servers that provide Terraform-native services. Learn about the login protocol. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Login Protocol Reference This topic provides reference information about the login protocol Terraform uses for authentication against servers that profide Terraform-native services. You can use this reference information to offer Terraform-native services in a third-party system. diff --git a/website/docs/internals/machine-readable-ui.mdx b/website/docs/internals/machine-readable-ui.mdx index 05f4c20fb2..46b2d19be9 100644 --- a/website/docs/internals/machine-readable-ui.mdx +++ b/website/docs/internals/machine-readable-ui.mdx @@ -4,6 +4,9 @@ description: >- Terraform streams machine-readable output in JSON format, letting you use third-party tools to monitor operations. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Machine-readable UI Output Reference This topic provides reference information about the machine-readable output Terraform prints. diff --git a/website/docs/internals/module-registry-protocol.mdx b/website/docs/internals/module-registry-protocol.mdx index 71ceff93a9..1e05200a13 100644 --- a/website/docs/internals/module-registry-protocol.mdx +++ b/website/docs/internals/module-registry-protocol.mdx @@ -4,6 +4,9 @@ description: |- Terraform discovers modules available for installation using the module registry protocol. Learn about the module registry protocol so consumers can find your modules. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Module Registry Protocol Reference This topic provides reference information about the module registry protocol. diff --git a/website/docs/internals/provider-meta.mdx b/website/docs/internals/provider-meta.mdx index 50bb31dbf3..f9f5927094 100644 --- a/website/docs/internals/provider-meta.mdx +++ b/website/docs/internals/provider-meta.mdx @@ -4,6 +4,9 @@ description: >- Provider developers can enable the modules created for the their providers to collect provider metadata. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Collect Provider Metadata This topic describes how to create an inferface in the providers you develop that allows you to collect metadata that is unrelated to the resources in the module, such as usage statistics. This is an advanced topic and is not required to use Terraform. diff --git a/website/docs/internals/provider-network-mirror-protocol.mdx b/website/docs/internals/provider-network-mirror-protocol.mdx index 7178de4725..c64dbce70a 100644 --- a/website/docs/internals/provider-network-mirror-protocol.mdx +++ b/website/docs/internals/provider-network-mirror-protocol.mdx @@ -4,6 +4,9 @@ description: |- The provider network mirror protocol lets you provide an alternate installation source for your providers. Learn about the provider network mirror protocol. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Provider Network Mirror Protocol Reference This topic provides reference information about the provider network mirror protocol. You can implement an alternative installation source for Terraform providers and make the source available over the provider network mirror protocol, regardless of their origin registries. diff --git a/website/docs/internals/provider-registry-protocol.mdx b/website/docs/internals/provider-registry-protocol.mdx index a8acc4e948..9549c19f7a 100644 --- a/website/docs/internals/provider-registry-protocol.mdx +++ b/website/docs/internals/provider-registry-protocol.mdx @@ -4,6 +4,9 @@ description: |- Use the provider registry protocol to enable Terraform to discover metadata about available providers and locate their distribution packages. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Provider Registry Protocol Reference This topic provides reference information about the provider registry protocol. The protocol allows the Terraform CLI to discover metadata about the providers available for installation and to locate the distribution packages for a selected provider. diff --git a/website/docs/internals/remote-service-discovery.mdx b/website/docs/internals/remote-service-discovery.mdx index 5aeb17888c..cef8233164 100644 --- a/website/docs/internals/remote-service-discovery.mdx +++ b/website/docs/internals/remote-service-discovery.mdx @@ -4,6 +4,9 @@ description: |- The remote service discovery protocol presents Terraform-native services at a human-readable hostname. Learn about the remote service discovery protocol. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Remote Service Discovery Protocol Reference This topic provides reference information about the remote service discovery protocol in Terraform. diff --git a/website/docs/intro/core-workflow.mdx b/website/docs/intro/core-workflow.mdx index 3d49b7db39..7c5ebac352 100644 --- a/website/docs/intro/core-workflow.mdx +++ b/website/docs/intro/core-workflow.mdx @@ -3,6 +3,9 @@ page_title: Overview of the core Terraform workflow description: Learn how to provision and manage infrastructure using the core Terraform workflow for individuals, teams, and organizations. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Core Terraform Workflow Overview The core Terraform workflow has three steps: diff --git a/website/docs/intro/index.mdx b/website/docs/intro/index.mdx index 50df0b90fc..c405d2427a 100644 --- a/website/docs/intro/index.mdx +++ b/website/docs/intro/index.mdx @@ -5,6 +5,9 @@ sidebar_current: "what" description: |- Terraform is an infrastructure as code tool that lets you build, change, and version cloud and on-prem resources safely and efficiently. --- + +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. # What is Terraform? HashiCorp Terraform is an infrastructure as code tool that lets you define both cloud and on-prem resources in human-readable configuration files that you can version, reuse, and share. You can then use a consistent workflow to provision and manage all of your infrastructure throughout its lifecycle. Terraform can manage low-level components like compute, storage, and networking resources, as well as high-level components like DNS entries and SaaS features. diff --git a/website/docs/intro/phases/adopt.mdx b/website/docs/intro/phases/adopt.mdx index f2ff29b4df..8bcf7d849a 100644 --- a/website/docs/intro/phases/adopt.mdx +++ b/website/docs/intro/phases/adopt.mdx @@ -3,6 +3,9 @@ page_title: Adopt Terraform description: Establish strong foundational practices that support future scale and make Terraform operations predictable and secure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Adopt Terraform An individual practitioner can establish strong foundational practices that support future scale and make Terraform operations predictable and secure. diff --git a/website/docs/intro/phases/collaborate.mdx b/website/docs/intro/phases/collaborate.mdx index 4b39110509..e1d699510d 100644 --- a/website/docs/intro/phases/collaborate.mdx +++ b/website/docs/intro/phases/collaborate.mdx @@ -3,6 +3,9 @@ page_title: Collaborate with Terraform description: Ease collaboration and coordinate execution across your team. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Collaborate with Terraform Multiple developers working on the same codebase introduces a new set of challenges, but solutions such as remote state backends help ease collaboration and coordinate execution. diff --git a/website/docs/intro/phases/govern.mdx b/website/docs/intro/phases/govern.mdx index d5ed5748a5..ee9110f374 100644 --- a/website/docs/intro/phases/govern.mdx +++ b/website/docs/intro/phases/govern.mdx @@ -3,6 +3,9 @@ page_title: Govern Terraform description: Use codified, automated policy enforcement to govern your organization's standards and best practices. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Govern Terraform As your teams grow, a common operational challenge is deciding how to enforce your organization's standards and practices. Using codified, automated policy enforcement with Sentinel or OPA ensures consistent application of your standards. diff --git a/website/docs/intro/phases/index.mdx b/website/docs/intro/phases/index.mdx index b4f9fad2b3..ffec13bb88 100644 --- a/website/docs/intro/phases/index.mdx +++ b/website/docs/intro/phases/index.mdx @@ -3,6 +3,9 @@ page_title: Phases of Terraform Adoption description: Evolve your Terraform strategy as adoption grows within your organization --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Phases of Terraform Adoption As more of your organization adopts Terraform, your infrastructure provisioning workflows will need to change and adapt. The workflows that are suitable for individual practitioners may not scale to larger enterprises. This guide will help you plan your organization's Terraform adoption strategy and presents workflow considerations that you should keep in mind to support future scale. This guide focuses on challenges faced by larger organizations, but we recommend implementing each practice as early as you can to help you scale smoothly. diff --git a/website/docs/intro/phases/scale.mdx b/website/docs/intro/phases/scale.mdx index 857c15807c..649e2f5f7c 100644 --- a/website/docs/intro/phases/scale.mdx +++ b/website/docs/intro/phases/scale.mdx @@ -3,6 +3,9 @@ page_title: Scale Terraform description: Define boundaries of infrastructure ownership across your team with Terraform. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Scale Terraform As Terraform usage expands across your organization, you will need to decide how to define boundaries of infrastructure ownership. diff --git a/website/docs/intro/terraform-editions.mdx b/website/docs/intro/terraform-editions.mdx index 0d3962b153..e12b32d50b 100644 --- a/website/docs/intro/terraform-editions.mdx +++ b/website/docs/intro/terraform-editions.mdx @@ -6,6 +6,9 @@ description: |- Learn how Terraform Community Edition, HCP Terraform, and Terraform Enterprise solve increasingly complex infrastructure and collaboration challenges. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform Editions Overview As your organization adopts infrastructure as code (IaC), you will encounter increasingly complex technical and collaboration challenges. We offer three Terraform editions designed to help you solve them. diff --git a/website/docs/intro/use-cases.mdx b/website/docs/intro/use-cases.mdx index a6985db4bb..0515ff652f 100644 --- a/website/docs/intro/use-cases.mdx +++ b/website/docs/intro/use-cases.mdx @@ -6,6 +6,9 @@ description: |- Learn about Terraform use cases, such as enabling multi-cloud deployments, application management, policy compliance, and self-service infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform Use Cases [HashiCorp Terraform](/terraform/intro) is an infrastructure as code (IaC) tool that lets you define infrastructure resources in human-readable configuration files that you can version, reuse, and share. You can then use a consistent workflow to safely and efficiently provision and manage your infrastructure throughout its lifecycle. diff --git a/website/docs/intro/vs/boto.mdx b/website/docs/intro/vs/boto.mdx index 698e10a28d..bd38a4cad8 100644 --- a/website/docs/intro/vs/boto.mdx +++ b/website/docs/intro/vs/boto.mdx @@ -3,6 +3,9 @@ page_title: Terraform versus Boto, Fog, and other cloud provider client librarie description: Learn how Terraform's syntax compares to Boto, Flog, and other cloud provider client libraries. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform versus Boto, Fog, and other cloud provider client libraries Libraries like Boto, Fog, etc. are used to provide native access diff --git a/website/docs/intro/vs/chef-puppet.mdx b/website/docs/intro/vs/chef-puppet.mdx index c846ffac7b..4eb646a5f4 100644 --- a/website/docs/intro/vs/chef-puppet.mdx +++ b/website/docs/intro/vs/chef-puppet.mdx @@ -5,6 +5,9 @@ description: >- Puppet. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform vs. Chef, Puppet, etc. Configuration management tools install and manage software on a machine diff --git a/website/docs/intro/vs/cloudformation.mdx b/website/docs/intro/vs/cloudformation.mdx index eaa57524da..76d7136b5f 100644 --- a/website/docs/intro/vs/cloudformation.mdx +++ b/website/docs/intro/vs/cloudformation.mdx @@ -4,6 +4,9 @@ description: >- Learn how Terraform manages various cloud providers and services, such as AWS, OpenStack, Cloudflare, and DNSimple, versus CloudFormation, Heat, and other tools. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform versus CloudFormation, Heat, and other infrastructure as code tools CloudFormation, Heat, and other infrastructure as code tools allow you to codify the details of infrastructure diff --git a/website/docs/intro/vs/custom.mdx b/website/docs/intro/vs/custom.mdx index 32b18d6eb8..6dfe126d9d 100644 --- a/website/docs/intro/vs/custom.mdx +++ b/website/docs/intro/vs/custom.mdx @@ -4,6 +4,9 @@ description: >- Learn how the Terraform syntax enables to Terraform binary to overcome challenges of custom infrastructure as code solutions. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform versus Custom Solutions Most organizations start by manually managing infrastructure through diff --git a/website/docs/intro/vs/index.mdx b/website/docs/intro/vs/index.mdx index 3504ffacb4..3cd133b1ed 100644 --- a/website/docs/intro/vs/index.mdx +++ b/website/docs/intro/vs/index.mdx @@ -3,6 +3,9 @@ page_title: Terraform versus alternatives overview description: Terraform lets you define infrastructure as code and automate infrastructure lifecycle management. Learn how Terraform compares to other cloud infrastructure tools. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform versus Alternatives Overview Terraform provides a flexible abstraction of resources and providers. This model diff --git a/website/docs/language/attr-as-blocks.mdx b/website/docs/language/attr-as-blocks.mdx index 86b53ebe60..96801dccbc 100644 --- a/website/docs/language/attr-as-blocks.mdx +++ b/website/docs/language/attr-as-blocks.mdx @@ -7,6 +7,9 @@ description: >- block or attribute syntax. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Attributes as Blocks -> **Note:** This page is an appendix to the Terraform documentation. Most users do not need to know the full details of this behavior. diff --git a/website/docs/language/backend/azurerm.mdx b/website/docs/language/backend/azurerm.mdx index 6237ed3f61..2a6008e8e0 100644 --- a/website/docs/language/backend/azurerm.mdx +++ b/website/docs/language/backend/azurerm.mdx @@ -3,6 +3,9 @@ page_title: 'Backend Type: azurerm' description: Terraform can store state remotely in Azure Blob Storage. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # azurerm Stores the state as a Blob with the given Key within the Blob Container within [the Blob Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-introduction). diff --git a/website/docs/language/backend/consul.mdx b/website/docs/language/backend/consul.mdx index f6c60f01e2..2a6298c02b 100644 --- a/website/docs/language/backend/consul.mdx +++ b/website/docs/language/backend/consul.mdx @@ -3,6 +3,9 @@ page_title: 'Backend Type: consul' description: Terraform can store state in Consul. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # consul Stores the state in the [Consul](https://www.consul.io/) KV store at a given path. diff --git a/website/docs/language/backend/cos.mdx b/website/docs/language/backend/cos.mdx index 80551ad7ab..8b1444c244 100644 --- a/website/docs/language/backend/cos.mdx +++ b/website/docs/language/backend/cos.mdx @@ -5,6 +5,9 @@ description: >- with in a team. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # COS Stores the state as an object in a configurable prefix in a given bucket on [Tencent Cloud Object Storage](https://intl.cloud.tencent.com/product/cos) (COS). diff --git a/website/docs/language/backend/gcs.mdx b/website/docs/language/backend/gcs.mdx index 7647c8c098..bec3758196 100644 --- a/website/docs/language/backend/gcs.mdx +++ b/website/docs/language/backend/gcs.mdx @@ -5,6 +5,9 @@ description: >- with in a team. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # gcs Stores the state as an object in a configurable prefix in a pre-existing bucket on [Google Cloud Storage](https://cloud.google.com/storage/) (GCS). diff --git a/website/docs/language/backend/http.mdx b/website/docs/language/backend/http.mdx index 787f669cca..6138314b0c 100644 --- a/website/docs/language/backend/http.mdx +++ b/website/docs/language/backend/http.mdx @@ -3,6 +3,9 @@ page_title: 'Backend Type: http' description: Terraform can store state remotely at any valid HTTP endpoint. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # http Stores the state using a simple [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) client. diff --git a/website/docs/language/backend/index.mdx b/website/docs/language/backend/index.mdx index 278607ddbe..bd20096e87 100644 --- a/website/docs/language/backend/index.mdx +++ b/website/docs/language/backend/index.mdx @@ -4,6 +4,9 @@ description: >- Use the `backend` block to control where Terraform stores state. Learn about the available state backends, the backend block, initializing backends, partial backend configuration, changing backend configuration, and unconfiguring a backend. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Backend block configuration overview This topic provides an overview of how to configure the `backend` block in your Terraform configuration. The `backend` defines where Terraform stores its [state](/terraform/language/state) data files. diff --git a/website/docs/language/backend/kubernetes.mdx b/website/docs/language/backend/kubernetes.mdx index 937c461a75..c94f9b96fb 100644 --- a/website/docs/language/backend/kubernetes.mdx +++ b/website/docs/language/backend/kubernetes.mdx @@ -3,6 +3,9 @@ page_title: 'Backend Type: Kubernetes' description: Terraform can store state remotely in Kubernetes and lock that state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # kubernetes Stores the state in a [Kubernetes secret](https://kubernetes.io/docs/concepts/configuration/secret/). diff --git a/website/docs/language/backend/local.mdx b/website/docs/language/backend/local.mdx index 26fdfa6bd8..6f7f575188 100644 --- a/website/docs/language/backend/local.mdx +++ b/website/docs/language/backend/local.mdx @@ -5,6 +5,9 @@ description: >- with in a team. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # local **Kind: Enhanced** diff --git a/website/docs/language/backend/oci.mdx b/website/docs/language/backend/oci.mdx index 2996c07c88..af278913b9 100644 --- a/website/docs/language/backend/oci.mdx +++ b/website/docs/language/backend/oci.mdx @@ -3,6 +3,9 @@ page_title: 'Backend Type: oci' description: Terraform can store and lock state remotely in OCI object storage. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # oci The oci backend stores the Terraform state file in [Oracle Cloud Infrastructure (OCI) Object Storage](https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/objectstorageoverview.htm#overview), allowing multiple users to collaborate using a shared remote state and benefit from features such as [state locking](https://developer.hashicorp.com/terraform/language/v1.12.x/state/locking) and [workspaces](https://developer.hashicorp.com/terraform/language/v1.12.x/state/workspaces). diff --git a/website/docs/language/backend/oss.mdx b/website/docs/language/backend/oss.mdx index 94740e9d7e..e31583fc39 100644 --- a/website/docs/language/backend/oss.mdx +++ b/website/docs/language/backend/oss.mdx @@ -3,6 +3,9 @@ page_title: 'Backend Type: oss' description: Terraform can store state remotely in OSS and lock that state with OSS. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # OSS Stores the state as a given key in a given bucket on Stores diff --git a/website/docs/language/backend/pg.mdx b/website/docs/language/backend/pg.mdx index fa231b962b..6382191e10 100644 --- a/website/docs/language/backend/pg.mdx +++ b/website/docs/language/backend/pg.mdx @@ -3,6 +3,9 @@ page_title: 'Backend Type: pg' description: Terraform can store state remotely in a Postgres database with locking. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # pg Stores the state in a [Postgres database](https://www.postgresql.org) version 10 or newer. diff --git a/website/docs/language/backend/remote.mdx b/website/docs/language/backend/remote.mdx index e9ea55281a..b15fc6ec2c 100644 --- a/website/docs/language/backend/remote.mdx +++ b/website/docs/language/backend/remote.mdx @@ -5,6 +5,9 @@ description: >- version and work with in a team. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # remote -> **Note:** We introduced the remote backend in Terraform v0.11.13 and Terraform Enterprise v201809-1. As of Terraform v1.1.0 and Terraform Enterprise v202201-1, we recommend using HCP Terraform's built-in [`cloud` integration](/terraform/cli/cloud/settings) instead. The `cloud` option supports an improved user experience and more features, such as [structured run output mode](/terraform/cloud-docs/workspaces/settings#user-interface), which displays your plan and apply results in a human-readable format. diff --git a/website/docs/language/backend/s3.mdx b/website/docs/language/backend/s3.mdx index 77794f44cd..95552103ad 100644 --- a/website/docs/language/backend/s3.mdx +++ b/website/docs/language/backend/s3.mdx @@ -3,6 +3,9 @@ page_title: 'Backend Type: s3' description: Terraform can store and lock state remotely in Amazon S3. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # S3 Stores the state as a given key in a given bucket on [Amazon S3](https://aws.amazon.com/s3/). diff --git a/website/docs/language/checks/index.mdx b/website/docs/language/checks/index.mdx index 469c215749..0bfa757a2a 100644 --- a/website/docs/language/checks/index.mdx +++ b/website/docs/language/checks/index.mdx @@ -4,6 +4,9 @@ description: >- Check customized infrastructure requirements to provide ongoing and continuous verification. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Checks -> **Note:** Check blocks are only available in Terraform v1.5.0 and later. diff --git a/website/docs/language/data-sources/index.mdx b/website/docs/language/data-sources/index.mdx index f8d6522395..5a921a4a1f 100644 --- a/website/docs/language/data-sources/index.mdx +++ b/website/docs/language/data-sources/index.mdx @@ -6,6 +6,9 @@ description: >- lifecycle. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Data Sources _Data sources_ allow Terraform to use information defined outside of Terraform, diff --git a/website/docs/language/expressions/conditionals.mdx b/website/docs/language/expressions/conditionals.mdx index 28ccc148b3..ecc58629ef 100644 --- a/website/docs/language/expressions/conditionals.mdx +++ b/website/docs/language/expressions/conditionals.mdx @@ -5,6 +5,9 @@ description: >- defaults to replace invalid values. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Conditional Expressions A _conditional expression_ uses the value of a boolean expression to select one of diff --git a/website/docs/language/expressions/custom-conditions.mdx b/website/docs/language/expressions/custom-conditions.mdx index 6f658ad36b..c4e6350d19 100644 --- a/website/docs/language/expressions/custom-conditions.mdx +++ b/website/docs/language/expressions/custom-conditions.mdx @@ -4,6 +4,9 @@ description: >- Check custom requirements for variables, outputs, data sources, and resources and provide better error messages in context. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Custom Conditions You can create conditions that produce custom error messages for several types of objects in a configuration. For example, you can add a condition to an input variable that checks whether incoming image IDs are formatted properly. Custom conditions can capture assumptions, helping future maintainers understand the configuration design and intent. They also return useful information about errors earlier and in context, helping consumers more easily diagnose issues in their configurations. diff --git a/website/docs/language/expressions/dynamic-blocks.mdx b/website/docs/language/expressions/dynamic-blocks.mdx index ce30ce9549..261b8392d5 100644 --- a/website/docs/language/expressions/dynamic-blocks.mdx +++ b/website/docs/language/expressions/dynamic-blocks.mdx @@ -5,6 +5,9 @@ description: >- Learn to configure dynamic blocks and understand their behavior. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `dynamic` Blocks Within top-level block constructs like resources, expressions can usually be diff --git a/website/docs/language/expressions/for.mdx b/website/docs/language/expressions/for.mdx index 80a883ff54..63bc58a828 100644 --- a/website/docs/language/expressions/for.mdx +++ b/website/docs/language/expressions/for.mdx @@ -5,6 +5,9 @@ description: >- Learn how to filter inputs and how to group results. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `for` Expressions A _`for` expression_ creates a complex type value by transforming diff --git a/website/docs/language/expressions/function-calls.mdx b/website/docs/language/expressions/function-calls.mdx index b12f667413..eb309e6508 100644 --- a/website/docs/language/expressions/function-calls.mdx +++ b/website/docs/language/expressions/function-calls.mdx @@ -5,6 +5,9 @@ description: >- functions. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Function Calls > **Hands-on:** Try the [Perform Dynamic Operations with Functions](/terraform/tutorials/configuration-language/functions?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/docs/language/expressions/index.mdx b/website/docs/language/expressions/index.mdx index 12a7cead19..01a1c8f256 100644 --- a/website/docs/language/expressions/index.mdx +++ b/website/docs/language/expressions/index.mdx @@ -5,6 +5,9 @@ description: >- configurations, including types, operators, and functions. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Expressions > **Hands-on:** Try the [Create Dynamic Expressions](/terraform/tutorials/configuration-language/expressions?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/docs/language/expressions/operators.mdx b/website/docs/language/expressions/operators.mdx index 4c77aca58f..11426f16a4 100644 --- a/website/docs/language/expressions/operators.mdx +++ b/website/docs/language/expressions/operators.mdx @@ -5,6 +5,9 @@ description: >- equality, and comparison operators. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Arithmetic and Logical Operators An _operator_ is a type of expression that transforms or combines one or more diff --git a/website/docs/language/expressions/references.mdx b/website/docs/language/expressions/references.mdx index f3febc16e0..88eb842647 100644 --- a/website/docs/language/expressions/references.mdx +++ b/website/docs/language/expressions/references.mdx @@ -6,6 +6,9 @@ description: >- data. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # References to Named Values > **Hands-on:** Try the [Create Dynamic Expressions](/terraform/tutorials/configuration-language/expressions?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/docs/language/expressions/splat.mdx b/website/docs/language/expressions/splat.mdx index e7d246253e..7e5bf1a4c5 100644 --- a/website/docs/language/expressions/splat.mdx +++ b/website/docs/language/expressions/splat.mdx @@ -5,6 +5,9 @@ description: >- also transform single, non-null values into a single-element tuple. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Splat Expressions > **Hands-on:** Try the [Create Dynamic Expressions](/terraform/tutorials/configuration-language/expressions?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/docs/language/expressions/strings.mdx b/website/docs/language/expressions/strings.mdx index e590c9380d..3dcfc9fcf5 100644 --- a/website/docs/language/expressions/strings.mdx +++ b/website/docs/language/expressions/strings.mdx @@ -5,6 +5,9 @@ description: >- Learn about both quoted and heredoc string syntax. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Strings and Templates String literals are the most complex kind of literal expression in diff --git a/website/docs/language/expressions/type-constraints.mdx b/website/docs/language/expressions/type-constraints.mdx index cef8cb50fb..0000bb8b51 100644 --- a/website/docs/language/expressions/type-constraints.mdx +++ b/website/docs/language/expressions/type-constraints.mdx @@ -5,6 +5,9 @@ description: >- resources. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Type Constraints Terraform module authors and provider developers can use detailed type diff --git a/website/docs/language/expressions/types.mdx b/website/docs/language/expressions/types.mdx index 5a9d86f951..ff7938b278 100644 --- a/website/docs/language/expressions/types.mdx +++ b/website/docs/language/expressions/types.mdx @@ -5,6 +5,9 @@ description: >- map. Also learn about complex types and type conversion. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Types and Values The result of an expression is a _value_. All values have a _type_, which diff --git a/website/docs/language/expressions/version-constraints.mdx b/website/docs/language/expressions/version-constraints.mdx index 9aa3c9217e..227ebd6661 100644 --- a/website/docs/language/expressions/version-constraints.mdx +++ b/website/docs/language/expressions/version-constraints.mdx @@ -5,6 +5,9 @@ description: >- providers, and Terraform itself. Learn version constraint syntax and behavior. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Version constraints This topic provides reference information about the version constraints syntax in Terraform configuration language. diff --git a/website/docs/language/files/dependency-lock.mdx b/website/docs/language/files/dependency-lock.mdx index 99aeb2bcdb..bb5b4cdf61 100644 --- a/website/docs/language/files/dependency-lock.mdx +++ b/website/docs/language/files/dependency-lock.mdx @@ -5,6 +5,9 @@ description: >- provider versions. Learn about dependency installation and lock file changes. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Dependency Lock File -> **Note:** This page is about a feature of Terraform 0.14 and later. Prior diff --git a/website/docs/language/files/index.mdx b/website/docs/language/files/index.mdx index 5e861a8c55..e1d6efedb7 100644 --- a/website/docs/language/files/index.mdx +++ b/website/docs/language/files/index.mdx @@ -5,6 +5,9 @@ description: >- learn how Terraform evaluates modules. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Files and Directories ## File Extension diff --git a/website/docs/language/files/override.mdx b/website/docs/language/files/override.mdx index 3595cd5ed3..b27ce4260b 100644 --- a/website/docs/language/files/override.mdx +++ b/website/docs/language/files/override.mdx @@ -5,6 +5,9 @@ description: >- Learn how to use override files and about merging behavior. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Override Files Terraform normally loads all of the `.tf` and `.tf.json` files within a diff --git a/website/docs/language/files/tests.mdx b/website/docs/language/files/tests.mdx index 370fdc4f8d..6c47e659fd 100644 --- a/website/docs/language/files/tests.mdx +++ b/website/docs/language/files/tests.mdx @@ -4,6 +4,9 @@ description: >- Learn how to write test files for validating your configuration and modules. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Test Files Specific Terraform commands, such as `test`, `init`, and `validate`, load Terraform test files for your configuration. diff --git a/website/docs/language/functions/abs.mdx b/website/docs/language/functions/abs.mdx index 5d40f25b5f..d04b8a5038 100644 --- a/website/docs/language/functions/abs.mdx +++ b/website/docs/language/functions/abs.mdx @@ -3,6 +3,9 @@ page_title: abs - Functions - Configuration Language description: The abs function returns the absolute value of the given number. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `abs` function reference This topic provides reference information about the `abs` function. The `abs` function returns the absolute value of the given number. diff --git a/website/docs/language/functions/abspath.mdx b/website/docs/language/functions/abspath.mdx index cf6da3b9a6..decf5de6d8 100644 --- a/website/docs/language/functions/abspath.mdx +++ b/website/docs/language/functions/abspath.mdx @@ -3,6 +3,9 @@ page_title: abspath - Functions - Configuration Language description: The abspath function converts the argument to an absolute filesystem path. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `abspath` Function `abspath` takes a string containing a filesystem path and converts it diff --git a/website/docs/language/functions/alltrue.mdx b/website/docs/language/functions/alltrue.mdx index 4236b71740..054e617326 100644 --- a/website/docs/language/functions/alltrue.mdx +++ b/website/docs/language/functions/alltrue.mdx @@ -5,6 +5,9 @@ description: |- are true or "true". If the collection is empty, it returns true. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `alltrue` Function -> **Note:** This function is available in Terraform 0.14 and later. diff --git a/website/docs/language/functions/anytrue.mdx b/website/docs/language/functions/anytrue.mdx index 4f3fb45479..798abc35f7 100644 --- a/website/docs/language/functions/anytrue.mdx +++ b/website/docs/language/functions/anytrue.mdx @@ -5,6 +5,9 @@ description: |- is true or "true". If the collection is empty, it returns false. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `anytrue` Function -> **Note:** This function is available in Terraform 0.14 and later. diff --git a/website/docs/language/functions/base64decode.mdx b/website/docs/language/functions/base64decode.mdx index 0e0ddf1574..472dc74ace 100644 --- a/website/docs/language/functions/base64decode.mdx +++ b/website/docs/language/functions/base64decode.mdx @@ -3,6 +3,9 @@ page_title: base64decode - Functions - Configuration Language description: The base64decode function decodes a string containing a base64 sequence. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `base64decode` Function `base64decode` takes a string containing a Base64 character sequence and diff --git a/website/docs/language/functions/base64encode.mdx b/website/docs/language/functions/base64encode.mdx index 1c4d6fda8b..e1190fc7e0 100644 --- a/website/docs/language/functions/base64encode.mdx +++ b/website/docs/language/functions/base64encode.mdx @@ -3,6 +3,9 @@ page_title: base64encode - Functions - Configuration Language description: The base64encode function applies Base64 encoding to a string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `base64encode` Function `base64encode` applies Base64 encoding to a string. diff --git a/website/docs/language/functions/base64gzip.mdx b/website/docs/language/functions/base64gzip.mdx index 66fe36e03f..423916d14c 100644 --- a/website/docs/language/functions/base64gzip.mdx +++ b/website/docs/language/functions/base64gzip.mdx @@ -4,6 +4,9 @@ description: |- The base64encode function compresses an HCL string using gzip, and then encodes it using Base64 encoding. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `base64gzip` function reference This topic provides reference information about the `base64gzip` function. diff --git a/website/docs/language/functions/base64sha256.mdx b/website/docs/language/functions/base64sha256.mdx index 7a1b340a5f..676ac766a3 100644 --- a/website/docs/language/functions/base64sha256.mdx +++ b/website/docs/language/functions/base64sha256.mdx @@ -5,6 +5,9 @@ description: |- encodes it with Base64. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `base64sha256` Function `base64sha256` computes the SHA256 hash of a given string and encodes it with diff --git a/website/docs/language/functions/base64sha512.mdx b/website/docs/language/functions/base64sha512.mdx index 7b426283ac..43c6625b0c 100644 --- a/website/docs/language/functions/base64sha512.mdx +++ b/website/docs/language/functions/base64sha512.mdx @@ -5,6 +5,9 @@ description: |- encodes it with Base64. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `base64sha512` Function `base64sha512` computes the SHA512 hash of a given string and encodes it with diff --git a/website/docs/language/functions/basename.mdx b/website/docs/language/functions/basename.mdx index 8f9262ad94..39d75440b3 100644 --- a/website/docs/language/functions/basename.mdx +++ b/website/docs/language/functions/basename.mdx @@ -5,6 +5,9 @@ description: |- path. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `basename` Function `basename` takes a string containing a filesystem path and removes all except diff --git a/website/docs/language/functions/bcrypt.mdx b/website/docs/language/functions/bcrypt.mdx index ca6913fd7c..23382bee84 100644 --- a/website/docs/language/functions/bcrypt.mdx +++ b/website/docs/language/functions/bcrypt.mdx @@ -5,6 +5,9 @@ description: |- cipher. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `bcrypt` Function `bcrypt` computes a hash of the given string using the Blowfish cipher, diff --git a/website/docs/language/functions/can.mdx b/website/docs/language/functions/can.mdx index c02f082071..8e22489979 100644 --- a/website/docs/language/functions/can.mdx +++ b/website/docs/language/functions/can.mdx @@ -5,6 +5,9 @@ description: |- indicates whether the evaluation succeeded. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `can` Function `can` evaluates the given expression and returns a boolean value indicating diff --git a/website/docs/language/functions/ceil.mdx b/website/docs/language/functions/ceil.mdx index 0245a82ac2..d1a94b417e 100644 --- a/website/docs/language/functions/ceil.mdx +++ b/website/docs/language/functions/ceil.mdx @@ -5,6 +5,9 @@ description: |- the given value. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `ceil` Function `ceil` returns the closest whole number that is greater than or equal to the diff --git a/website/docs/language/functions/chomp.mdx b/website/docs/language/functions/chomp.mdx index ff1b046c4c..3303feaf9b 100644 --- a/website/docs/language/functions/chomp.mdx +++ b/website/docs/language/functions/chomp.mdx @@ -3,6 +3,9 @@ page_title: chomp - Functions - Configuration Language description: The chomp function removes newline characters at the end of a string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `chomp` Function `chomp` removes newline characters at the end of a string. diff --git a/website/docs/language/functions/chunklist.mdx b/website/docs/language/functions/chunklist.mdx index dcc793a399..6491a88fdd 100644 --- a/website/docs/language/functions/chunklist.mdx +++ b/website/docs/language/functions/chunklist.mdx @@ -5,6 +5,9 @@ description: |- a list of lists. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `chunklist` Function `chunklist` splits a single list into fixed-size chunks, returning a list diff --git a/website/docs/language/functions/cidrhost.mdx b/website/docs/language/functions/cidrhost.mdx index 83b3762326..ebd806a6c5 100644 --- a/website/docs/language/functions/cidrhost.mdx +++ b/website/docs/language/functions/cidrhost.mdx @@ -5,6 +5,9 @@ description: |- IP network address prefix. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `cidrhost` Function `cidrhost` calculates a full host IP address for a given host number within diff --git a/website/docs/language/functions/cidrnetmask.mdx b/website/docs/language/functions/cidrnetmask.mdx index f66dc34c9e..4ef3df9f92 100644 --- a/website/docs/language/functions/cidrnetmask.mdx +++ b/website/docs/language/functions/cidrnetmask.mdx @@ -5,6 +5,9 @@ description: |- notation into a subnet mask address. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `cidrnetmask` Function `cidrnetmask` converts an IPv4 address prefix given in CIDR notation into diff --git a/website/docs/language/functions/cidrsubnet.mdx b/website/docs/language/functions/cidrsubnet.mdx index 8ee8b1cd8f..ac5190f4c5 100644 --- a/website/docs/language/functions/cidrsubnet.mdx +++ b/website/docs/language/functions/cidrsubnet.mdx @@ -5,6 +5,9 @@ description: |- address prefix. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `cidrsubnet` Function `cidrsubnet` calculates a subnet address within given IP network address prefix. diff --git a/website/docs/language/functions/cidrsubnets.mdx b/website/docs/language/functions/cidrsubnets.mdx index 0dfd573bd4..7864f6b921 100644 --- a/website/docs/language/functions/cidrsubnets.mdx +++ b/website/docs/language/functions/cidrsubnets.mdx @@ -5,6 +5,9 @@ description: |- ranges within a particular CIDR prefix. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `cidrsubnets` Function `cidrsubnets` calculates a sequence of consecutive IP address ranges within diff --git a/website/docs/language/functions/coalesce.mdx b/website/docs/language/functions/coalesce.mdx index fcbb6463cd..4ccb28a26e 100644 --- a/website/docs/language/functions/coalesce.mdx +++ b/website/docs/language/functions/coalesce.mdx @@ -5,6 +5,9 @@ description: |- first one that isn't null nor empty. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `coalesce` Function `coalesce` takes any number of arguments and returns the first one diff --git a/website/docs/language/functions/coalescelist.mdx b/website/docs/language/functions/coalescelist.mdx index 9d53dc05fb..109e76733b 100644 --- a/website/docs/language/functions/coalescelist.mdx +++ b/website/docs/language/functions/coalescelist.mdx @@ -5,6 +5,9 @@ description: |- first one that isn't empty. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `coalescelist` Function `coalescelist` takes any number of list arguments and returns the first one diff --git a/website/docs/language/functions/compact.mdx b/website/docs/language/functions/compact.mdx index 92321d62d6..d0ced8fb18 100644 --- a/website/docs/language/functions/compact.mdx +++ b/website/docs/language/functions/compact.mdx @@ -3,6 +3,9 @@ page_title: compact - Functions - Configuration Language description: The compact function removes null or empty string elements from a list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `compact` Function `compact` takes a list of strings and returns a new list with any null or empty string diff --git a/website/docs/language/functions/concat.mdx b/website/docs/language/functions/concat.mdx index 7709fe6cc0..3d63c76c75 100644 --- a/website/docs/language/functions/concat.mdx +++ b/website/docs/language/functions/concat.mdx @@ -3,6 +3,9 @@ page_title: concat - Functions - Configuration Language description: The concat function combines two or more lists into a single list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `concat` Function `concat` takes two or more lists and combines them into a single list. diff --git a/website/docs/language/functions/contains.mdx b/website/docs/language/functions/contains.mdx index b6c16d9f97..02ad6403c4 100644 --- a/website/docs/language/functions/contains.mdx +++ b/website/docs/language/functions/contains.mdx @@ -3,6 +3,9 @@ page_title: contains - Functions - Configuration Language description: The contains function determines whether a list or set contains a given value. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `contains` Function `contains` determines whether the list, tuple, or set given in its first diff --git a/website/docs/language/functions/csvdecode.mdx b/website/docs/language/functions/csvdecode.mdx index c6262c4558..09a30501e4 100644 --- a/website/docs/language/functions/csvdecode.mdx +++ b/website/docs/language/functions/csvdecode.mdx @@ -3,6 +3,9 @@ page_title: csvdecode - Functions - Configuration Language description: The csvdecode function decodes CSV data into a list of maps. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `csvdecode` Function `csvdecode` decodes a string containing CSV-formatted data and produces a diff --git a/website/docs/language/functions/dirname.mdx b/website/docs/language/functions/dirname.mdx index 1b4ab32eaf..8cc7823531 100644 --- a/website/docs/language/functions/dirname.mdx +++ b/website/docs/language/functions/dirname.mdx @@ -3,6 +3,9 @@ page_title: dirname - Functions - Configuration Language description: The dirname function removes the last portion from a filesystem path. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `dirname` Function `dirname` takes a string containing a filesystem path and removes the last diff --git a/website/docs/language/functions/distinct.mdx b/website/docs/language/functions/distinct.mdx index 95025deac9..c0658e5fbb 100644 --- a/website/docs/language/functions/distinct.mdx +++ b/website/docs/language/functions/distinct.mdx @@ -3,6 +3,9 @@ page_title: distinct - Functions - Configuration Language description: The distinct function removes duplicate elements from a list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `distinct` Function `distinct` takes a list and returns a new list with any duplicate elements diff --git a/website/docs/language/functions/element.mdx b/website/docs/language/functions/element.mdx index 49d8039a7e..8244d131e5 100644 --- a/website/docs/language/functions/element.mdx +++ b/website/docs/language/functions/element.mdx @@ -3,6 +3,9 @@ page_title: element - Functions - Configuration Language description: The element function retrieves a single element from a list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `element` Function `element` retrieves a single element from a list. diff --git a/website/docs/language/functions/endswith.mdx b/website/docs/language/functions/endswith.mdx index d6e5601f31..3591bb96be 100644 --- a/website/docs/language/functions/endswith.mdx +++ b/website/docs/language/functions/endswith.mdx @@ -4,6 +4,9 @@ description: |- The endswith function takes two values: a string to check and a suffix string. It returns true if the first string ends with that exact suffix. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `endswith` Function `endswith` takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. diff --git a/website/docs/language/functions/ephemeralasnull.mdx b/website/docs/language/functions/ephemeralasnull.mdx index 7e2092e63e..e01b81d091 100644 --- a/website/docs/language/functions/ephemeralasnull.mdx +++ b/website/docs/language/functions/ephemeralasnull.mdx @@ -4,6 +4,9 @@ description: |- The `ephemeralasnull` function accepts an ephemeral value and returns null. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `ephemeralasnull` function reference -> **Note**: The `ephemeralasnull` function is available in Terraform v1.10 and later. diff --git a/website/docs/language/functions/file.mdx b/website/docs/language/functions/file.mdx index 1c9872ba18..34031cb576 100644 --- a/website/docs/language/functions/file.mdx +++ b/website/docs/language/functions/file.mdx @@ -5,6 +5,9 @@ description: |- returns them as a string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `file` Function `file` reads the contents of a file at the given path and returns them as diff --git a/website/docs/language/functions/filebase64.mdx b/website/docs/language/functions/filebase64.mdx index 15c46ac4bd..5696e9b36e 100644 --- a/website/docs/language/functions/filebase64.mdx +++ b/website/docs/language/functions/filebase64.mdx @@ -5,6 +5,9 @@ description: |- returns them as a base64-encoded string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `filebase64` Function `filebase64` reads the contents of a file at the given path and returns them as diff --git a/website/docs/language/functions/filebase64sha256.mdx b/website/docs/language/functions/filebase64sha256.mdx index 2cdee344f0..a338a8c045 100644 --- a/website/docs/language/functions/filebase64sha256.mdx +++ b/website/docs/language/functions/filebase64sha256.mdx @@ -5,6 +5,9 @@ description: |- a given file and encodes it with Base64. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `filebase64sha256` Function `filebase64sha256` is a variant of [`base64sha256`](/terraform/language/functions/base64sha256) diff --git a/website/docs/language/functions/filebase64sha512.mdx b/website/docs/language/functions/filebase64sha512.mdx index 0fd09cbdd3..9c07f5bef2 100644 --- a/website/docs/language/functions/filebase64sha512.mdx +++ b/website/docs/language/functions/filebase64sha512.mdx @@ -5,6 +5,9 @@ description: |- a given file and encodes it with Base64. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `filebase64sha512` Function `filebase64sha512` is a variant of [`base64sha512`](/terraform/language/functions/base64sha512) diff --git a/website/docs/language/functions/fileexists.mdx b/website/docs/language/functions/fileexists.mdx index b95585f777..414a2eab1b 100644 --- a/website/docs/language/functions/fileexists.mdx +++ b/website/docs/language/functions/fileexists.mdx @@ -3,6 +3,9 @@ page_title: fileexists - Functions - Configuration Language description: The fileexists function determines whether a file exists at a given path. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `fileexists` Function `fileexists` determines whether a file exists at a given path. diff --git a/website/docs/language/functions/filemd5.mdx b/website/docs/language/functions/filemd5.mdx index 5b8525557f..529269a06c 100644 --- a/website/docs/language/functions/filemd5.mdx +++ b/website/docs/language/functions/filemd5.mdx @@ -5,6 +5,9 @@ description: |- a given file and encodes it as hex. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `filemd5` Function `filemd5` is a variant of [`md5`](/terraform/language/functions/md5) diff --git a/website/docs/language/functions/fileset.mdx b/website/docs/language/functions/fileset.mdx index 3a1661c83a..2e640d5940 100644 --- a/website/docs/language/functions/fileset.mdx +++ b/website/docs/language/functions/fileset.mdx @@ -3,6 +3,9 @@ page_title: fileset - Functions - Configuration Language description: The fileset function enumerates a set of regular file names given a pattern. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `fileset` Function `fileset` enumerates a set of regular file names given a path and pattern. diff --git a/website/docs/language/functions/filesha1.mdx b/website/docs/language/functions/filesha1.mdx index 7ae46bb0df..945eb9fe32 100644 --- a/website/docs/language/functions/filesha1.mdx +++ b/website/docs/language/functions/filesha1.mdx @@ -3,6 +3,9 @@ page_title: filesha1 - Functions - Configuration Language description: The filesha1 function computes the SHA1 hash of the contents of a given file and encodes it as hex. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `filesha1` function reference This topic provides reference information about the `filesha1` function, which calculates the SHA-1 hash of a file's contents. diff --git a/website/docs/language/functions/filesha256.mdx b/website/docs/language/functions/filesha256.mdx index 2be52d37b3..9089836e1e 100644 --- a/website/docs/language/functions/filesha256.mdx +++ b/website/docs/language/functions/filesha256.mdx @@ -5,6 +5,9 @@ description: |- a given file and encodes it as hex. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `filesha256` function reference This topic provides reference information about the `filesha256` function, which calculates the SHA-256 hash of a file's contents. diff --git a/website/docs/language/functions/filesha512.mdx b/website/docs/language/functions/filesha512.mdx index cb9aadd1d0..4c770d52f1 100644 --- a/website/docs/language/functions/filesha512.mdx +++ b/website/docs/language/functions/filesha512.mdx @@ -5,6 +5,9 @@ description: |- a given file and encodes it as hex. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `filesha512` function reference This topic provides reference information about the `filesha512` function, which calculates the SHA-512 hash of a file's contents. diff --git a/website/docs/language/functions/flatten.mdx b/website/docs/language/functions/flatten.mdx index 65dc855ff1..bc05031459 100644 --- a/website/docs/language/functions/flatten.mdx +++ b/website/docs/language/functions/flatten.mdx @@ -3,6 +3,9 @@ page_title: flatten - Functions - Configuration Language description: The flatten function eliminates nested lists from a list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `flatten` Function `flatten` takes a list and replaces any elements that are lists with a diff --git a/website/docs/language/functions/floor.mdx b/website/docs/language/functions/floor.mdx index c40b0e5f5a..9866495973 100644 --- a/website/docs/language/functions/floor.mdx +++ b/website/docs/language/functions/floor.mdx @@ -5,6 +5,9 @@ description: |- the given value. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `floor` Function `floor` returns the closest whole number that is less than or equal to the diff --git a/website/docs/language/functions/format.mdx b/website/docs/language/functions/format.mdx index 0bf30208d5..53189ad637 100644 --- a/website/docs/language/functions/format.mdx +++ b/website/docs/language/functions/format.mdx @@ -5,6 +5,9 @@ description: |- according to a specification string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `format` Function The `format` function produces a string by formatting a number of other values according diff --git a/website/docs/language/functions/formatdate.mdx b/website/docs/language/functions/formatdate.mdx index 358536d794..1229034abc 100644 --- a/website/docs/language/functions/formatdate.mdx +++ b/website/docs/language/functions/formatdate.mdx @@ -3,6 +3,9 @@ page_title: formatdate - Functions - Configuration Language description: The formatdate function converts a timestamp into a different time format. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `formatdate` Function `formatdate` converts a timestamp into a different time format. diff --git a/website/docs/language/functions/formatlist.mdx b/website/docs/language/functions/formatlist.mdx index 3d96865aa7..aa98e9bc1c 100644 --- a/website/docs/language/functions/formatlist.mdx +++ b/website/docs/language/functions/formatlist.mdx @@ -5,6 +5,9 @@ description: |- other values according to a specification string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `formatlist` Function `formatlist` produces a list of strings by formatting a number of other diff --git a/website/docs/language/functions/indent.mdx b/website/docs/language/functions/indent.mdx index bed6e96f03..69abec490c 100644 --- a/website/docs/language/functions/indent.mdx +++ b/website/docs/language/functions/indent.mdx @@ -4,6 +4,9 @@ description: |- The indent function adds spaces to the beginning of each line but the first in a multi-line string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `indent` function reference This topic provides reference information about the `indent` function. diff --git a/website/docs/language/functions/index.mdx b/website/docs/language/functions/index.mdx index a8f151986d..5613755d06 100644 --- a/website/docs/language/functions/index.mdx +++ b/website/docs/language/functions/index.mdx @@ -5,6 +5,9 @@ description: >- combine values in expressions. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Built-in Functions > **Hands-on:** Try the [Perform Dynamic Operations with Functions](/terraform/tutorials/configuration-language/functions?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/docs/language/functions/index_function.mdx b/website/docs/language/functions/index_function.mdx index 0839e0cbbf..92af814532 100644 --- a/website/docs/language/functions/index_function.mdx +++ b/website/docs/language/functions/index_function.mdx @@ -3,6 +3,9 @@ page_title: index - Functions - Configuration Language description: The index function finds the element index for a given value in a list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `index` Function `index` finds the first element index for a given value in a list. diff --git a/website/docs/language/functions/issensitive.mdx b/website/docs/language/functions/issensitive.mdx index 913edaab45..e310860207 100644 --- a/website/docs/language/functions/issensitive.mdx +++ b/website/docs/language/functions/issensitive.mdx @@ -3,6 +3,9 @@ page_title: issensitive - Functions - Configuration Language description: The issensitive function true if the value passed is marked as sensitive --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `issensitive` Function -> **Note:** This function is only available in Terraform v1.8 and later. diff --git a/website/docs/language/functions/join.mdx b/website/docs/language/functions/join.mdx index a917553f2b..fd1f7af0b0 100644 --- a/website/docs/language/functions/join.mdx +++ b/website/docs/language/functions/join.mdx @@ -5,6 +5,9 @@ description: |- with a given delimiter. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `join` Function `join` produces a string by concatenating all of the elements of the specified diff --git a/website/docs/language/functions/jsondecode.mdx b/website/docs/language/functions/jsondecode.mdx index e34322b1d1..97ef8ce3e1 100644 --- a/website/docs/language/functions/jsondecode.mdx +++ b/website/docs/language/functions/jsondecode.mdx @@ -5,6 +5,9 @@ description: |- value. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `jsondecode` Function `jsondecode` interprets a given string as JSON, returning a representation diff --git a/website/docs/language/functions/jsonencode.mdx b/website/docs/language/functions/jsonencode.mdx index 4afa3bcf07..a95b1553b9 100644 --- a/website/docs/language/functions/jsonencode.mdx +++ b/website/docs/language/functions/jsonencode.mdx @@ -3,6 +3,9 @@ page_title: jsonencode - Functions - Configuration Language description: The jsonencode function encodes a given value as a JSON string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `jsonencode` Function `jsonencode` encodes a given value to a string using JSON syntax. diff --git a/website/docs/language/functions/keys.mdx b/website/docs/language/functions/keys.mdx index 96a1553888..0ff6c6c5ce 100644 --- a/website/docs/language/functions/keys.mdx +++ b/website/docs/language/functions/keys.mdx @@ -3,6 +3,9 @@ page_title: keys - Functions - Configuration Language description: The keys function returns a list of the keys in a given map. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `keys` Function `keys` takes a map and returns a list containing the keys from that map. diff --git a/website/docs/language/functions/length.mdx b/website/docs/language/functions/length.mdx index add12b52f2..f96a47b43f 100644 --- a/website/docs/language/functions/length.mdx +++ b/website/docs/language/functions/length.mdx @@ -3,6 +3,9 @@ page_title: length - Functions - Configuration Language description: The length function determines the length of a collection or string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `length` Function `length` determines the length of a given list, map, or string. diff --git a/website/docs/language/functions/list.mdx b/website/docs/language/functions/list.mdx index c62663e66e..57dca8f8fb 100644 --- a/website/docs/language/functions/list.mdx +++ b/website/docs/language/functions/list.mdx @@ -3,6 +3,9 @@ page_title: list - Functions - Configuration Language description: The list function constructs a list from some given elements. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `list` Function The `list` function is no longer available. Prior to Terraform v0.12 it was diff --git a/website/docs/language/functions/log.mdx b/website/docs/language/functions/log.mdx index 7d9044e3a2..e2a445cf2c 100644 --- a/website/docs/language/functions/log.mdx +++ b/website/docs/language/functions/log.mdx @@ -3,6 +3,9 @@ page_title: log - Functions - Configuration Language description: The log function returns the logarithm of a given number in a given base. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `log` Function `log` returns the logarithm of a given number in a given base. diff --git a/website/docs/language/functions/lookup.mdx b/website/docs/language/functions/lookup.mdx index f08ffc9ada..c555c63a35 100644 --- a/website/docs/language/functions/lookup.mdx +++ b/website/docs/language/functions/lookup.mdx @@ -3,6 +3,9 @@ page_title: lookup - Functions - Configuration Language description: The lookup function retrieves an element value from a map given its key. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `lookup` Function `lookup` retrieves the value of a single element from a map, given its key. diff --git a/website/docs/language/functions/lower.mdx b/website/docs/language/functions/lower.mdx index 2e999ebd04..57203e06d4 100644 --- a/website/docs/language/functions/lower.mdx +++ b/website/docs/language/functions/lower.mdx @@ -5,6 +5,9 @@ description: >- lowercase. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `lower` Function `lower` converts all cased letters in the given string to lowercase. diff --git a/website/docs/language/functions/map.mdx b/website/docs/language/functions/map.mdx index 85d603c727..3ead11c04c 100644 --- a/website/docs/language/functions/map.mdx +++ b/website/docs/language/functions/map.mdx @@ -3,6 +3,9 @@ page_title: map - Functions - Configuration Language description: The map function constructs a map from some given elements. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `map` Function The `map` function is no longer available. Prior to Terraform v0.12 it was diff --git a/website/docs/language/functions/matchkeys.mdx b/website/docs/language/functions/matchkeys.mdx index e7005200b6..784f4e01c9 100644 --- a/website/docs/language/functions/matchkeys.mdx +++ b/website/docs/language/functions/matchkeys.mdx @@ -5,6 +5,9 @@ description: |- corresponding indexes in another list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `matchkeys` Function `matchkeys` constructs a new list by taking a subset of elements from one diff --git a/website/docs/language/functions/max.mdx b/website/docs/language/functions/max.mdx index 05a4ee6b07..149b716ead 100644 --- a/website/docs/language/functions/max.mdx +++ b/website/docs/language/functions/max.mdx @@ -3,6 +3,9 @@ page_title: max - Functions - Configuration Language description: The max function takes one or more numbers and returns the greatest number. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `max` Function `max` takes one or more numbers and returns the greatest number from the set. diff --git a/website/docs/language/functions/md5.mdx b/website/docs/language/functions/md5.mdx index 97e61f1960..4c9a3d86bf 100644 --- a/website/docs/language/functions/md5.mdx +++ b/website/docs/language/functions/md5.mdx @@ -5,6 +5,9 @@ description: |- with hexadecimal digits. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `md5` Function `md5` computes the MD5 hash of a given string and encodes it with diff --git a/website/docs/language/functions/merge.mdx b/website/docs/language/functions/merge.mdx index 6a3d230a73..8f30b7f073 100644 --- a/website/docs/language/functions/merge.mdx +++ b/website/docs/language/functions/merge.mdx @@ -6,6 +6,9 @@ description: |- arguments. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `merge` Function `merge` takes an arbitrary number of maps or objects, and returns a single map diff --git a/website/docs/language/functions/min.mdx b/website/docs/language/functions/min.mdx index f5388b2cc0..4a4d22843b 100644 --- a/website/docs/language/functions/min.mdx +++ b/website/docs/language/functions/min.mdx @@ -3,6 +3,9 @@ page_title: min - Functions - Configuration Language description: The min function takes one or more numbers and returns the smallest number. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `min` Function `min` takes one or more numbers and returns the smallest number from the set. diff --git a/website/docs/language/functions/nonsensitive.mdx b/website/docs/language/functions/nonsensitive.mdx index c25ba18432..87c39fbc1f 100644 --- a/website/docs/language/functions/nonsensitive.mdx +++ b/website/docs/language/functions/nonsensitive.mdx @@ -5,6 +5,9 @@ description: >- Terraform considers to be sensitive. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `nonsensitive` Function -> **Note:** This function is only available in Terraform v0.15 and later. diff --git a/website/docs/language/functions/one.mdx b/website/docs/language/functions/one.mdx index ceb6a16164..54d3653978 100644 --- a/website/docs/language/functions/one.mdx +++ b/website/docs/language/functions/one.mdx @@ -5,6 +5,9 @@ description: |- either a null value or the value of the first element. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `one` Function -> **Note:** This function is available only in Terraform v0.15 and later. diff --git a/website/docs/language/functions/parseint.mdx b/website/docs/language/functions/parseint.mdx index 952a147a0a..d33920f2c1 100644 --- a/website/docs/language/functions/parseint.mdx +++ b/website/docs/language/functions/parseint.mdx @@ -5,6 +5,9 @@ description: >- integer. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `parseint` Function `parseint` parses the given string as a representation of an integer in diff --git a/website/docs/language/functions/pathexpand.mdx b/website/docs/language/functions/pathexpand.mdx index 2383f84f8b..9e3019c135 100644 --- a/website/docs/language/functions/pathexpand.mdx +++ b/website/docs/language/functions/pathexpand.mdx @@ -5,6 +5,9 @@ description: |- home directory. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `pathexpand` Function `pathexpand` takes a filesystem path that might begin with a `~` segment, diff --git a/website/docs/language/functions/plantimestamp.mdx b/website/docs/language/functions/plantimestamp.mdx index 7b3a41e0d0..d91e09e581 100644 --- a/website/docs/language/functions/plantimestamp.mdx +++ b/website/docs/language/functions/plantimestamp.mdx @@ -5,6 +5,9 @@ description: |- during the plan. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `plantimestamp` Function -> **Note:** This function is only available in Terraform v1.5 and later. diff --git a/website/docs/language/functions/pow.mdx b/website/docs/language/functions/pow.mdx index f542d26b62..db92225704 100644 --- a/website/docs/language/functions/pow.mdx +++ b/website/docs/language/functions/pow.mdx @@ -3,6 +3,9 @@ page_title: pow - Functions - Configuration Language description: The pow function raises a number to a power. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `pow` Function `pow` calculates an exponent, by raising its first argument to the power of the second argument. diff --git a/website/docs/language/functions/range.mdx b/website/docs/language/functions/range.mdx index ecf5c39bf5..779bd8f282 100644 --- a/website/docs/language/functions/range.mdx +++ b/website/docs/language/functions/range.mdx @@ -3,6 +3,9 @@ page_title: range - Functions - Configuration Language description: The range function generates sequences of numbers. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `range` Function `range` generates a list of numbers using a start value, a limit value, diff --git a/website/docs/language/functions/regex.mdx b/website/docs/language/functions/regex.mdx index 98edcdf616..f2459ba065 100644 --- a/website/docs/language/functions/regex.mdx +++ b/website/docs/language/functions/regex.mdx @@ -5,6 +5,9 @@ description: |- matching substrings. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `regex` Function `regex` applies a diff --git a/website/docs/language/functions/regexall.mdx b/website/docs/language/functions/regexall.mdx index ea794af23b..546647f472 100644 --- a/website/docs/language/functions/regexall.mdx +++ b/website/docs/language/functions/regexall.mdx @@ -5,6 +5,9 @@ description: >- of all matches. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `regexall` Function `regexall` applies a diff --git a/website/docs/language/functions/replace.mdx b/website/docs/language/functions/replace.mdx index e4e76a1c68..19529aec4c 100644 --- a/website/docs/language/functions/replace.mdx +++ b/website/docs/language/functions/replace.mdx @@ -5,6 +5,9 @@ description: |- and replaces all occurrences with a given replacement string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `replace` Function `replace` searches a given string for another given substring, and replaces diff --git a/website/docs/language/functions/reverse.mdx b/website/docs/language/functions/reverse.mdx index c46350a256..279b2dd746 100644 --- a/website/docs/language/functions/reverse.mdx +++ b/website/docs/language/functions/reverse.mdx @@ -3,6 +3,9 @@ page_title: reverse - Functions - Configuration Language description: The reverse function reverses a sequence. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `reverse` Function `reverse` takes a sequence and produces a new sequence of the same length diff --git a/website/docs/language/functions/rsadecrypt.mdx b/website/docs/language/functions/rsadecrypt.mdx index 472731142e..e91d77a771 100644 --- a/website/docs/language/functions/rsadecrypt.mdx +++ b/website/docs/language/functions/rsadecrypt.mdx @@ -3,6 +3,9 @@ page_title: rsadecrypt - Functions - Configuration Language description: The rsadecrypt function decrypts an RSA-encrypted message. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `rsadecrypt` Function `rsadecrypt` decrypts an RSA-encrypted ciphertext, returning the corresponding diff --git a/website/docs/language/functions/sensitive.mdx b/website/docs/language/functions/sensitive.mdx index 2aeb2da177..7b7f758416 100644 --- a/website/docs/language/functions/sensitive.mdx +++ b/website/docs/language/functions/sensitive.mdx @@ -3,6 +3,9 @@ page_title: sensitive - Functions - Configuration Language description: The sensitive function marks a value as being sensitive. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `sensitive` Function -> **Note:** This function is only available in Terraform v0.15 and later. diff --git a/website/docs/language/functions/setintersection.mdx b/website/docs/language/functions/setintersection.mdx index 74c7de92a7..08d6dc6f94 100644 --- a/website/docs/language/functions/setintersection.mdx +++ b/website/docs/language/functions/setintersection.mdx @@ -5,6 +5,9 @@ description: |- containing only the elements that all of the given arrays have in common. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `setintersection` function reference This topic provides reference information about the `setintersection` function, diff --git a/website/docs/language/functions/setproduct.mdx b/website/docs/language/functions/setproduct.mdx index 39298bbcb2..e37ff846fe 100644 --- a/website/docs/language/functions/setproduct.mdx +++ b/website/docs/language/functions/setproduct.mdx @@ -5,6 +5,9 @@ description: |- from all of the given sets by computing the cartesian product. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `setproduct` Function The `setproduct` function finds all of the possible combinations of elements diff --git a/website/docs/language/functions/setsubtract.mdx b/website/docs/language/functions/setsubtract.mdx index 5397ed8168..1d418c576c 100644 --- a/website/docs/language/functions/setsubtract.mdx +++ b/website/docs/language/functions/setsubtract.mdx @@ -5,6 +5,9 @@ description: |- from the first set that are not present in the second set --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `setsubtract` Function 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 diff --git a/website/docs/language/functions/setunion.mdx b/website/docs/language/functions/setunion.mdx index 85874bd030..1cfb7f778e 100644 --- a/website/docs/language/functions/setunion.mdx +++ b/website/docs/language/functions/setunion.mdx @@ -5,6 +5,9 @@ description: |- containing the elements from all of the given sets. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `setunion` Function The `setunion` function takes multiple sets and produces a single set diff --git a/website/docs/language/functions/sha1.mdx b/website/docs/language/functions/sha1.mdx index dde0142fd3..8e06eda744 100644 --- a/website/docs/language/functions/sha1.mdx +++ b/website/docs/language/functions/sha1.mdx @@ -5,6 +5,9 @@ description: |- with hexadecimal digits. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `sha1` Function `sha1` computes the SHA1 hash of a given string and encodes it with diff --git a/website/docs/language/functions/sha256.mdx b/website/docs/language/functions/sha256.mdx index a4bba263e2..fd041c7b55 100644 --- a/website/docs/language/functions/sha256.mdx +++ b/website/docs/language/functions/sha256.mdx @@ -5,6 +5,9 @@ description: |- with hexadecimal digits. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `sha256` Function `sha256` computes the SHA256 hash of a given string and encodes it with diff --git a/website/docs/language/functions/sha512.mdx b/website/docs/language/functions/sha512.mdx index 83f55882f2..035a193d71 100644 --- a/website/docs/language/functions/sha512.mdx +++ b/website/docs/language/functions/sha512.mdx @@ -5,6 +5,9 @@ description: |- with hexadecimal digits. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `sha512` Function `sha512` computes the SHA512 hash of a given string and encodes it with diff --git a/website/docs/language/functions/signum.mdx b/website/docs/language/functions/signum.mdx index 9590d7faa9..c8efbb829d 100644 --- a/website/docs/language/functions/signum.mdx +++ b/website/docs/language/functions/signum.mdx @@ -3,6 +3,9 @@ page_title: signum - Functions - Configuration Language description: The signum function determines the sign of a number. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `signum` Function `signum` determines the sign of a number, returning a number between -1 and diff --git a/website/docs/language/functions/slice.mdx b/website/docs/language/functions/slice.mdx index 570c282dd5..917e9c3459 100644 --- a/website/docs/language/functions/slice.mdx +++ b/website/docs/language/functions/slice.mdx @@ -3,6 +3,9 @@ page_title: slice - Functions - Configuration Language description: The slice function extracts some consecutive elements from within a list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `slice` Function `slice` extracts some consecutive elements from within a list. diff --git a/website/docs/language/functions/sort.mdx b/website/docs/language/functions/sort.mdx index 7f079967f7..2e03156ce1 100644 --- a/website/docs/language/functions/sort.mdx +++ b/website/docs/language/functions/sort.mdx @@ -5,6 +5,9 @@ description: |- strings sorted lexicographically. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `sort` Function `sort` takes a list of strings and returns a new list with those strings diff --git a/website/docs/language/functions/split.mdx b/website/docs/language/functions/split.mdx index 2d22e03a24..aaead23db2 100644 --- a/website/docs/language/functions/split.mdx +++ b/website/docs/language/functions/split.mdx @@ -5,6 +5,9 @@ description: |- occurrences of a given separator. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `split` Function `split` produces a list by dividing a given string at all occurrences of a diff --git a/website/docs/language/functions/startswith.mdx b/website/docs/language/functions/startswith.mdx index d9ff41c912..aee4c3fb21 100644 --- a/website/docs/language/functions/startswith.mdx +++ b/website/docs/language/functions/startswith.mdx @@ -4,6 +4,9 @@ description: |- The startswith function takes two values: a string to check and a prefix string. It returns true if the string begins with that exact prefix. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `startswith` Function `startswith` takes two values: a string to check and a prefix string. The function returns true if the string begins with that exact prefix. diff --git a/website/docs/language/functions/strcontains.mdx b/website/docs/language/functions/strcontains.mdx index 6e684a6f6a..cf76fae446 100644 --- a/website/docs/language/functions/strcontains.mdx +++ b/website/docs/language/functions/strcontains.mdx @@ -4,6 +4,9 @@ description: |- The strcontains function checks whether a given string can be found within another string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `strcontains` Function `strcontains` function checks whether a substring is within another string. diff --git a/website/docs/language/functions/strrev.mdx b/website/docs/language/functions/strrev.mdx index f5e1e36a2a..abc6a085bf 100644 --- a/website/docs/language/functions/strrev.mdx +++ b/website/docs/language/functions/strrev.mdx @@ -3,6 +3,9 @@ page_title: strrev - Functions - Configuration Language description: The strrev function reverses a string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `strrev` Function `strrev` reverses the characters in a string. diff --git a/website/docs/language/functions/substr.mdx b/website/docs/language/functions/substr.mdx index 8317848de7..1cfbf8cd26 100644 --- a/website/docs/language/functions/substr.mdx +++ b/website/docs/language/functions/substr.mdx @@ -5,6 +5,9 @@ description: |- length. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `substr` Function `substr` extracts a substring from a given string by offset and (maximum) length. diff --git a/website/docs/language/functions/sum.mdx b/website/docs/language/functions/sum.mdx index b8bf154da1..a5877ea11a 100644 --- a/website/docs/language/functions/sum.mdx +++ b/website/docs/language/functions/sum.mdx @@ -5,6 +5,9 @@ description: |- numbers. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `sum` Function `sum` takes a list or set of numbers and returns the sum of those numbers. diff --git a/website/docs/language/functions/templatefile.mdx b/website/docs/language/functions/templatefile.mdx index 6d79bff054..18ee9feaaa 100644 --- a/website/docs/language/functions/templatefile.mdx +++ b/website/docs/language/functions/templatefile.mdx @@ -5,6 +5,9 @@ description: |- content as a template. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `templatefile` Function `templatefile` reads the file at the given path and renders its content diff --git a/website/docs/language/functions/templatestring.mdx b/website/docs/language/functions/templatestring.mdx index 843325c92d..0772dc3a91 100644 --- a/website/docs/language/functions/templatestring.mdx +++ b/website/docs/language/functions/templatestring.mdx @@ -4,6 +4,9 @@ description: |- The templatestring function takes a string from elsewhere in the module and renders its content as a template using a supplied set of template variables. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `templatestring` function reference This topic provides reference information about the `templatestring` function. The `templatestring` function renders a string defined elsewhere in the module as a template using a set of variables. diff --git a/website/docs/language/functions/terraform-applying.mdx b/website/docs/language/functions/terraform-applying.mdx index 7cd525d3d0..02cc77bac9 100644 --- a/website/docs/language/functions/terraform-applying.mdx +++ b/website/docs/language/functions/terraform-applying.mdx @@ -4,6 +4,9 @@ description: |- The terraform.applying symbol enables you to determine if Terraform is currently running an apply operation. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The `terraform.applying` symbol -> **Note**: The `terraform.applying` symbol is available in Terraform v1.10 and later. diff --git a/website/docs/language/functions/terraform-decode_tfvars.mdx b/website/docs/language/functions/terraform-decode_tfvars.mdx index 6bd7d6c8c4..238d22c15a 100644 --- a/website/docs/language/functions/terraform-decode_tfvars.mdx +++ b/website/docs/language/functions/terraform-decode_tfvars.mdx @@ -5,6 +5,9 @@ description: >- in a ".tfvars" file. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `provider::terraform::decode_tfvars` Function -> **Note:** This function is supported only in Terraform v1.8 and later. diff --git a/website/docs/language/functions/terraform-encode_expr.mdx b/website/docs/language/functions/terraform-encode_expr.mdx index 84cf609e5f..3b42ac9001 100644 --- a/website/docs/language/functions/terraform-encode_expr.mdx +++ b/website/docs/language/functions/terraform-encode_expr.mdx @@ -5,6 +5,9 @@ description: >- using Terraform expression syntax. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `provider::terraform::encode_expr` Function -> **Note:** This function is supported only in Terraform v1.8 and later. diff --git a/website/docs/language/functions/terraform-encode_tfvars.mdx b/website/docs/language/functions/terraform-encode_tfvars.mdx index c7e36d1c4b..c15307e631 100644 --- a/website/docs/language/functions/terraform-encode_tfvars.mdx +++ b/website/docs/language/functions/terraform-encode_tfvars.mdx @@ -5,6 +5,9 @@ description: >- using the same syntax as for ".tfvars" files used in Terraform CLI. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `provider::terraform::encode_tfvars` Function -> **Note:** This function is supported only in Terraform v1.8 and later. diff --git a/website/docs/language/functions/textdecodebase64.mdx b/website/docs/language/functions/textdecodebase64.mdx index 2ee2007dc1..5b86c05e3e 100644 --- a/website/docs/language/functions/textdecodebase64.mdx +++ b/website/docs/language/functions/textdecodebase64.mdx @@ -8,6 +8,9 @@ description: >- encoding. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `textdecodebase64` Function -> **Note:** This function is supported only in Terraform v0.14 and later. diff --git a/website/docs/language/functions/textencodebase64.mdx b/website/docs/language/functions/textencodebase64.mdx index 1fae4fcce1..bc08fa9f2b 100644 --- a/website/docs/language/functions/textencodebase64.mdx +++ b/website/docs/language/functions/textencodebase64.mdx @@ -7,6 +7,9 @@ description: >- specified character encoding, returning the result base64 encoded. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `textencodebase64` Function -> **Note:** This function is supported only in Terraform v0.14 and later. diff --git a/website/docs/language/functions/timeadd.mdx b/website/docs/language/functions/timeadd.mdx index 4a96720d3c..9a84fb9030 100644 --- a/website/docs/language/functions/timeadd.mdx +++ b/website/docs/language/functions/timeadd.mdx @@ -5,6 +5,9 @@ description: |- timestamp. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `timeadd` function reference This topic provices reference information about the `timeadd` function. diff --git a/website/docs/language/functions/timecmp.mdx b/website/docs/language/functions/timecmp.mdx index 2c078a9b4e..de474157a0 100644 --- a/website/docs/language/functions/timecmp.mdx +++ b/website/docs/language/functions/timecmp.mdx @@ -5,6 +5,9 @@ description: |- timestamp. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `timecmp` Function `timecmp` compares two timestamps and returns a number that represents the diff --git a/website/docs/language/functions/timestamp.mdx b/website/docs/language/functions/timestamp.mdx index ad9f8be08a..502b12a41f 100644 --- a/website/docs/language/functions/timestamp.mdx +++ b/website/docs/language/functions/timestamp.mdx @@ -5,6 +5,9 @@ description: |- and time. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `timestamp` Function `timestamp` returns a UTC timestamp string in [RFC 3339](https://tools.ietf.org/html/rfc3339) format. diff --git a/website/docs/language/functions/title.mdx b/website/docs/language/functions/title.mdx index ba7a6d98bb..94552bed6d 100644 --- a/website/docs/language/functions/title.mdx +++ b/website/docs/language/functions/title.mdx @@ -5,6 +5,9 @@ description: |- to uppercase. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `title` Function `title` converts the first letter of each word in the given string to uppercase. diff --git a/website/docs/language/functions/tobool.mdx b/website/docs/language/functions/tobool.mdx index 766b6a2d61..0b0d11a738 100644 --- a/website/docs/language/functions/tobool.mdx +++ b/website/docs/language/functions/tobool.mdx @@ -3,6 +3,9 @@ page_title: tobool - Functions - Configuration Language description: The tobool function converts a value to boolean. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `tobool` Function `tobool` converts its argument to a boolean value. diff --git a/website/docs/language/functions/tolist.mdx b/website/docs/language/functions/tolist.mdx index 212a430440..71b79d6f7a 100644 --- a/website/docs/language/functions/tolist.mdx +++ b/website/docs/language/functions/tolist.mdx @@ -3,6 +3,9 @@ page_title: tolist - Functions - Configuration Language description: The tolist function converts a value to a list. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `tolist` Function `tolist` converts its argument to a list value. diff --git a/website/docs/language/functions/tomap.mdx b/website/docs/language/functions/tomap.mdx index da2ebc6757..ba15ef0774 100644 --- a/website/docs/language/functions/tomap.mdx +++ b/website/docs/language/functions/tomap.mdx @@ -3,6 +3,9 @@ page_title: tomap - Functions - Configuration Language description: The tomap function converts a value to a map. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `tomap` Function `tomap` converts its argument to a map value. diff --git a/website/docs/language/functions/tonumber.mdx b/website/docs/language/functions/tonumber.mdx index 4aa15c0306..3fddfb3a39 100644 --- a/website/docs/language/functions/tonumber.mdx +++ b/website/docs/language/functions/tonumber.mdx @@ -3,6 +3,9 @@ page_title: tonumber - Functions - Configuration Language description: The tonumber function converts a value to a number. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `tonumber` Function `tonumber` converts its argument to a number value. diff --git a/website/docs/language/functions/toset.mdx b/website/docs/language/functions/toset.mdx index 1b42f4d8e5..6fe947c58e 100644 --- a/website/docs/language/functions/toset.mdx +++ b/website/docs/language/functions/toset.mdx @@ -3,6 +3,9 @@ page_title: toset - Functions - Configuration Language description: The toset function converts a value to a set. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `toset` Function `toset` converts its argument to a set value. diff --git a/website/docs/language/functions/tostring.mdx b/website/docs/language/functions/tostring.mdx index 5df650aa2b..74671ea0cf 100644 --- a/website/docs/language/functions/tostring.mdx +++ b/website/docs/language/functions/tostring.mdx @@ -3,6 +3,9 @@ page_title: tostring - Functions - Configuration Language description: The tostring function converts a value to a string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `tostring` Function `tostring` converts its argument to a string value. diff --git a/website/docs/language/functions/transpose.mdx b/website/docs/language/functions/transpose.mdx index 2de3bf4c31..327717f3c3 100644 --- a/website/docs/language/functions/transpose.mdx +++ b/website/docs/language/functions/transpose.mdx @@ -5,6 +5,9 @@ description: |- and values. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `transpose` Function `transpose` takes a map of lists of strings and swaps the keys and values diff --git a/website/docs/language/functions/trim.mdx b/website/docs/language/functions/trim.mdx index 7cdd03283e..1a8b816d40 100644 --- a/website/docs/language/functions/trim.mdx +++ b/website/docs/language/functions/trim.mdx @@ -7,6 +7,9 @@ description: >- a given string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `trim` Function `trim` removes the specified set of characters from the start and end of the given diff --git a/website/docs/language/functions/trimprefix.mdx b/website/docs/language/functions/trimprefix.mdx index 195cacd455..c1d71096b4 100644 --- a/website/docs/language/functions/trimprefix.mdx +++ b/website/docs/language/functions/trimprefix.mdx @@ -5,6 +5,9 @@ description: |- given string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `trimprefix` Function `trimprefix` removes the specified prefix from the start of the given string, but only once. If the string does not begin with the prefix, the original string is returned unchanged. diff --git a/website/docs/language/functions/trimspace.mdx b/website/docs/language/functions/trimspace.mdx index a1eafaba91..d257ba0318 100644 --- a/website/docs/language/functions/trimspace.mdx +++ b/website/docs/language/functions/trimspace.mdx @@ -5,6 +5,9 @@ description: |- a given string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `trimspace` Function `trimspace` removes any space characters from the start and end of the given diff --git a/website/docs/language/functions/trimsuffix.mdx b/website/docs/language/functions/trimsuffix.mdx index 272d0cc48e..7f0c6a3e53 100644 --- a/website/docs/language/functions/trimsuffix.mdx +++ b/website/docs/language/functions/trimsuffix.mdx @@ -5,6 +5,9 @@ description: |- given string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `trimsuffix` Function `trimsuffix` removes the specified suffix from the end of the given string, but only once, even if the suffix appears multiple times. If the suffix does not appear at the very end of the string, the original string is returned unchanged. diff --git a/website/docs/language/functions/try.mdx b/website/docs/language/functions/try.mdx index fffc932f0a..ba07694715 100644 --- a/website/docs/language/functions/try.mdx +++ b/website/docs/language/functions/try.mdx @@ -6,6 +6,9 @@ description: |- any errors. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `try` Function `try` evaluates all of its argument expressions in turn and returns the result diff --git a/website/docs/language/functions/type.mdx b/website/docs/language/functions/type.mdx index 9a5eb7253d..f721ff84c9 100644 --- a/website/docs/language/functions/type.mdx +++ b/website/docs/language/functions/type.mdx @@ -3,6 +3,9 @@ page_title: type - Functions - Configuration Language description: 'The type function returns the type of a given value. ' --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `type` Function -> **Note:** This function is available only in Terraform 1.0 and later. diff --git a/website/docs/language/functions/upper.mdx b/website/docs/language/functions/upper.mdx index 874e40fe5b..eaf517eec5 100644 --- a/website/docs/language/functions/upper.mdx +++ b/website/docs/language/functions/upper.mdx @@ -5,6 +5,9 @@ description: >- uppercase. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `upper` Function `upper` converts all cased letters in the given string to uppercase. diff --git a/website/docs/language/functions/urlencode.mdx b/website/docs/language/functions/urlencode.mdx index 1ce11da573..256afed2ad 100644 --- a/website/docs/language/functions/urlencode.mdx +++ b/website/docs/language/functions/urlencode.mdx @@ -3,6 +3,9 @@ page_title: urlencode - Functions - Configuration Language description: The urlencode function applies URL encoding to a given string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `urlencode` Function `urlencode` applies URL encoding to a given string. diff --git a/website/docs/language/functions/uuid.mdx b/website/docs/language/functions/uuid.mdx index 08a3471e52..fbf5fc6a26 100644 --- a/website/docs/language/functions/uuid.mdx +++ b/website/docs/language/functions/uuid.mdx @@ -3,6 +3,9 @@ page_title: uuid - Functions - Configuration Language description: The uuid function generates a unique id. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `uuid` Function `uuid` generates UUID-format strings using random bytes. diff --git a/website/docs/language/functions/uuidv5.mdx b/website/docs/language/functions/uuidv5.mdx index 0b45bb57cc..6ef3520f2d 100644 --- a/website/docs/language/functions/uuidv5.mdx +++ b/website/docs/language/functions/uuidv5.mdx @@ -5,6 +5,9 @@ description: >- the specified namespace. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `uuidv5` Function `uuidv5` generates a _name-based_ UUID, as described in diff --git a/website/docs/language/functions/values.mdx b/website/docs/language/functions/values.mdx index b7362ab5d2..0af69dac86 100644 --- a/website/docs/language/functions/values.mdx +++ b/website/docs/language/functions/values.mdx @@ -3,6 +3,9 @@ page_title: values - Functions - Configuration Language description: The values function returns a list of the element values in a given map. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `values` Function `values` takes a map and returns a list containing the values of the elements diff --git a/website/docs/language/functions/yamldecode.mdx b/website/docs/language/functions/yamldecode.mdx index d1fa41eb33..b95fd9dc81 100644 --- a/website/docs/language/functions/yamldecode.mdx +++ b/website/docs/language/functions/yamldecode.mdx @@ -5,6 +5,9 @@ description: |- value. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `yamldecode` Function `yamldecode` parses a string as a subset of YAML, and produces a representation diff --git a/website/docs/language/functions/yamlencode.mdx b/website/docs/language/functions/yamlencode.mdx index c06012492e..c0f0cf579e 100644 --- a/website/docs/language/functions/yamlencode.mdx +++ b/website/docs/language/functions/yamlencode.mdx @@ -3,6 +3,9 @@ page_title: yamlencode - Functions - Configuration Language description: The yamlencode function encodes a given value as a YAML string. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `yamlencode` Function `yamlencode` encodes a given value to a string using diff --git a/website/docs/language/functions/zipmap.mdx b/website/docs/language/functions/zipmap.mdx index 277543e3ab..1c612a9775 100644 --- a/website/docs/language/functions/zipmap.mdx +++ b/website/docs/language/functions/zipmap.mdx @@ -5,6 +5,9 @@ description: |- list of values. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `zipmap` Function `zipmap` constructs a map from a list of keys and a corresponding list of diff --git a/website/docs/language/import/generating-configuration.mdx b/website/docs/language/import/generating-configuration.mdx index e717036a63..ecf3f67810 100644 --- a/website/docs/language/import/generating-configuration.mdx +++ b/website/docs/language/import/generating-configuration.mdx @@ -4,6 +4,9 @@ description: >- Generate configuration and manage existing resources with Terraform using configuration-driven import. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Generating configuration ~> **Experimental:** Configuration generation is available in Terraform v1.5 as an experimental feature. Later minor versions may contain changes to the formatting of generated configuration and behavior of the `terraform plan` command using the `-generate-config-out` flag. diff --git a/website/docs/language/import/index.mdx b/website/docs/language/import/index.mdx index d6d8727483..920caa3ba3 100644 --- a/website/docs/language/import/index.mdx +++ b/website/docs/language/import/index.mdx @@ -4,6 +4,9 @@ description: >- Import and manage existing resources with Terraform using configuration-driven import. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Import -> **Note:** Import blocks are only available in Terraform v1.5.0 and later. diff --git a/website/docs/language/index.mdx b/website/docs/language/index.mdx index fdaef99afc..8c362d4b8d 100644 --- a/website/docs/language/index.mdx +++ b/website/docs/language/index.mdx @@ -4,6 +4,9 @@ description: >- Use the Terraform configuration language to describe the infrastructure that Terraform manages. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform Language Documentation This is the documentation for Terraform's configuration language. It is relevant diff --git a/website/docs/language/meta-arguments/count.mdx b/website/docs/language/meta-arguments/count.mdx index f08b3f7c11..711d10891e 100644 --- a/website/docs/language/meta-arguments/count.mdx +++ b/website/docs/language/meta-arguments/count.mdx @@ -5,6 +5,9 @@ description: >- without writing a separate block for each one. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The `count` Meta-Argument -> **Version note:** Module support for `count` was added in Terraform 0.13, and diff --git a/website/docs/language/meta-arguments/depends_on.mdx b/website/docs/language/meta-arguments/depends_on.mdx index 5f12751b53..85eea5709f 100644 --- a/website/docs/language/meta-arguments/depends_on.mdx +++ b/website/docs/language/meta-arguments/depends_on.mdx @@ -5,6 +5,9 @@ description: >- dependencies. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The `depends_on` Meta-Argument Use the `depends_on` meta-argument to handle hidden resource or module dependencies that Terraform cannot automatically infer. You only need to explicitly specify a dependency when a resource or module relies on another resource's behavior but does not access any of that resource's data in its arguments. diff --git a/website/docs/language/meta-arguments/for_each.mdx b/website/docs/language/meta-arguments/for_each.mdx index 7001fd08fd..837f0deb13 100644 --- a/website/docs/language/meta-arguments/for_each.mdx +++ b/website/docs/language/meta-arguments/for_each.mdx @@ -5,6 +5,9 @@ description: >- resources without writing a separate block for each one. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The `for_each` Meta-Argument By default, a [resource block](/terraform/language/resources/syntax) configures one real diff --git a/website/docs/language/meta-arguments/lifecycle.mdx b/website/docs/language/meta-arguments/lifecycle.mdx index b62bb5131f..4e1bccc47c 100644 --- a/website/docs/language/meta-arguments/lifecycle.mdx +++ b/website/docs/language/meta-arguments/lifecycle.mdx @@ -5,6 +5,9 @@ description: >- behavior. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The `lifecycle` Meta-Argument > **Hands-on:** Try the [Lifecycle Management](/terraform/tutorials/state/resource-lifecycle?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/docs/language/meta-arguments/module-providers.mdx b/website/docs/language/meta-arguments/module-providers.mdx index 3b7339cfdb..d8b07528ca 100644 --- a/website/docs/language/meta-arguments/module-providers.mdx +++ b/website/docs/language/meta-arguments/module-providers.mdx @@ -5,6 +5,9 @@ description: >- parent module are available in a child module. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The Module `providers` Meta-Argument In a [module call](/terraform/language/modules/syntax) block, the diff --git a/website/docs/language/meta-arguments/resource-provider.mdx b/website/docs/language/meta-arguments/resource-provider.mdx index a4b72a0b64..3507ef44f2 100644 --- a/website/docs/language/meta-arguments/resource-provider.mdx +++ b/website/docs/language/meta-arguments/resource-provider.mdx @@ -5,6 +5,9 @@ description: >- should use for a resource, overriding Terraform's default behavior. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The Resource `provider` Meta-Argument The `provider` meta-argument specifies which provider configuration to use for a resource, diff --git a/website/docs/language/modules/develop/composition.mdx b/website/docs/language/modules/develop/composition.mdx index d50679f411..174063a646 100644 --- a/website/docs/language/modules/develop/composition.mdx +++ b/website/docs/language/modules/develop/composition.mdx @@ -5,6 +5,9 @@ description: |- building blocks. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Module Composition In a simple Terraform configuration with only one root module, we create a diff --git a/website/docs/language/modules/develop/index.mdx b/website/docs/language/modules/develop/index.mdx index aee54ee9e5..1caa7fe356 100644 --- a/website/docs/language/modules/develop/index.mdx +++ b/website/docs/language/modules/develop/index.mdx @@ -5,6 +5,9 @@ description: >- configuration. Learn when to create modules and about module structure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Creating Modules > **Hands-on:** Try the [Reuse Configuration with Modules](/terraform/tutorials/modules?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorials. diff --git a/website/docs/language/modules/develop/providers.mdx b/website/docs/language/modules/develop/providers.mdx index 393ff1948e..323661e1ee 100644 --- a/website/docs/language/modules/develop/providers.mdx +++ b/website/docs/language/modules/develop/providers.mdx @@ -4,6 +4,9 @@ description: >- Use providers within Terraform modules. Learn about version constraints, aliases, implicit inheritance, and passing providers to Terraform modules. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Providers Within Modules [inpage-providers]: #providers-within-modules diff --git a/website/docs/language/modules/develop/publish.mdx b/website/docs/language/modules/develop/publish.mdx index c904a0a23a..ea512af932 100644 --- a/website/docs/language/modules/develop/publish.mdx +++ b/website/docs/language/modules/develop/publish.mdx @@ -3,6 +3,9 @@ page_title: Publishing Modules description: A module is a container for multiple resources that are used together. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Publishing Modules If you've built a module that you intend to be reused, we recommend diff --git a/website/docs/language/modules/develop/refactoring.mdx b/website/docs/language/modules/develop/refactoring.mdx index 1344b0d791..48f4b77675 100644 --- a/website/docs/language/modules/develop/refactoring.mdx +++ b/website/docs/language/modules/develop/refactoring.mdx @@ -3,6 +3,9 @@ page_title: Refactoring description: How to make backward-compatible changes to modules already in use. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Refactoring -> **Note:** Explicit refactoring declarations with `moved` blocks is available in Terraform v1.1 and later. For earlier Terraform versions or for refactoring actions too complex to express as `moved` blocks, you can diff --git a/website/docs/language/modules/develop/structure.mdx b/website/docs/language/modules/develop/structure.mdx index 20ba5c9458..fefeba673a 100644 --- a/website/docs/language/modules/develop/structure.mdx +++ b/website/docs/language/modules/develop/structure.mdx @@ -4,6 +4,9 @@ description: >- Learn about the recommended file and directory structure for developing reusable modules distributed as separate repositories. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Standard Module Structure The standard module structure is a file and directory layout we recommend for diff --git a/website/docs/language/modules/index.mdx b/website/docs/language/modules/index.mdx index 9898b34c10..e5bc9998b0 100644 --- a/website/docs/language/modules/index.mdx +++ b/website/docs/language/modules/index.mdx @@ -5,6 +5,9 @@ description: >- configuration. Find resources for using, developing, and publishing modules. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Modules > **Hands-on:** Try the [Reuse Configuration with Modules](/terraform/tutorials/modules?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorials. diff --git a/website/docs/language/modules/sources.mdx b/website/docs/language/modules/sources.mdx index 7144fd7eca..5b388a8309 100644 --- a/website/docs/language/modules/sources.mdx +++ b/website/docs/language/modules/sources.mdx @@ -6,6 +6,9 @@ description: >- Git, Mercurial, S3, and GCS. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Module Sources The `source` argument in [a `module` block](/terraform/language/modules/syntax) diff --git a/website/docs/language/modules/syntax.mdx b/website/docs/language/modules/syntax.mdx index e23e26ada9..1fc4d9a280 100644 --- a/website/docs/language/modules/syntax.mdx +++ b/website/docs/language/modules/syntax.mdx @@ -6,6 +6,9 @@ description: >- output. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Module Blocks > **Hands-on:** Try the [Reuse Configuration with Modules](/terraform/tutorials/modules?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorials. diff --git a/website/docs/language/moved.mdx b/website/docs/language/moved.mdx index b5dbc79ab5..4efa761efd 100644 --- a/website/docs/language/moved.mdx +++ b/website/docs/language/moved.mdx @@ -3,6 +3,9 @@ page_title: moved block configuration reference description: Learn about the `moved` block that you can specify in Terraform configurations. The `moved` block programmatically changes the location of a resource. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `moved` block reference This topic provides reference information for the `moved` block. Use this block to programmatically change the address of a resource. Refer to [Refactoring](/terraform/language/modules/develop/refactoring) for details about how to use the `moved` block in your Terraform configurations. diff --git a/website/docs/language/providers/configuration.mdx b/website/docs/language/providers/configuration.mdx index f3cce651ed..dffeb78773 100644 --- a/website/docs/language/providers/configuration.mdx +++ b/website/docs/language/providers/configuration.mdx @@ -5,6 +5,9 @@ description: >- specify multiple configurations for a single provider. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Provider Configuration Providers allow Terraform to interact with cloud providers, SaaS providers, and diff --git a/website/docs/language/providers/index.mdx b/website/docs/language/providers/index.mdx index 49b68ad6b6..0cfd1709b9 100644 --- a/website/docs/language/providers/index.mdx +++ b/website/docs/language/providers/index.mdx @@ -5,6 +5,9 @@ description: >- interact with services, cloud providers, and other APIs. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Providers > **Hands-on:** Try the [Perform CRUD Operations with Providers](/terraform/tutorials/configuration-language/provider-use?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/docs/language/providers/requirements.mdx b/website/docs/language/providers/requirements.mdx index 171aa9294d..d8112623d2 100644 --- a/website/docs/language/providers/requirements.mdx +++ b/website/docs/language/providers/requirements.mdx @@ -5,6 +5,9 @@ description: >- providers, and other APIs. Learn how to declare providers in a configuration. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Provider Requirements Terraform relies on plugins called "providers" to interact with remote systems. diff --git a/website/docs/language/resources/behavior.mdx b/website/docs/language/resources/behavior.mdx index c65de9d1f4..a33f50c713 100644 --- a/website/docs/language/resources/behavior.mdx +++ b/website/docs/language/resources/behavior.mdx @@ -5,6 +5,9 @@ description: >- Also learn about resource dependencies and how to access resource attributes. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Resource Behavior A `resource` block declares that you want a particular infrastructure object diff --git a/website/docs/language/resources/ephemeral/index.mdx b/website/docs/language/resources/ephemeral/index.mdx index 687d613f00..a1e6d9314e 100644 --- a/website/docs/language/resources/ephemeral/index.mdx +++ b/website/docs/language/resources/ephemeral/index.mdx @@ -3,6 +3,9 @@ page_title: Ephemeral resources description: Learn how to keep sensitive resource data out of state and plan files in Terraform with ephemeral resource blocks and write-only arguments. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Ephemerality in resources Managing infrastructure often requires creating and handling sensitive values that you may not want Terraform to persist outside of the current operation. Terraform provides two tools for resources to manage data you do not want to store in state or plan files: the `ephemeral` resource block and ephemeral write-only arguments on specific resources. diff --git a/website/docs/language/resources/ephemeral/reference.mdx b/website/docs/language/resources/ephemeral/reference.mdx index 8c2324c854..516f6e9523 100644 --- a/website/docs/language/resources/ephemeral/reference.mdx +++ b/website/docs/language/resources/ephemeral/reference.mdx @@ -3,6 +3,9 @@ page_title: Ephemeral block configuration reference description: Learn to define ephemeral blocks in Terraform configurations to keep temporary and sensitive information out of Terraform state and plan files. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Ephemeral block configuration reference This topic provides reference information for the `ephemeral` block. diff --git a/website/docs/language/resources/ephemeral/write-only.mdx b/website/docs/language/resources/ephemeral/write-only.mdx index 730af8abd8..6e8742342f 100644 --- a/website/docs/language/resources/ephemeral/write-only.mdx +++ b/website/docs/language/resources/ephemeral/write-only.mdx @@ -3,6 +3,9 @@ page_title: Use write-only arguments description: Learn how to use write-only arguments to set temporary values that are not stored in Terraform's state or plan files. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Use write-only arguments Write-only arguments let you securely pass temporary values to Terraform's managed resources during an operation without persisting those values to state or plan files. Use write-only arguments to handle sensitive data such as passwords, API tokens, and other secrets. diff --git a/website/docs/language/resources/index.mdx b/website/docs/language/resources/index.mdx index 0c3d230f91..ccb783a835 100644 --- a/website/docs/language/resources/index.mdx +++ b/website/docs/language/resources/index.mdx @@ -5,6 +5,9 @@ description: >- documentation for resource syntax, behavior, and meta-arguments. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Resources > **Hands-on:** Try the [Terraform: Get Started](/terraform/tutorials/aws-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorials. diff --git a/website/docs/language/resources/provisioners/connection.mdx b/website/docs/language/resources/provisioners/connection.mdx index 333b58e4c1..3b8bd01b67 100644 --- a/website/docs/language/resources/provisioners/connection.mdx +++ b/website/docs/language/resources/provisioners/connection.mdx @@ -5,6 +5,9 @@ description: >- SSH and WinRM. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Provisioner Connection Settings Most provisioners require access to the remote resource via SSH or WinRM and diff --git a/website/docs/language/resources/provisioners/file.mdx b/website/docs/language/resources/provisioners/file.mdx index 9655e8a3de..e8c30cc368 100644 --- a/website/docs/language/resources/provisioners/file.mdx +++ b/website/docs/language/resources/provisioners/file.mdx @@ -6,6 +6,9 @@ description: >- supports both `ssh` and `winrm` type connections. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # File Provisioner The `file` provisioner copies files or directories from the machine diff --git a/website/docs/language/resources/provisioners/local-exec.mdx b/website/docs/language/resources/provisioners/local-exec.mdx index c3bd882908..baec3f0706 100644 --- a/website/docs/language/resources/provisioners/local-exec.mdx +++ b/website/docs/language/resources/provisioners/local-exec.mdx @@ -6,6 +6,9 @@ description: >- resource. See the `remote-exec` provisioner to run commands on the resource. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # local-exec Provisioner The `local-exec` provisioner invokes a local executable after a resource is diff --git a/website/docs/language/resources/provisioners/null_resource.mdx b/website/docs/language/resources/provisioners/null_resource.mdx index b91430807b..920faa7ef3 100644 --- a/website/docs/language/resources/provisioners/null_resource.mdx +++ b/website/docs/language/resources/provisioners/null_resource.mdx @@ -5,6 +5,9 @@ description: >- are not directly associated with a single existing resource. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Provisioners Without a Resource If you need to run provisioners that aren't directly associated with a specific diff --git a/website/docs/language/resources/provisioners/remote-exec.mdx b/website/docs/language/resources/provisioners/remote-exec.mdx index ef548d5ddd..027bc502e8 100644 --- a/website/docs/language/resources/provisioners/remote-exec.mdx +++ b/website/docs/language/resources/provisioners/remote-exec.mdx @@ -8,6 +8,9 @@ description: >- `winrm` type connections. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # remote-exec Provisioner The `remote-exec` provisioner invokes a script on a remote resource after it diff --git a/website/docs/language/resources/provisioners/syntax.mdx b/website/docs/language/resources/provisioners/syntax.mdx index cf73194a10..82f1f5dcb6 100644 --- a/website/docs/language/resources/provisioners/syntax.mdx +++ b/website/docs/language/resources/provisioners/syntax.mdx @@ -5,6 +5,9 @@ description: >- or destruction. Learn how to declare provisioners in a configuration. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Provisioners You can use provisioners to model specific actions on the local machine or on diff --git a/website/docs/language/resources/syntax.mdx b/website/docs/language/resources/syntax.mdx index 9cdf9b1410..c9aa040421 100644 --- a/website/docs/language/resources/syntax.mdx +++ b/website/docs/language/resources/syntax.mdx @@ -6,6 +6,9 @@ description: >- arguments. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Resource Blocks > **Hands-on:** Try the [Terraform: Get Started](/terraform/tutorials/aws-get-started?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorials. diff --git a/website/docs/language/resources/terraform-data.mdx b/website/docs/language/resources/terraform-data.mdx index 4e82c44815..ea4d36af0b 100644 --- a/website/docs/language/resources/terraform-data.mdx +++ b/website/docs/language/resources/terraform-data.mdx @@ -5,6 +5,9 @@ description: >- in a remote backend. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The `terraform_data` Managed Resource Type The `terraform_data` implements the standard resource lifecycle, but does not directly take any other actions. diff --git a/website/docs/language/stacks/create/config.mdx b/website/docs/language/stacks/create/config.mdx index eb62f63b77..22625c8932 100644 --- a/website/docs/language/stacks/create/config.mdx +++ b/website/docs/language/stacks/create/config.mdx @@ -3,6 +3,9 @@ page_title: Define configuration description: Learn to write Stack configuration files to declare what infrastructure your Stack deploys. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Define configuration In the Stack configuration file, you declare what infrastructure components are part of the Stack. diff --git a/website/docs/language/stacks/create/declare-providers.mdx b/website/docs/language/stacks/create/declare-providers.mdx index 188e8beff8..568bf15029 100644 --- a/website/docs/language/stacks/create/declare-providers.mdx +++ b/website/docs/language/stacks/create/declare-providers.mdx @@ -3,6 +3,9 @@ page_title: Declare providers description: Learn how to declare providers in Stack configurations. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Declare providers Terraform relies on plugins called providers to interact with cloud providers, SaaS providers, and other APIs. diff --git a/website/docs/language/stacks/deploy/authenticate.mdx b/website/docs/language/stacks/deploy/authenticate.mdx index 441900179e..948d000a7c 100644 --- a/website/docs/language/stacks/deploy/authenticate.mdx +++ b/website/docs/language/stacks/deploy/authenticate.mdx @@ -3,6 +3,9 @@ page_title: Authenticate a Stack description: Learn how to set up OIDC authentication or use the store block to authenticate Stacks with their providers. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Authenticate a Stack You can authenticate a Stack in two ways: by using OIDC to dynamically authenticate with the built-in `identity_token` block or by accessing existing authentication credentials with the `store` block. We recommend authenticating your Stack with OIDC because using static credentials to authenticate providers presents a security risk, even if you rotate your credentials regularly. diff --git a/website/docs/language/stacks/deploy/conditions.mdx b/website/docs/language/stacks/deploy/conditions.mdx index b14dbbc590..fcde768507 100644 --- a/website/docs/language/stacks/deploy/conditions.mdx +++ b/website/docs/language/stacks/deploy/conditions.mdx @@ -3,6 +3,9 @@ page_title: Set conditions for deployment plans description: Learn how to use the orchestrate block to automatically approve Stack deployment plans and help you manage your Stack deployments at scale. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Set conditions for deployment plans Orchestration rules allow you to automate aspects of your Stack deployments, such as auto-approving plans when those plans meet certain conditions. By setting orchestration rules, you can help streamline managing many deployments. diff --git a/website/docs/language/stacks/deploy/config.mdx b/website/docs/language/stacks/deploy/config.mdx index e09b3c3f4d..d86ff08507 100644 --- a/website/docs/language/stacks/deploy/config.mdx +++ b/website/docs/language/stacks/deploy/config.mdx @@ -3,6 +3,9 @@ page_title: Define deployment configuration description: Learn how to write stack deployment configuration files to define how to deploy your stack’s infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Define deployment configuration In Stacks, deployments allow you to replicate infrastructure across multiple environments, regions, or accounts. Each deployment runs in its own isolated agent, ensuring that changes in one deployment do not affect others. diff --git a/website/docs/language/stacks/deploy/pass-data.mdx b/website/docs/language/stacks/deploy/pass-data.mdx index 1f8d6e2921..b91aa4178b 100644 --- a/website/docs/language/stacks/deploy/pass-data.mdx +++ b/website/docs/language/stacks/deploy/pass-data.mdx @@ -3,6 +3,9 @@ page_title: Pass data from one Stack to another description: Learn how to link Stacks together to pass data from one Stack to another using `publish_output` blocks to export data and `upstream_input` blocks to consume that data. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Pass data from one Stack to another If you have multiple Stacks that do not share a provisioning lifecycle, you can link Stacks together to export data from one Stack for another to consume. If the output value of a Stack changes after a run, HCP Terraform automatically triggers runs for any Stacks that depend on those outputs. diff --git a/website/docs/language/stacks/design.mdx b/website/docs/language/stacks/design.mdx index 480d05852a..c4f0db2c3e 100644 --- a/website/docs/language/stacks/design.mdx +++ b/website/docs/language/stacks/design.mdx @@ -3,6 +3,9 @@ page_title: Design a Stack description: Learn how to design a Stack that aligns with your existing infrastructure and deployment needs. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Design a Stack Stacks allow you to break down your existing infrastructure into logical components, making it easier to deploy and manage as a cohesive system. Designing a Stack begins with planning how to structure your infrastructure and thinking about how you intend to deploy the resources your Stack defines. diff --git a/website/docs/language/stacks/index.mdx b/website/docs/language/stacks/index.mdx index 6745d1bd1b..764ad0fa54 100644 --- a/website/docs/language/stacks/index.mdx +++ b/website/docs/language/stacks/index.mdx @@ -3,6 +3,9 @@ page_title: Stacks overview description: Stacks are a configuration layer that simplify managing infrastructure modules. Learn how Stacks help you provision and coordinate your infrastructure lifecycle at scale. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Stacks overview As your infrastructure grows, managing Terraform configurations becomes increasingly complex. Stacks are a powerful configuration layer in HCP Terraform that simplifies managing your infrastructure modules and then repeating that infrastructure. diff --git a/website/docs/language/stacks/reference/tfdeploy.mdx b/website/docs/language/stacks/reference/tfdeploy.mdx index dd899b9c45..4829deb3b9 100644 --- a/website/docs/language/stacks/reference/tfdeploy.mdx +++ b/website/docs/language/stacks/reference/tfdeploy.mdx @@ -3,6 +3,9 @@ page_title: Deployment configuration file reference description: Stacks help you provision and coordinate your infrastructure lifecycle at scale. Learn how to write a deployment configurion to tell HCP Terraform how many times to deploy your Stack's infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Deployment configuration file reference A deployment configuration file defines how to deploy your Stack's infrastructure. Each Stack deployment runs in its agent, wholly isolated from other Stack deployments. diff --git a/website/docs/language/stacks/reference/tfstack.mdx b/website/docs/language/stacks/reference/tfstack.mdx index d776834126..da8f79b000 100644 --- a/website/docs/language/stacks/reference/tfstack.mdx +++ b/website/docs/language/stacks/reference/tfstack.mdx @@ -3,6 +3,9 @@ page_title: Stack configuration file reference description: Stacks help you provision and coordinate your infrastructure lifecycle at scale. Learn how to write a Stack configurion file to create a Stack for your infrastructure. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Stack configuration file reference A Stack configuration file defines all the infrastructure pieces included in a Stack. Every Stack needs a configuration file, `tfstack.hcl`, and this page describes all the blocks you can use within a Stack configuration file. diff --git a/website/docs/language/stacks/reference/tfstacks-cli.mdx b/website/docs/language/stacks/reference/tfstacks-cli.mdx index 5f0ed006e3..2d72a40a67 100644 --- a/website/docs/language/stacks/reference/tfstacks-cli.mdx +++ b/website/docs/language/stacks/reference/tfstacks-cli.mdx @@ -3,6 +3,9 @@ page_title: Terraform Stack CLI reference description: The terraform-stacks-cli is a command-line tool for validating, initializing, and managing Stack configurations. Learn about the terraform-stacks-cli commands and options. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform Stack CLI reference The `terraform-stacks-cli` is a command-line tool for validating, initializing, and testing Stack configurations. diff --git a/website/docs/language/stacks/use-cases.mdx b/website/docs/language/stacks/use-cases.mdx index c796c84a67..e607e170be 100644 --- a/website/docs/language/stacks/use-cases.mdx +++ b/website/docs/language/stacks/use-cases.mdx @@ -3,6 +3,9 @@ page_title: Use cases description: Learn about example use cases to better understand how to use Stacks to manage your infrastructure lifecycle more effectively. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Use Cases Stacks provide a way to define, organize, and reuse components and then deploy the infrastructure those components describe consistently across different deployments. diff --git a/website/docs/language/state/backends.mdx b/website/docs/language/state/backends.mdx index fc302fdbcd..bae530f5bf 100644 --- a/website/docs/language/state/backends.mdx +++ b/website/docs/language/state/backends.mdx @@ -5,6 +5,9 @@ description: >- section. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # State Storage and Locking Backends are responsible for storing state and providing an API for diff --git a/website/docs/language/state/import.mdx b/website/docs/language/state/import.mdx index 1bf2c7d5fd..5f2b062b44 100644 --- a/website/docs/language/state/import.mdx +++ b/website/docs/language/state/import.mdx @@ -5,6 +5,9 @@ description: >- Terraform ran. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Import Existing Resources Terraform is able to import existing infrastructure. This allows you to take diff --git a/website/docs/language/state/index.mdx b/website/docs/language/state/index.mdx index 89b539ad36..96b3e04fe9 100644 --- a/website/docs/language/state/index.mdx +++ b/website/docs/language/state/index.mdx @@ -5,6 +5,9 @@ description: >- a configuration, track metadata, and improve performance. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # State Terraform must store state about your managed infrastructure and diff --git a/website/docs/language/state/locking.mdx b/website/docs/language/state/locking.mdx index 95b3ba4570..a0ed56c327 100644 --- a/website/docs/language/state/locking.mdx +++ b/website/docs/language/state/locking.mdx @@ -5,6 +5,9 @@ description: >- Terraform ran. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # State Locking If supported by your [backend](/terraform/language/backend), Terraform will lock your diff --git a/website/docs/language/state/purpose.mdx b/website/docs/language/state/purpose.mdx index bd66636753..061a615299 100644 --- a/website/docs/language/state/purpose.mdx +++ b/website/docs/language/state/purpose.mdx @@ -7,6 +7,9 @@ description: >- large infrastructures. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Purpose of Terraform State State is a necessary requirement for Terraform to function. It is often diff --git a/website/docs/language/state/refactor.mdx b/website/docs/language/state/refactor.mdx index 1e4833d60e..6d130b65ca 100644 --- a/website/docs/language/state/refactor.mdx +++ b/website/docs/language/state/refactor.mdx @@ -4,6 +4,9 @@ description: >- Learn how to move resources between state files and identify dependencies between resources. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Refactor Terraform state As your Terraform configuration grows in complexity, you might want to reorganize your resources to improve maintainability and performance. Terraform operations complete faster when you split configuration with large state files. diff --git a/website/docs/language/state/remote-state-data.mdx b/website/docs/language/state/remote-state-data.mdx index c3c230e6b2..02167ebfb2 100644 --- a/website/docs/language/state/remote-state-data.mdx +++ b/website/docs/language/state/remote-state-data.mdx @@ -5,6 +5,9 @@ description: >- in a remote backend. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # The `terraform_remote_state` Data Source [backends]: /terraform/language/backend diff --git a/website/docs/language/state/remote.mdx b/website/docs/language/state/remote.mdx index 73875a2c17..b2a2d08c1c 100644 --- a/website/docs/language/state/remote.mdx +++ b/website/docs/language/state/remote.mdx @@ -5,6 +5,9 @@ description: >- with in a team. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Remote State By default, Terraform stores state locally in a file named `terraform.tfstate`. diff --git a/website/docs/language/state/sensitive-data.mdx b/website/docs/language/state/sensitive-data.mdx index 788654a0d6..776538aac4 100644 --- a/website/docs/language/state/sensitive-data.mdx +++ b/website/docs/language/state/sensitive-data.mdx @@ -3,6 +3,9 @@ page_title: 'State: Sensitive Data' description: Sensitive data in Terraform state. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Sensitive Data in State Terraform state can contain sensitive data, depending on the resources in use diff --git a/website/docs/language/state/workspaces.mdx b/website/docs/language/state/workspaces.mdx index 88f7515248..5a41ab3183 100644 --- a/website/docs/language/state/workspaces.mdx +++ b/website/docs/language/state/workspaces.mdx @@ -5,6 +5,9 @@ description: >- directory. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Workspaces Each Terraform configuration has an associated [backend](/terraform/language/backend) that defines how Terraform executes operations and where Terraform stores persistent data, like [state](/terraform/language/state/purpose). diff --git a/website/docs/language/style.mdx b/website/docs/language/style.mdx index 2991475b0e..03389418a2 100644 --- a/website/docs/language/style.mdx +++ b/website/docs/language/style.mdx @@ -5,6 +5,9 @@ description: >- workflows. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Style Guide The flexibility of Terraform's configuration language gives you many options to choose from as you write your code, structure your directories, and test your configuration. While some design decisions depend on your organization's needs or preferences, there are some common patterns that we suggest you adopt. Adopting and adhering to a style guide keeps your Terraform code legible, scalable, and maintainable. diff --git a/website/docs/language/syntax/configuration.mdx b/website/docs/language/syntax/configuration.mdx index 2ca57fe5bd..11049eba5d 100644 --- a/website/docs/language/syntax/configuration.mdx +++ b/website/docs/language/syntax/configuration.mdx @@ -5,6 +5,9 @@ description: >- arguments, blocks, and comments. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Configuration Syntax Other pages in this section have described various configuration constructs diff --git a/website/docs/language/syntax/index.mdx b/website/docs/language/syntax/index.mdx index 8cf3a25400..ecd188876e 100644 --- a/website/docs/language/syntax/index.mdx +++ b/website/docs/language/syntax/index.mdx @@ -5,6 +5,9 @@ description: >- formatting conventions that you can enforce with terraform fmt. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Syntax The majority of the Terraform language documentation focuses on the practical diff --git a/website/docs/language/syntax/json.mdx b/website/docs/language/syntax/json.mdx index 9f8ae509fa..cf2ea730f1 100644 --- a/website/docs/language/syntax/json.mdx +++ b/website/docs/language/syntax/json.mdx @@ -5,6 +5,9 @@ description: >- expression mapping, block mapping, and block-type-specific exceptions. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # JSON Configuration Syntax Most Terraform configurations are written in diff --git a/website/docs/language/terraform.mdx b/website/docs/language/terraform.mdx index 704fb87c03..7c29373435 100644 --- a/website/docs/language/terraform.mdx +++ b/website/docs/language/terraform.mdx @@ -4,6 +4,9 @@ description: >- The `terraform` block allows you to configure Terraform behavior, including the Terraform version, backend, integration with HCP Terraform, and required providers. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # `terraform` block reference This topic provides reference information about the `terraform` block. The `terraform` block allows you to configure Terraform behavior, including the Terraform version, backend, integration with HCP Terraform, and required providers. diff --git a/website/docs/language/tests/index.mdx b/website/docs/language/tests/index.mdx index e15ef8af22..f39c3849f2 100644 --- a/website/docs/language/tests/index.mdx +++ b/website/docs/language/tests/index.mdx @@ -4,6 +4,9 @@ description: >- Write structured test code for validating your configuration. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Tests -> **Note:** This testing framework is available in Terraform v1.6.0 and later. diff --git a/website/docs/language/tests/mocking.mdx b/website/docs/language/tests/mocking.mdx index f6909d09a7..21e7b79c4b 100644 --- a/website/docs/language/tests/mocking.mdx +++ b/website/docs/language/tests/mocking.mdx @@ -4,6 +4,9 @@ description: >- Provide mocked data for providers and resources in your tests. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Mocks -> **Note**: Test mocking is available in Terraform v1.7.0 and later. diff --git a/website/docs/language/upgrade-guides/index.mdx b/website/docs/language/upgrade-guides/index.mdx index c94757da21..dff820b489 100644 --- a/website/docs/language/upgrade-guides/index.mdx +++ b/website/docs/language/upgrade-guides/index.mdx @@ -3,6 +3,9 @@ page_title: Upgrading to Terraform v1.13 description: Upgrading to Terraform v1.13 --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Upgrading to Terraform v1.13 -> **Tip:** Use the version selector to view the upgrade guides for older Terraform versions. diff --git a/website/docs/language/v1-compatibility-promises.mdx b/website/docs/language/v1-compatibility-promises.mdx index 75d5600695..c309772d9a 100644 --- a/website/docs/language/v1-compatibility-promises.mdx +++ b/website/docs/language/v1-compatibility-promises.mdx @@ -6,6 +6,9 @@ description: |- workflow, until the next major release. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Terraform v1.x Compatibility Promises The release of Terraform v1.0 represents an important milestone in the diff --git a/website/docs/language/values/index.mdx b/website/docs/language/values/index.mdx index bd207554bf..7b07149e7b 100644 --- a/website/docs/language/values/index.mdx +++ b/website/docs/language/values/index.mdx @@ -5,6 +5,9 @@ description: >- language. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Variables and Outputs The Terraform language includes a few kinds of blocks for requesting or diff --git a/website/docs/language/values/locals.mdx b/website/docs/language/values/locals.mdx index e831cba02c..623e48abea 100644 --- a/website/docs/language/values/locals.mdx +++ b/website/docs/language/values/locals.mdx @@ -5,6 +5,9 @@ description: >- within a Terraform module. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Local Values > **Hands-on:** Try the [Simplify Terraform Configuration with Locals](/terraform/tutorials/configuration-language/locals?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. diff --git a/website/docs/language/values/outputs.mdx b/website/docs/language/values/outputs.mdx index 8587004147..cf8c72ec08 100644 --- a/website/docs/language/values/outputs.mdx +++ b/website/docs/language/values/outputs.mdx @@ -3,6 +3,9 @@ page_title: Output Values - Configuration Language description: Output values are the return values of a Terraform module. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Output Values Output values make information about your infrastructure available on the diff --git a/website/docs/language/values/variables.mdx b/website/docs/language/values/variables.mdx index 28769f72dc..fa167bc25e 100644 --- a/website/docs/language/values/variables.mdx +++ b/website/docs/language/values/variables.mdx @@ -5,6 +5,9 @@ description: >- code. Learn how to declare, define, and reference variables in configurations. --- +> [!IMPORTANT] +> **Documentation Update:** Product documentation previously located in `/website` has moved to the [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs) repository, where all product documentation is now centralized. Please make contributions directly to `web-unified-docs`, since changes to `/website` in this repository will not appear on developer.hashicorp.com. + # Input Variables > **Hands-on:** Try the [Customize Terraform Configuration with Variables](/terraform/tutorials/configuration-language/variables?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial.