Quickstart Guide

Installing Terrateam is a straightforward process. By following these three easy steps, you’ll have Terrateam up and running in your GitHub repository in no time.

Terrateam Installation

Step 1. Install the Terrateam GitHub Application

• $149/mo unlimited. 14-day free trial. No credit card required.
• Select any of your GitHub organizations and repositories that contain Terraform code.
• Click here to install the Terrateam GitHub application

Step 2. Add the Terrateam GitHub Actions Workflow

• Download terrateam.yml
• The Terrateam GitHub Actions workflow file (.github/workflows/terrateam.yml) must be stored in the default branch of your Terraform repository. The default branch is usually named main or master.

Note

Create the .github/workflows directory if it doesn’t exist. This is done for you automatically if you’re using the GitHub UI (GitHub.com in a browser).

Step 3. Start Using Terrateam

If you want to see how Terrateam works without connecting to your cloud provider, continue reading to deploy a simple null_resource. Otherwise, jump to Cloud Providers .

Your First Terrateam Deployment

Did you know?

With Terrateam you can apply changes before or after merging a pull request.

Plan and Apply

We will now trigger our first Terrateam deployment by creating a simple pull request with a null_resource. The null_resource provider does not take any action against live environments making it completely safe for our first deployment.

1. New Branch

   Create a new branch against a repository with Terrateam installed.

   

2. Add Terraform Code

   Create a new file called main.tf in any directory in the repository. Download the code here.

   

3. Pull Request

   Commit and push main.tf to your branch and then create a pull request.

   

4. Terraform Plan

   Terrateam will automatically trigger a terraform plan.

   

5. Terraform Apply

   Comment terrateam apply on the pull request. Terrateam will trigger a terraform apply.

   

6. Merge

   Merge the pull request.

   

   Apply after merge

   Click here to learn how to apply your changes after merging a pull request.

Bravo!

You’ve just completed your first Terrateam deployment.

Learn More

See Cloud Providers to learn how to integrate Terrateam against AWS, GCP, Azure, and more.