Skip to content
Terragrunt Logo
🎉 Terragrunt v1.0 is here! Read the announcement to learn more.

Installation

This page provides a brief overview of the setup process.

Getting Started

Section titled “Getting Started”

  1. Sign up — Create an account at app.gruntwork.io. The rest of the steps listed here will be guided by the onboarding wizard that runs after sign-up.

  2. Connect your VCS — Install the Gruntwork.io GitHub App or configure a GitLab machine user to connect to one or more Git repositories.

  3. Bootstrap your cloud resources — Provision all the cloud resources you need to bootstrap your cloud environment for use with Terragrunt Scale. This involves running a single script, then merging a single pull request, generated by the onboarding wizard.

  4. Run your first pipeline — Click a button in the wizard and have an automatically generated Pull Request (PR) created for you to review and merge. On creation, Pipelines will run a plan, with plan output commented on the pull request. On merge, Pipelines will apply the changes in the PR.

Configuration

Section titled “Configuration”

Terragrunt Scale uses configuration-as-code defined in HCL. You can configure settings at the repository, environment, or individual unit level, including:

  • Cloud provider authentication (e.g. aws_oidc with per-environment plan/apply IAM roles)
  • Environment definitions that filter which units a configuration applies to
  • Repository-level settings like the branch that deploys IaC (e.g. main) and environment variables to set for Terragrunt runs
  • Per-unit overrides for authentication and other settings

Requirements

Section titled “Requirements”
  • A GitHub or GitLab repository you can push to
  • An AWS, GCP, or Azure account you can provision infrastructure in