Moot - A Serverless Release Dashboard

AWS Serverless solution that implements a release dashboard that provides a single button press for deploying code changes to production.

How it all works

User’s onboard github or gitlab repositories (need to specify a BASE (main) and HEAD (develop) branch) in the frontend, at which point you can then deploy code changes to a production environment by hitting deploy. Deploying creates pull requests which merge the HEAD branch into BASE, and creates a release. Users can also select hotfix, which skips the pull request and creates a release based on the BASE branch.

To make it all work, you’ll need to configure your production continuous integration deployment pipeline trigger with a regex check on the release version number so that it’s only triggered on semver releases, for example. You’ll also need to provide a github or gitlab API token to give the dashboard access to make API calls to the respective VCS provider. These tokens will be stored as SSM parameters within AWS.

Deploys trigger the following workflow:

• Create Github / Gitlab PR base <- head (e.g. main <- develop)
• Approve PR
• Create Release based on base branch
• Send Slack message to a channel with the release notes.

Hotfix Deploys trigger the following workflow:

• Create Release based on base branch
• Send Slack message to a channel with the release notes.

This solution utilises the following services:

• API Gateway (auth + routing)
• Cloudwatch (logging)
• Cognito (auth)
• DynamoDB (backend storage)
• Lambda (backend compute)
• S3 + Cloudfront (VueJS frontend)
• SSM Parameter Store (secrets management)

Requirements

The following tools must be installed in order to fully deploy Moot

• yarn — used to build the frontend locally
• awscli — used to aws s3 sync the frontend assets
• go — requires at least version 16 because of go modules
• gcc (build essentials) — required for go build

Installation

The below snippet will fully deploy the dashboard (backend + frontend). In this instance, I am deploying to a cheap Route53 domain I purchased for testing purposes (moot.link).

If your AWS account does not have a Route53 hosted zone, remove the hosted_zone_name and fqdn_alias lines to use Cloudfront’s default certificate and dns.

See the terraform_examples directory for deployable examples.

module "moot" {
  source = "github.com/seanturner026/moot.git"
  name                           = "moot"
  aws_profile                    = "default"
  admin_user_email               = var.admin_user_email
  enable_delete_admin_user       = false
  github_token                   = var.github_token
  gitlab_token                   = var.gitlab_token
  slack_webhook_url              = var.slack_webhook_url
  fqdn_alias                     = "moot.link"
  hosted_zone_name               = "moot.link"
  enable_api_gateway_access_logs = true
  tags                           = var.tags
}

Repositories View

Add Repository View

Users View

Terraform Information

Requirements

No requirements.

Providers

Inputs

Outputs