Orchestrator

A RESTful API with Flask (and Flask-PyMongo), which provides traceability of transactions occuring on the Morpheo platform. In its next version, the Orchestrator will be translated to a permissionned blockchain.

Documentation (with endpoints specification) can be found here!

Licence: CECILL 2.1 (compatible with GNU GPL)

Getting started

Requirements:

• MongoDB
• Python3
• If you want: virtualenv and virtualenvwrapper

Make sure Python3 and MongoDB are installed.

Clone the repository, create a virtual environment with Python3, and instal pip packages:

git clone https://github.com/DeepSeeOrg/orchestrator.git
cd orchestrator/app
mkvirtualenv --python=/usr/bin/python3 orchestrator
setvirtualenvproject
pip install -r requirements.txt

Define two env variables for (temporary) authentication: USER_AUTH and PWD_AUTH.

Note: If you want to enable CORS, set the environment variable: CORS=True

Usage

Start MongoDB:
on Linux it is done automatically but you can force it with
sudo service mongod start
on OSX
mongod

Launch the app: python api.py
To launch the app with gunicorn: gunicorn --config gunicorn_config.py api:app

Interact with the api (see here for more details):

• GET example with curl: curl -u $USER_AUTH:$PWD_AUTH http://0.0.0.0:5000/problem
• POST example with curl: curl -u $USER_AUTH:$PWD_AUTH http://0.0.0.0:5000/problem -d '{"uuid": "2d0aa3a3-eb5f-42e6-9d34-c6e4db235816", "workflow": "5d13b116-6dad-4311-94a6-784273cc0467", 'test_dataset': ['7aca2765-996a-4175-8d46-7f32ba34d75e', 'ec619ded-5907-45e2-bf73-42b0873e807b'], 'size_train_dataset': 2}' -X POST -H "Content-type: application/json"
• POST example with python requests package:

import os
import requests
d = {'problems': ['26f0a7ee-5077-443b-8159-8c6783cf7e5a'], 'uuid': '70aec8ac-7f5b-4808-b0e8-f59b04821540'}
a = requests.post("http://0.0.0.0:5000/data", auth=(os.environ.get("USER_AUTH"), os.environ.get("PWD_AUTH")), json=d)

Run the app using Docker Compose

Requirements:

• docker
• docker-compose 1.11.2

To build and run the service:

docker-compose up --build

Coverage

We use coverage.py.

Run
coverage run test_api.py
coverage report -m api.py
Without -m api.py the coverage report goes to irrelevant depth. We can specify the files to be reported on with -m file1 file2 ...