2020-10-09 18:37:20 +00:00
---
layout: docs
page_title: Architecture
description: >-
Consul-Terraform-Sync Architecture
---
# Consul-Terraform-Sync Architecture
Consul-Terraform-Sync is a service-oriented tool for managing
network infrastructure near real-time. Consul-Terraform-Sync runs as a daemon
and integrates the network topology maintained by your Consul cluster with your
network infrastructure to dynamically secure and connect services.
## 10,000 Foot View
2020-11-23 07:47:58 +00:00
[](/img/nia-highlevel-diagram.svg)
2020-10-09 18:37:20 +00:00
The diagram shows Consul-Terraform-Sync monitoring the Consul service catalog
for updates and utilizing Terraform to update the state of the infrastructure.
There are two principal aspects of Sync to know about corresponding to the
lines to Consul and Terraform in the diagram above. The line to Consul
represents the Watchers monitoring the state of Consul's service catalog (and
possibly KV store) while the line to Terraform represents tasks being run to
update the infrastructure.
## Watcher and Views
Consul-Terraform-Sync monitors Consul for updates utilizing Consul's [Blocking
Queries](/api-docs/features/blocking) whenever supported, falling back on
polling when not. The watcher maintains a separate thread (known internally as
a view) for each value monitored, running any tasks that depend on that watched
value whenever it's updated. Say, for example, running a task to update a
proxy when an instance goes unhealthy.
## Tasks
A task is the action triggered by the updated data monitored in Consul. It
2022-01-19 04:43:11 +00:00
takes that dynamic service data and translates it into a call to the
2020-10-09 18:37:20 +00:00
infrastructure application to configure it with the updates. It uses a driver
to push out these updates, the initial driver being a local Terraform run. An
example of a task is to automate a firewall security policy rule with
discovered IP addresses for a set of Consul services.
## Drivers
A driver encapsulates the resources required to communicate the updates to the
2021-09-01 18:45:36 +00:00
network infrastructure. The following [drivers](/docs/nia/network-drivers#terraform) are supported:
2021-10-13 14:58:12 +00:00
- Terraform driver
- Terraform Cloud driver<EnterpriseAlert inline />
2021-09-01 18:45:36 +00:00
Each driver includes a set of providers that [enables support](/docs/nia/terraform-modules) for a wide variety of infrastructure applications.
2021-03-24 17:58:10 +00:00
## Security Guidelines
2021-10-13 14:58:12 +00:00
The [Secure Consul-Terraform-Sync for Production](https://learn.hashicorp.com/tutorials/consul/consul-terraform-sync-secure?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS)
tutorial contains a checklist of best practices to secure your
2021-03-24 17:58:10 +00:00
Consul-Terraform-Sync installation for a production environment.
