Published on

Introduction to Terraform Module Toggle


Advanced Terraform with AWS (Part 2)

Unraveling the Intricacies of Dynamic Terraform Module Enablement


In our ongoing journey through Advanced Terraform techniques, we delve deeper into the dynamic enablement or disablement of Terraform Modules, a highly sought-after facet of cloud resource management. Picture this: leveraging a single code base, but with the nuanced control to dictate precisely which modules are activated in each environment. This capability is not just powerful; it's transformative.

This technique opens the door to creative solutions for a variety of complex scenarios. Imagine effortlessly toggling security modules for different environments, enabling stricter protocols in production while keeping development environments more open for testing. Consider the ease of managing multi-tier applications, where database, application, and front-end modules can be independently controlled, allowing for seamless updates and maintenance without disrupting the entire system.

Moreover, this module-based approach can significantly streamline disaster recovery processes. In the event of a failure, specific recovery modules can be activated in an isolated environment, minimizing downtime and reducing the risk of cascading failures.

Another fascinating application lies in cost management. By selectively disabling non-essential modules in certain environments, organizations can optimize resource usage, leading to substantial cost savings without compromising functionality.

Furthermore, this technique enhances the ability to experiment and innovate. Teams can safely test new modules or updates in isolated environments before rolling them out across the board, encouraging a culture of continuous improvement and agility.

By aligning this approach with the DRY (Don't Repeat Yourself) principle, we not only streamline our processes but also open a realm of possibilities for bespoke infrastructure management. It empowers DevOps teams to tailor infrastructure setups with unprecedented precision, catering to the unique demands of each project or environment. This is the essence of adaptive, responsive infrastructure management in the cloud era.

Embrace Module Toggling

A Deep Dive into modularity


Our example focuses on the precise orchestration of AWS subnet creation through an advanced parent-child module architecture in Terraform. Picture the scenario where you have absolute control over the specific environments in which a subnet materializes. For instance, imagine effortlessly deciding whether a subnet should be provisioned in a development, staging, or production environment, based on a simple toggle. This level of control is not just convenient; it's a great asset in cloud resource management.

The complete source code can be referenced on my related Github repository.

Child Module

In the the child module, we define an AWS subnet resource with Terraform's HashiCorp Configuration Language (HCL). This resource is crafted to accommodate various subnet attributes, including VPC identification, IPv6 address assignment policy, specific availability zones and so on. The code snippet below illustrates this configuration in HCL:

resource "aws_subnet" "this" {
  vpc_id                          = var.vpc_id
  assign_ipv6_address_on_creation = var.assign_ipv6_address_on_creation
  availability_zone               = var.availability_zone
  # Additional configuration parameters ...

Parent Module

The parent module exemplifies the implementation of conditional logic using Terraform's for_each construct alongside the var.enabled flag. This approach allows for the conditional instantiation of subnets based on the enabled state, thereby providing a streamlined and efficient mechanism for subnet management:

module "aws_subnets" {
  source                          = "modules/aws_subnet"
  for_each                        = var.enabled ? { for subnet in var.subnets : "${}" => subnet } : {}
  vpc_id                          = each.value.vpc_id
  assign_ipv6_address_on_creation = each.value.assign_ipv6_address_on_creation
  availability_zone               = each.value.availability_zone
  # Additional configuration parameters ...

In the parent module's, we define the "enabled" variable, setting its type to boolean and providing a clear description. This method elegantly circumvents the need for the count parameter, which traditionally impacts resource naming and can lead to complications during state management. Moreover, we intricately introduce the "subnets" variable, ingeniously structured as a list of objects.

This structure is not just a list; it's a blueprint for various subnet configurations. Each object within this list is equipped with its unique set of attributes, providing a customizable and detailed representation of individual subnet properties. This design choice not only enhances the modularity of our Terraform code but also injects a level of detail and precision into our infrastructure definition, catering to the complex and diverse needs of modern cloud environments.

variable "enabled" {
  type        = bool
  description = "(Optional) Enables or disables the module. Default is true."
  default     = true

variable "subnets" {
  type = list(object({
    name                            = string
    vpc_id                          = string
    assign_ipv6_address_on_creation = optional(bool)
    availability_zone               = optional(string)
    # Additional configuration attributes ...
  description = "A collection of subnet configuration objects."
  default     = []

Project Repository

In the file within a project repository, we exemplify the real-world implementation of the aws_subnets module. This file acts as a strategic guide, illustrating the dynamic configuration and management of various subnets across distinct Terraform Workspaces.

The local.project_condition variable plays a pivotal role in this setup. It acts as a decisive toggle, determining whether the subnets defined in the module should be provisioned or not. This variable, defined locally within the project, can be set based on specific conditions or logic relevant to the project's requirements. Its integration with the enabled parameter in the aws_subnets module showcases the dynamic nature of our infrastructure setup. By simply adjusting the value of local.project_condition, we can control the activation or deactivation of subnet creation without altering the core module code. This design offers a high degree of flexibility and control in managing cloud resources, allowing for precise and conditional infrastructure deployment.

The following HCL code snippet demonstrates this sophisticated interaction:

module "project_subnets" {
  source                         = "modules/aws_subnets"
  enabled                        = local.project_condition
  subnets                        = [
      vpc_id                           = each.value.vpc_id
      assign_ipv6_address_on_creation  = each.value.assign_ipv6_address_on_creation
      availability_zone                = each.value.availability_zone
      # Additional configuration attributes ...

This enhanced approach, imbued with Terraform's HCL syntax and best practices, not only keeps the infrastructure code DRY but also elevates the flexibility and control over cloud resource management.

This setup provides various advantages and is designed to avoid common pitfalls as outlined below.

  1. Improved Resource Management: Enables precise control over which resources are provisioned, reducing unnecessary costs and complexity.
  2. Enhanced Flexibility: Easily adapt to different project needs and environments without altering the core code.
  3. Streamlined Configuration: Simplifies management by using a single code base for various conditions.
  4. Optimized for Scalability: Facilitates scaling infastructure up or down based on actual requirements, ensuring efficient use of cloud resources.

Final Thoughts

This approach of dynamically toggling Terraform modules heralds a new era of versatility in resource provisioning. It equips teams with the ability to craft bespoke solutions, meticulously adapted to the varying demands of different projects, environments, and geographic regions. This method not only aligns infrastructure deployment with the specific needs and strategic objectives of the organization but also encourages practitioners to rethink and integrate module toggling into their Terraform module strategies.

By adopting this flexible module control, teams can significantly enhance their infrastructure's responsiveness to change, ensuring that it remains agile, scalable, and precisely aligned with evolving business requirements. I encourage all Terraform users to consider incorporating this module toggle technique into their strategies, to unlock the full potential of their infrastructure and stay ahead in the dynamic landscape of cloud computing.