Generate Terraform moved
blocks automatically.
moved
blocksterraform state mv
commandsinit
and refresh
stepseverything
kindwhitespace
kindprefix
kindtfautomv
(a.k.a Terraform auto-move) is a refactoring helper. With it, making
structural changes to your Terraform codebase becomes much easier.
When you move a resource in your code, Terraform loses track of the resource's state. The next time you run Terraform, it will plan to delete the resource it has memory of and create the "new" resource it found in your refactored code.
tfautomv
inspects the output of terraform plan
, detects such
creation/deletion pairs and writes a moved
block
so that Terraform now knows no deletion or creation is required.
We explain why we built tfautomv in more detail in this blog article.
Here's a quick view of what tfautomv
does:
tfautomv
uses the Terraform CLI command under the hood. This allows it to work
with any Terraform version reliably.
Certain features require specific versions of Terraform:
moved
blocks require Terraform v1.1 or aboveterraform state mv
commands require Terraform v0.14 or aboveterraform state mv
commands require Terraform v0.13 or aboveContributions to support other installation methods are welcome!
On MacOS or Linux:
brew install busser/tap/tfautomv
On Arch Linux:
yay tfautomv-bin
With asdf version manager:
asdf plugin add tfautomv https://github.com/busser/asdf-tfautomv.git
On MacOS or Linux:
curl -sSfL https://raw.githubusercontent.com/busser/tfautomv/main/install.sh | sh
This script can probably support Windows with a small amount of work. Contributions welcome!
On the Github repository's Releases page, download the binary that matches your workstation's OS and CPU architecture.
Put the binary in a directory present in your system's PATH
environment
variable.
You must have Go 1.18+ installed to compile tfautomv.
Clone the repository and build the binary:
git clone https://github.com/busser/tfautomv
cd tfautomv
make build
Then, move bin/tfautomv
to a directory resent in your system's PATH
environment variable.
moved
blocksIn any directory where you would run terraform plan
, you can run:
tfautomv
This will run terraform init
, terraform refresh
, and terraform plan
, and
then write moved
blocks to a moves.tf
file.
That's all there is to it!
You can also target a specific working directory:
tfautomv ./production
terraform state mv
commandsBy default, tfautomv writes moves to as moved
blocks when possible and falls
back to terraform state mv
commands when not.
You can force tfautomv
to write only moved
blocks with the --output=moves
flag:
tfautomv --output=moves
You can force tfautomv
to write only terraform state mv
commands with the
--output=commands
flag:
tfautomv --output=commands
This will print commands to standard output. You can copy and paste them to a terminal to run them manually.
Alternatively, you can write the commands to a file:
tfautomv --output=commands > moves.sh
Or pipe them into a shell to run them immediately:
tfautomv --output=commands | sh
The -o
flag is shorthand for --output
:
tfautomv -o commands
If you have multiple Terraform modules in different directories, you can pass
those directories to tfautomv
:
tfautomv ./production/main ./production/backup -o commands
This will run terraform init
, terraform refresh
, and terraform plan
in
each directory, and then write terraform state mv
commands to standard output.
These commands will move resources within and across directories as needed.
Terraform does not natively support moving resources across directories. To
achieve this, tfautomv
will output commands that pull copies of each
directory's state, perform the moves, and then push the new state back to the
directory's state backend.
You can pass as many directories as you want to tfautomv
.
This is only compatible with the commands
output format. Terraform's moved
block syntax does not support moving resources across directories.
init
and refresh
stepsBy default, tfautomv
runs Terraform's init
, refresh
, and plan
steps.
To save time, you can skip the init
or refresh
steps with the --skip-init
and --skip-refresh
flags:
tfautomv --skip-init --skip-refresh
The -s
flag is shorthand for --skip-init
and -S
for `--skip-refresh:
tfautomv -sS
If you are not seeing a moved
block for a resource you expected to be moved,
you can increase tfautomv
's verbosity with the -v
flag to get more
information:
tfautomv -v
The default verbosity level is 0. You can increase the verbosity up to 3 by
repeating the -v
flag:
tfautomv -vvv
Alternatively, you can specify a specific verbosity level with the --verbosity
flag:
tfautomv --verbosity=2
Based on why the resource was not moved, you can choose to edit your code,
write a moved
block manually, or use the -ignore
flag to ignore certain
differences.
level 0 (default) | level 1 (-v ) |
level 2 (-vv ) |
level 3 (-vvv ) |
---|---|---|---|
tfautomv
works by comparing resources Terraform plans to create (those in your
code) to those Terraform plans to delete (those in your state). Sometimes,
tfautomv
may not be able to match two resources together because of a
difference in a specific attribute, even though the resources are in fact the
same. This usually happens when the Terraform provider that manages the resource
has transformed the attribute's value in some way.
In those cases, you can use the -ignore
flag to ignore specific differences.
tfautomv
will ignore differences based on a set of rules that you can
provide.
Each rule includes:
A rule is written as a colon-separated string:
<KIND>:<RESOURCE TYPE>:<ATTRIBUTE NAME>[:<KIND ARGUMENTS>]
You can use the --ignore
flag multiple times to provide multiple rules:
tfautomv \
--ignore="whitespace:azurerm_api_management_policy:xml_content" \
--ignore="prefix:google_storage_bucket_iam_member:bucket:b/"
If you have a use case that is not covered by existing kinds, please open an issue so we can track demand for it.
everything
kindUse the everything
kind to ignore any difference between two values of an
attribute:
tfautomv --ignore="everything:<RESOURCE TYPE>:<ATTRIBUTE>"
For example:
tfautomv --ignore="everything:random_pet:length"
whitespace
kindUse the whitespace
kind to ignore differences in whitespace between two
values of an attribute:
tfautomv --ignore="whitespace:<RESOURCE TYPE>:<ATTRIBUTE NAME>"
For example, this rule:
tfautomv --ignore="whitespace:azurerm_api_management_policy:xml_content"
will allow these two resources to match:
# This resource has its XML nicely formatted.
resource "azurerm_api_management_policy" "foo" {
api_management_id = "..."
xml_content = <<-EOT
<policies>
<inbound>
<cross-domain />
<base />
<find-and-replace from="xyz" to="abc" />
</inbound>
</policies>
EOT
}
# This resource has its XML on one line.
resource "azurerm_api_management_policy" "bar" {
api_management_id = "..."
xml_content = "<policies><inbound><cross-domain /><base /><find-and-replace from=\"xyz\" to=\"abc\" /></inbound></policies>"
}
prefix
kindUse the prefix
kind to ignore a specific prefix between in one of two values
of an attribute:
tfautomv --ignore="prefix:<RESOURCE TYPE>:<ATTRIBUTE NAME>:<PREFIX>"
For example:
tfautomv --ignore="prefix:google_storage_bucket_iam_member:bucket:b/"
will strip the b/
prefix from the bucket
attribute of any
google_storage_bucket_iam_member
resources before comparing the attirbute's
values.
Join parent attributes with child attributes with a .
:
<KIND>:<RESOURCE TYPE>:parent_obj.child_field
<KIND>:<RESOURCE TYPE>:parent_list.0
To get an attribute's full path, increase the verbosity level with the -v
flag:
tfautomv -vvv
You can pass additional arguments to Terraform by using Terraform's built-in
TF_CLI_ARGS
and TF_CLI_ARGS_name
environment variables..
For example, in order to use a file of variables during Terraform's plan:
TF_CLI_ARGS_plan="-var-file=production.tfvars" tfautomv
You can tell tfautomv
to use the Terragrunt CLI instead of the Terraform CLI
with the --terraform-bin
flag:
tfautomv --terraform-bin=terragrunt
This also works with any other executable that has an init
and plan
command.
Add the --no-color
flag to your tfautomv
command to disable output
formatting like colors, bold text, etc.
For example:
tfautomv --no-color
Alternatively, you can achieve the same result by setting the NO_COLOR
environment variable to any value:
NO_COLOR=true tfautomv
Thanks to Padok, where this project was born 💜
The code is licensed under the permissive Apache v2.0 license. Read this for a summary.