Overview


Orbit Deploy / Destroy Details


Steps to Deploy AWS Orbit Workbench

This page outlines the steps to deploy an AWS Orbit Workbench. The workbench source code is found in the AWS Labs github repository.

Some of these steps (as indicated) will only need to be run once, others can be run multiple times in order to update the deployment.



IMPORTANT
The workbench uses a manifest to define componenents of the infrastructure. The manifest is in YAML format.
Please see the full list of elements in a manifest for reference.

Steps Outline

Dependancies

  • Python 3.7 (recommended)

Outline

  1. Clone AWS Labs github repository
  2. Install the CLI
    • only once
  3. Install AWS CodeSeeder
    • only once
  4. Generate a new manifest
    • once created, you will add / remove from this manifest as your platform changes
  5. Deploy a new foundation
    • you may have an existing foundation (VPC, Subnets, EFS, and Cognito) that can be leveraged
    • this is OPTIONAL if you have the necessary components
  6. Deploy a new toolkit
    • only once
  7. Deploy credentials
    • only once
    • this is OPTIONAL
  8. Deploy docker images
    • once deployed, you may deploy one or all the base workbench images as needed
  9. Deploy environment
    • only once, but can be rerun to update an existing environment
  10. Deploy teams
    • you may run this repeatedly to update teams or plugins