CLI.3 Draft a command line workflow

[neebs12]

Overview

This issue is opened to give an overview of how a constellation deploy script.js would be able to:

• Determine where the Home Region is
  • This is a non-issue. Home Region is hardcoded as "us-east-1"
• Determine the components within the Home Region
  • This is a non-issue. Home region components are absolute
• Determine where the Remote Regions are
  • Issue: This is crucial ➡️➡️ What is this going to look like in the script.js file?
  • Solution 🤔: Need to better determine the expected schema of the script.js file
• Determine the components of the Remote Regions
  • Non-issue: The architecture of a remote region is definite (tester container(s), aggregator, etc),
  • Issue: ➡️➡️ the number of VUs is user-defined - therefore tester containers must be defined to match the user-defined users
  • Issue: ➡️➡️ if we are to allow the user to determine TOTAL_VUs, REMOTE_REGIONS. We also need to be able to give the user the freedom to determine the pct in which those users are coming from.
  • Solution 🤔: Need to better determine the expected schema of the script.js file

Think about:

$ constellation deploy script.js
$ constellation view
$ constellation teardown

See examples:

• https://github.com/monsoon-load-testing/monsoon
• https://artemis-load-testing.github.io/

Teardown Issue

• Concerning $ constellation teardown. Since we are using a timestream database. This database cannot be automatically destroyed by cdk destroy (throws an error). The constraint is that NO TABLES must exist within the timestream database before the database can be torn down.
  • Solution 🤔: Think about an .sh script. This is potentially a viable solution as (1) We know the home region (2) We know the tables that are going to be created (3) We know the name of the database that is going to be deleted. Therefore this command should theoretically work:

    
    aws --region $HOME_REGION timestream-write delete-table --database-name $DB_NAME --table-name $TABLE1_NAME

aws --region us-west-2 timestream-write delete-table --database-name sample-database --table-name data_received aws --region us-west-2 timestream-write delete-table --database-name sample-database --table-name http_req-received

... etc.

  - Another Solution 🤔: Timestream Teardown lambda that is attached to an API gateway. That, when hit, is able to dynamically delete the timestream tables then database.

## Required Items for `script.js`
> What do you think a `script.js` script should consist of given what is highlighted in the **overview** section? See example ...

## Implementation

This will NOT include: 
- Home Region - as this will be hardcoded in

This will include:
- Remote Region(s) - ie: `["us-east-1", "ap-southeast-2"]`
- Number of Total VUs
- Percentage split difference between aforementioned remote regions

## Tasks

[neebs12]

See: https://app.diagrams.net/#G1sPavT1p1V-QE88XFGU8zWTYwApNRrJEm

for some ideas that are yet to be implemented

[neebs12]

Latest PR finalizes the crucial CLI workflow (visualizer still needs to be completed)