tf-sdk-migrator

README

tf-sdk-migrator

The Terraform provider plugin SDK, previously part of the github.com/hashicorp/terraform "Core" Go module, has been moved to a new Go module, github.com/hashicorp/terraform-plugin-sdk. Terraform providers should now import hashicorp/terraform-plugin-sdk.

tf-sdk-migrator is a CLI tool which will migrate a Terraform provider to the new SDK module by rewriting import paths. tf-sdk-migrator check checks the eligibility of the Provider for migration.

Installation

go install github.com/hashicorp/tf-sdk-migrator
$GOBIN/tf-sdk-migrator

tf-sdk-migrator check: check eligibility for migration

Checks whether a Terraform provider is ready to migrate to the newly extracted Terraform SDK package.

tf-sdk-migrator check [--help] [--csv] PATH

Outputs a report containing:

• Go version used in provider (soft requirement)
• Whether the provider uses Go modules
• Version of hashicorp/terraform used
• Whether the provider uses any hashicorp/terraform packages that are not in hashicorp/terraform-plugin-sdk

The --csv flag will output values in CSV format.

Exits 0 if the provider meets all the hard requirements, 1 otherwise.

The Go version requirement is a "soft" requirement: it is strongly recommended to upgrade to Go version 1.12+ before migrating to the new SDK, but the migration can still be performed if this requirement is not met.

tf-sdk-migrator migrate: migrate to standalone SDK

Migrates the Terraform provider to the new extracted SDK (github.com/hashicorp/terraform-plugin-sdk), replacing references to the old SDK (github.com/hashicorp/terraform).

Note: No backup is made before modifying files. Please make sure your VCS staging area is clean.

tf-sdk-migrator migrate [--help] PATH

The eligibility check will be run first: migration will not proceed if this check fails.

The migration tool will then make the following changes:

• go.mod: replace github.com/hashicorp/terraform dependency with github.com/hashicorp/terraform-plugin-sdk
• rewrite import paths in all provider .go files (except in vendor/) accordingly
• run go mod tidy

If you use vendored Go dependencies, you should run go mod vendor afterwards.

tf-sdk-migrator v2upgrade: migrate from SDKv1 to SDKv2

Migrates a Terraform provider using version 1.x of the standalone SDK to version 2.x of the standalone SDK, updating package import paths.

tf-sdk-migrator v2upgrade

Optionally, --sdk-version may be passed, which is parsed as a Go module release version. For example tf-sdk-migrator v2upgrade --sdk-version v2.0.0-rc.1.

This command rewrites go.mod and updates package import paths, but does not replace deprecated identifiers, so it is likely that the provider will not compile after upgrading. Please follow the steps in the Terraform Plugin SDK v2 Upgrade Guide after running this command.