実行までの流れ
-
terraform init→ 初期設定を行う- ロックファイルを作成する(terraform.lock.hcl)
- プロバイダのダウンロード(.terraform/.providers)
-
プロバイダ →
terraformとクラウドサービスがAPI通信するためのモノ
-
プロバイダ →
-
terraform plan→ 変更内容を確認する-
tfstateに記載されたIDから現在の状態を取得し、比較する
-
-
terraform apply→ リソースを作成する- AWSリソースの作成・変更・削除
-
tfstateファイルの作成・更新terraform.tfstate-
Terraformで管理しているAWSリソースが記載されている
tfファイルの中身
providerブロック → どのクラウドサービスを使用するか指定
provider "aws" {
region = "ap-northeast-1"
}
resourceブロック → 実際に作成するAWSリソースを指定
resource "aws_vpc" "terraform_vpc" {
cidr_block = "10.0.0.0/16"
tags = {
Name = "aws_vpc_handson"
}
}
resource "aws_subnet" "terraform_subnet" {
vpc_id = aws_vpc.terraform_vpc.id
cidr_block = "10.0.0.0/24"
tags = {
Name = "aws_subnet_name"
}
}
localsブロック → 定数を宣言する
-
localsの中に複数定数を定義出来る - 定数の初期化時に他の変数を使用出来る
locals {
vpc_cidr_block = "10.0.0.0/16"
env = "dev"
vpc_name = "${local.env}_aws_vpc_name"
}
resource "aws_vpc" "terraform_vpc" {
cidr_block = local.vpc_cidr_block
tags = {
# local.変数名で値を取得
Name = local.vpc_name
}
}
variableブロック → 入力変数を宣言する
-
variableブロックの中身は省略して良い -
default値が省略された場合は以下の4つから選ぶ- terraform apply実行時に対話形式で入力する
-
varオプション:
terraform apply -var="env=abc" -
terraform.tfvarsファイルを作る-
-var-fileオプションで任意の変数ファイルをロードする
ex):terraform apply -var-file="dev.tfvars"
-
variable "vpc_cidr_block" {
type = string # 省略可能
default = "10.0.0.0/16" # 省略可能
}
resource "aws_vpc" "terraform_vpc" {
# var.変数名で値を取得
cidr_block = var.vpc_cidr_block
}
moduleブロック → 選択したモジュールを関数の要領で呼び出す
-
モジュール → 1ディレクトリに存在する
tfファイル群のこと-
ルートモジュール →
呼び出し元のモジュール
→ moduleブロックのsource引数で子モジュールを指定する
子モジュールの入力変数を引数として渡せる -
子モジュール →
呼び出される側のモジュール-
ローカルモジュール →
ローカル環境に存在する子モジュール -
リモートモジュール →
インターネット上に存在する子モジュール
→.terraform配下にモジュールがダウンロードされる
-
ローカルモジュール →
-
ルートモジュール →
ルートモジュール(dev/main.tf)
module "web" {
# source引数で子モジュールを指定する
source = "../web"
# 子モジュールに引数として入力変数を渡せる
env = "dev"
}
子モジュール(web/main.tf)
source "aws_vpc" "web_vpc" {
cidr_block = "10.0.0.0/16"
name = "${var.env}-vpc"
}
outputブロック → 戻り値の定義・apply後、コンソールへ情報を表示する
-
子モジュールからルートモジュールへの戻り値を定義
root/main.tf
module "child" {
source = "../child"
}
resource "aws_vpc" "vpc" {
# module.モジュール名.output変数名 → outputブロックの戻り値を取得
cidr_block = module.child.cidr_addr
}
child/main.tf
output "cidr_addr" {
value = "10.0.0.0/16"
}
-
terraform apply後、コンソールへ情報を表示する
main.tf
module "child" {
source = "../child"
}
resource "aws_vpc" "vpc" {
cidr_block = module.child.cidr_addr
}
output "abc" {
# コンソール: abc = "123"
value = "123"
}
importブロック → terraform外で作成したリソースをterraformの管理対象に含む
-
resourceブロックを自動生成する場合(以下のvpcを対象とする)
main.tf
import {
# idで指定したリソースをtoの変数名で取得する
id = "vpc-05bd9871ee8d32877"
to = aws_vpc.imported_vpc
}
# generated.tfファイルにresourceブロックを出力
terraform plan --generate-config-out=generated.tf
-
generated.tfは以下の通り
generated.tf
# __generated__ by Terraform
# Please review these resources and move them into your main configuration files.
# __generated__ by Terraform
resource "aws_vpc" "imported_vpc" {
assign_generated_ipv6_cidr_block = false
cidr_block = "10.0.0.0/24"
enable_dns_hostnames = false
enable_dns_support = true
enable_network_address_usage_metrics = false
instance_tenancy = "default"
ipv4_ipam_pool_id = null
ipv4_netmask_length = null
ipv6_ipam_pool_id = null
ipv6_netmask_length = 0
region = "ap-northeast-1"
tags = {
Name = "handson-vpc"
}
tags_all = {
Name = "handson-vpc"
}
}
# terraform.tfstateに反映
terraform apply
dataブロック → Terraform外のリソースをデータソースとして使用する
-
filterブロックは、入れ子でAND検索が出来る
data "aws_vpc" "existing_vpc" {
# ↑ VPCの中から、Name="handson-vpc"のAWSリソースを変数名existing_vpcとして取得する
filter {
name = "tag:Name"
values = ["handson-vpc"]
}
}
resource "aws_subnet" "data_subnet" {
# data.リソースタイプ.変数名で使用する
vpc_id = data.aws_vpc.existing_vpc.id
cidr_block = "10.0.0.0/24"
tags = {
Name = "handson-subnet"
}
}
teraformブロック → terraform本体・プロバイダのバージョン指定・バックエンドの保存場所・ロックの有無を指定する
-
required_version引数は、terraform本体のバージョンを指定する
terraform {
required_version = "1.9.8"
}
-
required_providersブロックは、プロバイダのバージョンを指定する
(以下はAWSプロバイダの例)
terraform {
required_providers {
aws = {
source = "hashicorp/aws"
version = "~> 5.0"
}
}
}
-
バックエンド →
.tfstateファイルをどこに保存するかを指定する-
ローカルバックエンド → ローカルで
.tfstateファイルを保持する -
リモートバックエンド → オブジェクトストレージで
.tfstateファイルを保持する
-
ローカルバックエンド → ローカルで
(以下はS3をリモートバックエンドとして利用する例)
terraform {
backend "s3" {
# ↓ バケット名
bucket = "s3-bucket-name"
# ↓ 保存したいファイル名
key = "test/terraform.tfstate"
region = "ap-northeast-1"
# ロック有無の設定(複数のクライアントから同時にapplyされることを防ぐため)
use_lockfile = true
}
}
TerraformからAWSにアクセスする
-
IAMユーザのアクセスキー・シークレットアクセスキーを発行 - 発行したキーを環境変数に設定
-
アクセスキー →
AWS_ACCESS_KEY_ID -
シークレットアクセスキー →
AWS_SECRET_ACCESS_KEY
-
アクセスキー →
