stateファイルの保存先となるバックエンドとは - Terraform

Terraformのstateファイルは、Terraformが管理するリソースの状態を保存するためのファイルです。

Terraformのstateファイルには、各リソースの状態やIDなどの情報が保存されており、

"terraform plan"や"terraform apply"コマンドの実行時に使用されます。

 

stateファイルは、ローカルのファイルシステムに保存されることもありますが、

複数の人が同じTerraformプロジェクトを共有する場合や、複数のマシンでTerraformを実行する場合は、

stateファイルを共有する必要があります。

そのため、Terraformにはバックエンドという機能が用意されており、stateファイルを保存する場所を指定することができます。

 

バックエンドには、以下のようなものがあります。

S3: Amazon S3にstateファイルを保存する
GCS: Google Cloud Storageにstateファイルを保存する
Azure: Azure Storageにstateファイルを保存する
etcd: etcdにstateファイルを保存する
Consul: Consulにstateファイルを保存する

 

バックエンドを使用することで、複数の人やマシンでTerraformを実行する場合でも、stateファイルを共有することができます。

また、バックエンドを使用することで、stateファイルのセキュリティを強化することもできます。

 

stateファイルを保存する場所を指定するには

Terraformでバックエンドを設定するためには、"backend"ブロックを定義する必要があります。

S3をバックエンドとして使用する場合の設定例を以下に示します。

 

terraform {
  backend "s3" {
    bucket = "my-terraform-state-bucket"
    key = "terraform.tfstate"
    region = "us-west-2"
  }
}

上記の例では、"backend"ブロックの中に"s3"を指定しています。また、"bucket"、"key"、"region"などのパラメーターを設定しています。

"bucket":stateファイルを保存するS3バケット名
"key":stateファイルの保存場所となるオブジェクト名
"region":S3バケットが存在するリージョン

設定例では、S3の"my-terraform-state-bucket"というバケットにstateファイルを保存するように指定しています。

また、"terraform.tfstate"というオブジェクト名で保存しています。

このように、Terraformでバックエンドを設定する場合は、"backend"ブロックの中に選択したバックエンドに応じたパラメーターを指定する必要があります。

S3以外のバックエンドを使用する場合は、パラメーターの指定方法が異なる場合があります。

 

上記の記述をするファイル名は?

このようなbackendの設定を記述するファイルは、"backend configuration file"と呼ばれ、通常は "backend.tf" という名前で保存されます。

ただし、"backend.tf"というファイル名は強制されるものではなく、設定ファイルの名前は自由に変更することができます。

ただし、Terraformは、"backend"ブロックが定義されている設定ファイルを自動的に検出するため、

"backend"ブロックを定義するファイルには、"backend.tf"以外の名前を使用しないことを推奨しています。

 

S3にはどのような権限が必要ですか?

TerraformでバックエンドをAWSで利用する場合、S3にはどのような権限が必要ですか?

 

TerraformでS3をバックエンドに使用する場合、S3に対して適切な権限を持つIAMユーザーを作成し、そのIAMユーザーに対して権限を付与する必要があります。以下に必要な権限を示します。

s3:ListBucket
s3:GetObject
s3:PutObject

これらの権限を付与することで、TerraformがS3バケット内にstateファイルを読み込み、書き込みを行うことができます。ただし、これらの権限は必要最低限のものであり、特定の環境によっては、追加の権限が必要になる場合があります。

また、S3バケットのアクセス権限も適切に設定する必要があります。S3バケットのアクセス権限は、通常はバケットポリシーを使用して設定されます。バケットポリシーは、S3バケットに対して誰がどのような操作を許可するかを定義するためのJSONファイルです。

Terraformを使用する場合、バケットポリシーには、以下のような権限が必要になります。

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "TerraformBucketPolicy",
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::ACCOUNT_ID:user/Terraform"
      },
    "Action": [
    "s3:GetObject",
    "s3:PutObject"
    ],
    "Resource": "arn:aws:s3:::BUCKET_NAME/STATE_FILE_NAME"
   }
  ]
}

 

上記の例では、IAMユーザーの"arn:aws:iam::ACCOUNT_ID:user/Terraform"に、

S3バケットの"BUCKET_NAME"内の"STATE_FILE_NAME"に対してGetObjectとPutObjectのアクセス権が付与されています。

Terraformを使用する場合は、適切な権限を持つIAMユーザーと、適切なバケットポリシーを設定することが重要です。

 

 

おすすめの記事