Skip to content

boltops-tools/terraspace

Repository files navigation

Terraspace

Gem Version

BoltOps Badge

BoltOps Learn Badge

The Terraform Framework.

Official Docs Site: terraspace.cloud

Support the Project

  • Please watch/star this repo to help grow and support the project.
  • Consider subscribing to BoltOps Learn. You'll get access to many training videos. Subscribing helps support the project.

Quick Start

Watch the video

Here are commands to get started:

terraspace new project infra --plugin aws --examples
cd infra
terraspace up demo
terraspace down demo
  • The new command generates a starter project.
  • The up command creates an s3 bucket.
  • The down command cleans up and deletes the bucket.

The default plugin is aws. Major cloud providers are supported: aws, azurerm, google.

Usage

Create infrastructure:

$ terraspace up demo
Building .terraspace-cache/us-west-2/dev/stacks/demo
Current directory: .terraspace-cache/us-west-2/dev/stacks/demo
=> terraform init -get >> /tmp/terraspace/log/init/demo.log
=> terraform apply
Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
$

Destroy infrastructure:

$ terraspace down demo
Building .terraspace-cache/us-west-2/dev/stacks/demo
Current directory: .terraspace-cache/us-west-2/dev/stacks/demo
=> terraform destroy
Destroy complete! Resources: 2 destroyed.
$

Deploy Multiple Stacks

To deploy all the infrastructure stacks:

$ terraspace all up
Will run:
    terraspace up vpc      # batch 1
    terraspace up mysql    # batch 2
    terraspace up redis    # batch 2
    terraspace up instance # batch 3
Are you sure? (y/N)

To choose multiple stacks to deploy

$ terraspace all up mysql redis
Will run:
    terraspace up vpc   # batch 1
    terraspace up mysql # batch 2
    terraspace up redis # batch 2
Are you sure? (y/N)

When you use the all command, the dependency graph is calculated and the stacks are deployed in the right order.

Terrafile

Terraspace makes it easy to use Terraform modules sourced from your own git repositories, other git repositories, or the Terraform Registry. Use any module you want:

Terrafile:

# GitHub repo
mod "s3", source: "boltops-tools/terraform-aws-s3", tag: "v0.1.0"
# Terraform registry
mod "sg", source: "terraform-aws-modules/security-group/aws", version: "3.10.0"

To install modules:

terraspace bundle

Features

  • DRY: You can keep your code DRY. Terraspace builds your Terraform project with common app and config/terraform structure that gets built each deploy. You can override the settings if needed, like for using existing backends. See: Existing Backends.
  • Generators: Built-in generators to quickly create the starter module. Focus on code instead of boilerplate structure.
  • Multiple Environments: Tfvars & Layering allow you to the same code with different tfvars to create multiple environments. Terraspace conventionally loads tfvars from the tfvars folder. Rich layering support allows you to build different environments like dev and prod with the same code. Examples are in Full Layering.
  • Deploy Multiple Stacks: The ability to deploy multiple stacks with a single command. Terraspace calculates the dependency graph and deploys stacks in the right order. You can also target specific stacks and deploy subgraphs.
  • Secrets Support: Terraspace has built-in secrets support for AWS Secrets Manager, AWS SSM Parameter Store, Azure Key Vault, Google Secrets Manager. Easily set variables from Cloud secrets providers.
  • Terrafile: Terraspace makes it easy to use Terraform modules sourced from your own git repositories, other git repositories, or the Terraform Registry. The git repos can be private or public. This is an incredibly powerful feature of Terraspace because it opens up a world of modules for you to use. Use any module you want.
  • Configurable CLI: Configurable CLI Hooks and CLI Args allow you to adjust the underlying terraform command.
  • Testing: A testing framework that allows you to create test harnesses, deploy real-resources, and have higher confidence that your code works.
  • Terraform Cloud and Terraform Enterprise Support: TFC and TFE are both supported. Terraspace adds additional conveniences to make working with Terraform Cloud Workspaces easier.
  • Terraspace Cloud Support: Terraspace Cloud adds additional features and conveniences like a Dashboard, History, Team Management, Permissions, Real-time Logging, and Cost Estimates. It's specifically designed for Terraspace. You might also be interested in this blog post: Terraspace Cloud Intro

Comparison

Here are some useful comparisons to help you compare Terraspace vs other tools in the ecosystem:

More info: terraspace.cloud