# Terraformにおける`locals`と`variables`の使い分けによるコード整理

## 目次
1. はじめに
2. Terraformの`variables`とは
3. `locals`とは
4. `variables`と`locals`の使い分け
   1. プロジェクトのスケールに応じた選択
   2. 保守性の考慮
5. コード例による具体的な使い分け
6. よくある質問
7. まとめ

## 1. はじめに
Terraformはインフラストラクチャをコードで管理するための強力なツールです。大規模な管理を行う際には、コードを整理し、プロジェクトの保守性を向上させるために、`locals`（ローカル変数）と`variables`（変数）を効果的に使い分けることが重要です。本記事では、`locals`と`variables`の違いを解説し、それぞれをどのように使い分けるべきかを詳しく見ていきます。

## 2. Terraformの`variables`とは
`variables`はTerraformの入力パラメータとして使用されます。これらは、Terraformの設定を柔軟にし、同じ構造で異なる環境や設定で再利用できるように設計されています。通常、`variables`はユーザー入力を受け取る方法として用いられ、プロジェクトの初期設定で指定されます。

**例:**
![img](/mosaic-code.jpg)

## 3. `locals`とは
`locals`は、Terraformの設定内で一定の値を共有するための一時的な変数です。`locals`は一度に複数の場所で使用される共通の値を定義する時に便利で、ステートへの影響なくロジックを明確化する手段となります。

**例:**
![img](/mosaic-code.jpg)

## 4. `variables`と`locals`の使い分け

### 4-1. プロジェクトのスケールに応じた選択
- **小規模プロジェクトやスクリプト**: `locals`を使うことが多いです。これは複数のリソースやモジュール間で共通の値を管理しやすくするためです。

- **中規模から大規模プロジェクト**: `variables`を用いて設定を柔軟にし、環境ごとの差異を管理します。一般的に、チーム開発やCI/CDパイプラインと統合する場合に重宝されます。

### 4-2. 保守性の考慮
- **`variables`**: 入力として外部から受け取るデータを管理しやすくします。ユーザー設定が多い箇所や、再利用性の高いコンポーネントで有用です。
  
- **`locals`**: 計算された値や一定の設定を短く明確にするのに最適です。特にコードの途中で複数回使用される定数には効果的です。

## 5. コード例による具体的な使い分け
以下のコード例では、`variables`と`locals`の両方を活用し、AWSインスタンスをデプロイしています。

![img](/mosaic-code.jpg)

### 説明
- **`variable "region"`**: デプロイ先のAWSリージョンを定義。
- **`locals.common_tags`**: 各リソースに一様にタグ付けされる共通設定を定義。
- **`locals.instance_count`**: 環境に応じてインスタンスの数を動的に変更。

## 6. よくある質問
**Q1: `locals`を使用することのメリットは何ですか？**

A1: コードブロック内での重複を避け、一貫した設定を各リソースで使用できるため、コードの可読性と保守性が向上します。

**Q2: `variables`をどのように活用すれば良いですか？**

A2: `variables`は、特に異なる環境で動作する必要がある設定や、外部から受け取るべきデータに対して使用するべきです。これにより、簡単に設定を変更したり、CI/CDパイプラインで統合できます。

## 7. まとめ
`variables`と`locals`を適切に活用することで、Terraformコードの保守性と見通しが良くなります。開発規模や用途に応じて慎重に使い分けることが、プロジェクトの成功につながります。特に大規模プロジェクトでは、変更の容易さや再利用性が重要であり、これらを組み合わせて効率的にコードを構築することが求められます。

エンジニアの皆さんも、コードの最適化を進める中で、`locals`と`variables`を有効に活用し、効率的なインフラストラクチャ管理を目指してください。 [cv:issue_marketplace_engineer]

# Terraformにおける`locals`と`variables`の使い分けによるコード整理

## 目次
1. はじめに
2. Terraformの`variables`とは
3. `locals`とは
4. `variables`と`locals`の使い分け
   1. プロジェクトのスケールに応じた選択
   2. 保守性の考慮
5. コード例による具体的な使い分け
6. よくある質問
7. まとめ

## 1. はじめに
Terraformはインフラストラクチャをコードで管理するための強力なツールです。大規模な管理を行う際には、コードを整理し、プロジェクトの保守性を向上させるために、`locals`（ローカル変数）と`variables`（変数）を効果的に使い分けることが重要です。本記事では、`locals`と`variables`の違いを解説し、それぞれをどのように使い分けるべきかを詳しく見ていきます。

## 2. Terraformの`variables`とは
`variables`はTerraformの入力パラメータとして使用されます。これらは、Terraformの設定を柔軟にし、同じ構造で異なる環境や設定で再利用できるように設計されています。通常、`variables`はユーザー入力を受け取る方法として用いられ、プロジェクトの初期設定で指定されます。

**例:**
```hcl
variable "instance_type" {
  description = "Type of instance to use"
  type        = string
  default     = "t2.micro"
}
```

## 3. `locals`とは
`locals`は、Terraformの設定内で一定の値を共有するための一時的な変数です。`locals`は一度に複数の場所で使用される共通の値を定義する時に便利で、ステートへの影響なくロジックを明確化する手段となります。

**例:**
```hcl
locals {
  common_tags = {
    Project     = "MyProject"
    Environment = "Production"
  }
}
```

## 4. `variables`と`locals`の使い分け

### 4-1. プロジェクトのスケールに応じた選択
- **小規模プロジェクトやスクリプト**: `locals`を使うことが多いです。これは複数のリソースやモジュール間で共通の値を管理しやすくするためです。

- **中規模から大規模プロジェクト**: `variables`を用いて設定を柔軟にし、環境ごとの差異を管理します。一般的に、チーム開発やCI/CDパイプラインと統合する場合に重宝されます。

### 4-2. 保守性の考慮
- **`variables`**: 入力として外部から受け取るデータを管理しやすくします。ユーザー設定が多い箇所や、再利用性の高いコンポーネントで有用です。
  
- **`locals`**: 計算された値や一定の設定を短く明確にするのに最適です。特にコードの途中で複数回使用される定数には効果的です。

## 5. コード例による具体的な使い分け
以下のコード例では、`variables`と`locals`の両方を活用し、AWSインスタンスをデプロイしています。

```hcl
variable "region" {
  description = "The AWS region to deploy in"
  type        = string
  default     = "us-east-1"
}

locals {
  common_tags = {
    Owner       = "TeamA"
    Deployed_by = "Terraform"
  }

  instance_count = var.environment == "prod" ? 5 : 2
}

resource "aws_instance" "example" {
  count         = local.instance_count
  ami           = "ami-a1b2c3d4"
  instance_type = var.instance_type

  tags = merge(local.common_tags, {
    Name = "example-${count.index}"
  })
}
```

### 説明
- **`variable "region"`**: デプロイ先のAWSリージョンを定義。
- **`locals.common_tags`**: 各リソースに一様にタグ付けされる共通設定を定義。
- **`locals.instance_count`**: 環境に応じてインスタンスの数を動的に変更。

## 6. よくある質問
**Q1: `locals`を使用することのメリットは何ですか？**

A1: コードブロック内での重複を避け、一貫した設定を各リソースで使用できるため、コードの可読性と保守性が向上します。

**Q2: `variables`をどのように活用すれば良いですか？**

A2: `variables`は、特に異なる環境で動作する必要がある設定や、外部から受け取るべきデータに対して使用するべきです。これにより、簡単に設定を変更したり、CI/CDパイプラインで統合できます。

## 7. まとめ
`variables`と`locals`を適切に活用することで、Terraformコードの保守性と見通しが良くなります。開発規模や用途に応じて慎重に使い分けることが、プロジェクトの成功につながります。特に大規模プロジェクトでは、変更の容易さや再利用性が重要であり、これらを組み合わせて効率的にコードを構築することが求められます。

エンジニアの皆さんも、コードの最適化を進める中で、`locals`と`variables`を有効に活用し、効率的なインフラストラクチャ管理を目指してください。 

Terraformにおけるlocalsとvariablesの使い分けによるコード整理

目次

続きを読むには単価診断を受けてください（30秒）

Terraformにおける`locals`と`variables`の使い分けによるコード整理