執筆者：Handbook編集部
手動で作成したAWS上のリソースをTerraform Importを使ってTerraform管理下に置く方法
はじめに
AWS 上で手動で作成したリソースを Terraform で管理したいことはよくあります。この記事では、そのような手動で作成された AWS リソースを Terraform の管理下に取り込む方法を、terraform import を利用して実施します。さらに、取り込んだ結果を S3 に保存して、今後は Terraform でのリソース管理をスムーズに進める方法についても詳しく解説します。
Terraform Import とは？
Terraform は Infrastructure as Code (IaC)ツールの一つで、コードによってクラウドインフラの作成や変更を管理することができます。しかし、実際のクラウドの世界では、Terraform 以外の方法で作成されたリソースが存在します。これらの既存リソースを Terraform の管理下に置くためのコマンドが terraform import です。
Terraform Import の動作
terraform import コマンドを使用すると、既存のクラウドリソースの現在の状態を Terraform の状態ファイル(terraform.tfstate)に取り込むことができます。これにより、そのリソースを Terraform で管理することが可能になります。 重要な点として、terraform import は Terraform のコード（.tf ファイル）を自動的に生成または更新するものではありません。実際のリソースを状態ファイルに取り込むだけです。そのため、リソースを正確に管理するためには、対応する Terraform コードも手動で作成する必要があります。
Terraform Import の利点
統一的な管理: Terraform 以外で作成されたリソースも Terraform で一元的に管理することができるようになります。 再利用: 既存のリソースを再利用しながら、Terraform を導入することが可能です。 コンプライアンスと監査: Terraform を通してリソースを管理することで、インフラの変更履歴やコンプライアンスを確保しやすくなります。
Terraform の注意点と制約
terraform import は現在のリソースの状態を取り込むだけで、Terraform コードは自動生成されません。すべてのリソースや属性が import に対応しているわけではありません。公式ドキュメントでサポートされているリソースと属性を確認することが重要です。複雑なリソースやリソースの関連性を持つ場合、一つ一つのリソースを import するのは手間がかかる場合があります。
Terraform の初期設定
最初に Terraform の設定を行います。
$ terraform init
実行結果:
Initializing the backend...
Initializing provider plugins...
- Reusing previous version of hashicorp/aws from the dependency lock file
Terraform has been successfully initialized!
Terraform のコードを作成
既存の VPC の情報を管理するための Terraform コードを main.tf に作成します。
provider "aws" {
region = "us-west-1" # 任意のリージョンを指定
}
resource "aws_vpc" "imported_vpc" {
# このブロック内の詳細はimport後に記入する
}
Terraform Import の実行
# 以下のコマンドを使って、既存のVPCをTerraformの管理下に置きます。
$ terraform import aws_vpc.imported_vpc vpc-0123456789abcdef0
実行結果:
aws_vpc.imported_vpc: Importing from ID "vpc-0123456789abcdef0"...
aws_vpc.imported_vpc: Import complete!
Imported aws_vpc (ID: vpc-0123456789abcdef0)
aws_vpc.imported_vpc: Refreshing state... (ID: vpc-0123456789abcdef0)
Terraform コードの更新
Import した VPC の詳細を main.tf に追記します。
provider "aws" {
region = "us-west-1" # 任意のリージョンを指定
}
resource "aws_vpc" "imported_vpc" {
# このブロック内の詳細はimport後に記入する
}
Terraform Plan の実行
$ terraform plan
:warning: 注意: この時「No changes. Infrastructure is up-to-date.」と表示されるまで修正を行います。
実行結果:
Refreshing Terraform state in-memory prior to plan...
------------------------------------------------------------------------
No changes. Infrastructure is up-to-date.
Terraform Apply の実行
変更内容を適用します。ただし、今回の場合、import したので実際に変更は発生していません。
$ terraform apply
実行結果:
Apply complete! Resources: 0 added, 0 changed, 0 destroyed.
Terraform の状態を S3 に保存
S3 バケットの作成
まず、Terraform の状態を保存するための S3 バケットを作成する必要があります。AWS Management Console または AWS CLI を使用して S3 バケットを作成します。
例: AWS CLI を使用して S3 バケットを作成:
$ aws s3api create-bucket --bucket my-terraform-state-bucket --region us-west-1
実行結果:
{
"Location": "/my-terraform-state-bucket"
}
Terraform のバックエンド設定
terraform {
backend "s3" {
bucket = "my-terraform-state-bucket"
key = "path/to/my/key"
region = "us-west-1"
}
}
この設定は、Terraform の状態を my-terraform-state-bucket という S3 バケットに保存することを指定しています。
Terraform Init の再実行
新しいバックエンド設定を適用するために terraform init を再実行します。
$ terraform init
実行結果:
Initializing the backend...
Successfully configured the backend "s3"! Terraform will automatically use this backend unless the backend configuration changes.
状態の移動
Do you want to copy existing state to the new backend?
Pre-existing state was found while migrating the previous "local" backend to the
newly configured "s3" backend. No existing state was found in the newly
configured "s3" backend. Do you want to copy this state to the new "s3"
backend? Enter "yes" to copy and "no" to start with an empty state.
Enter a value: yes
"yes"と入力して、既存の状態を新しい S3 バックエンドにコピーします。
これで、Terraform の状態が S3 バケットに保存されるようになりました。今後の terraform apply や terraform plan などの操作は、この S3 バケットを参照して実行されます。
まとめ
Terraform Import は、既存のクラウドリソースを Terraform の管理下に置くための強力なツールです。ただし、その動作や制約を理解して適切に利用することが、スムーズなインフラ管理に繋がります。正確な Terraform コードの記述と組み合わせることで、効果的なインフラの管理・運用が可能となります。
参考
Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。
