terraform.tfstateをAzureストレージアカウント(Blobコンテナー)に保管 2021-07-04 Azure , Terraform
今回はマイクロソフト社のチュートリアルを参考にterraform.tfstateをAzureストレージアカウント(Blobコンテナー)に保管する設定をやってみました。
Terraformはterraform.tfstateファイルで構成情報を管理しています。
terraform.tfstateをAzure ストレージに保管する事で、ユーザー間でTerraformが管理する構成情報を共有する事が出来ます。
Terraform関連の記事はこちらに記載しております。
Terraformの記事一覧
terraform.tfstateをAzureストレージアカウントに保存 ストレージアカウントを作成 事前準備としてterraform.tfstateを保管する為のストレージアカウントを作成します。サンプル
※今回は検証用なのでアクセス制限等は実施していません。実環境ではアクセス元のIP制限など十分にセキュリティにご留意ください。
ストレージアカウント作成
作成条件
リソースグループ名は、terraformtest01とする
ストレージアカウント名は、tstate＋ランダムの数字
Blobコンテナー名はtstateとする
ロケーションはeastus2(米国東部2)とする
echoコマンドでストレージアカウント名やアクセスキーを出力する。
Azure CLI(Linux環境で実行)
#!/bin/bash RESOURCE_GROUP_NAME=terraformtest01 STORAGE_ACCOUNT_NAME=tstate$RANDOM CONTAINER_NAME=tstate # Create resource group az group create –name $RESOURCE_GROUP_NAME –location eastus2 # Create storage account az storage account create –resource-group $RESOURCE_GROUP_NAME –name $STORAGE_ACCOUNT_NAME –sku Standard_LRS –encryption-services blob # Get storage account key ACCOUNT_KEY=$(az storage account keys list –resource-group $RESOURCE_GROUP_NAME –account-name $STORAGE_ACCOUNT_NAME –query '[0].value’ -o tsv) # Create blob container az storage container create –name $CONTAINER_NAME –account-name $STORAGE_ACCOUNT_NAME –account-key $ACCOUNT_KEY echo “storage_account_name: $STORAGE_ACCOUNT_NAME" echo “container_name: $CONTAINER_NAME" echo “access_key: $ACCOUNT_KEY “
作成後にAzure Portalで確認してみます。リソースグループやストレージアカウント(コンテナー含む)が作成されている事が確認出来ます。
作成後メッセージ
storage_account_name: tstate9158
Azure Portalで確認した結果
main.tfファイルにBlobコンテナーの情報を記載 こちら で利用したファイルを参照しながら進めます。
main.tfにバックエンドの情報を記載します。terraformブロックに記載します。チュートリアル
指定内容
ストレージアカウントのリソースグループ名
ストレージアカウント名
BLOBコンテナー名
保管するtfstateファイル名
アクセスキー
※事前に認証を行っている環境だとAccess Keyを記載しなくても大丈夫そうです。マイクロソフト公式サイト
設定ファイルを編集
作成条件
バックエンドに利用するストレージアカウントやBlobコンテナーは作成したものを利用。
Access Keyを利用してストレージアカウントへアクセス。
アクセスキーはストレージアカウント作成時に取得したものを利用。
元々のmain.tfファイルにbackend “azurerm"{}(オレンジ部分)を追加。
【main.tf】
terraform { required_providers { azurerm = { source = “hashicorp/azurerm" version = “=2.46.0" } } backend “azurerm" { resource_group_name = “terraformtest01" storage_account_name = “tstate9158" container_name = “tstate" key = “terraform.tfstate" access_key = “ji0/0qhk9xSphFHl(~中略~)N==" } }
terraformブロック変更後にterraform initを実行 ファイル設定変更後にterraform initを実行します。今回はすでにローカルにterraform.tfstateが存在する前提になります。
terraform init
バックエンドの情報を変更しましたので、再度terraform initを実行する必要があります。
PS C:\terraform>
terraform init
Initializing the backend… ╷ │ Error: Backend configuration changed │ │ A change in the backend configuration has been detected, which may require migrating existing state. │ │ If you wish to attempt automatic migration of the state, use “terraform init -migrate-state". │ If you wish to store the current configuration with no changes to the state, use “terraform init -reconfigure"
エラーになります。ローカルにterraform.tfstateが存在しておりその扱いを指定する必要があります。こちら
terraform init -migrate-stateを実行してみます。
PS C:\terraform> terraform init -migrate-state
Initializing the backend… Backend configuration changed!
Terraform has detected that the configuration specified for the backend has changed. Terraform will now check for existing state in the backends.
Successfully configured the backend “azurerm"! Terraform will automatically use this backend unless the backend configuration changes.
Initializing provider plugins… – Reusing previous version of hashicorp/azurerm from the dependency lock file – Using previously-installed hashicorp/azurerm v2.46.0
Terraform has been successfully initialized!
You may now begin working with Terraform. Try running “terraform plan" to see any changes that are required for your infrastructure. All Terraform commands should now work.
If you ever set or change modules or backend configuration for Terraform, rerun this command to reinitialize your working directory. If you forget, other commands will detect it and remind you to do so if necessary.
今度は成功した事が分かりました。
実際にAzure Portalでファイルを確認してみます。コンテナー内にterraform.tfstateファイルが生成されている事が分かります。
terraform applyを実行しterraform.tfstateロック状態を確認 terraform applyを実行した際のロック状態を確認してみます。
terraform apply
terraform applyを実行してみます。メッセージを見ますと一番最初にstateがロックされている事が分かります。(plan時も同様にロックされています。)
PS C:\terraform> terraform apply
Acquiring state lock. This may take a few moments…
Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols: + create
Terraform will perform the following actions:
apply中にファイルのステータスを確認するとロック状態になっている事が確認出来ます。
terraformapply実行後にterraform.tfstateの内容を確認 terraform apply前後のterraform.tfstateを確認し更新されている事を見てみます。
terraform.tfstateの比較
terraform apply実行前
{
“version": 4,
(~中略~
{
(～以下略～) 【】
最後に terraformブロックのbackendを使う事で、terraform.tfstateファイルをAzureストレージアカウントに保管する事出来ました。
今後もTerraformについて色々試したいと思います。Terraform関連の記事はこちらに記載しております。
Terraformの記事一覧
