2020-04-23 17:41:57 +02:00
|
|
|
---
|
2020-10-27 01:58:30 +01:00
|
|
|
layout: "docs"
|
2020-04-23 17:41:57 +02:00
|
|
|
page_title: "Command: state replace-provider"
|
|
|
|
|
sidebar_current: "docs-commands-state-sub-replace-provider"
|
|
|
|
|
description: |-
|
|
|
|
|
The `terraform state replace-provider` command replaces the provider for resources in the Terraform state.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Command: state replace-provider
|
|
|
|
|
|
|
|
|
|
The `terraform state replace-provider` command is used to replace the provider
|
2021-01-15 23:13:53 +01:00
|
|
|
for resources in a [Terraform state](/docs/language/state/index.html).
|
2020-04-23 17:41:57 +02:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Usage: `terraform state replace-provider [options] FROM_PROVIDER_FQN TO_PROVIDER_FQN`
|
|
|
|
|
|
|
|
|
|
This command will update all resources using the "from" provider, setting the
|
|
|
|
|
provider to the specified "to" provider. This allows changing the source of a
|
|
|
|
|
provider which currently has resources in state.
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
The command-line flags are all optional. The list of available flags are:
|
|
|
|
|
|
|
|
|
|
* `-auto-approve` - Skip interactive approval.
|
|
|
|
|
|
|
|
|
|
* `-backup=path` - Path where Terraform should write the backup for the
|
|
|
|
|
original state. This can't be disabled. If not set, Terraform will write it
|
|
|
|
|
to the same path as the statefile with a ".backup" extension.
|
|
|
|
|
|
|
|
|
|
* `-lock=true`- Lock the state files when locking is supported.
|
|
|
|
|
|
|
|
|
|
* `-lock-timeout=0s` - Duration to retry a state lock.
|
|
|
|
|
|
|
|
|
|
* `-state=path` - Path to the source state file to read from. Defaults to the
|
|
|
|
|
configured backend, or "terraform.tfstate".
|
|
|
|
|
|
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-13 22:43:56 +01:00
|
|
|
* `-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.
|
|
|
|
|
|
2020-04-23 17:41:57 +02:00
|
|
|
## Example
|
|
|
|
|
|
|
|
|
|
The example below replaces the `hashicorp/aws` provider with a fork by `acme`, hosted at a private registry at `registry.acme.corp`:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ terraform state replace-provider hashicorp/aws registry.acme.corp/acme/aws
|
|
|
|
|
```
|