mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-02-23 17:09:31 -05:00
4d665a0091
* Initial renaming, rewriting and cleaning up wave for the CLI docs. Signed-off-by: Jakub Martin <kubam@spacelift.io> * More renaming. Signed-off-by: Jakub Martin <kubam@spacelift.io> * More renaming. Signed-off-by: Jakub Martin <kubam@spacelift.io> * More renaming. Signed-off-by: Jakub Martin <kubam@spacelift.io> * Remove tutorial references. Signed-off-by: Jakub Martin <kubam@spacelift.io> * Post-review fixes. Signed-off-by: Jakub Martin <kubam@spacelift.io> --------- Signed-off-by: Jakub Martin <kubam@spacelift.io>
73 lines
3.0 KiB
Plaintext
73 lines
3.0 KiB
Plaintext
---
|
|
page_title: 'Command: untaint'
|
|
description: |-
|
|
The `opentf untaint` command tells OpenTF that an object is functioning
|
|
correctly, even though its creation failed or it was previously manually
|
|
marked as degraded.
|
|
---
|
|
|
|
# Command: untaint
|
|
|
|
OpenTF has a marker called "tainted" which it uses to track that an object
|
|
might be damaged and so a future OpenTF plan ought to replace it.
|
|
|
|
OpenTF automatically marks an object as "tainted" if an error occurs during
|
|
a multi-step "create" action, because OpenTF can't be sure that the object
|
|
was left in a fully-functional state.
|
|
|
|
You can also manually mark an object as "tainted" using the deprecated command
|
|
[`opentf taint`](/opentf/cli/commands/taint), although we no longer recommend that
|
|
workflow.
|
|
|
|
If OpenTF 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 `opentf untaint` to remove the taint marker from that object.
|
|
|
|
This command _will not_ modify any real remote objects, but will modify the
|
|
state in order to remove the tainted status.
|
|
|
|
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:
|
|
|
|
```
|
|
opentf apply -replace="aws_instance.example[0]"
|
|
```
|
|
|
|
## Usage
|
|
|
|
Usage: `opentf untaint [options] address`
|
|
|
|
The `address` argument is a [resource address](/opentf/cli/state/resource-addressing)
|
|
identifying a particular resource instance which is currently tainted.
|
|
|
|
This command also accepts the following options:
|
|
|
|
- `-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.
|
|
|
|
- `-lock=false` - Don't hold a state lock during the operation. This is
|
|
dangerous if others might concurrently run commands against the same
|
|
workspace.
|
|
|
|
- `-lock-timeout=DURATION` - Unless locking is disabled with `-lock=false`,
|
|
instructs OpenTF 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.
|
|
|
|
- `-no-color` - Disables terminal formatting sequences in the output. Use this
|
|
if you are running OpenTF in a context where its output will be
|
|
rendered by a system that cannot interpret terminal formatting.
|
|
|
|
For configurations using the [`cloud` backend](/opentf/cli/cloud) or the [`remote` backend](/opentf/language/settings/backends/remote)
|
|
only, `opentf untaint`
|
|
also accepts the option
|
|
[`-ignore-remote-version`](/opentf/cli/cloud/command-line-arguments#ignore-remote-version).
|
|
|
|
For configurations using
|
|
[the `local` backend](/opentf/language/settings/backends/local) only,
|
|
`opentf untaint` also accepts the legacy options
|
|
[`-state`, `-state-out`, and `-backup`](/opentf/language/settings/backends/local#command-line-arguments).
|