2017-02-15 22:14:32 +01:00
|
|
|
---
|
2020-10-27 01:58:30 +01:00
|
|
|
layout: "docs"
|
2017-02-15 22:14:32 +01:00
|
|
|
page_title: "Command: state push"
|
2018-12-21 03:18:13 +01:00
|
|
|
sidebar_current: "docs-commands-state-sub-push"
|
2017-02-15 22:14:32 +01:00
|
|
|
description: |-
|
2018-09-05 04:12:24 +02:00
|
|
|
The `terraform state push` command pushes items to the Terraform state.
|
2017-02-15 22:14:32 +01:00
|
|
|
---
|
|
|
|
|
|
|
|
# Command: state push
|
|
|
|
|
|
|
|
The `terraform state push` command is used to manually upload a local
|
2021-01-15 23:13:53 +01:00
|
|
|
state file to [remote state](/docs/language/state/remote.html). This command also
|
2017-02-15 22:14:32 +01:00
|
|
|
works with local state.
|
|
|
|
|
|
|
|
This command should rarely be used. It is meant only as a utility in case
|
|
|
|
manual intervention is necessary with the remote state.
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
Usage: `terraform state push [options] PATH`
|
|
|
|
|
|
|
|
This command will push the state specified by PATH to the currently
|
2021-01-15 23:13:53 +01:00
|
|
|
configured [backend](/docs/language/settings/backends/index.html).
|
2017-02-15 22:14:32 +01:00
|
|
|
|
2017-03-01 22:10:48 +01:00
|
|
|
If PATH is "-" then the state data to push is read from stdin. This data
|
|
|
|
is loaded completely into memory and verified prior to being written to
|
|
|
|
the destination state.
|
|
|
|
|
2017-02-15 22:14:32 +01:00
|
|
|
Terraform will perform a number of safety checks to prevent you from
|
|
|
|
making changes that appear to be unsafe:
|
|
|
|
|
|
|
|
* **Differing lineage**: If the "lineage" value in the state differs,
|
|
|
|
Terraform will not allow you to push the state. A differing lineage
|
|
|
|
suggests that the states are completely different and you may lose
|
|
|
|
data.
|
|
|
|
|
|
|
|
* **Higher remote serial**: If the "serial" value in the destination state
|
|
|
|
is higher than the state being pushed, Terraform will prevent the push.
|
|
|
|
A higher serial suggests that data is in the destination state that isn't
|
|
|
|
accounted for in the local state being pushed.
|
|
|
|
|
|
|
|
Both of these safety checks can be disabled with the `-force` flag.
|
|
|
|
**This is not recommended.** If you disable the safety checks and are
|
|
|
|
pushing state, the destination state will be overwritten.
|
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
|
|
|
|
2021-05-11 20:37:32 +02:00
|
|
|
For configurations using
|
|
|
|
[the `remote` backend](/docs/language/settings/backends/remote.html)
|
|
|
|
only, `terraform state push`
|
|
|
|
also accepts the option
|
|
|
|
[`-ignore-remote-version`](/docs/language/settings/backends/remote.html#command-line-arguments).
|