Deprecate the tfmigrate plan --out=tfplan option #63
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closes #62 The tfmigrate plan --out=tfplan option was originally requested in #36, and added in #37. While testing Terraform 1.1 support, I found it no longer work with Terraform 1.1. #62 After debugging, the tfmigrate plan --out=tfplan option was based on a bug prior to Terraform 1.1. Since terraform state push increments the serial of tfstate, a saved plan file in tfmigrate plan phase should not be able to terraform apply. However, prior to Terraform 1.1, there was no proper validation and terraform apply allows a such case incorrectly. Starting from Terraform 1.1, it now rejects the plan as stale, which seems to be a correct behavior. That is, the tfmigrate plan --out=tfplan option doesn't work with Terraform 1.1 or later. There is no way to do this. Fortunately, Terraform 1.1 added a new `moved` block feature, so some use-cases could be covered by the `moved` block. So, I decided to deprecate the tfmigrate plan --out=tfplan option without replacement and it will be removed in a future release.
minamijoyo
added a commit
that referenced
this pull request
Dec 10, 2021
A notable change is only #63.
This was referenced Dec 10, 2021
|
@minamijoyo wondering if we should we run |
|
Hi @joestump, Yes. If resource drift remains after |
minamijoyo
added a commit
that referenced
this pull request
Sep 14, 2022
The `tfmigrate plan --out=tfplan` option was initially implemented in tfmigrate v0.2.7 and deprecated in v0.3.0 because the feature was based on a bug before Terraform v1.1. This means that the saved plan file is no longer applicable in Terraform v1.1+. #63 Even though, we found the plan file would still be useful for static analysis such as Conftest. #106 Let’s revert the deprecation and clarify it's intended to use only for static analysis. Note that the old terraform show command before Terraform v1.1.3 rejects a plan file generated by `tfmigrate plan —out=tfplan` as stale. It works after this change. hashicorp/terraform#30205 Use Terraform v1.1.3+ for this feature. I think this limitation is acceptable as long as it works with the latest Terraform.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #62
The tfmigrate plan --out=tfplan option was originally requested in #36, and added in #37.
While testing Terraform 1.1 support, I found it no longer work with Terraform 1.1. #62
After debugging, the tfmigrate plan --out=tfplan option was based on a bug prior to Terraform 1.1.
Since terraform state push increments the serial of tfstate, a saved plan file in tfmigrate plan phase should not be able to terraform apply. However, prior to Terraform 1.1, there was no proper validation and terraform apply allows a such case incorrectly. Starting from Terraform 1.1, it now rejects the plan as stale, which seems to be a correct behavior.
That is, the tfmigrate plan --out=tfplan option doesn't work with Terraform 1.1 or later. There is no way to do this.
Fortunately, Terraform 1.1 added a new
movedblock feature, so some use-cases could be covered by themovedblock.So, I decided to deprecate the tfmigrate plan --out=tfplan option without replacement and it will be removed in a future release.