tf-migrate execute reference

The tf-migrate execute command directs Terraform to run the init, plan, and apply commands on the configuration generated with the tf-migrate prepare command.

Usage

$ tf-migrate execute

Description

The tf-migrate execute command creates the project and workspace in HCP Terraform or Terraform Enterprise, migrates the existing state, and updates your configuration to replace the backend block with the cloud block. If you responded to the prompt in the prepare workflow to create a pull request, tf-migrate creates the pull request after it completes the migration.

When Terraform migrate completes the migration, it displays the number of workspaces migrated, a link to each HCP Terraform workspace, and a link to the GitHub pull request if you configured it to create one.

Example

The tf-migrate execute command automatically performs the migration and code updates.

$ tf-migrate execute
✓ Init command ran successfully
✓ Plan command ran successfully and changes are detected
✓ Apply command ran successfully
Apply complete! Resources: 7 added, 0 changed, 0 destroyed.
 
 
Migration Summary
┌───────────────────────────────┬───────┐
│             Metric            │ Count │
├───────────────────────────────┼───────┤
│ Number of Projects Migrated   │     2 │
│ Number of Directories Skipped │     0 │
│ Number of New Workspaces      │     2 │
│ Number of Variables Migrated  │     8 │
└───────────────────────────────┴───────┘
┌───────────────────────────────────────────────────────────────────────────────────────────────────┐
│                                           Workspace URLs                                          │
├───────────────────────────────────────────────────────────────────────────────────────────────────┤
│ https://app.terraform.io//workspaces/web_default                                             │
│ https://app.terraform.io//workspaces/api_default                                             │
└───────────────────────────────────────────────────────────────────────────────────────────────────┘
┌────────────────────────────────────────────────────────────────────────┐
│                            Pull Request Link                           │
├────────────────────────────────────────────────────────────────────────┤
│ https://github.com//learn-terraform-migrate/pull/1                │
└────────────────────────────────────────────────────────────────────────┘

Available options

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

Clean up temporary migration branches

If you chose to create a new branch when you ran the tf-migrate prepare command and you created a VCS-driven workspace, tf-migrate automatically configures you HCP Terraform workspaces to use the new branch rather than your default branch. To update your workspace use your default branch, complete the following steps:

1. Merge the hcp-migrate-<BRANCH> branch into your default branch.
2. Open your workspace Settings page.
3. Click Version Control.
4. Update the VCS branch field with the name of your default branch.
5. Click Update VCS settings.

After you complete these steps, we recommend that you start a new run in your workspace to verify these changes.

1. Navigate back to your workspace overview page.
2. Click New run.
3. Under Run Type, choose Plan only.
4. Click Start.
5. Verify that Terraform does not plan to make any changes to your infrastructure.

After you verify these changes, you can safely delete the hcp-migrate-<BRANCH> branch.