terraform/command/state_pull.go

90 lines
2.2 KiB
Go
Raw Normal View History

2017-01-19 05:50:45 +01:00
package command
import (
"bytes"
2017-01-19 05:50:45 +01:00
"fmt"
"strings"
"github.com/hashicorp/terraform/states/statefile"
"github.com/hashicorp/terraform/states/statemgr"
2017-01-19 05:50:45 +01:00
)
// StatePullCommand is a Command implementation that shows a single resource.
type StatePullCommand struct {
Meta
2017-01-19 05:50:45 +01:00
StateMeta
}
func (c *StatePullCommand) Run(args []string) int {
args = c.Meta.process(args)
cmdFlags := c.Meta.defaultFlagSet("state pull")
2017-01-19 05:50:45 +01:00
if err := cmdFlags.Parse(args); err != nil {
c.Ui.Error(fmt.Sprintf("Error parsing command-line flags: %s\n", err.Error()))
return 1
2017-01-19 05:50:45 +01:00
}
// Load the backend
b, backendDiags := c.Backend(nil)
if backendDiags.HasErrors() {
c.showDiagnostics(backendDiags)
2017-01-19 05:50:45 +01:00
return 1
}
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
// This is a read-only command
c.ignoreRemoteBackendVersionConflict(b)
// Get the state manager for the current workspace
env, err := c.Workspace()
if err != nil {
c.Ui.Error(fmt.Sprintf("Error selecting workspace: %s", err))
return 1
}
stateMgr, err := b.StateMgr(env)
2017-01-19 05:50:45 +01:00
if err != nil {
c.Ui.Error(fmt.Sprintf(errStateLoadingState, err))
2017-01-19 05:50:45 +01:00
return 1
}
if err := stateMgr.RefreshState(); err != nil {
c.Ui.Error(fmt.Sprintf("Failed to refresh state: %s", err))
2017-01-19 05:50:45 +01:00
return 1
}
// Get a statefile object representing the latest snapshot
stateFile := statemgr.Export(stateMgr)
if stateFile != nil { // we produce no output if the statefile is nil
var buf bytes.Buffer
err = statefile.Write(stateFile, &buf)
if err != nil {
c.Ui.Error(fmt.Sprintf("Failed to write state: %s", err))
return 1
}
c.Ui.Output(buf.String())
}
2017-01-19 05:50:45 +01:00
return 0
}
func (c *StatePullCommand) Help() string {
helpText := `
Usage: terraform state pull [options]
Pull the state from its location, upgrade the local copy, and output it
to stdout.
2017-01-19 05:50:45 +01:00
This command "pulls" the current state and outputs it to stdout.
As part of this process, Terraform will upgrade the state format of the
local copy to the current version.
2017-01-19 05:50:45 +01:00
The primary use of this is for state stored remotely. This command
will still work with local state but is less useful for this.
`
return strings.TrimSpace(helpText)
}
func (c *StatePullCommand) Synopsis() string {
return "Pull current state and output to stdout"
}