Skip to content
Overview

vect at a glance

The problem

If you run Terraform at any size, you probably have many roots, each with its own state, plus scripts that glue them together: run network, copy an output into a tfvars file, run app, then kick off a migration. Order lives in a wiki or a CI file, values pass through files and terraform_remote_state, and nobody can see the whole picture before running it.

vect keeps your Terraform roots as they are and adds a layer above them. You declare each root, and what it needs from the others, in one HCL configuration. vect builds a dependency graph across all of them, plans the whole thing, asks for approval where it matters, and applies it in order. Runs execute as Temporal workflows, so they are durable and observable. vect also records what it applied, so it can destroy it later.

How it fits together

    flowchart LR
  A[Configuration] --> B[Bundle]
  B --> C[Run in Temporal]
  C --> D[Executors]
  D --> E[(Inventory)]
  

Your configuration is packaged into a content-addressed bundle. A run executes as a Temporal workflow, which walks the dependency graph and hands each node to an executor (for example, one that runs a Terraform root). What each executor applied is recorded in the Inventory.

A configuration sketch

Two Terraform roots, where the second consumes an output of the first:

main.hcl
executor "terraform" "network" {
  source = "./roots/network"
}

executor "terraform" "app" {
  source = "./roots/app"
  inputs = {
    network_id = terraform.network.id
  }
}

The reference terraform.network.id is the whole story: vect sees that app depends on network, runs network first, and passes the value. There is no terraform_remote_state and no copying. You build this in Part 2 of the tutorial.

Vocabulary

Terms you’ll meet in the tutorial. The glossary defines all of them.

TermWhat it means
executorAn executor "<type>" "<name>" block. It wraps one unit of work, such as a Terraform root, that vect plans and applies.
stackOne .hcl directory and its scope. It is vect’s grouping unit. Never called a “module”; that word is reserved for Terraform modules.
data sourceA data "<type>" "<name>" block. It reads a value and changes nothing.
InventoryThe durable, workspace-scoped record of every applied executor node. It is what lets vect destroy things later.
bundleThe packaged form of a whole configuration: content-addressed units plus a root manifest. A run executes a bundle, and a bundle never depends on a workspace.
runOne vect plan, vect apply, or vect destroy, executed as one Temporal workflow in one workspace.
workspaceThe named deployment target a run acts on, typically one cloud account. It is not a Terraform CLI workspace.
Coming from Terraform: a vect workspace is a deployment target that scopes Inventory, leases, and state keys. It is not a Terraform CLI workspace.

Next steps

Install vect, then start the tutorial with Part 1.