Categorygithub.com/terramate-io/terramate
modulepackage
0.11.1
Repository: https://github.com/terramate-io/terramate.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
2
Dependents
4
Files
8 SLOC

# README

Terramate

Terramate


Latest Release Go Docs Go Report Card Terramate CI Status Discord Server

🚀 Getting Started | 📖 Documentation | 💻 Playground



What is Terramate CLI?

Terramate CLI is an open-source Infrastructure as Code (IaC) code generation and orchestration tool for Terraform, OpenTofu and Terragrunt. With Terramate, you can:

(a) Simplify complex codebases to make your work more productive and reliable. Break down large state files with stacks to reduce run-time and blast radius and keep them DRY with native code generation.

(b) Automate and orchestrate Terraform, OpenTofu and Terragrunt in any CI/CD using Pull Request automation, GitOps blueprints, and workflow tooling with zero-config orchestration and change detection.

(c) Provide the foundation to later leverage Terramate Cloud, a management layer that gives you visibility, control, and actionable insights into your infra.

Installation

With brew:

brew install terramate

With Go:

go install github.com/terramate-io/terramate/cmd/...@latest

For other installation methods, please see the documentation.

Getting Started

The fastest way to get started with Terramate is our getting started guide.

Why simplify complex codebases?

As Terraform and OpenTofu offer no standard pattern on how to organize code efficiently, projects quickly sprawl out of control. The consequences are code complexity, long-running pipelines, large blast radius, drift, and poor governance.

Terramate CLI enables a new approach to eliminating the root cause of these consequences: using a modular and efficient approach called Terramate Stacks. A stack is a combination of infrastructure code, state and configuration, which can be nested to split state further.

Organizationally, a stack is a way to establish an ownership model. By consistently sizing stacks into isolated units that your team members can quickly understand, assuming ownership of your infra becomes a lot simpler. Terramate CLI supports Terraform, OpenTofu and Terragrunt, and can be run locally as well as in your existing VCS (Github, Gitlab) CI/CD.

Terramate CLI is designed to work especially well with Terramate Cloud, which provides an IaC management layer and offers a generous free tier.

Features

  • Orchestration: Run any command and configurable workflows in stacks with unlimited concurrency.
  • Change Detection: Only execute stacks that contain changes. Allows to detect changes in referenced Terraform and OpenTofu modules as well as Terragrunt dependencies.
  • Code Generation: Generate code such HCL, JSON and YAML to keep your stacks DRY (Don't repeat yourself). Comes with support for global variables and functions.
  • Automation Blueprints: Pre-configured GitOps workflows for GitHub, GitLab, BitBucket and Atlantis to enable Pull Automation with plan previews in your existing CI/CD.
  • Drift Management: Detect and reconcile drift with scheduled workflows.
  • Observability, Visibility and Insights: Provides actionable insights and observability into your stacks, deployments, and resources.

Terramate Cloud

Terramate Cloud provides you with the best IaC management experience possible. It helps you orchestrate your stacks in your existing CI/CD platform, such as GitHub Actions, GitLab and Bitbucket Pipelines, so you don't need to buy yet another CI/CD vendor.

It also provides a powerful dashboard that adds observability and insights, deployment metrics (e.g., DORA), notifications, drift management, asset management, and more for your stacks to provide the developer experience and infrastructure to build, scale and observe all your infrastructure managed with IaC.

Terramate Cloud Dashboard

Join the Community

Additional Resources

Reporting Bugs, Requesting Features, or Contributing to Terramate

Want to report a bug or request a feature? Open an issue

Interested in contributing to Terramate? Check out our Contribution Guide

License

See the LICENSE file for licensing information.

Terramate

Terramate is a CNCF and Linux Foundation silver member.

CNCF Silver Member logo

# Packages

No description provided by the author
Package cloud implements the SDK for communicating with the Terramate Cloud.
No description provided by the author
Package config provides high level Terramate configuration facilities.
No description provided by the author
Package errors implements the Terramate standard error type.
Package event implements a simple event stream and defines all events generated by different parts of Terramate.
Package fs provides filesystem related functionality.
Package generate implements code generation.
Package git provides a wrapper for the git command line program.
Package globals provides functions for loading globals.
Package hcl provides parsing functionality for Terramate HCL configuration.
Package lets provides parsing and evaluation of lets blocks.
Package tmls implements a Terramate Language Server (LSP).
Package mapexpr implements the `map` block as an HCL expression type.
Package modvendor provides basic functions and types to support Terraform module vendoring.
Package printer defines funtionality for "printing" text to an io.Writer e.g.
Package project defines concepts that are related to a Terramate project.
Package run provides facilities to run commands inside Terramate context and ordering.
Package safeguard provides types and methods for dealing with safeguards keywords.
Package scheduler defines schedulers to execute functions on DAGs based on a specific scheduling strategy.
Package stack defines all functionality around stacks, like loading, listing all stacks, etc.
Package stdlib implements the Terramate language functions.
Package strconv provides helper functions for the Go standard strconv package.
Package test provides testing routines reused throughout terramate code base.
Package tf provides parsing and abstractions specific to Terraform.
Package tg implements functions to deal with Terragrunt files.
Package versions provide helper functions for version constraint matching.

# Functions

Version of terramate.