Terraform For Loop

Terraform is an infrastructure-as-code (IaC) tool. It is used to create and manage infrastructure resources in a declarative way. It enables the user to define the infrastructure as a code and automates creating and managing infrastructure resources. One of the most useful features of Terraform is the ability to use loops in the code to create and manage multiple resources at once. In this article, we are going to explore Terraform loops, including their syntax, examples, advantages, and disadvantages.

Terraform Loops

Terraform loops allow the user to iterate over a set of values and create multiple resources with the same configuration. There are two types of loops supported by Terraform: for_each and count.

1. For_Each Loop

The for_each loop creates multiple resources with the same configuration, each with a unique name or ID. It works by iterating over a map or set of strings, and for each item in the map or set; it creates a new resource.

Syntax

resource "resource_type" "resource_name" {
  for_each = {key1 = value1, key2 = value2, ...}
  # Resource configuration here
}

Example

variable "regions" {
  type = list(string)
  default = ["us-west-1", "us-west-2", "us-east-1"]
}
 
resource "aws_instance" "ec2" {
  for_each = toset(var.regions)
  ami = "ami-0c55b159cbfafe1f0"
  instance_type = "t2.micro"
  subnet_id = "subnet-123456"
  availability_zone = "${each.value}a"
}
 
output "instance_public_ips" {
  value = {
    for instance_id, instance in aws_instance.ec2 :
      instance.id => instance.public_ip
  }
}

Output:

Explanation

In the above example, we use a for_each loop to create an EC2 instance in each region specified in the region's variable. The for_each loop is applied to the aws_instance resource and creates an instance for each element in the regions list.

The output block uses a for expression to create a mapping of instance IDs to public IP addresses. This output is useful for debugging or verifying the instances that were created.

2. Count Loop

The count loop is used to create a fixed number of resources with the same configuration. It defines a numeric count value and creates a new resource for each count value.

Syntax:

resource "resource_type" "resource_name" {
  count = number_of_resources
  # Resource configuration here
}

Example

variable "count" {
  default = 3
}
 
resource "aws_instance" "example" {
 
count = var.count
  ami = "ami-0c55b159cbfafe1f0"
 
instance_type = "t2.micro"
}
 
output "public_ips" {
  value = [
    for instance in aws_instance.example : instance.public_ip
  ]
}
 
output "print_public_ips" {
  value = [
    for instance in aws_instance.example : "Instance ${instance.id} public IP: ${instance.public_ip}"
  ]
}

Output:

Explanation

In the above example, we take a variable called "count" with a default value of 3. Then we create multiple instances of an EC2 instance using the count loop with the specified AMI and instance type.
Next, we define two outputs with the help of the output block. The first output, "public_ips," outputs an array of the public IP addresses of the created instances. We use a for loop with the "aws_instance.example" resource to iterate over each instance and extract its public IP.
The second output, "print_public_ips," outputs an array of strings containing each instance's ID and public IP address. We use a similar for loop to iterate over each instance and create a string that combines the instance ID and public IP address.

Advantages of Terraform Loops

There is some benefit to using the terraform loop. These are as follows.

Increased efficiency: Terraform loops allow users to create multiple resources in a single code block with the same configuration. This can save time and increase efficiency when managing large numbers of resources.
Improved readability: Terraform loops can make the code more readable and easier to understand by reducing the amount of repetitive code needed to create multiple resources.
Simplified resource management: Terraform loops can simplify the process of managing resources by allowing the user to group related resources together in a single block of code.

Disadvantages of Terraform Loops

There are also some disadvantages to using the terraform loop. These are as follows.

Complexity: Terraform loops can add complexity to the code. Suppose the user is unfamiliar with the syntax and logic required to use them effectively.
Limited functionality: While Terraform loops can be powerful, they are limited in their ability to handle complex use cases. In some cases, the user may need to use a combination of loops and other Terraform features to achieve the desired outcome.
Lack of flexibility: Terraform loops are not always flexible enough to handle dynamic changes to your infrastructure. For example, if the user needs to add or remove resources from a loop, you may need to modify the loop's configuration, re-run the Terraform plan, and apply commands.

Conclusion

Terraform loops are a powerful feature that can help the user to manage the infrastructure more efficiently and effectively. Whether the user works with a small or large number of resources, Terraform loops can simplify creating and managing them. However, as with any Terraform feature, the main thing is understanding loops' syntax, logic, and limitations before using them in the code. By doing so, anyone can ensure the Terraform code is reliable, maintainable, and scalable.

Next TopicTerraform Format

← prev next →