search

cognoma / core-service

Cognoma Core API
Other
9 stars 12 forks source link
codeforphilly cognoma django docker python webserver

readme

Cognoma core-service

This repository, under the umbrella of Project Cognoma (https://github.com/cognoma), holds the source code, under open source license, of a runnable django rest API, a component in the overall system specified in Project Cognoma.

Getting started

Make sure to fork this repository on +GitHub first.

Prerequisites

Starting up the service

docker-compose up

Sometimes the postgres image takes a while to load on first run and the Django server starts up first. If this happens just ctrl+C and rerun docker-compose up

The code in the repository is also mounted as a volume in the core-service container. This means you can edit code on your host machine, using your favorite editor, and the django server will automatically restart to reflect the code changes.

The server should start up at http://localhost:8080/, see the API docs.

Swagger UI

Accessing the root API endpoint (ex: http://localhost:8080/) will bring up the Swagger UI for viewing the API.

Note: swagger will only display endpoints that you are authorized to view. In order to authenticate, go to the top right corner and click Authorize. Where it says api_key, type in `Bearer

` and hit enter to authenticate for the rest of the session. ## Running tests locally Make sure the service is up first using `docker-compose up` then run: ```sh docker-compose exec core python manage.py test ``` ## Loading cancer static data To load data, again with service up run: ```sh docker-compose exec core bash python manage.py acquiredata python manage.py loaddata ``` To verify, run `curl http://localhost:8000/diseases/` to get a list of all diseases. Or, run `curl http://localhost:8000/samples?limit=10` to view data for 10 samples. ## Deployment ### Prerequisites This project is deployed within the Greene Lab AWS account. To be able to deploy this project you will need to: 1. Be invited to the account. 2. Receive an AWS access key and secret key. ### Logging Into ECR This project leverages [AWS Ec2 Container Service (ECS)](https://aws.amazon.com/ecs/details). ECS provides a private container registry called the [Ec2 Container Repository (ECR)](https://aws.amazon.com/ecr/). To be able to push Docker images to this repository you will first need to get a login with: ```sh aws ecr get-login --region us-east-1 ``` and then run the output of that command. It will look something like: ```sh docker login -u AWS -p -e none https://589864003899.dkr.ecr.us-east-1.amazonaws.com ``` ### Building, Tagging, and Pushing the Container This project uses two containers: one for Nginx and one for the core-service. You will probably be deploying only the core-service unless you have modified `config/prod/nginx.conf`. #### Core Service Container Run these commands: ``` docker build --tag cognoma-core-service . docker tag cognoma-core-service:latest 589864003899.dkr.ecr.us-east-1.amazonaws.com/cognoma-core-service:latest docker push 589864003899.dkr.ecr.us-east-1.amazonaws.com/cognoma-core-service:latest ``` #### Nginx Container Run these commands: ``` docker build --tag cognoma-nginx --file config/prod/Dockerfile_nginx . docker tag cognoma-nginx:latest 589864003899.dkr.ecr.us-east-1.amazonaws.com/cognoma-nginx:latest docker push 589864003899.dkr.ecr.us-east-1.amazonaws.com/cognoma-nginx:latest ``` ### Restarting the ECS Task Navigate to [Cognoma's ECS Tasks Page](https://console.aws.amazon.com/ecs/home?region=us-east-1#/clusters/cognoma/tasks) and select the tasks corresponding to the container you are deploying. The tasks will have a **Task Definition** like either `cognoma-core-service:X` or `cognoma-nginx:X` which can be used to determine which are the correct tasks. Once you have selected the correct tasks click the **Stop** button. This will cause the tasks to be stopped and ECS will restart them with the new version of the container you have pushed. Therefore you're now done. ### Updating the Data Take a look at `api/management/commands/acquiredata.py`. In there are two commit hashes, one for most of the data called `COMMIT_HASH` and one just for genes data called `GENES_COMMIT_HASH`. Update these hashes to the hash of the data that you want to update to. Once you've done so you should redploy the core-service. Once the core-service has been redeployed you should ssh onto the EC2 instance next you should run `docker ps` to get a list of containers running on that instance. Find the name for the core-service container and run `docker exec -it /bin/bash`. Within that shell run the following commands: ``` python3 manage.py acquiredata python3 manage.py loaddata ``` If these complete successfully then the data has been downloaded and loaded into cognoma's database.