vect documentation
vect documentation
vect composes Terraform roots, read-only data sources, and operational tasks into one dependency-ordered graph and runs it in Temporal.
First steps
This is the place to start. You should know Terraform; you don’t need to know vect or Temporal.
- From scratch: Overview | Installation
- Tutorial:
Using vect
Once you’ve done the tutorial, the topic guides explain how vect works and why.
- How vect builds the graph: what creates a dependency edge, and how to inspect the graph before anything runs.
- Stacks and projects: scoping rules, and sharing stacks between repositories.
- How runs work: facts, plan and apply, failures, approvals, and CLI-direct versus served runs.
- Inventory, bundles, and storage: what vect stores, where, and for how long.
- Values: how values flow between nodes, unknowns, and sensitive and ephemeral values.
- Change detection and reuse: when vect reruns a node, and the loops that start runs for you.
- Refactoring: renaming and removing nodes with
movedandremoved.
How-to guides
Step-by-step recipes for real tasks.
- Plan in review, apply on merge: saved plans, targets, and unattended approvals in a CI script.
- Run vect as a shared server:
vect serve, loops, authentication, and policy. - Run workers and route work: task queues, slots, and where each node runs.
- Run your own code as a step: Temporal activities and workflows in the graph.
Reference
Look up the exact syntax and options.
- Command-line reference: every
vectcommand and flag. - Server configuration reference: every block and attribute of
server.vect. - Executors, data sources, and ephemeral sources: every built-in type and meta-argument.
Getting help
Found a problem or have a question? Open an issue on the issue tracker.
How the documentation is organized
- Tutorials are on this site. They take you through building and running a small vect project, one step at a time.
- Topic guides are on this site, under Using vect. Each explains one part of vect in depth. For further reading,
docs/architecture.mdin the repository covers how the parts fit and why. - How-to guides are on this site, under How-to guides. Each walks through one task, start to finish.
- The reference is on this site, under Reference: commands, server configuration, and built-in types. The normative specification in the repository has a stable ID for every requirement.