【実践ガイド】terraform importの使い方完全解説！これまでのリソースを15分で安全にコード化する方法

SHARE

目次

目次へ

terraform import とは？ 基礎知識と重要性を理解しよう

既存のインフラをコード化する際の課題とterraform import の役割

クラウドインフラの運用において、Infrastructure as Code（IaC）の導入は今や必須となっています。しかし、既存の本番環境を途中からコード化する際には、大きな課題に直面することがあります。ここでは、terraform importの役割と、それがどのようにして既存環境のコード化を実現するのかを詳しく解説します。

既存環境をコード化する際の主な課題

  1. 手動設定の正確な把握
  • 長期運用で積み重なった設定変更の履歴が不明確
  • GUIで作成されたリソースの詳細設定を完全に把握することが困難
  • 複数のエンジニアによる設定変更が混在
  1. 依存関係の複雑さ
  • リソース間の依存関係が複雑に絡み合っている
  • 作成順序や関連付けの把握が困難
  • 手動で設定された参照関係の整理が必要

terraform importの役割

terraform importは、これらの課題を解決するための重要なツールです。具体的には以下のような役割を果たします：

  1. 既存リソースの状態取得
  • AWSなどのクラウド環境から、現在のリソース状態を取得
  • Terraformの状態ファイル（terraform.tfstate）への変換
  • リソースの設定情報を構造化データとして保持
  1. 段階的な移行の実現
  • 既存リソースを維持したまま、徐々にコード化が可能
  • 運用中のシステムに影響を与えることなく移行作業が実施可能
  • 必要に応じて一部のリソースだけを選択的にインポート可能

terraform import を使用するメリット3つ

1. 確実な構成管理の実現

  • 現状把握の正確性
  • 実際の環境から直接情報を取得するため、設定の見落としが防止できる
  • クラウドプロバイダーのAPI経由で最新の状態を取得
  • 手動での設定確認よりも信頼性が高い
  • バージョン管理との連携
  • インポートしたリソースの設定をGitなどで履歴管理可能
  • 設定変更の追跡が容易になる
  • チーム間での設定共有が促進される

2. 運用リスクの低減

  • 既存環境への影響最小化
  • read-onlyな操作でインポートが可能
  • 本番環境に影響を与えることなく移行作業が可能
  • 段階的な移行による安全性の確保
  • 変更管理の容易化
  • terraformでの変更計画（plan）が可能になる
  • 意図しない変更の防止
  • ロールバックの実現性向上

3. 運用効率の向上

  • 自動化の促進
  • コード化されたインフラ設定を基に自動化が可能
  • CI/CDパイプラインへの組み込みが容易
  • 環境の複製や災害復旧計画の実現性向上
  • ドキュメントとしての価値
  • コードが最新のインフラ構成を表現
  • 設定根拠の明確化
  • 新規メンバーの参画時の理解促進

実践的な活用シーン

以下の表は、terraform importが特に有効な代表的なシーンをまとめたものです：

活用シーン具体例メリット
レガシー環境の移行手動作成された本番環境のコード化・リスクを最小化した段階的移行
・既存設定の完全な把握
マルチアカウント管理複数AWSアカウントの統合管理・設定の標準化
・一元的な管理の実現
緊急対応後の同期障害対応で手動追加したリソースの取り込み・状態の整合性維持
・設定のバージョン管理への統合

このように、terraform importは既存環境のコード化を実現する上で、非常に重要なツールとなります。次のセクションでは、具体的な使用方法について詳しく解説していきます。

terraform importの基本的な使い方

terraform importコマンドの基本構文と動作の仕組み

terraform importは、既存のインフラストラクチャリソースをTerraformの管理下に置くためのコマンドです。基本的な使用方法から、実際の動作の仕組みまでを詳しく解説します。

基本構文

terraform import aws_resource_type.resource_name resource_id

主要なパラメータの説明：

  • aws_resource_type: インポートするリソースの種類（例：aws_instance）
  • resource_name: Terraform設定で使用するリソース名
  • resource_id: クラウド上の実際のリソースID

動作の仕組み

  1. 状態の読み取り
  • クラウドプロバイダーのAPIを使用して既存リソースの状態を取得
  • 取得した情報をTerraform用の状態データに変換
  1. 状態ファイルへの記録
  • 変換されたデータをterraform.tfstateに保存
  • リソースの現在の状態を完全に記録
  1. 設定との紐付け
  • 状態ファイルの情報と.tfファイルの定義を関連付け
  • 以降の管理をTerraformで実施可能に

インポートするためのterraform設定ファイルの書き方

基本的な設定ファイル構造

# プロバイダーの設定
provider "aws" {
  region = "ap-northeast-1"
}

# インポート対象のリソース定義
resource "aws_instance" "example" {
  # 最小限必要な設定のみを記述
  # その他の設定は import 後に state から補完可能
}

設定ファイル作成のベストプラクティス

  1. 最小限の設定から開始
   # 良い例：必要最小限の設定
   resource "aws_instance" "web" {
     # import 後に他の設定を追加
   }

   # 避けるべき例：import 前から詳細設定を記述
   resource "aws_instance" "web" {
     ami           = "ami-12345678"
     instance_type = "t2.micro"
     # その他多数の設定...
   }
  1. リソース間の依存関係を考慮
   # 依存関係のあるリソースの例
   resource "aws_vpc" "main" {
     # VPC の設定
   }

   resource "aws_subnet" "public" {
     vpc_id = aws_vpc.main.id  # VPC への参照
   }

実行時の注意点とベストプラクティス

実行前の準備チェックリスト

  1. 環境の確認
  • [ ] AWS認証情報の設定
  • [ ] 適切なリージョンの指定
  • [ ] 必要な権限の確認
  1. 設定ファイルの準備
  • [ ] リソース定義の作成
  • [ ] プロバイダーの設定
  • [ ] バックエンドの設定（必要な場合）
  1. 実行計画
  • [ ] 依存関係の洗い出し
  • [ ] インポート順序の決定
  • [ ] ロールバック手順の確認

インポート実行のベストプラクティス

  1. 段階的なアプローチ
   # 1. まず状態を確認
   terraform plan

   # 2. 一つのリソースをインポート
   terraform import aws_instance.web i-1234567890abcdef0

   # 3. 状態を確認
   terraform show

   # 4. 設定ファイルを更新
   # state show の出力を参考に設定を追加
  1. エラー対応の基本手順
エラーパターン対処方法予防策
リソースが見つからないIDの確認とリージョンの確認事前のリソース存在確認
権限エラーIAMポリシーの確認と修正必要権限の事前確認
設定の不整合最小構成からの段階的設定事前の設定項目確認

重要な注意点

  1. バックアップの重要性
  • 実行前の状態ファイルのバックアップ
  • クラウド環境のスナップショット取得
  • ロールバック手順の準備
  1. 段階的な実施
  • 小規模なリソースから開始
  • 正常性確認後に次のリソースへ
  • エラー発生時の影響を最小化
  1. ドキュメント化
  • 実行手順の記録
  • エラー発生時の対応記録
  • 設定変更の履歴管理

このように、terraform importの基本的な使用方法を理解し、適切な準備と手順で実行することで、既存リソースを安全にTerraformの管理下に置くことができます。次のセクションでは、具体的なAWSリソースのインポート手順について詳しく解説していきます。

主要なAWSリソースのインポート手順と実例

EC2インスタンスのインポート方法とコード例

EC2インスタンスは最も基本的なAWSリソースの一つですが、関連リソースも多いため、慎重なインポートが必要です。

基本的な設定ファイル

# main.tf
provider "aws" {
  region = "ap-northeast-1"
}

# EC2インスタンス定義
resource "aws_instance" "example" {
  # インポート時は最小限の設定から開始
}

# セキュリティグループ定義
resource "aws_security_group" "example" {
  # セキュリティグループの設定
}

インポート手順

  1. インスタンス情報の取得
# インスタンスIDの確認
aws ec2 describe-instances --filters "Name=tag:Name,Values=example-instance" --query 'Reservations[].Instances[].InstanceId' --output text

# インポートの実行
terraform import aws_instance.example i-1234567890abcdef0
  1. 関連リソースの設定反映
# インポート後の設定例
resource "aws_instance" "example" {
  ami           = "ami-12345678"  # 現在のAMI ID
  instance_type = "t2.micro"

  vpc_security_group_ids = [
    aws_security_group.example.id
  ]

  tags = {
    Name = "example-instance"
  }
}

注意点

  • AMI IDは定期的に更新が必要
  • セキュリティグループは別途インポートが必要
  • EBSボリュームは自動的にインポートされる

VPCとサブネットのインポート手順

VPCとサブネットは依存関係が重要なリソースです。正しい順序でのインポートが必要です。

インポート用設定ファイル

# network.tf
resource "aws_vpc" "main" {
  # VPCの最小設定
}

resource "aws_subnet" "public" {
  # サブネットの最小設定
}

resource "aws_route_table" "public" {
  # ルートテーブルの最小設定
}

インポート手順と実行コマンド

  1. VPCのインポート
# VPC IDの確認
aws ec2 describe-vpcs --filters "Name=tag:Name,Values=main-vpc" --query 'Vpcs[].VpcId' --output text

# VPCのインポート
terraform import aws_vpc.main vpc-1234567890abcdef0
  1. サブネットのインポート
# サブネットのインポート
terraform import aws_subnet.public subnet-1234567890abcdef0
  1. 設定の更新
# インポート後の完全な設定例
resource "aws_vpc" "main" {
  cidr_block           = "10.0.0.0/16"
  enable_dns_hostnames = true
  enable_dns_support   = true

  tags = {
    Name = "main-vpc"
  }
}

resource "aws_subnet" "public" {
  vpc_id            = aws_vpc.main.id
  cidr_block        = "10.0.1.0/24"
  availability_zone = "ap-northeast-1a"

  tags = {
    Name = "public-subnet"
  }
}

依存関係の注意点

リソース依存するリソースインポート順序
サブネットVPCVPC → サブネット
ルートテーブルVPCVPC → ルートテーブル
ネットワークACLVPCVPC → NACL

IAMロールとポリシーのインポート方法

IAMリソースは特に慎重な取り扱いが必要です。誤った設定変更は大きな影響を及ぼす可能性があります。

基本設定

# iam.tf
resource "aws_iam_role" "example" {
  # ロールの最小設定
}

resource "aws_iam_role_policy" "example" {
  # インラインポリシーの最小設定
}

resource "aws_iam_role_policy_attachment" "example" {
  # ポリシーアタッチメントの最小設定
}

インポート手順

  1. IAMロールのインポート
# ロールのインポート
terraform import aws_iam_role.example example-role-name
  1. ポリシーのインポート
# インラインポリシーのインポート
terraform import aws_iam_role_policy.example example-role-name:example-policy-name

# ポリシーアタッチメントのインポート
terraform import aws_iam_role_policy_attachment.example example-role-name/arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
  1. 完全な設定例
resource "aws_iam_role" "example" {
  name = "example-role"

  assume_role_policy = jsonencode({
    Version = "2012-10-17"
    Statement = [
      {
        Action = "sts:AssumeRole"
        Effect = "Allow"
        Principal = {
          Service = "ec2.amazonaws.com"
        }
      }
    ]
  })
}

resource "aws_iam_role_policy" "example" {
  name = "example-policy"
  role = aws_iam_role.example.id

  policy = jsonencode({
    Version = "2012-10-17"
    Statement = [
      {
        Effect = "Allow"
        Action = [
          "s3:GetObject",
          "s3:ListBucket"
        ]
        Resource = [
          "arn:aws:s3:::example-bucket",
          "arn:aws:s3:::example-bucket/*"
        ]
      }
    ]
  })
}

IAMリソースのインポート時の注意点

  1. セキュリティの考慮事項
  • 最小権限の原則を維持
  • 既存のポリシーを慎重にレビュー
  • 不要な権限の削除
  1. インポート順序の重要性
  • ロール → インラインポリシー → ポリシーアタッチメント
  • 依存関係を考慮した順序付け
  • エラー時の適切なロールバック
  1. ベストプラクティス
  • ポリシードキュメントのバージョン管理
  • 変更前の設定のバックアップ
  • テスト環境での事前確認

terraform importの実践的な手法

大規模インフラのimportを効率化するためのスクリプト活用法

大規模なインフラストラクチャをTerraformに移行する際は、手動での作業は現実的ではありません。以下では、効率的なインポート作業を実現するためのスクリプト活用法を解説します。

リソース一覧取得スクリプト

#!/bin/bash
# aws_resources_list.sh
# AWS環境からリソースを一覧取得し、Terraformインポート用の設定を生成

# EC2インスタンス一覧取得
echo "Retrieving EC2 instances..."
aws ec2 describe-instances --query 'Reservations[].Instances[].[InstanceId,Tags[?Key==`Name`].Value|[0]]' --output text | while read -r id name; do
    echo "resource \"aws_instance\" \"${name:-unnamed}\" {}" >> terraform_config.tf
    echo "terraform import aws_instance.${name:-unnamed} $id" >> import_commands.sh
done

# VPC一覧取得
echo "Retrieving VPCs..."
aws ec2 describe-vpcs --query 'Vpcs[].[VpcId,Tags[?Key==`Name`].Value|[0]]' --output text | while read -r id name; do
    echo "resource \"aws_vpc\" \"${name:-unnamed}\" {}" >> terraform_config.tf
    echo "terraform import aws_vpc.${name:-unnamed} $id" >> import_commands.sh
done

chmod +x import_commands.sh

依存関係を考慮した実行スクリプト

# import_orchestrator.py
import boto3
import json

def get_resource_dependencies():
    """リソース間の依存関係を定義"""
    return {
        'aws_vpc': [],
        'aws_subnet': ['aws_vpc'],
        'aws_instance': ['aws_subnet', 'aws_security_group'],
        'aws_security_group': ['aws_vpc']
    }

def create_import_order():
    """インポート順序を生成"""
    deps = get_resource_dependencies()
    ordered_resources = []
    visited = set()

    def visit(resource):
        if resource in visited:
            return
        for dep in deps[resource]:
            visit(dep)
        visited.add(resource)
        ordered_resources.append(resource)

    for resource in deps:
        visit(resource)

    return ordered_resources

def generate_import_script():
    """インポート用のスクリプトを生成"""
    order = create_import_order()
    with open('ordered_import.sh', 'w') as f:
        f.write('#!/bin/bash\n\n')
        for resource_type in order:
            f.write(f'echo "Importing {resource_type}..."\n')
            f.write(f'source import_{resource_type}.sh\n')
            f.write('sleep 2\n\n')

依存関係のあるリソースを正しい順序でimportする方法

依存関係管理の基本原則

  1. 依存関係の可視化
# dependencies.tf
locals {
  dependency_map = {
    vpc = []
    subnet = ["vpc"]
    security_group = ["vpc"]
    instance = ["subnet", "security_group"]
    rds = ["subnet_group", "security_group"]
  }
}
  1. インポート順序の自動生成
def generate_import_sequence(resources):
    """トポロジカルソートによるインポート順序の生成"""
    def topological_sort(graph):
        visited = set()
        sequence = []

        def dfs(node):
            if node in visited:
                return
            visited.add(node)
            for dep in graph[node]:
                dfs(dep)
            sequence.append(node)

        for node in graph:
            dfs(node)

        return sequence

    return topological_sort(resources)

実践的なインポートワークフロー

フェーズ実行内容確認ポイント
準備依存関係の分析とマッピングリソース間の関係性が正しいか
計画インポート順序の決定循環依存がないか
実行順序に従ったインポートエラーが発生していないか
検証状態の確認とテストリソースが正しく管理されているか

インポートしたリソースの状態確認とトラブルシューティング

状態確認の自動化スクリプト

#!/bin/bash
# check_import_status.sh

# 状態ファイルの検証
echo "Checking terraform state..."
terraform show -json | jq -r '.values.root_module.resources[] | select(.type != "aws_provider") | "\(.type).\(.name): \(.values.id)"'

# プランの実行と差分確認
terraform plan -out=tfplan
terraform show -json tfplan | jq -r '.resource_changes[] | select(.change.actions[] != "no-op") | "\(.type).\(.name): \(.change.actions[])"'

トラブルシューティングガイド

  1. 一般的な問題と対処法
問題原因対処方法
依存関係エラーインポート順序の誤り依存関係マップの見直しと再実行
状態の不一致手動変更との競合terraform refreshで状態を同期
権限エラーIAM権限の不足必要な権限の追加と確認
  1. 状態確認のためのコマンド集
# リソースの詳細確認
terraform state show aws_instance.example

# 状態ファイルのバックアップ
terraform state pull > terraform.tfstate.backup

# 特定リソースの状態削除（必要な場合）
terraform state rm aws_instance.example

# 状態の更新
terraform refresh
  1. デバッグ用環境変数
# デバッグログの有効化
export TF_LOG=DEBUG
export TF_LOG_PATH=./terraform.log

# AWSデバッグログの有効化
export AWS_DEBUG=true

ベストプラクティスと注意点

  1. 効率的なインポート管理
  • バッチサイズの適切な設定
  • エラーハンドリングの実装
  • 進捗状況のログ記録
  1. セーフガード
   # インポート前の状態確認
   terraform plan

   # 状態ファイルのバックアップ
   cp terraform.tfstate terraform.tfstate.$(date +%Y%m%d_%H%M%S)

   # ドライランモードでの実行
   terraform plan -input=false -lock=false
  1. モニタリングとアラート
   # インポート進捗監視スクリプト
   while true; do
     terraform show -json | jq -r '.values.root_module.resources | length'
     sleep 60
   done

このように、大規模なインフラストラクチャのインポートでは、適切なツールとスクリプトを活用することで、効率的かつ安全な移行を実現できます。

terraform importの実践的な手法

大規模インフラのimportを効率化するためのスクリプト活用法

大規模なインフラストラクチャをTerraformに移行する際は、手動での作業は現実的ではありません。以下では、効率的なインポート作業を実現するためのスクリプト活用法を解説します。

リソース一覧取得スクリプト

#!/bin/bash
# aws_resources_list.sh
# AWS環境からリソースを一覧取得し、Terraformインポート用の設定を生成

# EC2インスタンス一覧取得
echo "Retrieving EC2 instances..."
aws ec2 describe-instances --query 'Reservations[].Instances[].[InstanceId,Tags[?Key==`Name`].Value|[0]]' --output text | while read -r id name; do
    echo "resource \"aws_instance\" \"${name:-unnamed}\" {}" >> terraform_config.tf
    echo "terraform import aws_instance.${name:-unnamed} $id" >> import_commands.sh
done

# VPC一覧取得
echo "Retrieving VPCs..."
aws ec2 describe-vpcs --query 'Vpcs[].[VpcId,Tags[?Key==`Name`].Value|[0]]' --output text | while read -r id name; do
    echo "resource \"aws_vpc\" \"${name:-unnamed}\" {}" >> terraform_config.tf
    echo "terraform import aws_vpc.${name:-unnamed} $id" >> import_commands.sh
done

chmod +x import_commands.sh

依存関係を考慮した実行スクリプト

# import_orchestrator.py
import boto3
import json

def get_resource_dependencies():
    """リソース間の依存関係を定義"""
    return {
        'aws_vpc': [],
        'aws_subnet': ['aws_vpc'],
        'aws_instance': ['aws_subnet', 'aws_security_group'],
        'aws_security_group': ['aws_vpc']
    }

def create_import_order():
    """インポート順序を生成"""
    deps = get_resource_dependencies()
    ordered_resources = []
    visited = set()

    def visit(resource):
        if resource in visited:
            return
        for dep in deps[resource]:
            visit(dep)
        visited.add(resource)
        ordered_resources.append(resource)

    for resource in deps:
        visit(resource)

    return ordered_resources

def generate_import_script():
    """インポート用のスクリプトを生成"""
    order = create_import_order()
    with open('ordered_import.sh', 'w') as f:
        f.write('#!/bin/bash\n\n')
        for resource_type in order:
            f.write(f'echo "Importing {resource_type}..."\n')
            f.write(f'source import_{resource_type}.sh\n')
            f.write('sleep 2\n\n')

依存関係のあるリソースを正しい順序でimportする方法

依存関係管理の基本原則

  1. 依存関係の可視化
# dependencies.tf
locals {
  dependency_map = {
    vpc = []
    subnet = ["vpc"]
    security_group = ["vpc"]
    instance = ["subnet", "security_group"]
    rds = ["subnet_group", "security_group"]
  }
}
  1. インポート順序の自動生成
def generate_import_sequence(resources):
    """トポロジカルソートによるインポート順序の生成"""
    def topological_sort(graph):
        visited = set()
        sequence = []

        def dfs(node):
            if node in visited:
                return
            visited.add(node)
            for dep in graph[node]:
                dfs(dep)
            sequence.append(node)

        for node in graph:
            dfs(node)

        return sequence

    return topological_sort(resources)

実践的なインポートワークフロー

フェーズ実行内容確認ポイント
準備依存関係の分析とマッピングリソース間の関係性が正しいか
計画インポート順序の決定循環依存がないか
実行順序に従ったインポートエラーが発生していないか
検証状態の確認とテストリソースが正しく管理されているか

インポートしたリソースの状態確認とトラブルシューティング

状態確認の自動化スクリプト

#!/bin/bash
# check_import_status.sh

# 状態ファイルの検証
echo "Checking terraform state..."
terraform show -json | jq -r '.values.root_module.resources[] | select(.type != "aws_provider") | "\(.type).\(.name): \(.values.id)"'

# プランの実行と差分確認
terraform plan -out=tfplan
terraform show -json tfplan | jq -r '.resource_changes[] | select(.change.actions[] != "no-op") | "\(.type).\(.name): \(.change.actions[])"'

トラブルシューティングガイド

  1. 一般的な問題と対処法
問題原因対処方法
依存関係エラーインポート順序の誤り依存関係マップの見直しと再実行
状態の不一致手動変更との競合terraform refreshで状態を同期
権限エラーIAM権限の不足必要な権限の追加と確認
  1. 状態確認のためのコマンド集
# リソースの詳細確認
terraform state show aws_instance.example

# 状態ファイルのバックアップ
terraform state pull > terraform.tfstate.backup

# 特定リソースの状態削除（必要な場合）
terraform state rm aws_instance.example

# 状態の更新
terraform refresh
  1. デバッグ用環境変数
# デバッグログの有効化
export TF_LOG=DEBUG
export TF_LOG_PATH=./terraform.log

# AWSデバッグログの有効化
export AWS_DEBUG=true

ベストプラクティスと注意点

  1. 効率的なインポート管理
  • バッチサイズの適切な設定
  • エラーハンドリングの実装
  • 進捗状況のログ記録
  1. セーフガード
   # インポート前の状態確認
   terraform plan

   # 状態ファイルのバックアップ
   cp terraform.tfstate terraform.tfstate.$(date +%Y%m%d_%H%M%S)

   # ドライランモードでの実行
   terraform plan -input=false -lock=false
  1. モニタリングとアラート
   # インポート進捗監視スクリプト
   while true; do
     terraform show -json | jq -r '.values.root_module.resources | length'
     sleep 60
   done

このように、大規模なインフラストラクチャのインポートでは、適切なツールとスクリプトを活用することで、効率的かつ安全な移行を実現できます。

前の記事

【保守性抜群】Terraform Moduleの作り方と活用方…

次の記事

AWS SDK for Java完全ガイド：セットアップから実…