Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 3.28 KB

DeveloperGuide.md

File metadata and controls

84 lines (50 loc) · 3.28 KB
Raw

VAMS Developer Guide

Installing VAMS

VAMS is installed using AWS CDK.

Prerequisites

  • Python 3.8
  • Node 16.x
  • Node Version Manager (nvm)
  • AWS cli
  • CDK cli
  • Amplify cli
  • Programatic access to AWS account at minimum access levels outlined above.

Installation Steps

Build & Deploy Steps

  1. cd ./web nvm use - make sure you're node version matches the project.

  2. npm run build - build the web app

  3. cd ../infra npm install - installs dependencies in package.json

  4. If you haven't already bootstrapped your aws account with CDK. cdk bootstrap aws://101010101010/us-east-1 - replace with your account and region

  5. cdk deploy dev --parameters [email protected] - replace with your email address to deploy dev stack

Deployment Success

  1. Navigate to URL provided in {stackName].WebAppCloudFrontDistributionDomainName{uuid} from cdk deploy output.

  2. Check email for temporary account password.

Multiple Deployments Same Account/Region

Providing a unique stack name in the deployment command cdk deploy STACK_NAME --parameters [email protected] will allow for this to work without conflicts.

Uninstalling

  1. Run cdk destroy from infra folder
  2. Some resources may not be deleted by CDK (e.g S3 buckets and DynamoDB table) and you will have to delete them via aws cli or using aws console

Note:

After running CDK destroy there might still some resources be running in AWS that will have to be cleaned up manually as CDK does not delete some resources.

Deployment Overview

The CDK deployment deploys the VAMS stack into your account. The components that are created by this app are:

  1. Web app hosted on cloudfront distribution
  2. API Gateway to route front end calls to api handlers.
  3. Lambda Lambda handlers are created per API path.
  4. DynamoDB tables to store Workflows, Assets, Pipelines
  5. S3 Buckets for assets, cdk deployments and log storage
  6. Jupyter Notebook is created one per pipeline
  7. Sagemaker Processing jobs are created per pipeline execution
  8. Cognito User Pool for authentication

ARCHITECTURE

API Schema:

Please see Swagger Spec for details

Updating Backend

The dependencies for the backend lambda functions are handled using poetry. If you changed the lambda functions make sure to do a cdk deploy to reflect the change.

The lambda handlers are categorized based on the project domain. E.g you will find all assets related functions in /backend/backend/assets folder.

Testing API

Please see the corresponding Postman Collection provided.

Once the solution is deployed, you will have to put in the below details as Global Variables in the Postman Collection

Postman Variables

Updating and Testing Frontend

Within the web folder You can do npm run start to start a local frontend application.