Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

Latest commit

 

History

History
284 lines (197 loc) · 8.22 KB

README.md

File metadata and controls

284 lines (197 loc) · 8.22 KB
Raw

Qualifier Scoreboard

This repository contains a number of React frontends applications:

  • countdown_frontend
  • registration_frontend
  • scoreboard_frontend

Additionally, the scoreboard_backend directory contains a serverless application for managing the server-side components that run in AWS lambda.

Table of Contents

Deployment Prerequisites

The following are necessary in order to develop, test, and deploy the components that make up the scoreboard.

AWS Configuration

In order to deploy these applications, you will need a profile named ooo in your ~/.aws/credentials file containing your aws_access_key_id and aws_secret_access_key. For more information on setting up this file see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html

You also need the AWS CLI. New versions have their own install system.

Frontend Dependencies

The frontend applications are all written using React. React depends on npm and Node.js. Install node via your favorite package manager or from https://nodejs.org/.

Additionally, the instructions below use yarn as the Javascript package manager, so you will want to install yarn as well. Instructions for installing yarn can be found at https://yarnpkg.com/lang/en/docs/install/.

Once yarn is installed, to develop or deploy any of the frontend application will first require installing the application's packages. Do that via:

cd APP_frontend
yarn install

Backend Dependencies

All the backend applications use serverless https://serverless.com/framework/docs/providers/aws/guide/installation/.

Install using

npm install -g serverless
npm install --save-dev serverless-kms-secrets

.env files

TODO: you have to source .env at the repo root.

Frontend Applications

The frontend applications each build to static html, css, and javascript. The deployed code lives in the ooodc2019q-scoreboard S3 bucket under the dev and prod prefixes.

Cloudfront distributions are configured to serve files out of that S3 bucket mapped to an appropriate prefix.

The S3 bucket is accessible via Coudfront through the access-identity Origin Access Identity: https://console.aws.amazon.com/cloudfront/home?#oai:

TODO: changed? The development distribution is protected by HTTP basic authentication using the attached scoreboard-basic-auth lambda function: https://console.aws.amazon.com/lambda/home?region=us-east-1#/functions/scoreboard-basic-auth?tab=graph

Countdown

Countdown Screenshot

Up until the competition starts, https://scoreboard.oooverflow.io should host the countdown_frontend. This application counts down to the start of the competition. When the countdown is exhausted a message appears indicating to wait for changes to propagate.

Development

cd countdown_frontend
yarn start

Deployment

Deploy to https://scoreboard.oooverflow.io via:

cd countdown_frontend
./deploy.sh

The index.html file is set to be cached for 60 seconds so everyone should be able to see updates within a minute of deployment.

Registration

This application is where team will go to register. By default it deploys to https://d1768hg74eqlzd.cloudfront.net/#/ where it is protected by HTTP basic authentication (credentials listed on Slack). This application is intended to be deployed to the production environment at the start of the competition.

Development

cd registration_frontend
yarn start

Deployment

Deploy to https://d1768hg74eqlzd.cloudfront.net/ via:

cd registration_frontend
./deploy.sh

Production Deployment

To make an update to the registration page, deploy to https://register.oooverflow.io via:

cd registration_frontend
BUILD=production ./deploy.sh

You will be prompted to confirm that you want to deploy to production.

The index.html file is set to be cached for 60 seconds so everyone should be able to see updates within a minute of deployment.

Scoreboard

Countdown Screenshot

This application is the actual scoreboard that the qualifiers will use. By default it deploys to https://d2b8nk094e89za.cloudfront.net where it is protected by HTTP basic authentication (credentials listed in #quals_scoreboard on Slack). This application is intended to be deployed to the production environment at the start of the competition.

Development

cd scoreboard_frontend
yarn start

Deployment

Deploy to https://d2b8nk094e89za.cloudfront.net via:

cd countdown_frontend
./deploy.sh

Production Deployment

To kick off the competition, or make an update during the competition, deploy to https://scoreboard.oooverflow.io via:

cd countdown_frontend
BUILD=production ./deploy.sh

You will be prompted to confirm that you want to deploy to production.

The index.html file is set to be cached for 60 seconds so everyone should be able to see updates within a minute of deployment.

scoreboard_backend

This directory contains a serverless application for managing the server-side components that run in AWS lambda.

If you're not familiar with lambda, each function is its own program. Some functions are mapped to API endpoints, and others (migrate, scoreboard_set) are only meant to be invoked directly.

Development

By default, all the commands listed below are set up to deploy to the development environment. When making changes, first deploy to development via sls deploy, or sls deploy -f FUNCTION to quickly push code changes to a single function. Then re-run the test suite via pytest.

Note: If you make changes to registration, run the slow tests via pytest --runslow.

Once the tests have passed on development (you've written new tests for your changes, right?), deploy to production via sls deploy --stage production. Make sure you've coordinated the release of any respective front-end changes as well.

Note: For all the following sls commands, add --stage production in order to issue that command in the production environment.

Setting the challenges

TODO: can use the script instead?

To rewrite the set of challenges (this is a destructive action), first create a scoreboard.json using chalmanager.

Noting where scoreboard.json is saved as SCOREBOARD_JSON_PATH, run the following command to update the challenges on the scoreboard:

cd scoreboard_backend
sls invoke -lf challenges_set --path SCOREBOARD_JSON_PATH

Opening a challenge

Run the following:

cd scoreboard_backend
sls invoke -lf challenge_open -d '{"id": "CHALLENGE_ID"}'

Helper Scripts

Reset Password

cd scoreboard_backend
STAGE=production ./scripts/reset_password.sh USERNAME PASSWORD

Note: the password must be at least 10 characters

Other Comments

Run terraform apply in ./terraform to build/update the scoreboard infrastructure in AWS.

After running for the first time a few values have to be updated:

In serverless.yml

  • securityGroupIds needs to be set to the ID of the lambda security group
  • subnetIds needs to be set to all of the private subnet ids
  • DB_HOST needs to be updated to the endpoint of the RDS instance