Paul comes from the Microsoft ecosystem, where his focus has been building Web and Windows applications on SQL Server and the .NET Framework stack. He continually studies to hone his cloud and DevOps skillsets. He has recently begun a deep dive into the various cloud and DevOps technologies.

All posts by Paul Delcogliano - DevOps Expert

Paul Delcogliano

Author title

Title category

Get all the latest content on Infrastructure as Code, DevOps, Spacelift features & news directly to your inbox!

Level up your IaC knowledge. Stay up to date with educational devops guides & news in infrastructure as code, cloud & more!

Managing Infrastructure at Scale | Spacelift Blog

applepodcasts

spotify

missionctrl

Welcome to missionCTRL, a show dedicated to exploring the frontiers of modern DevOps. Listen (or watch) as we sit down with the practitioners who are pushing the boundaries of development

Practice DRY in Terraform Configurations Using `dynamic` Blocks

Want to level up your Terraform knowledge? Explore our tutorials and step-by-step guides written by Terraform experts. Learn Terraform best practices and solutions to the most difficult problems.

Terraform Guides and Tutorials | Spacelift Blog

Terraform

The Don&#8217;t Repeat Yourself (DRY) principle of software development states that code should be written once and not repeated. An important goal of the DRY principle is to improve the maintainability of code.
See how you can <a href="https://spacelift.io/blog/terragrunt-with-spacelift" target="_blank" rel="noopener">keep your configuration DRY with Terragrunt on Spacelift</a>.
Some Terraform resources include repeatable nested blocks in their arguments. These nested blocks represent separate resources that are related to the containing resource. For example, Azure VNets contain a subnet block attribute that repeats for each subnet within the VNet. This can lead to repeated configuration blocks in a Terraform script, which violates the DRY principle.
Dynamic blocks are a solution for applying DRY in Terraform configuration scripts.

Terraform provides the <code>dynamic</code> block to create repeatable nested blocks within a resource. A <code>dynamic</code> block is similar to the <code>for</code> expression. Where <code>for</code> creates repeatable top-level resources, like VNets, <code>dynamic</code> creates nested blocks within a top-level resource, like subnets within a VNet. A <code>dynamic</code> block iterates over a child resource and generates a nested block for each element of that resource.
<h3>Example</h3>
The following code shows the configuration of an Azure VNet and four subnets. In this example, the subnet blocks are written out explicitly, creating repeated code.

That same configuration using a <code>dynamic</code> block is shown below. Replacing the four <code>subnet</code> blocks with a <code>dynamic</code> block removes repeated attributes, leading to cleaner code that is easier to maintain.

Here is the definition of the variable subnets:

The values for the subnets variable are defined in a <a href="https://spacelift.io/blog/terraform-tfvars" target="_blank" rel="noopener">tfvars file</a>. Sample values are:

<code>dynamic</code> blocks are supported inside of <code>resource</code>, <code>data</code>, <code>provider</code>, and <code>provisioner</code> blocks. A <code>dynamic</code> block consists of the following components:
<table>
<tbody>
<tr>
<td>Component</td>
<td>Description</td>
</tr>
<tr>
<td>label
&nbsp;</td>
<td>Specifies what kind of nested block to generate. In the above example, the label is &#8220;subnet&#8221;. A subnet resource will be generated for each element in the <code>var.subnets</code> variable.
&nbsp;</td>
</tr>
<tr>
<td>for_each
&nbsp;</td>
<td>The complex value to iterate over.
&nbsp;</td>
</tr>
<tr>
<td>iterator
&nbsp;</td>
<td>(optional) Sets the name of a temporary variable that represents the current element. If not provided, the name of the variable defaults to the label of the dynamic block. An iterator has two attributes: key and value. Key is the element index. Value is the element value.
&nbsp;</td>
</tr>
<tr>
<td>content
&nbsp;</td>
<td>Defines the body of each generated block.
&nbsp;</td>
</tr>
</tbody>
</table>

A <code>dynamic</code> block can only generate attributes that belong to the resource type being created. It isn&#8217;t possible to generate meta-argument blocks like <code>lifecycle</code>. Some resource types have blocks with multiple levels of nesting.
When working with multi-level nested blocks, the iterators for each block are important. It is recommended to use the optional <code>iterator</code> component to clearly define each level in the configuration, and to remove any ambiguities resulting from attributes with the same name as a parent block.
The listing below illustrates a nested block example, with clearly defined iterators for each block.

A <code>dynamic</code> block is a great way to apply the DRY principle in Terraform configuration scripts. Implementing a <code>dynamic</code> block where appropriate removes repeated code leading to configurations that are easier to read, maintain, and reuse &#8211; just as the DRY principle aims to do.

If you are struggling with Terraform automation and management, check out Spacelift. It helps you manage Terraform state, build more complex workflows, and adds several must-have capabilities for end-to-end infrastructure management.

12 Terraform Best Practices to Improve your TF workflow

Terraform Count vs. For Each Meta-Argument - When to Use It

Terraform Cheat Sheet: Commands Reference & Useful Examples

Learn what Terraform Dynamic Blocks are, what are their components and how to use them for applying the DRY principle.

Paul Delcogliano

Practice DRY in Terraform Configurations Using Dynamic Blocks

Get the newsletter