tf-migrate prepare reference

The tf-migrate prepare command recursively scans the current directory for Terraform state files, then generates new Terraform configuration to migrate the state to HCP Terraform or Terraform Enterprise.

Usage

$ tf-migrate prepare [options]

Description

The tf-migrate prepare command prompts you for the following information:

• The HCP Terraform or Terraform Enterprise organization to migrate your state to.
• If you would like to create a new branch named hcp-migrate-<BRANCH> where <BRANCH> is the name of the branch you currently have checked out.
• If you would like it to automatically create a pull request with the updated code change when the migration is complete.

The tf-migrate prepare command generates a new Terraform configuration in the _hcp-migrate-configs directory to perform the migration. This configuration creates the following resources:

• One workspace per state file. The tf-migrate tool names the workspace following the <DIRECTORY NAME>-<LOCAL WORKSPACE NAME> pattern. The tf-migrate tool also creates workspace variables from the Terraform configuration's variables.
• One project to store all workspaces. The tf-migrate tool uses the directory path to the state file as the project name. For example, if your configuration is stored at ./frontend/networking/terraform.tfstate, tf-migrate names the project "frontend_networking". Because of this, your directory path must be between 3-40 characters and only include letters, numbers, inner spaces, hyphens, and underscores.
• A new local git branch if you responded to the prompt to create a new branch with yes.
• A new pull request in the remote git repository if you responded to the prompt to create a pull request with yes.

The tf-migrate CLI tool adds the generated configuration to the .gitignore file so that the configuration is not committed to source control.

The tf-migrate tool creates the following structure in HCP Terraform or Terraform Enterprise depending on your local configuration:

Example

The tf-migrate prepare command generates the configuration to migrate this state to a single HCP Terraform workspace.

$ tf-migrate prepare
✓ Current working directory: /tmp/learn-terraform-migrate
✓ Environment readiness checks completed
✓ Found 3 HCP Terraform organizations
┌────────────────────────────┐
│ Available Orgs             │
├────────────────────────────┤
│ my-org-1                   │
│ my-org-2                   │
│ my-org-3                   │
└────────────────────────────┘
Enter the name of the HCP Terraform organization to migrate to:  my-org-1
✓ You have selected organization my-org-1 for migration
✓ Found 2 directories with Terraform files
┌────────────────────────────────┐
│   Terraform File Directories   │
├────────────────────────────────┤
│ web                            │
│ api                            │
└────────────────────────────────┘
Create a local branch named hcp-migrate-main from the current branch main: ... ?
 
 
  Only 'yes or no' will be accepted as input.
  Type 'yes' to approve the step
  Type 'no' to to skip
 
 
Enter a value:  yes
 
✓ Successfully created branch hcp-migrate-main
Do you want to open a pull request from hcp-migrate-main ... ?
 
 
  Only 'yes or no' will be accepted as input.
  Type 'yes' to approve the step
  Type 'no' to to skip
 
 
Enter a value:  yes
 
✓ Migration config generation completed
✓ Successfully updated .gitignore

Available options

You can include the following flags when you run the tf-migrate prepare command: