resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

website: Update taint command docs to reflect new 0.12 usage

This commit is contained in:
David Liao 2019-06-03 15:36:38 -07:00 committed by Martin Atkins
parent e9e718b318
commit 97ad35f90c
1 changed files with 9 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
website/docs/commands/taint.html.markdown
View File

@ -33,10 +33,14 @@ the case.
## Usage
Usage: `terraform taint [options] name`
Usage: `terraform taint [options] address`
The `name` argument is the name of the resource to mark as tainted.
The format of this argument is `TYPE.NAME`, such as `aws_instance.foo`.
The `address` argument is the address of the resource to mark as tainted.
The address is in the usual resource address syntax, as shown in
the output from other commands, such as:
* `aws_instance.foo`
* `aws_instance.bar[1]`
* `module.foo.module.bar.aws_instance.baz`
The command-line flags are all optional. The list of available flags are:
@ -51,14 +55,6 @@ The command-line flags are all optional. The list of available flags are:
* `-lock-timeout=0s` - Duration to retry a state lock.
* `-module=path` - The module path where the resource to taint exists.
By default this is the root path. Other modules can be specified by
a period-separated list. Example: "foo" would reference the module
"foo" but "foo.bar" would reference the "bar" module in the "foo"
module.
* `-no-color` - Disables output with coloring
* `-state=path` - Path to read and write the state file to. Defaults to "terraform.tfstate".
Ignored when [remote state](/docs/state/remote.html) is used.
@ -80,6 +76,6 @@ The resource aws_security_group.allow_all in the module root has been marked as
This example will only taint a resource within a module:
```
$ terraform taint -module=couchbase aws_instance.cb_node.9
The resource aws_instance.cb_node.9 in the module root.couchbase has been marked as tainted!
$ terraform taint "module.couchbase.aws_instance.cb_node[9]"
Resource instance module.couchbase.aws_instance.cb_node[9] has been marked as tainted!
```