Infrastructure as Code (IaC) とは、機械が読み取れる定義ファイルを使ってクラウドや IT のリソースを管理、プロビジョニングするプロセスで、最新の継続的インテグレーション パイプラインの一部です。IaC を使うと、組織は最新の DevOps ツールでコンピューティング リソースのプロビジョニング、管理、破棄を行えます。IaC では、こうしたリソースをコードで静的に定義、宣言し、そのコードを通じてリソースをデプロイして動的に維持します。
最近、開発者と話していて、IaC を知らない人や、知ってはいても導入の手間が大きすぎて最初の取り組みを断念した人が多いことに気づきました。この記事では、IaC への移行が少しでも楽になるよう、IaC の利点と現在利用できるツールの選択肢を説明し、その使い方を簡単に紹介します。取り上げるのは、特に広く使われている 2 つの IaC ツール、HashiCorp の Terraform と Pulumi です。
前提条件
始める前に、以下を用意してください。
- 課金が有効になっている Google Cloud アカウント
- Compute Engine API が有効になっている Google Cloud プロジェクト
- ローカルにインストールされた Google Cloud CLI
- ローカルにインストールされた Docker
- ローカルにインストールされた Git
このチュートリアルで使う仮想マシン (VM) は、us-central1 リージョンの e2-micro で、10 GB の標準ディスクを備えています。この構成は Compute Engine の無料枠に収まります。また、Google Cloud の新規ユーザーは、90 日間使える 300 ドル分のクレジットを利用できます。
プロジェクトで Compute Engine API を有効にするには、<your-project-id> を自分のプロジェクト ID に置き換えて、次のコマンドを実行します。
gcloud services enable compute.googleapis.com --project <your-project-id>
アプリケーションのデフォルト認証情報でサインインする
Terraform と Pulumi がプロジェクトにリソースを作成するには、Google Cloud の認証情報が必要です。ローカル開発では、Google はサービス アカウント キーをダウンロードする代わりに、アプリケーションのデフォルト認証情報 (ADC) を使うことを推奨しています。また、現在では多くの組織がサービス アカウント キーの作成をデフォルトでブロックしています。
ADC ファイルを作成するには、次のコマンドを実行し、開いたブラウザー ウィンドウで Google アカウントにサインインします。
gcloud auth application-default login
認証情報は ~/.config/gcloud/application_default_credentials.json に保存されます。後でこのディレクトリを IaC101 コンテナーと共有し、Terraform と Pulumi が認証情報を使えるようにします。
IaC101 Docker イメージをビルドする
IaC101 Docker イメージには、Terraform と Pulumi の CLI ツールと、それぞれのツールのサンプル コードが含まれています。Intel プロセッサーと Apple シリコンのどちらのマシンでもネイティブに実行できるよう、イメージはサンプル リポジトリからビルドします。
ターミナルで、リポジトリのクローンを作成してイメージをビルドします。
git clone https://github.com/CIRCLECI-GWP/infrastructure-as-code101.git
cd infrastructure-as-code101
docker build -t iac101 .
docker images を実行すると、ビルドを確認できます。結果に iac101 イメージが表示されるはずです。
IaC101 コンテナーを実行する
次に、iac101 イメージから新しい Docker コンテナーを作成します。このコマンドは、IaC ツールが ADC ファイルを見つけられるよう、ローカルの ~/.config/gcloud/ ディレクトリを読み取り専用でコンテナーにマウントします。また、GOOGLE_CLOUD_PROJECT も設定します。Terraform と Pulumi はどちらもこの変数を読み取って、リソースを作成するプロジェクトを判断します。
<your-project-id> を自分のプロジェクト ID に置き換えて、次のコマンドを実行します。
docker run -it --name iac101 \
-v "$HOME/.config/gcloud:/root/.config/gcloud:ro" \
-e GOOGLE_CLOUD_PROJECT=<your-project-id> \
iac101
Windows では、gcloud の設定ディレクトリは ~/.config/gcloud ではなく %APPDATA%\gcloud です。
IaC101 コンテナーが実行中
前述の docker run コマンドを実行すると、IaC101 コンテナーが起動し、ターミナル シェルは実行中のコンテナーの中に切り替わります。これ以降、手動で exit してコンテナーを終了するまで、ターミナル シェルで実行するコマンドはすべて Docker コンテナー内で実行されます。コンテナー内のプロジェクト ファイルの構成は次のとおりです。
project/
|_ terraform/gcp/compute/ # Contains the Terraform code files
|_ pulumi/gcp/compute/ # Contains the Pulumi code files
途中でコンテナーを終了した場合は、docker start -ai iac101 を実行するとコンテナーに戻れます。Terraform と Pulumi の状態はコンテナー内に保存されるため、作成したリソースを破棄するときも同じコンテナーを使ってください。
HashiCorp Terraform
HashiCorp Terraform は、インフラストラクチャを安全かつ効率的に構築、変更、バージョン管理するためのツールです。Terraform は、既存のサービス プロバイダーだけでなく、社内のカスタム ソリューションも管理できます。Terraform 1.6 以降は、Business Source License (BSL 1.1) のもとでソースが公開されています。オープンソース ライセンスを希望する場合は、Terraform のコミュニティ フォークである OpenTofu を使えます。このチュートリアルのコマンドは、terraform の代わりに tofu を使っても同じように動作します。
設定ファイルには、単一のアプリケーションからデータセンター全体まで、Terraform で実行するために必要なコンポーネントを記述します。Terraform は、目的の状態に到達するために何を行うかを示す実行計画を生成し、それを実行して記述どおりのインフラストラクチャを構築します。設定が変更されると、Terraform は何が変わったかを判断し、適用可能な差分の実行計画を作成できます。
Terraform で管理できるインフラストラクチャには、コンピューティング インスタンス、ストレージ、ネットワークなどの低レベルのコンポーネントから、DNS エントリや SaaS の機能などの高レベルのコンポーネントまで含まれます。
Terraform でインフラストラクチャをプロビジョニングする
まずは、Terraform のコードを使って Google Cloud にいくつかのリソースをプロビジョニングしましょう。terraform/gcp/compute/ ディレクトリにある main.tf ファイルが、インフラストラクチャを定義したコードです。このファイルでは、Docker コンテナーにパッケージ化されたサンプル Web アプリを実行する Compute Engine VM を新しく作成します。また、チュートリアルがプロジェクトのデフォルト ネットワークに依存しないよう、VM 専用の VPC ネットワークと、ポート 8080 でアプリへのパブリック アクセスを許可するファイアウォール ルールも作成します。
VM は、Docker がインストール済みの Google の Container-Optimized OS から起動します。startup.sh のスタートアップ スクリプトが、VM の起動のたびにアプリのコンテナーを起動します。
#!/bin/bash
# Runs at every boot on Container-Optimized OS: starts the sample web app on port 8080.
CONTAINER_NAME="hello-app"
IMAGE="us-docker.pkg.dev/google-samples/containers/gke/hello-app:2.0"
iptables -w -A INPUT -p tcp --dport 8080 -j ACCEPT
docker stop "$CONTAINER_NAME" || true
docker rm "$CONTAINER_NAME" || true
docker run --detach --restart=always --name="$CONTAINER_NAME" -p 8080:8080 "$IMAGE"
以前のコンテナー スタートアップ エージェントが非推奨になったため、現在 Google はスタートアップ スクリプトでコンテナーを実行する方法を推奨しています。main.tf では、VM リソースが cos-stable イメージ ファミリーを指定し、スタートアップ スクリプトを渡しています。
resource "google_compute_instance" "app" {
name = "iac101-terraform"
machine_type = "e2-micro"
tags = ["iac101-terraform"]
boot_disk {
initialize_params {
image = "cos-cloud/cos-stable"
size = 10
type = "pd-standard"
}
}
network_interface {
subnetwork = google_compute_subnetwork.app.id
access_config {
# Ephemeral public IP
}
}
metadata_startup_script = file("${path.module}/startup.sh")
}
これをプロビジョニングするには、ターミナルで次のコマンドを実行します。
cd ~/project/terraform/gcp/compute/
Terraform を初期化する
~/project/terraform/gcp/compute/ で次のコマンドを実行します。
terraform init
次のような結果が表示されます。
Initializing the backend...
Initializing provider plugins...
- Reusing version 8.8.1 of hashicorp/google from the dependency lock file
- Installing hashicorp/google v8.8.1...
- Installed hashicorp/google v8.8.1 (signed by HashiCorp)
Terraform has been successfully initialized!
Terraform でプレビューする
Terraform には、実際には何も実行せずに Terraform のコードのドライランと検証を行うコマンドがあります。terraform plan というコマンドで、Terraform が既存のインフラストラクチャに対して実行するすべてのアクションと変更も示します。ターミナルで次を実行します。
terraform plan
次のような結果が表示されます (ここでは一部を省略し、省略した行を ... で示しています)。
Terraform will perform the following actions:
# google_compute_firewall.allow_app will be created
+ resource "google_compute_firewall" "allow_app" {
+ name = "iac101-terraform-allow-8080"
+ network = "iac101-terraform"
+ source_ranges = [
+ "0.0.0.0/0",
]
+ target_tags = [
+ "iac101-terraform",
]
...
}
# google_compute_instance.app will be created
+ resource "google_compute_instance" "app" {
+ machine_type = "e2-micro"
+ name = "iac101-terraform"
+ zone = "us-central1-a"
...
}
# google_compute_network.app will be created
...
# google_compute_subnetwork.app will be created
...
Plan: 4 to add, 0 to change, 0 to destroy.
Changes to Outputs:
+ app_url = (known after apply)
+ public_ip = (known after apply)
このように、Terraform は main.tf ファイルのコードに基づいて、新しい Google Cloud リソースを作成しようとしています。
Terraform apply
これで、新しいインフラストラクチャを作成してアプリケーションをデプロイする準備が整いました。ターミナルで次のコマンドを実行します。
terraform apply
Terraform からコマンドの確認を求められます。yes と入力して Enter キーを押します。
Do you want to perform these actions?
Terraform will perform the actions described above.
Only 'yes' will be accepted to approve.
Enter a value: yes
Terraform がインフラストラクチャを構築し、完了するとすぐに Google Cloud 上でアプリケーションが稼働します。ただし、Terraform の完了後、VM が起動してアプリのコンテナー イメージをプルするまで、アプリケーションがオンラインになるには 1、2 分かかることがあります。
完了すると、次のような結果が表示されます (ここでは一部を省略しています)。
google_compute_network.app: Creation complete after 53s
google_compute_firewall.allow_app: Creation complete after 11s
google_compute_subnetwork.app: Creation complete after 32s
google_compute_instance.app: Creation complete after 18s
Apply complete! Resources: 4 added, 0 changed, 0 destroyed.
Outputs:
app_url = "http://136.80.19.220:8080"
public_ip = "136.80.19.220"
app_url の値が、アプリが実行されているアドレスです。ブラウザーで開くか、ローカルのターミナルからこのアドレスに curl を実行すると、Google Cloud 上で実行中のアプリを確認できます。
$ curl http://136.80.19.220:8080
Hello, world!
Version: 2.0.0
Hostname: 9333c39d2637
Terraform destroy
Compute Engine VM とアプリケーションが動作することを確認できたので、terraform destroy コマンドを実行し、確認を求められたら yes と入力して、このチュートリアルで作成したリソースを破棄します。リソースを実行したままにしておくこともできますが、無料枠を超えて Google Cloud で実行されているリソースの費用は自己負担になることに注意してください。どうするかはお任せしますが、terraform destroy を実行すれば、実行中のリソースはすべて終了します。
次は、Pulumi を使ってインフラストラクチャをプロビジョニングする方法を紹介します。
Pulumi SDK
Pulumi SDK は、クラウド アプリと IaC を定義、デプロイするためのオープンソース フレームワークです。Pulumi を使うと、開発者は TypeScript、JavaScript、Python、Go など好みの言語でコードを書けます。そのため、別の YAML や DSL の方言を覚えることなく、クラウド アプリケーションとインフラストラクチャに最新のアプローチを取り入れられます。抽象化や再利用が可能になるほか、使い慣れた IDE、リファクタリング ツール、テスト ツールも活用できます。1 つのツールチェーンとフレームワーク群を習得すれば、AWS、Azure、GCP、Kubernetes のどのクラウドにも簡単に対応できます。
Pulumi でインフラストラクチャをプロビジョニングする
Terraform でのインフラストラクチャの構築を体験したので、次は Pulumi で新しいインフラストラクチャをプロビジョニングしてデプロイする方法を学びます。Pulumi の例では、Pulumi のコードとツールを使って、Terraform の例と同じ種類の Google Cloud リソースを作成します。Pulumi ではプログラミング言語でインフラストラクチャを定義できるため、柔軟性が大きく高まります。この例では、言語として Python を使います。~/project/pulumi/gcp/compute/ ディレクトリにある __main__.py ファイルで、インフラストラクチャを定義しています。VM リソースは次のとおりです。
instance = gcp.compute.Instance(
"iac101-pulumi",
machine_type="e2-micro",
tags=[VM_TAG],
boot_disk={
"initialize_params": {
"image": "cos-cloud/cos-stable",
"size": 10,
"type": "pd-standard",
},
},
network_interfaces=[
{
"subnetwork": subnet.id,
"access_configs": [{}], # Ephemeral public IP
}
],
metadata_startup_script=startup_script,
)
これは Terraform の例と同じ VM を、Python のオブジェクトとして記述したものです。同じ startup.sh スクリプトのコピーを使い、プログラムは独自の VPC ネットワーク、サブネット、ファイアウォール ルールも作成します。
Pulumi の例は ~/project/pulumi/gcp/compute/ ディレクトリにあります。次のコマンドを実行して、Pulumi の例のディレクトリに移動します。
cd ~/project/pulumi/gcp/compute/
Pulumi プロジェクトを設定する
Pulumi は、インフラストラクチャの状態をバックエンドで管理します。このチュートリアルを単独で完結させるため、ここではローカル バックエンドを使います。ローカル バックエンドは状態をコンテナー内のディレクトリに保存するため、Pulumi アカウントは必要ありません。状態を Pulumi Cloud に保存したい場合は、pulumi login を実行して画面の指示に従ってください。
ターミナルで次のコマンドを実行して、ローカル バックエンドにログインし、パスフレーズを設定します。Pulumi はこのパスフレーズを使って、スタック設定内のシークレットを暗号化します。
pulumi login --local
export PULUMI_CONFIG_PASSPHRASE="<choose-a-passphrase>"
IaC の仕様を Python で定義しているため、Pulumi Python SDK の依存関係をインストールする必要があります。pulumi install コマンドは、プロジェクト ディレクトリに Python の仮想環境を作成し、requirements.txt に記載されたパッケージをインストールします。
pulumi install
最後に、dev という名前のスタックを作成します。スタックとは、開発環境や本番環境など、Pulumi プログラムの独立したインスタンスです。
pulumi stack init dev
Pulumi でプレビューする
Pulumi には、pulumi preview というドライラン コマンドがあります。このコマンドは、既存の状態ファイルで状態が表される既存のスタックに対する更新のプレビューを表示します。新しい目的の状態は、Pulumi プログラムを実行し、その結果のオブジェクト グラフからすべてのリソース割り当てを抽出して算出されます。次に、これらの割り当てを既存の状態と比較して、目的の状態を実現するために必要な操作を判断します。スタックに実際の変更は加えられません。
ターミナルで次のコマンドを実行します。
pulumi preview
次のような結果が表示されます。
Previewing update (dev):
+ pulumi:pulumi:Stack compute-dev create
+ gcp:compute:Network iac101-pulumi create
+ gcp:compute:Subnetwork iac101-pulumi create
+ gcp:compute:Firewall allow-8080 create
+ gcp:compute:Instance iac101-pulumi create
Outputs:
app_url : [unknown]
public_ip: [unknown]
Resources:
+ 5 to create
Pulumi up
Pulumi のコードを実行するには、pulumi up コマンドを使います。このコマンドは、スタック内のリソースを作成または更新します。対象スタックの新しい目標状態は、現在の Pulumi プログラムを実行し、すべてのリソース割り当てを観察してリソース グラフを作成することで算出されます。次に、この目標状態を既存の状態と比較し、目標状態を最小限の影響で実現するために必要な作成、読み取り、更新、削除の操作を判断します。その後、このコマンドはスタックの新しい状態の完全なトランザクション スナップショットを記録し、後で再びスタックを差分更新できるようにします。
ターミナルで次を実行します。
pulumi up
yes オプションを選択して Enter キーを押します。Pulumi アプリが実行され、まもなく Google Cloud 上でアプリケーションを実行するサーバーが完成します。次のような結果が表示されます。
Updating (dev):
+ gcp:compute:Network iac101-pulumi created (21s)
+ gcp:compute:Subnetwork iac101-pulumi created (11s)
+ gcp:compute:Firewall allow-8080 created (11s)
+ gcp:compute:Instance iac101-pulumi created (27s)
+ pulumi:pulumi:Stack compute-dev created (62s)
Outputs:
app_url : "http://136.80.19.220:8080"
public_ip: "136.80.19.220"
Resources:
+ 5 created
Duration: 1m3s
結果に app_url という出力があります。この値は、ポート 8080 で公開されているアプリケーションのアドレスです。前の Terraform の例と同じように、ブラウザーでアプリケーションにアクセスできます。VM がすべてをオンラインにするまで 1、2 分かかることを忘れないでください。
Pulumi destroy
Pulumi には、すべてのクラウド リソースを終了する pulumi destroy というコマンドがあります。このコマンドは、既存のスタック内のリソースをすべて削除します。現在の状態は、バックエンドにあるスタックの状態から読み込まれます。完了すると、このスタックのリソースはすべて削除されますが、スタック自体は残るため、再びデプロイできます。
ターミナルで pulumi destroy を実行し、作成した Google Cloud リソースを完全に破棄するかどうかを確認されたら、yes オプションを選択します。
両方の例が終わったら、exit を実行してコンテナーを終了します。その後、docker rm iac101 でコンテナーを削除できます。
まとめ
おめでとうございます。これで、最新の IaC ツールである Terraform と Pulumi を使って、Google Cloud にインフラストラクチャをプロビジョニングし、アプリケーションをデプロイする経験を積めました。サンプル リポジトリには、両方の例のテストも含まれています。テストはモック プロバイダーを使うため認証情報なしで実行でき、コミットのたびにテストを実行する CircleCI の設定も用意されています。さらに知識を広げるには、以下のリソースが役立ちます。