»Network Drivers

Network drivers are used by Consul-Terraform-Sync to execute and update network infrastructure. Drivers transform Consul service level information into downstream changes by understanding and abstracting API and resource details tied to specific network infrastructure.


Consul-Terraform-Sync is a HashiCorp solution to Network Infrastructure Automation by bridging the networking features of Consul and infrastructure management with Terraform. The solution seamlessly embeds Terraform as a network driver to manage automation of Terraform modules. This expands the Consul ecosystem and taps into the rich features and community of Terraform and Terraform providers. Consul-Terraform-Sync automates Terraform execution of templated configuration files to carry out infrastructure changes. The auto-generated configuration leverages input variables sourced from Consul and builds on top of reusable Terraform modules published and maintained by HashiCorp partners and the community.

»Understanding Terraform Automation

On startup, Consul-Terraform-Sync downloads and installs Terraform, prepares the local environment, and generates Terraform configuration files that make up the root module for each task. Terraform configuration and execution for each task is organized as separate Terraform workspaces. The state files for tasks are independent of each other.

Within the Consul-Terraform-Sync configuration for a task, practitioners can select the desired module to run for the task as well as set the condition to execute the task. Each task executed by the Terraform driver corresponds to an automated root module that calls the selected module in an isolated Terraform environment. Consul-Terraform-Sync will manage concurrent execution of these tasks.

»Root Module

The root module is simple in structure and proxies Consul information, configuration, and other variables to the Terraform module for the task. The content of the files that make up the root module are sourced from Consul-Terraform-Sync configuration, information for task's module to use as the automation playbook, and information from Consul such as service information.

Auto-generated root modules for tasks are stored in local subdirectories of the Terraform working directory. By default, the working directory sync-tasks is created in the current directory. To configure where Terraform configuration files are stored, set working_dir for the Terraform driver to the desired path.

A working directory with one task named "my-task" would have the folder structure below.

sync-tasks/  my-task/    main.tf    variables.tf    terraform.tfvars    terraform.tfvars.tmpl

The following files of the root module are generated for each task. An example of a root module created by Consul-Terraform-Sync can be found in the project repository.

  • main.tf - The main file contains the terraform block, provider blocks, and a module block calling the module configured for the task.
    • terraform block - The corresponding provider source and versions for the task from the configuration files are placed into this block for the root module. The Terraform backend from the configuration is also templated here.
    • provider blocks - The provider blocks generated in the root module resemble the terraform_provider blocks in the configuration. They have identical arguments present and are set from the intermediate variable created per provider.
    • module block - The module block is where the task's module is called as a child module. The child module contains the core logic for automation. Required and optional input variables are passed as arguments to the module.
  • variables.tf - This file contains 3 types of variable declarations. The first type is the required services input variable which determines module compatibility with Consul-Terraform Sync (read more on compatible Terraform modules for more details). The second type is any additional Consul-Terraform-Sync provided optional input variables that the module may include. The final type is various intermediate variables used to dynamically configure providers. These intermediate provider variables are interpolated from the provider blocks and arguments configured in the Consul-Terraform-Sync configuration.
  • variables.module.tf - This file is conditionally created if there are variables configured for the task and contains the interpolated variable declarations that match the variables from configuration. These are then used to proxy the configured variables to the module through explicit assignment in the module block.
  • terraform.tfvars - The variable definitions file is where the services input variable and any optional Consul-Terraform-Sync input variables are assigned values from Consul. It is periodically updated, typically when the task condition is met, to reflect the current state of Consul.
  • terraform.tfvars.tmpl - The template file is used by Consul-Terraform-Sync to template information from Consul by using the HashiCorp configuration and templating library (hashicorp/hcat).

»Upgrading Terraform

Upgrading the Terraform version used by Consul-Terraform-Sync may introduce breaking changes that can impact the Terraform modules. Refer to the Terraform upgrade guides for details before upgrading.

The following versions were identified as containing changes that may impact Terraform modules.