Merge pull request #135 from ucladevx/kat-eb-deployment

Configure Backend for EB Deployment

Author: TrinaKat

.gitignore

@@ -1,5 +1,4 @@
 # Mappening
-id_rsa_mappening.pem
 scraping/data/
 src/mappening/api/*/*.json
 src/mappening/api/*.json

Makefile

@@ -1,77 +1,30 @@
 # Include Environment Variables from .env file
 include .env 
 
-ECR_REPO=698514710897.dkr.ecr.us-west-1.amazonaws.com
-BASE_NAME=mappening/base
-APP_NAME=mappening/backend
-DEV_NAME=mappening/dev
-PROD_DOCKERFILE=./src/Dockerfile
-BASE_DOCKERFILE=./src/Base-Dockerfile
-DEV_DOCKER_COMPOSE=./docker-compose-dev.yml
-
-##########################      AWS / PRODUCTION      ##########################
-
-# Authenticate Docker client
-ecr-login:
-	$(shell aws ecr get-login --no-include-email --region us-west-1)
-
-# Build backend image
-build:
-	docker build ./src -t $(APP_NAME)
-
-# Login, build, and push latest image to AWS
-push: ecr-login build
-	docker tag $(APP_NAME):latest $(ECR_REPO)/$(APP_NAME):latest
-	docker push $(ECR_REPO)/$(APP_NAME):latest
-
-#############################      AWS / DEV      ##############################
-
-# Build backend image for dora
-build-dora:
-	docker build ./src -t $(DEV_NAME):dora
-
-# Login, build, and push latest image to AWS for dev testing
-dora: ecr-login build-dora
-	docker tag $(DEV_NAME):dora $(ECR_REPO)/$(DEV_NAME):dora
-	docker push $(ECR_REPO)/$(DEV_NAME):dora
-
 ##################       LOCAL DEVELOPMENT (Backend Only)     ##################
 
-# Build backend image
+# Build backend image. Must be built before dev work (and only once unless changed)
 build-base:
 	docker build ./src -t $(BASE_NAME) -f $(BASE_DOCKERFILE)
 
-# Build backend image
-build-dev:
-	docker build ./src -t $(APP_NAME) -f $(DEV_DOCKERFILE)
-
-# Build backend image
-build-prod:
-	docker build ./src -t $(APP_NAME) -f $(PROD_DOCKERFILE)
-
-# Build and run backend image
-dev: build-dev
-	docker run --rm --name backend-dev -v $(shell pwd)/src:/app -p "5000:5000" -it $(APP_NAME)
-
-prod: build-prod
-	docker run --rm --name backend-dev -v $(shell pwd)/src:/app -p "5000:5000" -it $(APP_NAME)
-
-# Stop running containers
-stop:
-	-docker ps | tail -n +2 | cut -d ' ' -f 1 | xargs docker kill
-
-##################     			  IN PROGRESS: POSTGRES 			    ##################
-
-up-dev:
+# Run backend in dev mode with local Postgres database
+dev:
 	docker-compose -f $(DEV_DOCKER_COMPOSE) up --build
 
-up-prod:
+# Run backend in prod mode with AWS Postgres database
+prod:
 	docker-compose up --build
 
 # Stops the stack. Can also Ctrl+C in the same terminal window stack was run.
-down:
+stop:
 	docker-compose down
 
+# Kill any running containers
+kill:
+	-docker ps | tail -n +2 | cut -d ' ' -f 1 | xargs docker kill
+
+##################           LOCAL POSTGRES DATABASE          ##################
+
 # Sets CONTAINER_ID variable with ID of postgres container.
 # := means CONTAINER_ID will only be set if output is non-empty.
 # -q option for quiet output with only the container ID.
@@ -86,7 +39,7 @@ endif
 
 # Connects to psql shell of Postgres container when running `dev` target.
 pg: check-id
-	docker exec -ti $(CONTAINER_ID) psql -U $(POSTGRES_USER)
+	docker exec -ti $(CONTAINER_ID) psql -U $(POSTGRES_USER) -d $(POSTGRES_DB)
 
 # Zip current db data.
 zip:

README.md

@@ -1,63 +1,30 @@
 # Mappening-Backend
 
-## Overview
-A single platform for events across campus. Mappening helps raise awareness of events by aggregating event information from various sources of advertising.
-
 ## Documentation
 Hosted on GitHub Pages at http://ucladevx.com/Mappening-Backend/
 
-## Built With
-- Python 2.7.14
-- Flask (Port 5000): Web microframework for Python
-- mLab: Database-as-a-Service cloud-hosted MongoDB
-- Pymongo: Database Connector between MongoDB and Flask
-- Facebook Graph API + Login/OAuth for getting event information and user authentication
-- Google Maps/Places API Web Service for getting place information
-- AWS EC2/Elastic Container Service for deployment
-- Sphinx to automatically generate documentation
-- Tkinter, Selenium, Google chromedriver for internal tools
-- Beautiful Soup for web scraping
-
 ## Setting Up the Environment
-- Download [Docker](https://www.docker.com) and [Docker-Compose](https://github.com/docker/compose/releases) release 1.16.1.
-  - Run the Docker daemon
-- Clone this repository
-  - `git clone https://github.com/ucladevx/Mappening-Backend.git`
-- For Mac users, install Xcode developer tools `xcode-select --install`
-- Get the `.env` file which contains sensitive information from a dev and add it to src/mappening/utils/
+- Follow instructions in main [Mappening](https://github.com/ucladevx/Mappening) repository
+- Get the `.env` file which contains sensitive information from a dev and add it to `src/mappening/utils/`
+- Build the base image that contains all dependencies that are fairly static but take a while to install
+  - `make build-base`
 - NOTE: the database connection doesn't seem to work over UCLA_WEB wifis, a more secure connection is needed (UCLA_WIFI)
 
-#### For AWS Access
-
-- Install [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)
-  - Configure CLI with `aws configure`
-  - Requires AWS secret info (only for PM/TL)
-  - NOTE: Computer local time must be accurate lol @Hakan
-
-## How to Push Image to AWS ECS
-- Enter the repository
-  - `cd Mappening-Backend`
-- Login, build, and push image to AWS
-  - For production deployment: `make push`
-- For dev site deployment: `make dora`
-  - NOTE: for Windows/Linux users that must use `sudo` with Docker commands, use the `docker login` command generated by `make ecr-login` and run it with `sudo` before running above commands
-  
-
 ## How to Run Backend Locally
-- Build and run container
+
+- Build and run container using local Postgres database
   - `make dev`
-- Navigate to `localhost`
-- Access flask api directly at port 5000
+  - To use production database (not recommended for local development):
+    - `make prod`
+- Navigate to [http://localhost](http://localhost)
+- Access flask api directly at port [5000](http://localhost:5000/)
   - Use `localhost:5000/api/<insert_api_route_here>`
   - e.g. `localhost:5000/api/events`
 - Stop running with `CTRL+C` or `make stop` in a separate terminal window
 
-## More Info
-- Check out the [frontend](https://github.com/ucladevx/Mappening-Frontend) repository
-- Check out the [deployment](https://github.com/ucladevx/Mappening-Deployment) repository
-  - Contains instructions for local development and production
-
 ## Repo Breakdown
+
+- Database config/data in `/database`
 - Backend source code in `src/`
 - tkinter GUIs in `tkinter/`
 - Autodocumentation in `docs/`

database/create.sql

@@ -1,5 +1,5 @@
-CREATE DATABASE devxdb;
-\c devxdb;
+CREATE DATABASE mapdb;
+\c mapdb;
 
 -- List all tables and types
 

database/postgres.zip

@@ -18,6 +18,6 @@ services:
       - ${API_SERVER_PORT}:${API_SERVER_PORT}
     command: bash -c 'while !</dev/tcp/postgres/5432; do sleep 2; done; python3 app.py'
     environment:
-      - POSTGRES_URL=${POSTGRES_URL}
+      - ENV=development
     depends_on:
       - postgres

docker-compose-dev.yml

@@ -5,6 +5,5 @@ services:
     build: ./src
     ports:
       - ${API_SERVER_PORT}:${API_SERVER_PORT}
-    command: python3 app.py -p
     environment:
-      - POSTGRES_URL=${AWS_PG_URL}
+      - ENV=production

docker-compose.yml

@@ -28,7 +28,7 @@ RUN set -ex ;\
 RUN pip3 install git+https://github.com/mitsuhiko/flask-oauth
 RUN pip3 install numpy scipy gensim
 RUN pip3 install Cython
-RUN pip3 install scikit-learn
+RUN pip3 install scikit-learn==0.20.3
 RUN pip3 install pandas
 
 # https://gist.github.com/orenitamar/f29fb15db3b0d13178c1c4dd611adce2

src/Base-Dockerfile

@@ -10,4 +10,4 @@ COPY . .
 RUN ls -l
 
 EXPOSE 5000
-CMD ["python3", "app.py"]
+CMD ["python3", "-u", "app.py", "-p"]

src/Dockerfile

@@ -65,5 +65,7 @@ def thread_scheduler(args):
         print("\n~~~~~~~~~~~~~~~~~~~\n~~~ IN DEV MODE ~~~\n~~~~~~~~~~~~~~~~~~~\n")
         app.run(host='0.0.0.0', debug=True)
     else:
+        print("\n~~~~~~~~~~~~~~~~~~~~\n~~~ IN PROD MODE ~~~\n~~~~~~~~~~~~~~~~~~~~\n")
+        # TODO: Breaks EB deployment. cron jobs?
         thread_scheduler(args)
         app.run(host='0.0.0.0', debug=False)