YAZエンジニアが運営するメディア

はじめに

今回の記事では、Terraform（テラフォーム）を使用してAWSリソースを構築する方法について説明します。

Terraformは、サーバーやネットワーク、データベースなどのインフラ構成をコードで定義するためのツールです。
このようにインフラをコードで管理する考え方を、Infrastructure as Code（IaC）と呼びます。

AWSマネジメントコンソールを使用する場合は、画面上で設定項目を一つずつ入力してリソースを作成します。 一方、Terraformでは、作成するリソースの種類や設定内容をコードとして記述し、そのコードをもとにAWSリソースを作成します。

参考画像

Terraformを使用することで、AWSリソースを作成するだけではなく、構成の再利用や変更内容の確認、設定の管理までコードを中心に行えるようになります。

ただし、Terraformを使用すれば自動的に安全な構成になるわけではありません。 terraform apply や terraform destroy を実行する前に、変更対象を確認することが重要です。

今回は、Terraformの基本的な操作から、AWSリソースの作成、既存リソースのインポート、リソースの削除までを行います。

この記事では、Terraformを初めて使用する人に向けて、実際に行った作業と各コマンドの役割を順番に説明します。

・ VS Code
　　└── Terraformの設定ファイルを作成

・ AWS CLI
　　└── IAM Identity CenterによるSSO認証
　　└── Terraform
　　　　　└── S3バケットを作成
　　　　　└── EC2インスタンスを作成
　　　　　└── Apache Webサーバーを構築
　　　　　└── 既存EC2をインポート

Terraformの設定ファイル
↓
AWS Provider
↓
AWSのAPI
↓
S3・EC2などのAWSリソース

0. AWS CLIでSSO認証を設定する

0-1. SSOの設定を開始する

詳細な作業手順に関しては以下のブログを参照してください。
ECS (Fargate) ＋ ALB Webアプリケーション構築ハンズオン | YAZエンジニアが運営するメディア Blilliant Engineer

1. TerraformでS3バケットを作成する

1-1. 作業フォルダを作成する

今回の作業では、PC上にTerraform用の作業フォルダを作成し、VS Codeで開きます。

C:\work\Terraform1

PowerShellから作成する場合は、次のコマンドを実行します。

cd C:\work
mkdir Terraform1
cd Terraform1
code .

code .を実行すると、現在開いているフォルダをVS Codeで開けます。

1-2. main.tfを作成する

作業フォルダの中に、次のファイルを作成します。

main.tf

main.tfに、AWS ProviderとS3バケットの設定を記述します。

provider "aws" {
region = "<自身のリージョン>"
profile = "my-sso"
}

resource "aws_s3_bucket" "my_bucket_02" {
bucket = "ojt-s3-<名前>-02"

tags = {
Name = "My Terraform Bucket"
Environment = "Dev"
}
}

各設定の役割は以下のとおりです。

provider "aws"
TerraformがAWSへ接続するための設定

region
AWSリソースを作成する自身のリージョン

profile
AWS CLIで作成したSSOプロファイル

resource "aws_s3_bucket"
S3バケットを作成するための定義

my_bucket_02
Terraform内部でS3バケットを識別するための名前

bucket
AWS上に実際に作成されるS3バケット名

1-3. Terraformを初期化する

設定ファイルを作成したら、VS Codeのターミナルで次のコマンドを実行します。

terraform init

terraform initは、TerraformがAWSを操作するために必要なAWS Providerなどを準備するコマンドです。

初めてTerraformを実行する場合や、使用するProviderを追加・変更した場合に実行します。

1-4. 作成予定の内容を確認する

次のコマンドを実行し、AWS上でどのような変更が行われるのかを確認します。

terraform plan

terraform planでは、実際にAWSリソースを変更する前に、作成・変更・削除される内容を確認できます。

S3バケットを1つ作成する場合は、実行結果の最後に次のような内容が表示されます。

Plan: 1 to add, 0 to change, 0 to destroy.

1 to add
1個のリソースを作成する

0 to change
変更されるリソースはない

0 to destroy
削除されるリソースはない

1-5. S3バケットを作成する

実行計画に問題がなければ、次のコマンドを実行します。

terraform apply

実行内容の確認を求められたら、次のように入力します。

yes

処理が完了し、次のメッセージが表示されれば作成成功です。

Apply complete!

AWSマネジメントコンソールからS3を開き、指定した名前のバケットが作成されていることを確認します。

2. TerraformでEC2インスタンスを作成する

2-1. ec2.tfを作成する

作業フォルダに、次のファイルを作成します。

ec2.tf

最初に、EC2インスタンスの基本設定を記述します。

resource "aws_instance" "my_instance_02" {
ami = "<自身のリージョンに対応したAMI ID>"
instance_type = "t2.micro"

tags = {
Name = "ojt-ec2-<名前>-02"
}
}

各設定の役割は以下のとおりです。

aws_instance
EC2インスタンスを作成するリソース

my_instance_02
Terraform内部で使用する識別名

ami
EC2で使用するOSイメージのID

instance_type
EC2のCPUやメモリなどの構成

tags
AWSマネジメントコンソール上で表示する名前

2-2. EC2の作成内容を確認する

設定を保存したら、次のコマンドを実行します。

terraform plan

実行計画に問題がなければ、次のコマンドを実行します。

terraform apply

確認画面でyesを入力します。

処理完了後、AWSマネジメントコンソールのEC2画面で、指定した名前のインスタンスが作成されていることを確認します。

3. EC2上にWebサーバーを構築する

実行する処理は以下のとおりです。

1. OSのパッケージを更新する
2. Apacheをインストールする
3. Apacheを起動する
4. EC2起動時にApacheが自動起動するよう設定する
5. index.htmlを作成する

3-1. user_dataを追加する

aws_instanceの設定に、次のユーザーデータを追加します。

resource "aws_instance" "my_instance_02" {
ami = "<自身のリージョンに対応したAMI ID>"
instance_type = "t2.micro"

user_data = <<-EOF
#!/bin/bash

dnf update -y
dnf install -y httpd

systemctl start httpd
systemctl enable httpd

echo "<h1>Hello from Terraform</h1>" > /var/www/html/index.html
EOF

user_data_replace_on_change = true

tags = {
Name = "ojt-ec2-<名前>-02"
}
}

それぞれのコマンドは、次の処理を行っています。

dnf update -y
インストール済みパッケージを更新する

dnf install -y httpd
Apacheをインストールする

systemctl start httpd
Apacheを起動する

systemctl enable httpd
EC2の起動時にApacheも自動起動するよう設定する

echo ... > /var/www/html/index.html
ブラウザに表示するHTMLファイルを作成する

user_data_replace_on_change = trueを設定すると、ユーザーデータの変更時にEC2インスタンスを置き換える設定になります。

設定変更後は、再度以下のコマンドを実行します。

terraform plan
terraform apply

4. ポート番号を変数として定義する

4-1. HTTPポートを定義する

variable "http_port" {
description = "The port used for HTTP traffic"
type = number
default = 80
}

default = 80によって、HTTP通信で使用する初期値を80番ポートに設定しています。

4-2. SSHポートを定義する

variable "ssh_port" {
description = "The port used for SSH traffic"
type = number
default = 22
}

default = 22によって、SSH通信で使用する初期値を22番ポートに設定しています。

4-3. セキュリティグループの受信ルールで変数を使用する

定義した変数を、セキュリティグループの受信ルールで使用します。

resource "aws_security_group" "my_security_group_04" {
name = "ojt-sgp-<名前>-04"

ingress {
from_port = var.http_port
to_port = var.http_port
protocol = "tcp"
cidr_blocks = ["0.0.0.0/0"]
}

ingress {
from_port = var.ssh_port
to_port = var.ssh_port
protocol = "tcp"
cidr_blocks = ["0.0.0.0/0"]
}
}

HTTPの受信ルールではvar.http_portを使用し、SSHの受信ルールではvar.ssh_portを使用しています。

セキュリティグループを作成しただけではEC2へ適用されないため、EC2側にセキュリティグループを関連付けます。

vpc_security_group_ids = [
aws_security_group.my_security_group_04.id
]

設定後、変更内容を確認して反映します。

terraform plan
terraform apply

5. EC2のパブリックIPアドレスを出力する

ec2.tfに次の設定を追加します。

output "public_ip" {
value = aws_instance.my_instance_02.public_ip
description = "The public IP address of the web server"
}

設定を反映した後、次のコマンドを実行します。

terraform output public_ip

表示されたパブリックIPアドレスを使用して、ブラウザからEC2へアクセスします。

http://<EC2のパブリックIPアドレス>

ブラウザ上に次の文字が表示されれば、Webサーバーの構築は成功です。

Hello from Terraform

Webページが表示されない場合

Webページが表示されない場合は、次の順番で確認します。

1. EC2がrunningになっているか
2. EC2にパブリックIPが割り当てられているか
3. セキュリティグループで80番ポートが許可されているか
4. Apacheがインストールされているか
5. Apacheが起動しているか
6. /var/www/html/index.htmlが作成されているか

ブラウザからEC2までの通信経路に沿って確認すると、問題が発生している場所を切り分けやすくなります。

ブラウザ
↓
EC2のパブリックIPアドレス
↓
セキュリティグループの80番ポート
↓
Apache
↓
index.html

6. 既存のEC2をTerraformへインポートする

既存のEC2
↓
Terraformへインポート
↓
Terraformのstateで管理

6-1. import.tfを作成する

作業フォルダに、次のファイルを作成します。

import.tf

ファイル内に、インポート先となるTerraform上のリソース名と、AWS上に存在するEC2のインスタンスIDを記述します。

import {
to = aws_instance.my_instance_01
id = "<既存EC2のインスタンスID>"
}

それぞれの項目は以下を表しています。

to
Terraform上で使用するリソース名

id
AWS上に存在するEC2のインスタンスID

6-2. 既存EC2の設定からTerraformコードを生成する

次のコマンドを実行します。

terraform plan -generate-config-out=generated_ec2.tf

このコマンドを実行すると、既存EC2の設定をもとに、次のファイルが生成されます。

generated_ec2.tf

生成されたファイルには、AWS上に存在するEC2の設定がTerraformコードとして出力されます。

生成後は、次のような項目を確認します。

・AMI
・インスタンスタイプ
・サブネット
・セキュリティグループ
・タグ
・パブリックIPに関する設定
・意図していない設定が含まれていないか

6-3. インポートを適用する

生成された内容を確認したら、次のコマンドを実行します。

terraform apply

実行内容を確認し、問題がなければyesを入力します。

処理が完了すると、既存のEC2インスタンスがTerraformの管理対象として登録されます。

6-4. インポート結果を確認する

インポート完了後、次のコマンドを実行します。

terraform plan

AWS上のEC2とTerraformのコードが一致している場合は、変更がないことを示す内容が表示されます。

No changes.

7. terraform.tfstateについて

Terraformを実行すると、作業フォルダ内に次のファイルが作成されます。

terraform.tfstate

terraform.tfstateには、Terraform上のリソースとAWS上の実際のリソースを対応付ける情報が保存されます。

Terraform上のリソース名
aws_instance.my_instance_02

↕ 対応付け

AWS上のEC2インスタンスID
i-xxxxxxxxxxxxxxxxx

Terraformは、この情報を使用して、次回のterraform plan実行時に変更の有無を判断します。

8. 作成したAWSリソースを削除する

Terraformで作成したAWSリソースを削除する場合は、次のコマンドを実行します。

terraform destroy

削除予定のリソースが表示されるため、内容を確認します。

問題がなければ、次のように入力します。

yes

作業終了後は、AWSマネジメントコンソールでもS3やEC2が削除されていることを確認します。

Terraformで発生しやすい問題・その対処法

AWSの認証エラーが表示される

SSOのログイン情報が有効でない場合は、次のコマンドを実行します。

aws sso login --profile my-sso

PowerShellでは、環境変数に設定されているプロファイルも確認します。

$env:AWS_PROFILE

AMIが見つからない

AWS Providerに設定したリージョンと、EC2で指定したAMI IDが一致しているか確認します。

provider "aws" {
region = "<自身のリージョン>"
}

S3バケットを作成できない

指定したS3バケット名が、すでにほかのAWS利用者に使われている可能性があります。

バケット名を重複しにくい名前へ変更し、再度以下のコマンドを実行します。

terraform plan
terraform apply

Webページへアクセスできない

次の通信経路に沿って確認します。

ブラウザ
↓
EC2のパブリックIPアドレス
↓
セキュリティグループ
↓
Apache
↓
index.html

まとめ

今回の記事では、Terraformを使用してAWSリソースをコードから管理する方法、手順を記載しました。

今回実施した内容は以下のとおりです。

・AWS CLIでSSO認証を設定
・Terraformの作業フォルダを作成
・terraform initによる初期化
・S3バケットの作成
・terraform planによる変更内容の確認
・terraform applyによるAWSへの反映
・EC2インスタンスの作成
・ユーザーデータによるApacheの自動構築
・変数を利用したHTTP・SSHポートの管理
・outputを利用したパブリックIPの確認
・既存EC2インスタンスのインポート
・terraform.tfstateによる状態管理
・terraform destroyによるリソースの削除

Terraformでは、コードを作成してすぐにAWSへ反映するのではなく、次の流れで作業することが重要です。

コードを記述する
↓
terraform initで必要な機能を準備する
↓
terraform planで変更内容を確認する
↓
terraform applyでAWSへ反映する
↓
terraform.tfstateで状態を管理する

また、AWSマネジメントコンソールから作成した既存リソースについても、インポート機能を使用することでTerraformの管理対象へ追加できます。

一方で、TerraformのコードとAWS上の実際の状態に差がある場合、意図していない変更や削除が発生する可能性があります。

特にterraform applyとterraform destroyを実行する前には、表示された実行計画を確認することが重要です。