rodan-docker-zero

Build Rodan docker images from zero.

Default docker-compose.yml sets up dev environment.

docker-compose.prod.yml sets up prod environment.

Background

Rodan is a web-based workflow engine developed by the Distributed Digital Music Archives Libraries (DDMAL) lab, McGill University.

A Rodan installation includes one Django server for backend APIs, several Celery workers and one frontend app server.

The dev environment only sets up backend API and frontend server, running Celery tasks in "eager" mode in server process.

Steps to follow

Install Docker CE (community edition) and docker-compose onto your system.
Fork studio-theyang/Rodan, clone your fork into ./rodan/Rodan, and add studio-theyang/Rodan as upstream:

cd rodan
git clone git@github.com:yourgithubname/Rodan.git
cd Rodan
git remote add upstream git@github.com:studio-theyang/Rodan.git

Fork studio-theyang/rodan-client, clone your fork into ./rodan-client/rodan-client, and add studio-theyang/rodan-client as upstream:

cd rodan-client
git clone git@github.com:yourgithubname/rodan-client.git
cd rodan-client
git remote add upstream git@github.com:studio-theyang/rodan-client.git

Run docker-compose build. (To build prod environment, run docker-compose -f docker-compose.prod.yml build)
Run docker-compose up. (To launch prod environment, run docker-compose -f docker-compose.prod.yml up)
Wait until things set up. If successful, the server is available at http://localhost:8080 and the client at http://localhost:8081.

Storage

./var/log: logs
./var/postgres: PostgreSQL database
./var/projects: Rodan projects and resources

Quick links

Create a super user for web login:

While containers are running, run docker-compose exec rodan-server /bin/bash.
Type ./manage.py createsuperuser and follow the instructions.

Troubleshoot

If you encounter "GitHub rate limit" error during the build of rodan-client, please follow these steps:

Check out the intermediate Docker image of last successful step. For example, 17e501b2b329 in following case.

Step 12/15 : RUN yarn install
 ---> Using cache
 ---> 17e501b2b329

Launch a disposable Docker container upon this image and enter into its console:

docker run --rm -it 17e501b2b329 /bin/bash

Run /code/rodan-client/node_modules/.bin/jspm registry config github and follow the instructions to enter your GitHub account, generate an API token and paste it back.
Run /code/rodan-client/node_modules/.bin/jspm registry export github and find the line like:

jspm config registries.github.auth YOUR_AUTH_TOKEN

Export this final token as a bash env:

export DEV_JSPM_GITHUB_AUTH_TOKEN=YOUR_AUTH_TOKEN docker-compose build

Finally, get back to where you were interrupted. You'll need to store this token somewhere safe, and be prepared to export again when you switch to another bash console.

docker-compose build