Quickstart Guide

The following steps on this page will help you to set up Terrateam, integrate it with GitHub, and run your first Terraform deployment in just a few steps.

Prerequisites

Before getting started with Terrateam quickstart guide, make sure you have the following:

• A GitHub account to fork the Terrateam demo repository.
• GitHub Actions enabled in your forked repository.
• Administrator access to install the Terrateam GitHub app.

Demo Repository Workflow

To have an overview on how to use Terrateam, use the the Terrateam ready-to-use demo repository with pre-configured Terraform code. Follow these steps to quickly test Terrateam’s capabilities.

Terrateam Demo Repository

1. Fork the Demo Repository

   Click the link above to access our demo repository, then click the Fork button in the top-right corner of the page.

   

   On the “Create a new fork” screen, keep the default settings and click “Create fork”.

   

2. Install the Terrateam GitHub Application (if you haven’t already)

   Sign up for a Terrateam account and install the GitHub app. Then, select the organizations and repositories that contain your Terraform code.

   Sign up for Terrateam

   

   Once the installation is complete, access your Terrateam dashboard. If the setup was successful, your forked repository will be listed there.

   

3. Clone Your Forked Repository

   Clone the repository to your local machine and navigate to its directory:

   git clone https://github.com/<your-username>/kick-the-tires.git
   cd kick-the-tires

4. Create a New Branch

   Create a branch to make your changes:

   git checkout -b test-branch

5. Modify a Terraform File

   Let’s modify a file to test the workflow, changes are detected automatically. Open staging/compute/main.tf and change the instance name.

   module "staging_compute_instance" {
     source = "../../modules/compute"
   
     instance_count = 0
     instance_name  = "staging-instance-modified"
     instance_zone  = "us-central1-a"
     boot_disk_image = "debian-cloud/debian-11"
     network_name    = "default"
   }

6. Commit and Push Your Changes

   Commit your changes and push them to your branch:

   git add .
   git commit -m "Testing Terrateam workflow"
   git push origin test-branch

7. Create a Pull Request

   Access your forked repository on GitHub. A prompt should appear, allowing you to create a pull request for your recently pushed branch.

   Caution

   Make sure to change the base repository to your fork instead of creating a PR on the original Terrateam repository. The base should be your main branch, and the compare should be your test-branch.

   Caution

   Ensure that workflows are enabled on your forked repository. If GitHub Actions workflows are disabled, you’ll need to enable them in the repository settings.

8. Watch the Automatic Terraform Plan

   Once the pull request is created, Terrateam will automatically trigger a terraform plan. This plan will appear as a comment on your pull request, showing what changes would be made.

   

   This plan is a preview of what will happen when you apply the changes.

9. Apply the Changes

   To execute the changes, comment terrateam apply on the pull request.

   After you add the comment, the Terrateam app will run the terraform apply command. This will apply the previous plan to the Terraform file, updating your infrastructure.

10. Merge Your Changes

    Once applied and everything looks good, you can merge the pull request to incorporate the changes into your main branch.

Next steps

Learn how Terrateam works

Explore key Terrateam concepts