Skip to content

Latest commit

 

History

History
64 lines (55 loc) · 3.63 KB

README.md

File metadata and controls

64 lines (55 loc) · 3.63 KB
Raw

Tools

Docker

Our project uses Docker for development and deployment. You should download Docker (community edition), then run through the Docker Tutorial to familiarize yourself with Docker commands and how they work. The Makefile depends on Docker.

Git-Crypt

git-crypt: We use git-crypt to decrypt files environment files and keys usage automatically while pushing/pulling. On Mac, install git-crypt using brew install git-crypt. Otherwise follow the INSTALL.md in the git-crypt repo. To use git-crypt, one must have the BruinBiteSecretKey.key file, which will be distributed to each developer through other means. make secrets and make unlock rely on this tool.

Installation Instructions

Using this repo requires Docker, docker-compose, and git-crypt. See the above sections on how to install them. After installing them, to set up the repo would require:

  1. Start Docker
  2. Download the BruinBitSecretKey.key into the repo
  3. Run make unlock to use the key to unlock the secrets
  4. Then run make (this step may take a while, you can use the -j flag to speed this up)

General Debugging Tips:

  • To listen to logs from python run docker logs -f <CONTAINER_ID>. You can find the container ID by running docker ps.

Makefile

Make commands for dev

  • make unlock: Decrypts files and untars secrets. Will move files that might be overwritten into a directory based on the git branch name (e.g. master-secrets/)
  • make: by default will build the development containers defined in docker-compose.dev.yml, and then calls docker-compose up on those containers
  • make dev-build: Builds containers defined in docker-compose.dev.yml
  • make dev-run: Calls docker-compose up on containers. Use Crtl-C to stop the containers
  • make dev-down: This deletes all the cached containers and volumes. This is especially critical for Postgres containers which will otherwise be reused despite being stopped, restarted, or even survive having the container removed.
  • make clean: Removes all generated files
  • make secrets: Makes tar file of env/pem files

Make commands for production

Instructions for running/deploying stuff on production servers. You should not normally do this on your own computer.

  • make prod: builds and runs containers in detached mode
  • prod-build: builds containers in docker-compose.yml
  • prod-up: calls docker-compose up in detached mode on containers (docker-compose.yml)
  • prod-down: Stops containers defined in docker-compose.yml

First Time Configuration of Server

Install required tools

  • sudo yum update -y # update all packages
  • sudo yum install git # need to git clone two repositories
  • sudo yum install gcc
  • sudo yum install gcc-c++ # need C++ compiler to build git-crypt
  • sudo yum install openssl-devel # needed for git-crypt
  • run git clone on the backend repository, and git clone the git-crypt repository
  • Follow the Install instructions for git-crypt https://github.com/AGWA/git-crypt/blob/master/INSTALL.md (run make and make install, requires gcc)

Installing docker and docker-compose

  • sudo yum update -y # update
  • sudo yum install docker -y # install docker
  • sudo service docker start # start docker as a service in the background
  • sudo usermod -aG docker ec2-user # add ec2-user to docker group, to use docker w/o sudo.
  • Get the latest version of docker-compose using the curl command here and then add the chmod permissions: https://docs.docker.com/compose/install/
  • sudo chmod +x /usr/local/bin/docker-compose

Log out and back in to make sure user permissions are correct.