Skip to content

Latest commit

 

History

History
142 lines (95 loc) · 5.38 KB

README.md

File metadata and controls

142 lines (95 loc) · 5.38 KB
Raw

Welcome to the Unified Makerspace Project

Basic Service Layout

This does not include all of the services that are stood up in each stack, but it details the relationship between major parts.

AWS services for the project

Configuring the CDK

Python version 3.9 is required (or some version of it since Windows and Mac worked with different versions)

The cdk.json file tells the CDK Toolkit how to execute your app.

This project is set up like a standard Python project. The initialization process also creates a virtualenv within this project, stored under the .env directory. To create the virtualenv it assumes that there is a python3 (or python for Windows) executable in your path with access to the venv package. If for any reason the automatic creation of the virtualenv fails, you can create the virtualenv manually.

To manually create a virtualenv on MacOS and Linux:

$ python3 -m venv .env

After the init process completes and the virtualenv is created, you can use the following step to activate your virtualenv.

$ source .env/bin/activate

If you are a Windows platform, you would activate the virtualenv like this:

% .env\Scripts\activate.bat

Once the virtualenv is activated, you can install the required dependencies.

$ pip install -r requirements.txt

You must now ensure that you are signed into AWS CLI:

Instructions for configuring AWS CLI:

In order to sign into your AWS account on the CLI, follow one of the 3 options below:

1. Configure the AWS CLI to use AWS SSO. This will allow you to use the AWS CLI without having
to manually navigate to the login page. To do this, follow the instructions in [this guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sso.html#sso-using-profile). Keep in mind that if you go this route, in order
to get temporary credentials you will need to run `aws sso login` before each command.

2. Export the credentials to your environment variables. To do this, login to the [AWS SSO Page](https://clemson-makerspace.awsapps.com/start/) for the Makerspace.
From there, Click on "AWS Account" and select the tab for your dev account.
It should say "dev-{your-clemson-username}". Lastly, select "Command line or programmatic access" on the row for "AdministratorAccess". Simply copy and paste what is in the option 1 box into your terminal, and the tokens should take effect.

3. Add the AWS account to your credentials file ~/.aws/credentials. This option is not reccomended because the credentials rotate every hour. Follow the same steps for option 2 to get access to the credentials for your dev account. From there, copy and paste the values in the option 2 box into `~/.aws/credentials` and the tokens should take effect.

At this point you can now synthesize the CloudFormation template for this code.

Something important to keep in mind is that your AWS credentials will rotate every hour. If you are running into any access issues with your tokens, check the SSO and make sure your tokens match those that are there.

$ cdk synth

If the synth is successful, you can then deploy to the AWS account you are currently signed into

$ cdk deploy

If you are updating an existing CloudFormation Stack, you will be met with a changelog which you can then review and hit "y" to approve

To add additional dependencies, for example other CDK libraries, just add them to your setup.py file and rerun the pip install -r requirements.txt command.

Useful commands

  • cdk ls list all stacks in the app
  • cdk synth emits the synthesized CloudFormation template
  • cdk deploy deploy this stack to your default AWS account/region
  • cdk diff compare deployed stack with current state
  • cdk docs open CDK documentation

Enjoy!

Synthesizing the dev stack

If you don't have an AWS account or haven't configured your workspace to create the dev stack (this might work automatically) then the only stack you'll see when synthesizing is the Pipeline stack, which works by creating a Beta and Prod stage and deploying the full makerspace stack.

If dev stack setup worked for you automatically, then you can skip this next part. If it did not, then you can get it working with the following steps:

  1. Add your Clemson username to the accounts_config python module
  2. Set USER=<you-username> when synthesizing or deploying, for example:
USER=mhall6 cdk list

You'll need to have account permissions to the account you configure for your username.

If you're trying to get an end-to-end example working in dev, you'll have to override the API URL and visit your cloudfront domains directly rather than, for example beta-visit.cumaker.space or visit.cumaker.space.

Local Testing with Pytest

Activate the virtualenv

Set all of these env variables (you can change ENV to Beta or Prod)

AWS_DEFAULT_REGION: us-east-1
AWS_REGION: us-east-1
ORIGINAL_TABLE_NAME: original
USERS_TABLE_NAME: users
VISITS_TABLE_NAME: visits
QUIZ_LIST_TABLE_NAME: quiz_list
QUIZ_PROGRESS_TABLE_NAME: quiz_progress
DOMAIN_NAME: https://visit.cumaker.space
ENV: Beta

Run this in the unified-makerspace folder (on Windows)

pytest cdk/visit/lambda_code

You can also run the testing_script.py which doesn't use Pytest (on Windows)

python ./cdk/visit/lambda_code/test_api/testing_script.py