Skip to main content

Quick Start

Step 1

Install the Terrateam GitHub Application

warning

You must be an owner of a GitHub organization or repository to install Terrateam

Step 2

Add the Terrateam GitHub Workflow File

Create a .github/workflows/terrateam.yml file in the default branch of your repository.

This branch is typically named main or master.

.github/workflows/terrateam.yml YAML content:

Workflow File
 ##########################################################################
# DO NOT MODIFY
#
# THIS FILE SHOULD LIVE IN .github/workflows/terrateam.yml
#
# Looking for the Terrateam configuration file? .terrateam/config.yml.
#
# See https://docs.terrateam.io/configuration/overview for details
##########################################################################
name: 'Terrateam Workflow'
on:
workflow_dispatch:
inputs:
# The work-token and api-base-url are automatically passed in by the Terrateam backend
work-token:
description: 'Work Token'
required: true
api-base-url:
description: 'API Base URL'
jobs:
terrateam:
permissions: # Required to pass credentials to the Terrateam action
id-token: write
contents: read
runs-on: ubuntu-latest
name: Terrateam Action
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Run Terrateam Action
id: terrateam
uses: terrateamio/action@v1 # Do not replace with a custom image. Doing so may cause Terrateam to not operate as intended.
with:
work-token: '${{ github.event.inputs.work-token }}'
api-base-url: '${{ github.event.inputs.api-base-url }}'
env:
SECRETS_CONTEXT: ${{ toJson(secrets) }}

Step 3 (Optional)

Cloud Provider Authentication

AWS
GCP
Azure

Step 4

Create a pull request with a Terraform code change

Details
  1. Create a pull request with a Terraform code change
  2. Terrateam will automatically run terraform plan against your changes
  3. Create a GitHub comment terrateam apply to apply Terraform plans
  4. Merge your pull request

What's next

Slack

Check out our community chat to ask questions and meet other users 👋

How Terrateam works

Terrateam Configuration

Full Example Use Cases

Support