Development¶

Before running any individual scripts, make sure to run the shell configuration script:

source .env.sh

Refer to Rafiki’s Architecture and Folder Structure for a developer’s overview of Rafiki.

Testing Latest Code Changes¶

To test the lastet code changes e.g. in the dev branch, you’ll need to do the following:

Build Rafiki’s images on each participating node (the quickstart instructions pull pre-built Rafiki’s images from Docker Hub):
bash scripts/build_images.sh
Purge all of Rafiki’s data (since there might be database schema changes):
bash scripts/clean.sh

Connecting to Rafiki’s DB¶

By default, you can connect to the PostgreSQL DB using a PostgreSQL client (e.g Postico) with these credentials:

RAFIKI_ADDR=127.0.0.1
POSTGRES_EXT_PORT=5433
POSTGRES_USER=rafiki
POSTGRES_DB=rafiki
POSTGRES_PASSWORD=rafiki

Connecting to Rafiki’s Cache¶

You can connect to Redis DB with rebrow:

bash scripts/start_rebrow.sh

…with these credentials by default:

RAFIKI_ADDR=127.0.0.1
REDIS_EXT_PORT=6380

Pushing Images to Docker Hub¶

To push the Rafiki’s latest images to Docker Hub (e.g. to reflect the latest code changes):

bash scripts/push_images.sh

Building Rafiki’s Documentation¶

Rafiki uses Sphinx documentation and hosts the documentation with Github Pages on the gh-pages branch. Build & view Rafiki’s Sphinx documentation on your machine with the following commands:

bash scripts/build_docs.sh latest
open docs/index.html

Troubleshooting¶

While building Rafiki’s images locally, if you encounter errors like “No space left on device”, you might be running out of space allocated for Docker. Try one of the following:

# Prunes dangling images
docker system prune

# Delete all containers
docker rm $(docker ps -a -q)
# Delete all images
docker rmi $(docker images -q)

From Mac Mojave onwards, due to Mac’s new privacy protection feature, you might need to explicitly give Docker Full Disk Access, restart Docker, or even do a factory reset of Docker.

Using Rafiki Admin’s HTTP interface¶

To make calls to the HTTP endpoints of Rafiki Admin, you’ll need first authenticate with email & password against the POST /tokens endpoint to obtain an authentication token token, and subsequently add the Authorization header for every other call:

Authorization: Bearer {{token}}