Self-Hosted Deployment Instructions

Deploy a self-hosted version of Terrateam with Docker.

Cloud vs. Self-Hosted

This plan covers our Kubernetes and Docker compose deployment with limited usage and without guarantee. This deployment is designed for evaluating Terrateam without vendor approval. It is not designed for production use.

If you need a fully supported and self-hosted version of Terrateam, reach out to hello@terrateam.io.

Architecture

The following diagram shows an overview of the Terrateam architecture:

The Terrateam application server is horizontally scalable. You can run as many as you’d like as long as they all point to the same PostgreSQL database.

Deployment Steps

Prerequisites

These instructions require you to run commands from a terminal.

• Docker
• Docker Compose

1. Create a private Terrateam GitHub application

Terrateam Self-Hosted requires a new Terrateam GitHub application to be created.

Clone the terrateamio/terrateam repository

git clone https://github.com/terrateamio/terrateam.git
cd terrateam

Start the setup container

docker-compose up setup

Navigate to http://localhost:3000 and follow the setup instructions

2. Deploy the Terrateam server

The following deployment methods are supported:

• Docker Compose
• Fly.io
• Manual Instructions
• Kubernetes

Coming soon:

• Amazon ECS

Next Steps

GitHub Actions Workflow

##########################################################################
# .github/workflows/terrateam.yml
##########################################################################
# DO NOT MODIFY
#
# THIS FILE SHOULD LIVE IN .github/workflows/terrateam.yml
#
# Looking for the Terrateam configuration file? .terrateam/config.yml.
#
# See https://terrateam.io/docs/configuration 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
    timeout-minutes: 1440
    name: Terrateam Action
    steps:
      - uses: actions/checkout@v3
      - 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) }}

Cloud Provider

Terrateam needs permission to access your cloud provider in order to make changes with the Terraform CLI.

• AWS
• GCP
• Azure
• Other

Start using Terrateam

Configuration

Learn how to fully customize your workflow with our configuration file.

Support

Join our Slack community or email support if you need help deploying.

Terrateam server

Environment variables

You can customize the Terrateam server using environment variables.

Listeners and endpoints

The Terrateam server listens on two ports:

• Nginx reverse proxy port 8080
• Terrateam application server port 8180

The following unauthenticated endpoints are included:

• /health - Health check port 8080
• /metrics - Prometheus metrics port 8180
• /nginx_status - Nginx status port 8080

Cost estimation

The Terrateam server sends cost estimation requests to the Cloud Pricing API endpoint defined by the INFRACOST_PRICING_API_ENDPOINT and SELF_HOSTED_INFRACOST_API_KEY environment variables. The Cloud Pricing API is an open-source service provided by Infracost and is easy to deploy. See their documentation for deployment instructions.

If you prefer to use the public Infracost Pricing API, then set your Infracost API key as a GitHub Secret in your Terraform repository. See the Cost Estimation documentation for details.

Docker

Official Docker image registry path for the Terrateam server: ghcr.io/terrateamio/terrateam