GCP入門： Terraformの状態管理 -Vol.3-

今日は、Terraformでの状態管理について解説しています。

背景

下記の記事の続きになります。

実施内容

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

gcloud storage buckets update gs://blog-573 --update-labels=key-1=value-1

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

terraform refresh

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

terraform show

下記のようにラベルが追加されていることが確認できれば成功です。

% terraform show
# google_storage_bucket.test-bucket-for-state:
resource "google_storage_bucket" "test-bucket-for-state" {
    default_event_based_hold    = false
    effective_labels            = {
        "key-1" = "value-1"
    }
（省略）
}

下記のような出力になれば成功です。

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.

解説

terraform refresh

terraform refresh コマンドについて説明します。

1. 基本的な機能:
   このコマンドは、Terraformの状態ファイル（state file）を実際のインフラストラクチャの現状と同期させるために使用されます。
2. 主な目的:

• 現在のインフラストラクチャの状態を読み取り、Terraformの状態ファイルを更新します。
• 実際のリソースの状態とTerraformの状態ファイルの間の不一致を検出し、修正します。

1. 動作プロセス:
   a. 既存のTerraform状態ファイルを読み込みます。
   b. 各リソースについて、実際のインフラストラクチャの状態を確認します。
   c. 状態ファイルを更新して、実際の状態を反映させます。
2. 使用例:

   terraform refresh

5. 重要な特徴:

• このコマンドは実際のインフラストラクチャを変更しません。
• 状態ファイルのみを更新します。

5. 使用シナリオ:

• 手動でインフラストラクチャに変更を加えた後、Terraformの状態を同期させる場合。
• Terraformの状態と実際のインフラストラクチャの状態が一致しているか確認したい場合。
• terraform plan や terraform apply を実行する前に、最新の状態を把握したい場合。

5. 注意点:

• 大規模なインフラストラクチャでは、実行に時間がかかる場合があります。
• センシティブなデータが出力される可能性があるため、セキュアな環境で実行することが重要です。

5. 関連するコマンド:

• terraform plan: refresh を含むため、通常は plan の前に明示的に refresh を実行する必要はありません。
• terraform apply: このコマンドも内部で refresh を実行します。

5. ベストプラクティス:

• 重要な操作を行う前に refresh を実行し、最新の状態を確認することをおすすめします。
• CI/CDパイプラインでは、自動的に refresh を実行するよう設定することが一般的です。

このコマンドは、Terraformの状態管理において重要な役割を果たし、インフラストラクチャの一貫性を維持するのに役立ちます。

おわりに

今日は、Terraformでの状態管理について解説しました。