Terraform から Pulumi への移行

重要な制約 — 実行前に必ずお読みください:

• pulumi convert を実行しないでください — state のマッピングを保持する terraform-migrate プラグインを代わりに使用してください。
• pulumi package add terraform-module を実行しないでください — これは異なるワークフロー用です。
• Pulumi プロジェクトを /workspace の下に作成しないでください — チェックアウト済みのリポジトリ内に作成してください。
• 以下の ${terraform_dir} と ${pulumi_dir} を、ユーザーと確認した実際のパスに置き換えてください。

まずスコープを確認し、ユーザーと一緒に以下の内容を確認して移行計画を立ててください:

• Terraform ソースコードの場所 (${terraform_dir})
• 移行された Pulumi プロジェクトの場所 (${pulumi_dir})
• ターゲット Pulumi 言語 (TypeScript、Python、YAML など)
• 移行の目的が Pulumi スタック状態のセットアップか、ソースコードの変換のみか

計画をユーザーと確認してから進めてください。

選択した言語で ${pulumi_dir} に新しい Pulumi プロジェクトを作成します。ソースコードを編集して空の状態にし、リソースを宣言しないようにします。Pulumi スタックが存在することを確認します。

初期スタック状態が書き込まれていることを確認するため、続行する前に pulumi_up ツールを実行する必要があります。

${terraform_dir} にローカルの .tfstate ファイルが存在しない場合、状態はリモートバックエンド (S3、Pulumi Cloud、Terraform Cloud など) にある可能性があります。続行する前に取得してください:

cd ${terraform_dir} && terraform state pull > terraform.tfstate

これはすべてのバックエンド (Pulumi Cloud を含む) で機能します。terraform が利用できない場合は、代わりに tofu state pull を試してください。

次に、Pulumi state の翻訳案を作成します:

pulumi plugin run terraform-migrate -- stack \
    --from ${terraform_dir} \
    --to ${pulumi_dir} \
    --out /tmp/pulumi-state.json \
    --plugins /tmp/required-providers.json

プラグインを自動インストールする必要があるため、インストールしないでください。

tofu refresh が認可されていないために terraform-migrate プラグインが失敗することがあります。このステップをスキップしないでください。ユーザーと協力して、コマンドを成功させるために必要な認証情報を提供する Pulumi ESC 環境を見つけるか構築してください。ESC 環境のセットアップが実行可能でない場合は、移行を自動的に続行できないことをユーザーに通知してください。

生成された /tmp/required-providers.json を読み込み、すべての Pulumi プロバイダーを新しいプロジェクトにインストールします。既にインストールされているプロバイダーがダウングレードされる場合でも、提案されたバージョンを尊重してください。ファイルには [{"name":"aws","version":"7.12.0"}] などのレコードが含まれます。

言語固有のパッケージマネージャーを使用してプロバイダーをプロジェクト依存関係としてインストールします (pulumi plugin install は使用しないでください。これはプラグインをダウンロードするだけで、依存関係を追加しません):

# TypeScript/JavaScript
npm install @pulumi/aws@7.12.0

# Python
pip install pulumi_aws==7.12.0

# Go
go get github.com/pulumi/pulumi-aws/sdk/v7@v7.12.0

# C#
dotnet add package Pulumi.Aws --version 7.12.0

翻訳された state 案 (/tmp/pulumi-state.json) を Pulumi スタックにインポートします:

pulumi stack import --file /tmp/pulumi-state.json

ソースコードを Terraform ソースと翻訳された state の両方に合わせるように変換します。完全一致を目指してください。state 案 /tmp/pulumi-state.json を参照して、使用する Pulumi リソースタイプと名前を確認できます。

pulumi_preview ツールが変更がなく、差分が空またはほぼ空であることを確認するまで、ソースコードの修正を繰り返します。プロバイダーの差分またはタグの差分は許容できます。

ユーザーに対して、ESC 環境をスタックにリンクするオプションを提供してください。これにより、各 Pulumi スタックがシームレスに必要なプロバイダー認証情報にアクセスできます。

すべてが問題ないように見えたら、移行されたソースコードを含む Pull Request を作成します。