šŸŽ‰Spacelift raises $51M Series C to redefine the future of infrastructure

āž”ļø Learn more

Terraform

Terraform For Loop – Expression Overview with Examples

Terraform for loop

šŸš€ Level Up Your Infrastructure Skills

You focus on building. We’ll keep you updated. Get curated infrastructure insights that help you make smarter decisions.

You will learn the following:

  1. What is a Terraform for loop?
  2. Types of loops in Terraform
  3. Terraform count, for_each, and for comparison
  4. Benefits of using loops in Terraform
  5. Terraform loops examples
  6. The for expression with if clause
  7. The for_each expression with if clause
  8. Nested Terraform for loops
  9. Terraform for loop with a map
  10. How do I iterate over a list in Terraform?
  11. Terraform for loop best practices

What is a Terraform for loop?

A Terraform for loop is pretty similar to a loop in any programming language. The key difference, however, is that you can use loops only when building maps or listing comprehension expressions.

TheĀ forĀ expression can be used to transform values and can be used with theĀ ifĀ clause to include or exclude expressions based on a boolean condition.

Types of loops in Terraform

Terraform count, for_each and for comparison

Below you can find the table comparison of Terraform count, for_each and for.

ConstructĀ  Ā  Type Description Use Case
Count Meta-Argument Based on a count value Resources you are provisioning are identical
For_each Meta-Argument Based on a set of input values Resources change between the different instances
For Expression Based on a set of input values Transform a value

Benefits of using loops in Terraform

One of the key benefits of using loops in Terraform is the fact that you can easily build powerful expressions that your resources can leverage. It makes your code reusable and, in the end, minimizes the amount of code you have to write to achieve the desired result. Combining for loops with ifs lets you easily reuse variables in many resources.

In a nutshell, Terraform for loops help with:

  • Code reusability
  • Dynamic configurations
  • Improved scalability
  • Easier resource management
  • Conditional creation of resources
  • Enhanced error handling
  • Support for complex data structures (such as nested lists or maps)

Terraform loops examples

Let’s take a look at some examples.

Using Terraform count

variable "storage_account_names" {
  type    = list(string)
  default = ["jackuksstr001", "jackuksstr002", "jackuksstr003"]
}

resource "azurerm_resource_group" "example" {
  name     = "storage-rg"
  location = "UK South"
}

resource "azurerm_storage_account" "my_storage" {
  count                    = length(var.storage_account_names)
  name                     = var.storage_account_names[count.index]
  resource_group_name      = azurerm_resource_group.example.name
  location                 = azurerm_resource_group.example.location
  account_tier             = "Standard"
  account_replication_type = "GRS"
}

Using Terraform for_each

The example below uses aĀ for_eachĀ loop to iterate through a list of the same storage account names and create a storage account with the name specified for each. The rest of the arguments are the same for each storage account.

The result will be the same as the example usingĀ count above.

variable "storage_account_names" {
  type    = list(string)
  default = ["jackuksstr001", "jackuksstr002", "jackuksstr003"]
}

resource "azurerm_resource_group" "example" {
  name     = "storage-rg"
  location = "UK South"
}

resource "azurerm_storage_account" "my_storage" {
  for_each                 = toset(var.storage_account_names)
  name                     = each.value
  resource_group_name      = azurerm_resource_group.example.name
  location                 = azurerm_resource_group.example.location
  account_tier             = "Standard"
  account_replication_type = "GRS"
}

Using the for expression

The example below builds on the previous one and shows how to output a list of storage account IDs from the given list. TheĀ for expression is used to iterate over theĀ storage_account_names list and retrieve the ID for each storage account instance with the corresponding name.

variable "storage_account_names" {
  type    = list(string)
  default = ["jackuksstr001", "jackuksstr002", "jackuksstr003"]
}

resource "azurerm_resource_group" "example" {
  name     = "storage-rg"
  location = "UK South"
}

resource "azurerm_storage_account" "my_storage" {
  for_each                 = toset(var.storage_account_names)
  name                     = each.value
  resource_group_name      = azurerm_resource_group.example.name
  location                 = azurerm_resource_group.example.location
  account_tier             = "Standard"
  account_replication_type = "GRS"
}

output "storage_account_names" {
  value = [
    for storage in var.storage_account_names:
    azurerm_storage_account.my_storage.example[storage].id
  ]
}

The Terraform for expression with is clause

AĀ forĀ expression can also include anĀ ifĀ clause to filter elements from the source variable, producing a value with fewer elements than the source value, and is commonly used to split lists based on a condition.

The syntax looks like the below:

[for VAR in COLLECTION: IF CONDITION_EXPRESSION: VAR]
variable "storage_account_names" {
  type    = list(string)
  default = ["jackuksstr001", "jackuksstr002", "jackuksstr003"]
}

resource "azurerm_resource_group" "example" {
  name     = "storage-rg"
  location = "UK South"
}

resource "azurerm_storage_account" "my_storage" {
  count                    = length(var.storage_account_names)
  name                     = var.storage_account_names[count.index]
  resource_group_name      = azurerm_resource_group.example.name
  location                 = azurerm_resource_group.example.location
  account_tier             = "Standard"
  account_replication_type = "GRS"
}

locals {
  grs_storage_accounts = [for sa in azurerm_storage_account.my_storage: sa if sa.account_replication_type == "GRS"]
}

output "grs_storage_account_names" {
  value = [for sa in local.grs_storage_accounts: sa.name]
}

The Terraform for_each expression with if clause

The ifĀ clause can be used to conditionally include or exclude certain expressions based on a boolean condition.

The syntax for using theĀ ifĀ clause in an expression is as follows:

${condition ? true_value : false_value}

In the example below, we use the ifĀ condition to set theĀ account_replication_typeĀ toĀ GRSĀ if theĀ environment variable is set toĀ prodĀ , if it is not, then theĀ account_replication_typeĀ will be set toĀ LRSĀ .

Because the default value for theĀ environmentĀ variable is set toĀ prod in the below example, the three storage accounts created using the for_eachĀ loop will all have theirĀ account_replication_typeset toĀ GRS.

variable "storage_account_names" {
  type    = list(string)
  default = ["jackuksstr001", "jackuksstr002", "jackuksstr003"]
}

variable "environment" {
  default = "prod"
}

resource "azurerm_resource_group" "example" {
  name     = "storage-rg"
  location = "UK South"
}

resource "azurerm_storage_account" "my_storage" {
  for_each                 = toset(var.storage_account_names)
  name                     = each.value
  resource_group_name      = azurerm_resource_group.example.name
  location                 = azurerm_resource_group.example.location
  account_tier             = "Standard"
  account_replication_type = "${var.environment == "prod" ? "GRS" : "LRS"}"
}

Nested Terraform for loops

When you are working with complex data structures, you need to use nested for loops to easily reuse configurations. DevOps engineers like to use YAML files for most of their configurations, and you can use these files as variables in Terraform, too.

Let’s take a look at an example that contains a nested YAML and how we would go for parsing that input:

instances:
 instance1:
   ami: ami1
   shape: t2-micro
   env: dev
 instance2:
   ami: ami2
   shape: t2-micro
   env: dev
 instance3:
   ami: ami1
   shape: t2-micro
   env: stage
 instance4:
   ami: ami2
   shape: t2-micro
   env: stage

In this YAML file, we have declared a couple of instances. Two of them will be used for the dev environment, and the other two will be used for the stage environment.

To read the data from the YAML file, we need to use the file function and to transform the data into a map, we will need to use the YAML decode function:

locals {
 data  = yamldecode(file("./data.yaml"))
}

Next, if we want to take only the instances that are in the dev environment and build a map with them, we will use a series of expressions:

dev   = merge([for data in local.data : { for instance_key, instance_value in data : instance_key => instance_value if instance_value.env == "dev" }]...)

Let’s break it down and forget about the merge function for now:

  • Initially, we do a for loop to enter the instance map and use a list for that (we don’t need key/value pairs at this point).
  • Next, as we also want to rebuild the data with key-value pairs, we loop using both the key and the value for each instance.
  • We rebuild the data only if the value of the environment is dev.

At this point, the dev data would look like this:

dev   = [for data in local.data : { for instance_key, instance_value in data : instance_key => instance_value if instance_value.env == "dev" }]

The value of the data would be:

dev = [
  {
    "instance1" = {
      "ami" = "ami1"
      "env" = "dev"
      "shape" = "t2-micro"
    }
    "instance2" = {
      "ami" = "ami2"
      "env" = "dev"
      "shape" = "t2-micro"
    }
  },
]

This is a list of maps and it would be hard to use in a for_each loop, so we use the merge function with an ellipsis at the end to transform this into a map:

dev = {
  "instance1" = {
    "ami" = "ami1"
    "env" = "dev"
    "shape" = "t2-micro"
  }
  "instance2" = {
    "ami" = "ami2"
    "env" = "dev"
    "shape" = "t2-micro"
  }
}

The entire setup that also shows the data is:

locals {
 data  = yamldecode(file("./data.yaml"))
 dev   = merge([for data in local.data : { for instance_key, instance_value in data : instance_key => instance_value if instance_value.env == "dev" }]...)
 stage = merge([for data in local.data : { for instance_key, instance_value in data : instance_key => instance_value if instance_value.env == "stage" }]...)

}


output "dev" {
 value = local.dev
}

output "stage" {
 value = local.stage
}

Terraform for loop with a map

As you’ve seen in the nested for loops example, you can use a loop over a map too. You can also iterate through both the keys and the values, and if you use a single iterator, it will iterate through the values. Let’s see it in action:

locals {
 pet_map = {
   cat = {
     color = "orange"
     age   = "7"
   }
   dog = {
     color = "white"
     age   = "5"
   }
 }

 pet_colors = [for pet in local.pet_map : pet.color]
}

output "pet_colors" {
 value = local.pet_colors
}


Apply complete! Resources: 0 added, 0 changed, 1 destroyed.

Outputs:

pet_colors = [
 "orange",
 "white",
]

In this example, we’ve just iterated through the values. Now, let’s also iterate through the keys, and create a list of the pets:

locals {
 pet_map = {
   cat = {
     color = "orange"
     age   = "7"
   }
   dog = {
     color = "white"
     age   = "5"
   }
 }

 pet_type = [for pet, pet_values in local.pet_map : pet]
}

output "pet_colors" {
 value = local.pet_type
}

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

Outputs:

pet_colors = [
 "cat",
 "dog",
]

Terraform for loop with a list

When iterating through lists, by using a single iterator, you will get the values one by one, and if you are using two iterators, the first one will be the index, and the other one will be the value.

Let’s take a look at an example that recreates a list with only the even numbers:

locals {
 my_numbers   = [1, 3, 5, 2, 8, 12, 33, 10]
 even_numbers = [for number in local.my_numbers : number if number % 2 == 0]
}

output "even_numbers" {
 value = local.even_numbers
}


Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

Outputs:

even_numbers = [
 2,
 8,
 12,

Now, we will create a list with the index positions for the numbers that are even:

locals {
 my_numbers   = [1, 3, 5, 2, 8, 12, 33, 10]
 even_numbers = [for index, number in local.my_numbers : index if number % 2 == 0]
}

output "even_numbers" {
 value = local.even_numbers
}

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.

Outputs:

even_numbers = [
 3,
 4,
 5,
 7,
]

Terraform for loop best practices

There are a couple of things you should have in mind when you are using for loops in Terraform:

  • Keep the number of loops you use to a minimum to make your code easier to understand. This way, the scope is kept narrow, and issues will be easier to debug.
  • For loops should be used in locals to simplify the resource configuration. Also, local variables can be easily reused if you need to do so.
  • Test incrementally – when you are designing a complex loop, go step by step, it will be easier to master how to use loops in any scenario
  • Document your loops
  • Use descriptive variable names

Even if these are not 100% specific to for loop, for looping in Terraform in general, try to use for_each instead of count all over the place and take advantage of dynamic blocks.

How to manage Terraform resources with Spacelift

Terraform is really powerful, but to achieve an end-to-end secure Gitops approach, you need to use a product that can run your Terraform workflows.Ā SpaceliftĀ takes managing Terraform to the next level by giving you access to a powerful CI/CD workflow and unlocking features such as:

  • Policies (based on Open Policy Agent) – You can control how many approvals you need for runs, what kind of resources you can create, and what kind of parameters these resources can have, and you can also control the behavior when a pull request is open or merged.
  • Multi-IaC workflows – Combine Terraform with Kubernetes, Ansible, and other infrastructure-as-code (IaC) tools such as OpenTofu, Pulumi, and CloudFormation,Ā  create dependencies among them, and share outputs
  • Build self-service infrastructure – You can useĀ BlueprintsĀ to build self-service infrastructure; simply complete a form to provision infrastructure based on Terraform and other supported tools.
  • Integrations with any third-party tools – You can integrate with your favorite third-party tools and even build policies for them. For example, see how toĀ integrate security toolsĀ in your workflows using Custom Inputs.

Spacelift enables you to create private workers inside your infrastructure, which helps you execute Spacelift-related workflows on your end. Read theĀ documentationĀ for more information on configuring private workers.

You can check it out for free byĀ creating a trial accountĀ orĀ booking a demo with one of our engineers.

archipelago logo white

Since AI-driven commercial property risk platform Archipelago started working with Spacelift, they have eliminated manual processes around direct Terraform applications and streamlined change coordination among their engineers.

Spacelift customer case study

Read the full story

Key Points

Note: New versions of Terraform are placed under the BUSL license, but everything created before version 1.5.x stays open-source. OpenTofu is an open-source version of Terraform that expands on Terraform’s existing concepts and offerings. It is a viable alternative to HashiCorp’s Terraform, being forked from Terraform version 1.5.6.

Manage Terraform Better with Spacelift

Build more complex workflows based on Terraform using policy as code, programmatic configuration, context sharing, drift detection, resource visualization and many more.

Start free trial
Terraform Loops and Conditionals Cheatsheet

Grab our ultimate cheat sheet PDF to keep your workflows DRY.

Share your data and download the cheatsheet