2016-03-08 21:37:34 +01:00
|
|
|
---
|
|
|
|
layout: "docs"
|
|
|
|
page_title: "Command: untaint"
|
|
|
|
sidebar_current: "docs-commands-untaint"
|
|
|
|
description: |-
|
2021-04-07 21:25:59 +02:00
|
|
|
The `terraform untaint` command tells Terraform that an object is functioning
|
|
|
|
correctly, even though its creation failed or it was previously manually
|
|
|
|
marked as degraded.
|
2016-03-08 21:37:34 +01:00
|
|
|
---
|
|
|
|
|
|
|
|
# Command: untaint
|
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
Terraform has a marker called "tainted" which it uses to track that an object
|
|
|
|
might be damaged and so a future Terraform plan ought to replace it.
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
Terraform automatically marks an object as "tainted" if an error occurs during
|
|
|
|
a multi-step "create" action, because Terraform can't be sure that the object
|
|
|
|
was left in a fully-functional state.
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
You can also manually mark an object as "tainted" using the deprecated command
|
|
|
|
[`terraform taint`](./taint.html), although we no longer recommend that
|
|
|
|
workflow.
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
If Terraform currently considers a particular object as tainted but you've
|
|
|
|
determined that it's actually functioning correctly and need _not_ be replaced,
|
|
|
|
you can use `terraform untaint` to remove the taint marker from that object.
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
This command _will not_ modify any real remote objects, but will modify the
|
|
|
|
state in order to remove the tainted status.
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-30 23:46:22 +02:00
|
|
|
If you remove the taint marker from an object but then later discover that it
|
|
|
|
was degraded after all, you can create and apply a plan to replace it without
|
|
|
|
first re-tainting the object, by using a command like the following:
|
|
|
|
|
|
|
|
```
|
|
|
|
terraform apply -replace="aws_instance.example[0]"
|
|
|
|
```
|
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
## Usage
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
Usage: `terraform untaint [options] address`
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
The `address` argument is a [resource address](/docs/cli/state/resource-addressing.html)
|
|
|
|
identifying a particular resource instance which is currently tainted.
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
This command also accepts the following options:
|
2017-04-04 19:48:59 +02:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
* `-allow-missing` - If specified, the command will succeed (exit code 0)
|
|
|
|
even if the resource is missing. The command might still return an error
|
|
|
|
for other situations, such as if there is a problem reading or writing
|
|
|
|
the state.
|
2017-04-04 19:48:59 +02:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
* `-lock=false` - Disables Terraform's default behavior of attempting to take
|
|
|
|
a read/write lock on the state for the duration of the operation.
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
* `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`,
|
|
|
|
instructs Terraform to retry acquiring a lock for a period of time before
|
|
|
|
returning an error. The duration syntax is a number followed by a time
|
|
|
|
unit letter, such as "3s" for three seconds.
|
2016-03-08 21:37:34 +01:00
|
|
|
|
2021-04-07 21:25:59 +02:00
|
|
|
* `-no-color` - Disables terminal formatting sequences in the output. Use this
|
|
|
|
if you are running Terraform in a context where its output will be
|
|
|
|
rendered by a system that cannot interpret terminal formatting.
|
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.
|
2021-04-07 21:25:59 +02:00
|
|
|
|
|
|
|
For configurations using
|
|
|
|
[the `local` backend](/docs/language/settings/backends/local.html) only,
|
|
|
|
`terraform taint` also accepts the legacy options
|
|
|
|
[`-state`, `-state-out`, and `-backup`](/docs/language/settings/backends/local.html#command-line-arguments).
|