CONTRIBUTING.md

IllumiDesk Containers Contributing Guide

Dockerfiles and related assets for IllumiDesk's stack images.

Pre Requisits

• Docker

Quickstart

1. Install dependencies

make venv

2. Build images

make build-all

You can also override default tags and/or images using the --build-args flag to override the defaults assigned to the BASE_IMAGE and TAG arguments.

For example:

docker build \
  --build-arg ARG BASE_IMAGE=jupyterhub/k8s-hub:0.11.1 \
  -t illumidesk/jupyterhub:latest \
  jupyterhub/.

3. Run:

Running the image standalone is helpful for testing:

docker run -p 8888:8888 illumidesk/jupyterhub:latest

Then, navigate to http://localhost:8888 to access your JupyterHub server.

Refer to docker's documentation for additional docker run ... options.

The grader-setup-service and nginx services also support the use of docker run ....

Development and Testing

1. Create your virtual environment and install dev-requirements:

make venv

2. Check Dockerfiles and code formatting with linters:

make lint-all

3. Run tests:

The standard make test command ensures the image is built before running tests:

make test

You can skip the build step and run the tests directly:

pytest -v

References

These images are based on the jupyter/docker-stacks images. Refer to their documentation for the full set of configuration options.

License

MIT