Quick Start

Two end-to-end, hands-on tutorials at two depths. Both run against real tooling; pick the one that matches where you are.

Pick your path

Simple — the first five minutes

Start here →

You have an existing Terraform state and want to see your fleet. In under five minutes you'll:

  1. Install the CLI.
  2. Write a small mapping config.
  3. terrantula import terraform your existing state.
  4. terrantula dashboard to open a working graph view.

No signup, no server, no Docker — everything runs locally and the view is a read-only projection of what Terrantula derived from your state. This is the on-ramp: visibility first, against the infrastructure you already have. It's the right starting point for Riley (Terraform sprawl, no fleet view yet).

Advanced — multi-stack greenfield with a cascade

Go deeper →

You're starting a fresh multi-tenant SaaS and want Terrantula to drive it from day one. You'll model four entity types across four stacks, then fire a single OnboardTenant Action that:

  1. Creates a Tenant entity and cascades three upstream entities (AWS account, Argo project, cluster binding).
  2. Auto-fires each entity type's Apply Action, which opens a pull request in your IaC repo.
  3. Gates the tenant's apply on its three upstreams via dependsOn — blocking, then resuming once they merge.

Terrantula never runs terraform apply itself — Actions open PRs, and your CI applies on merge. This is the cattle wedge end-to-end, and it serves Maya and Devon (tenant placement and templated per-customer provisioning), while staying fully self-hostable for Sam (no SaaS dependencies required).

Do Simple first. Advanced assumes you've installed the CLI and seen the dashboard, and that you're comfortable with entities, cells, and relationships. If those terms are new, read Core Concepts before the Advanced tutorial.

At a glance

SimpleAdvanced
GoalSee your existing fleet as a graphOnboard a tenant across four stacks with one command
Time< 5 minutes~20–30 minutes
SubstrateAny Terraform state (local, S3, Terraform Cloud) or AtmosGreenfield Terraform + GitHub Actions
What you runimport terraformdashboardmodel a blueprint → actions run OnboardTenant
OutcomeA read-only fleet viewA cascade that opens the right PRs in the right order
PersonaRileyMaya, Devon (self-hostable for Sam)

After the Quick Start

  • Your First Fleet — a guided build of the primitives (entity types, cells, relationships, Actions) in order.
  • Learn Terrantula — the cattle mindset and core concepts.
  • Examples — the canonical demos for TFC, Atmos, Atlantis, and bare Terraform + GitHub Actions.