Overview

This is a reference design and implementation of an environment template to provision self service developer environments running on Amazon ECS. This reference design is based on Rafay's Environment Manager.

Source Code for Template¶

The Terraform source code and related assets are available in a public Git repo as shown below

Git Repo

Design & Architecture¶

This design assumes an ECS cluster will be created and assigned on-demand to the developer for their applications.

Architecture

Initial Setup¶

The platform team is expected to setup the Environment Manager templates in a Rafay project that will then be used by developers for self service provisioning of ECS clusters.

sequenceDiagram 
    participant plat as Platform Team 
    participant rafay as Rafay Environment Manager 

    plat->>rafay: Create Developer Project
    plat->>rafay: Setup Environment Template
    plat->>rafay: Share Environment Template with Projects
    rafay-->>plat: Setup Complete

Request for Environment¶

When a developer requests a cluster via self service, a series of automated workflows need to be performed to fulfil this request. The sequence diagram below describes the high level steps.

Important

Although the recommended workflow assumes and recommends using an Integration with an Identity Provider (IdP) to provide a Single Sign On (SSO) experience, organizations can also use locally managed users.

sequenceDiagram
    participant dev as Developer
    participant rafay as Rafay
    participant csp as <br>AWS

    dev->>rafay: New ECS <br>based Environment
    rafay-->>csp: Create VPC  
    rafay-->>csp: Create ECS Cluster 
    rafay-->>csp: Deploy Application to ECS 
    rafay->>dev: Environment Ready
    dev-->>rafay: Access/Use Application

Assumptions¶

You have access to a AWS Account
You have access to a Mac or Linux machine
You have a Git client on your machine that is setup for push/pull
You have Docker installed on your machine