illumidesk / docker-stacks

IllumiDesk workspace docker images

IllumiDesk

This monorepo is used to maintain IllumiDesk's authenticators, spawners, and microservices. This setup assumes that all services are running with Kubernetes. Please refer to our help guides for more information.

Overview

Jupyter Notebooks are a great education tool for a variety of subjects since it offers instructors and learners a unified document standard to combine markdown, code, and rich visualizations. With the proper setup, Jupyter Notebooks allow organizations to enhance their learning experiences.

When combined with the nbgrader package instructors are able to automate much of tasks associated with grading and providing feedback for their users.

Why?

Running a multi-user setup using JupyterHub and nbgrader with containers requires some additional setup. Some of the questions this distribution attempts to answer are:

• How do we manage authentication when the user isn't a system user within the JupyterHub or Jupyter Notebook container?
• How do we manage permissions for student and instructor folders?
• How do we securely syncronize information with the Learning Management System (LMS) using the LTI 1.1 and LTI 1.3 standards?
• How do we improve the developer experience to provide more consistency with versions used in production, such as with Kubernetes?
• How should deployment tools reflect these container-based requirements and also (to the extent possible) offer users an option that is cloud-vendor agnostic?

Our goal is to remove these obstacles so that you can get on with the teaching!

Prerequisites

Kubernetes v1.17+.

Quick Start

This setup only supports Kubernetes-based installations at this time. Refer to the helm-chart repo for installation instructions.

Development Installation

Refer to the contributing guide located in the root of this repo.

Building the JupyterHubs

1. Build the JupyterHub for local testing with docker-compose or docker:

make build-hubs

1. Build the JupyterHub for local testing with Kubernetes:

make build-hubs-k8

General Guidelines

This project enforces the Contributor Covenant. Be kind and build a nice open source community with us. ++

License

Please refer to the included license in this repository's root directory.

docker-stacks's Issues

Include async-nbgrader package

Include the async-nbrader package in the grader-notebook.

Migrate from npm-based semantic release manager to python-semantic-release

Migrate to the Python-based semantic release package.

Update nbgrader package

Replace the custom nbgrader package with the standard nbgrader package.

Update base-image to provide support for SameSite cookies

Update base image's configuration and default python version to support SameSite cookie settings:

• Update base image that is built with repo2docker set python to 3.8 with either the environment.yml or runtime.txt
• Update jupyter_notebook_config.py with c.NotebookApp.tornado_settings = {"cookie_options": {"SameSite": "None", "Secure": True}}

IllumiDesk/illumidesk#291

Migrate to GitHub Actions

Migrate from Travis-CI to GitHub Actions to build and test images.

The Grader Console tab does not appear

The latest versions of the Notebook are missing the command to enable the formgrader extension. Update the grader's Dockerfile to include this command.

Segregate Julia notebook from Python/R notebook

The Julia dependencies are conflicting with the conda dependencies for both R and Python3. Users that use Julia for their assignments rarely need both Julia and R and only need the basic Python packages.

Update base-image to install packages from scripts / files

Install additional packages with files:

• Julia: install.jl
• R (currently using conda): environment.yml
• Python: requirements.txt

Add tests

Add tests to ensure:

• Language runtimes for base-notebook: Java, Julia, Python, R
• Conda packages (Python and R - tests inherited from jupyter/docker-stacks)
• Julia precompiled packages (based on install.jl package list)

Update bash script to add grader extensions based on notebook type

Update the enable_extensions.sh script to install the grader extensions based on theGrader role.

Theia image build error

Overview

Building the image fails during the build stage.

Reproduce

make build/theia

Additional context

Removing the SHELL directive in the build stage fixes the issue.

Update image build and push options

• Update docker image build and push options to improve automation.
• Update documentation to include examples with make
• Update GitHub Actions build and push images job
• Update nbgrader package to install with pip without traitlets==5.0.5

Update jupyter_server_proxy dependency

Update jupyter_server_proxy to version 3.x and refactor Dockerfiles to remove steps to enable server extension for Jupyter Classic and build/install extension for Jupyter Lab.