Problem
The state-first migration section of the Terraform migration guide walks through installing and running the pulumi-terraform-migrate tool, but its "Install the tool" step only says to ensure the Pulumi CLI is installed:
The tool runs as a Pulumi plugin. Ensure you have the Pulumi CLI installed.
The tool's own README (https://github.com/pulumi/pulumi-tool-terraform-migrate#usage) states plainly that it shells out to OpenTofu to extract state:
The tool may run tofu, tofu init, tofu refresh to extract the Terraform state and these commands may require authorizing read-only access to the cloud accounts.
A reader who has Terraform (but not OpenTofu) installed, or neither, follows the doc's steps, reaches "Translate your Terraform state," and hits a failure the doc gives them no way to explain, since it never told them tofu needed to be on their PATH.
Fix
Add a note to the "Install the tool" step (and/or just before "Translate your Terraform state") that the tool requires the OpenTofu CLI (tofu) to be installed and on PATH, since it uses it to extract Terraform state read-only, and that it never runs mutating commands like tofu apply.
Problem
The state-first migration section of the Terraform migration guide walks through installing and running the
pulumi-terraform-migratetool, but its "Install the tool" step only says to ensure the Pulumi CLI is installed:The tool's own README (https://github.com/pulumi/pulumi-tool-terraform-migrate#usage) states plainly that it shells out to OpenTofu to extract state:
A reader who has Terraform (but not OpenTofu) installed, or neither, follows the doc's steps, reaches "Translate your Terraform state," and hits a failure the doc gives them no way to explain, since it never told them
tofuneeded to be on theirPATH.Fix
Add a note to the "Install the tool" step (and/or just before "Translate your Terraform state") that the tool requires the OpenTofu CLI (
tofu) to be installed and onPATH, since it uses it to extract Terraform state read-only, and that it never runs mutating commands liketofu apply.