Skip to content

terrateamio/terrateam

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 

Repository files navigation

terrateamlogo

Docs - Using Terrateam - Support community - Roadmap - Bug report

Start running Terraform with cost estimation, security alerts, drift detection, access controls, and OPA policy testing. Self-hosted and cloud versions available.

Terraform continuous delivery for GitHub

Create Terraform changes by commenting on pull requests.

Terrateam delivers self-service Terraform across your organization, visibility into cloud spend, an expressive configuration file with fine-grained access controls, drift detection, policy enforcement, security alerts, and more.

Table of contents

⭐ Like us? Give us a star!

Features

  • Access Control - Define a set of capabilities, such as plan and apply, and which users can perform those operations. GitHub Users, Teams, and Repository Collaborator policies are supported.
  • Apply Requirements - Specify when an apply operation can be performed on a pull request that has not been merged.
  • Cost Estimation - Cost estimates on each pull request that Terrateam runs a plan operation against.
  • Drift Detection - Scheduled operations to detect drift between live infrastructure and your Terraform repository.
  • OIDC - Safely and securely authenticate to your cloud provider using temporary credentials.
  • OPA Policy Testing - Policy testing against plan operations with OPA and Conftest.
  • Static Analysis - Static analysis against plan operations with Checkov.
  • Workflows - Custom workflows to replace the default Terrateam steps for plan and apply operations.

Get started for free

Terrateam Cloud

The fastest way to get started with Terrateam is signing up for Terrateam Cloud.

Terrateam 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.

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 Postgres database.

graph LR
    gh[GitHub.com]
    ts[Terrateam Server]
    pd[(Postgres Database)]
    gh <--> ts
    ts <--> pd

Deployment instructions

See the Terrateam docs for deployment instructions.

How it works

Terrateam is a GitHub application that turns pull requests into Terraform executions using GitHub Actions. There are two major components of the Terrateam service:

  • The server which receives GitHub pull request events and makes decisions using the event payload
  • The Terrateam GitHub Actions runner which executes the Terraform jobs that the Terrateam server creates

🔒 Cloud credentials and source code never reach our servers. Sensitive information is isolated to your organization GitHub Actions runtime environment. The Terrateam GitHub Action is open-source and can be found here. See our Security page for more information.

graph TD
    gpr[GitHub Pull Request]
    ge[GitHub Events]
    ts[Terrateam Server]
    pd[(Postgres Database)]
    ga[GitHub Actions]
    gt[GitHub Teams]
    go[GitHub OIDC]
    gs[GitHub Secrets]
    cp[Cloud Provider]
    tr[Terraform Code Repository]
    gpr --> ge
    ge --> ts
    ts <--> pd
    ts <--> ga
    ga --> gpr
    gt --> ts
    ga <--> go
    gs --> ga
    ga --> cp
    tr --> ga

See our documentation to learn more about execution steps, types of operations, event evaluations, locking, and more.

Docs

Check out our documentation for getting started instructions, example use cases, and tutorials.

Support

We encourage users to submit a GitHub Issue. Additionally, if you need help, have a feature request, or anything else, please hop onto our Slack. This is often times the fastest way to talk to us.

About

Terraform automation for teams. Purpose-built for GitHub.

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published