terraform/command/taint.go

226 lines
6.7 KiB
Go
Raw Normal View History

2015-02-26 19:29:23 +01:00
package command
import (
"context"
2015-02-26 19:29:23 +01:00
"fmt"
"strings"
"github.com/hashicorp/terraform/states"
terraform: ugly huge change to weave in new HCL2-oriented types Due to how deeply the configuration types go into Terraform Core, there isn't a great way to switch out to HCL2 gradually. As a consequence, this huge commit gets us from the old state to a _compilable_ new state, but does not yet attempt to fix any tests and has a number of known missing parts and bugs. We will continue to iterate on this in forthcoming commits, heading back towards passing tests and making Terraform fully-functional again. The three main goals here are: - Use the configuration models from the "configs" package instead of the older models in the "config" package, which is now deprecated and preserved only to help us write our migration tool. - Do expression inspection and evaluation using the functionality of the new "lang" package, instead of the Interpolator type and related functionality in the main "terraform" package. - Represent addresses of various objects using types in the addrs package, rather than hand-constructed strings. This is not critical to support the above, but was a big help during the implementation of these other points since it made it much more explicit what kind of address is expected in each context. Since our new packages are built to accommodate some future planned features that are not yet implemented (e.g. the "for_each" argument on resources, "count"/"for_each" on modules), and since there's still a fair amount of functionality still using old-style APIs, there is a moderate amount of shimming here to connect new assumptions with old, hopefully in a way that makes it easier to find and eliminate these shims later. I apologize in advance to the person who inevitably just found this huge commit while spelunking through the commit history.
2018-04-30 19:33:53 +02:00
"github.com/hashicorp/terraform/addrs"
"github.com/hashicorp/terraform/command/clistate"
"github.com/hashicorp/terraform/tfdiags"
2015-02-26 19:29:23 +01:00
)
2015-02-26 23:30:02 +01:00
// TaintCommand is a cli.Command implementation that manually taints
// a resource, marking it for recreation.
2015-02-26 19:29:23 +01:00
type TaintCommand struct {
Meta
}
func (c *TaintCommand) Run(args []string) int {
args, err := c.Meta.process(args, false)
if err != nil {
return 1
}
2015-02-26 19:29:23 +01:00
2015-02-26 19:56:45 +01:00
var allowMissing bool
var module string
2015-02-26 19:29:23 +01:00
cmdFlags := c.Meta.flagSet("taint")
2015-02-26 19:56:45 +01:00
cmdFlags.BoolVar(&allowMissing, "allow-missing", false, "module")
cmdFlags.StringVar(&module, "module", "", "module")
2015-02-26 19:29:23 +01:00
cmdFlags.StringVar(&c.Meta.statePath, "state", DefaultStateFilename, "path")
cmdFlags.StringVar(&c.Meta.stateOutPath, "state-out", "", "path")
cmdFlags.StringVar(&c.Meta.backupPath, "backup", "", "path")
2017-02-06 16:07:32 +01:00
cmdFlags.BoolVar(&c.Meta.stateLock, "lock", true, "lock state")
cmdFlags.DurationVar(&c.Meta.stateLockTimeout, "lock-timeout", 0, "lock timeout")
2015-02-26 19:29:23 +01:00
cmdFlags.Usage = func() { c.Ui.Error(c.Help()) }
if err := cmdFlags.Parse(args); err != nil {
return 1
}
var diags tfdiags.Diagnostics
2015-02-26 19:29:23 +01:00
// Require the one argument for the resource to taint
args = cmdFlags.Args()
if len(args) != 1 {
c.Ui.Error("The taint command expects exactly one argument.")
cmdFlags.Usage()
return 1
}
2015-02-26 19:56:45 +01:00
if module != "" {
c.Ui.Error("The -module option is no longer used. Instead, include the module path in the main resource address, like \"module.foo.module.bar.null_resource.baz\".")
return 1
2015-02-26 19:56:45 +01:00
}
2015-02-26 19:29:23 +01:00
addr, addrDiags := addrs.ParseAbsResourceInstanceStr(args[0])
diags = diags.Append(addrDiags)
if addrDiags.HasErrors() {
c.showDiagnostics(diags)
return 1
}
if addr.Resource.Resource.Mode != addrs.ManagedResourceMode {
c.Ui.Error(fmt.Sprintf("Resource instance %s cannot be tainted", addr))
return 1
}
2017-01-19 05:50:45 +01:00
// Load the backend
b, backendDiags := c.Backend(nil)
diags = diags.Append(backendDiags)
if backendDiags.HasErrors() {
c.showDiagnostics(diags)
2017-01-19 05:50:45 +01:00
return 1
}
// Get the state
env := c.Workspace()
stateMgr, err := b.StateMgr(env)
2015-02-26 19:29:23 +01:00
if err != nil {
c.Ui.Error(fmt.Sprintf("Failed to load state: %s", err))
return 1
}
if c.stateLock {
stateLocker := clistate.NewLocker(context.Background(), c.stateLockTimeout, c.Ui, c.Colorize())
if err := stateLocker.Lock(stateMgr, "taint"); err != nil {
c.Ui.Error(fmt.Sprintf("Error locking state: %s", err))
2017-02-03 20:23:24 +01:00
return 1
}
defer stateLocker.Unlock(nil)
2017-02-03 20:23:24 +01:00
}
if err := stateMgr.RefreshState(); err != nil {
c.Ui.Error(fmt.Sprintf("Failed to load state: %s", err))
return 1
}
2015-02-26 19:29:23 +01:00
// Get the actual state structure
state := stateMgr.State()
if state.Empty() {
2015-02-26 19:56:45 +01:00
if allowMissing {
return c.allowMissingExit(addr)
2015-02-26 19:56:45 +01:00
}
diags = diags.Append(tfdiags.Sourceless(
tfdiags.Error,
"No such resource instance",
"The state currently contains no resource instances whatsoever. This may occur if the configuration has never been applied or if it has recently been destroyed.",
))
c.showDiagnostics(diags)
2015-02-26 19:29:23 +01:00
return 1
}
ss := state.SyncWrapper()
2015-02-26 19:56:45 +01:00
// Get the resource and instance we're going to taint
rs := ss.Resource(addr.ContainingResource())
is := ss.ResourceInstance(addr)
if is == nil {
2015-02-26 19:56:45 +01:00
if allowMissing {
return c.allowMissingExit(addr)
2015-02-26 19:56:45 +01:00
}
diags = diags.Append(tfdiags.Sourceless(
tfdiags.Error,
"No such resource instance",
fmt.Sprintf("There is no resource instance in the state with the address %s. If the resource configuration has just been added, you must run \"terraform apply\" once to create the corresponding instance(s) before they can be tainted.", addr),
))
c.showDiagnostics(diags)
2015-02-26 19:29:23 +01:00
return 1
}
obj := is.Current
if obj == nil {
if len(is.Deposed) != 0 {
diags = diags.Append(tfdiags.Sourceless(
tfdiags.Error,
"No such resource instance",
fmt.Sprintf("Resource instance %s is currently part-way through a create_before_destroy replacement action. Run \"terraform apply\" to complete its replacement before tainting it.", addr),
))
} else {
// Don't know why we're here, but we'll produce a generic error message anyway.
diags = diags.Append(tfdiags.Sourceless(
tfdiags.Error,
"No such resource instance",
fmt.Sprintf("Resource instance %s does not currently have a remote object associated with it, so it cannot be tainted.", addr),
))
2015-02-26 19:56:45 +01:00
}
c.showDiagnostics(diags)
2015-02-26 19:29:23 +01:00
return 1
}
obj.Status = states.ObjectTainted
ss.SetResourceInstanceCurrent(addr, obj, rs.ProviderConfig)
2015-02-26 19:29:23 +01:00
if err := stateMgr.WriteState(state); err != nil {
2017-01-19 05:50:45 +01:00
c.Ui.Error(fmt.Sprintf("Error writing state file: %s", err))
return 1
}
if err := stateMgr.PersistState(); err != nil {
2015-02-26 19:29:23 +01:00
c.Ui.Error(fmt.Sprintf("Error writing state file: %s", err))
return 1
}
c.Ui.Output(fmt.Sprintf("Resource instance %s has been marked as tainted.", addr))
2015-02-26 19:29:23 +01:00
return 0
}
func (c *TaintCommand) Help() string {
helpText := `
Usage: terraform taint [options] <address>
2015-02-26 19:29:23 +01:00
Manually mark a resource as tainted, forcing a destroy and recreate
on the next plan/apply.
This will not modify your infrastructure. This command changes your
state to mark a resource as tainted so that during the next plan or
apply that resource will be destroyed and recreated. This command on
its own will not modify infrastructure. This command can be undone
using the "terraform untaint" command with the same address.
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
2015-02-26 19:29:23 +01:00
Options:
2015-02-26 19:56:45 +01:00
-allow-missing If specified, the command will succeed (exit code 0)
even if the resource is missing.
2015-02-26 19:29:23 +01:00
-backup=path Path to backup the existing state file before
modifying. Defaults to the "-state-out" path with
".backup" extension. Set to "-" to disable backup.
2017-02-06 16:07:32 +01:00
-lock=true Lock the state file when locking is supported.
2017-02-03 20:23:24 +01:00
-lock-timeout=0s Duration to retry a state lock.
2015-02-26 19:29:23 +01:00
-no-color If specified, output won't contain any color.
-state=path Path to read and save state (unless state-out
is specified). Defaults to "terraform.tfstate".
-state-out=path Path to write updated state file. By default, the
"-state" path will be used.
`
return strings.TrimSpace(helpText)
}
func (c *TaintCommand) Synopsis() string {
return "Manually mark a resource for recreation"
}
2015-02-26 19:56:45 +01:00
func (c *TaintCommand) allowMissingExit(name addrs.AbsResourceInstance) int {
c.showDiagnostics(tfdiags.Sourceless(
tfdiags.Warning,
"No such resource instance",
"Resource instance %s was not found, but this is not an error because -allow-missing was set.",
))
2015-02-26 19:56:45 +01:00
return 0
}