Terraform state
Concept
Terraform が管理するインフラストラクチャの記録で、構成内のリソースを実際のリモートオブジェクトに対応付けます。Terraform はこれを使って行うべき変更を判断します。機密性の高い値を含む場合があるため、リモートでロックされ、アクセス制御されたバックエンドに保管するのが望ましいとされています。
よく一緒に取り上げられるテーマ
Terraform stateに関するエピソードでは、Amazon Web Services (AWS)もよく取り上げられます。
Description
Terraform の state は、Terraform が管理するインフラストラクチャについて Terraform 自身が保持する記録です。構成内で定義されたリソースを、クラウド環境に実際に存在するリモートオブジェクトに対応付けます。Terraform はこの記録を読み取り、どの変更を行うかを判断します。どのリソースを追加し、どれを更新し、どれを削除するかを決めます。state は Terraform が管理するすべての対象についての信頼できる情報源として機能するため、その保存方法と保護方法はデプロイの安全性に直接影響します。
実際には、state は state ファイルに保持されます。M365.FM のエピソード「Terraform vs Azure Bicep: Which IaC Tool Should You Choose?」では、Terraform がインフラストラクチャの現在の状態を追跡するために state ファイルに依存していると説明されています。また、state 管理は慎重に扱い、デプロイを妨げる問題を避ける必要があると強調しています。同じエピソードでは、state ファイルはローカルにもリモートにも保存でき、リモートの選択肢にはクラウドバケットなどの類似のストレージが含まれると述べています。ローカルとリモートのどちらに保存するかは、Terraform の state に関する中心的な判断の一つです。
Azure Storage に Terraform の state を保存する方法について説明した Microsoft Learn のドキュメントは、その選択がなぜ重要なのかを説明しています。デフォルトでは、Terraform は state をローカルに保存します。このドキュメントは、これがチームでの利用には不向きだと述べています。理由は、ファイルに平文のシークレットを含むなど機密情報が露出するおそれがあることと、誤って削除されるリスクが高いことです。推奨されるのは、azurerm バックエンドを通じて、state を Azure Storage の Blob コンテナーにリモートで保持する方法です。このバックエンドは、ストレージアカウント名、コンテナー名、そして state ファイルを指定するキーで構成します。
このドキュメントでは、そのストレージへのアクセスの扱い方についても説明しています。アクセスキーは、ディスクに書き込むのではなく環境変数で渡すのが望ましく、Key Vault に保存することもできます。Azure Blob Storage は書き込み操作の前に state を自動的にロックするため、同時変更による破損を防ぎ、データは保存時に暗号化されます。ドキュメントの例ではアクセスキーとオープンなネットワークアクセスを使用していますが、ページではこれは本番環境には適さないと明記されています。本番環境では、ファイアウォール、サービスエンドポイント、またはプライベートエンドポイントを使用し、サポートされている最も安全な認証方法と組み合わせるよう案内しています。
state が話題になる典型的な場面には、チームでの共同作業、パイプラインによるデプロイ、計画された変更のレビューなどがあります。エピソード「Azure Infrastructure as Code and DevOps with Maik van der Gaag [MVP]」では、リソースの現在の状態を追跡し、変更を安全に計画・適用するのに役立つ Terraform の state ファイルの利用に触れています。さらに、Terraform モジュールによるコードの共有、変更をマージする前のコードレビューの必須化、人的ミスのリスクを抑えて Azure 環境に確実に更新を届けるための継続的デプロイなど、他の実践も紹介しています。また、エンドツーエンドの自動化のために、Terraform を Ansible や PowerShell と組み合わせることにも言及しています。
これらの情報源を総合すると、一貫した一連の実践が見えてきます。Terraform の state は機密データとして扱い、ローカルマシンではなくリモートバックエンドに保管し、2 つの操作が同時に変更できないようロックで保護し、アクセス制御の下に置く必要があります。state に何が含まれているのか、誰またはどのプロセスがそれを読み取ったり変更したりできるのかを理解することは、Terraform を責任を持って運用するための一部です。特に、複数の担当者や自動化されたパイプラインが同じインフラストラクチャに対して作業する場合には重要です。最初のエピソードでも、Terraform と Azure Bicep を比較してインフラストラクチャ・アズ・コードを検討する際に、同様に state の扱いへの配慮が指摘されています。
Overview compiled with AI from M365.FM episodes and the facts on this page. You can improve it with the edit button below.
| Type | Concept |
|---|
Articles about Terraform state (2)
Terraform stateを扱った記事:
- Azure向けTerraformにおけるインフラストラクチャ・ドリフトの防止と修正
· Mirko Peters
Terraformとazureでインフラストラクチャ・ドリフトが発生する仕組み、緊急時のポータルでのホットフィックスがステートファイルを壊す理由、そしてドリフトを安全に検出して修正する方法を解説します。 - Preventing and Fixing Infrastructure Drift in Terraform for Azure
· Mirko Peters
Learn how infrastructure drift occurs in Terraform and Azure, how emergency portal hotfixes break state files, and how to detect and correct discrepancies safely.
Frequently asked questions
Questions marked with AI were written with AI from the facts on this page.
Terraform の state は何に使われますか? (AI)
Terraform は state を使って、構成内のリソースと実際にデプロイされたオブジェクトを対応付けます。これにより、変更を計画して適用する際に、どのリソースを追加、更新、削除すべきかを判断できます。
Terraform の state をローカルに保存すべきでないのはなぜですか? (AI)
Microsoft Learn によると、ローカルの state はチームでの利用には不向きで、ファイルに平文のシークレットが含まれる可能性があるため機密情報が露出するおそれがあり、誤削除のリスクも高くなります。推奨される代替手段はリモートバックエンドです。
Azure で Terraform の state を保存するにはどうすればよいですか? (AI)
azurerm バックエンドを使用して、Azure Storage の Blob コンテナーに state を保存できます。ストレージアカウント名、コンテナー名、state ファイル用のキーを設定します。Blob Storage は書き込み操作の前に state をロックし、保存時にデータを暗号化します。
Community wiki
Short info above, community knowledge below: add practical tips, examples or corrections. New contributions are reviewed first; trusted members publish directly.
Experts and companies for this topic
Nobody has listed this topic yet. Add it to your profile.
Sources
- developer.hashicorp.comのTerraform state developer.hashicorp.com
- Store Terraform state in Azure Storage – Microsoft Learn learn.microsoft.com
- RSSフィード: Terraform state
- Articles on this topic: 2
Maintained by Mirko Peters (Microsoft MVP) · Last updated: