mirror of https://github.com/opentffoundation/opentf.git synced 2026-02-14 01:00:34 -05:00

Files

Alisdair McDiarmid c5c1f31db3 backend: Validate remote backend Terraform version

When using the enhanced remote backend, a subset of all Terraform
operations are supported. Of these, only plan and apply can be executed
on the remote infrastructure (e.g. Terraform Cloud). Other operations
run locally and use the remote backend for state storage.

This causes problems when the local version of Terraform does not match
the configured version from the remote workspace. If the two versions
are incompatible, an `import` or `state mv` operation can cause the
remote workspace to be unusable until a manual fix is applied.

To prevent this from happening accidentally, this commit introduces a
check that the local Terraform version and the configured remote
workspace Terraform version are compatible. This check is skipped for
commands which do not write state, and can also be disabled by the use
of a new command-line flag, `-ignore-remote-version`.

Terraform version compatibility is defined as:

- For all releases before 0.14.0, local must exactly equal remote, as
  two different versions cannot share state;
- 0.14.0 to 1.0.x are compatible, as we will not change the state
  version number until at least Terraform 1.1.0;
- Versions after 1.1.0 must have the same major and minor versions, as
  we will not change the state version number in a patch release.

If the two versions are incompatible, a diagnostic is displayed,
advising that the error can be suppressed with `-ignore-remote-version`.
When this flag is used, the diagnostic is still displayed, but as a
warning instead of an error.

Commands which will not write state can assert this fact by calling the
helper `meta.ignoreRemoteBackendVersionConflict`, which will disable the
checks. Those which can write state should instead call the helper
`meta.remoteBackendVersionCheck`, which will return diagnostics for
display.

In addition to these explicit paths for managing the version check, we
have an implicit check in the remote backend's state manager
initialization method. Both of the above helpers will disable this
check. This fallback is in place to ensure that future code paths which
access state cannot accidentally skip the remote version check.

2020-11-19 13:19:40 -05:00

3.5 KiB

Raw Blame History

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
docs	Command: state rm	docs-commands-state-sub-rm	The `terraform state rm` command removes items from the Terraform state.

Command: state rm

The terraform state rm command is used to remove items from the Terraform state. This command can remove single resources, single instances of a resource, entire modules, and more.

Usage

Usage: terraform state rm [options] ADDRESS...

Remove one or more items from the Terraform state.

Items removed from the Terraform state are not physically destroyed. Items removed from the Terraform state are only no longer managed by Terraform. For example, if you remove an AWS instance from the state, the AWS instance will continue running, but terraform plan will no longer see that instance.

There are various use cases for removing items from a Terraform state file. The most common is refactoring a configuration to no longer manage that resource (perhaps moving it to another Terraform configuration/state).

The state will only be saved on successful removal of all addresses. If any specific address errors for any reason (such as a syntax error), the state will not be modified at all.

This command will output a backup copy of the state prior to saving any changes. The backup cannot be disabled. Due to the destructive nature of this command, backups are required.

This command requires one or more addresses that point to a resources in the state. Addresses are in resource addressing format.

The command-line flags are all optional. The list of available flags are:

-backup=path - Path where Terraform should write the backup state. This can't be disabled. If not set, Terraform will write it to the same path as the statefile with a backup extension.
-state=path - Path to a Terraform state file to use to look up Terraform-managed resources. By default it will use the configured backend, or the default "terraform.tfstate" if it exists.
-ignore-remote-version - When using the enhanced remote backend with Terraform Cloud, continue even if remote and local Terraform versions differ. This may result in an unusable Terraform Cloud workspace, and should be used with extreme caution.

Example: Remove a Resource

The example below removes the packet_device resource named worker:

$ terraform state rm 'packet_device.worker'

Example: Remove a Module

The example below removes the entire module named foo:

$ terraform state rm 'module.foo'

Example: Remove a Module Resource

The example below removes the packet_device resource named worker inside a module named foo:

$ terraform state rm 'module.foo.packet_device.worker'

Example: Remove a Resource configured with count

The example below removes the first instance of a packet_device resource named worker configured with count:

$ terraform state rm 'packet_device.worker[0]'

Example: Remove a Resource configured with for_each

The example below removes the "example" instance of a packet_device resource named worker configured with for_each:

Linux, Mac OS, and UNIX:

$ terraform state rm 'packet_device.worker["example"]'

PowerShell:

$ terraform state rm 'packet_device.worker[\"example\"]'

Windows cmd.exe:

$ terraform state rm packet_device.worker[\"example\"]

3.5 KiB Raw Blame History