The binderhub-service is a Helm chart and guide to run BinderHub (the Python software), as a standalone service to build and push images with repo2docker, possibly configured for use with a JupyterHub chart installation.
The BinderHub project provides two major pieces of functionality:
- Building (and pushing) images via an API using content from various providers.
- Launch interactive sessions using the built images (via a JupyterHub).
The current upstream binderhub helm chart is a very opinionated distribution, focusing purely on public instances of BinderHub (such as mybinder.org). It has strong opinions on how the JupyterHub should be configured, and how it should be connected to the BinderHub. While historically this allowed for faster iteration on mybinder.org itself, it has major limitations when used elsewhere.
- It places restrictions on how the JupyterHub used to launch the interactive sessions can be installed and configured. It required workarounds for several types of configuration, particularly around persistence (see persistent binderhub for example).
- It can not be deployed without the attached, opinionated JupyterHub it comes with. This makes deployment for use with alternate frontends (such as jupyterhub-fancy-profiles difficult)
This project is designed to provide a standalone helm chart that does not have these restrictions.
To prevent a recurrance of the issues with the existing binderhub chart, the following restrictions are in place for any work on this chart:
There will not be a direct dependency on a JupyterHub. We can provide documentation on how to set this chart up next to a JupyterHub, but we will not provide a JupyterHub directly (via a helm dependency) or otherwise.
The documentation should help configure the BinderHub service to:
- run behind JupyterHub authentication and authorization
- in one or more ways be able to launch built images
- in one or more ways handle the issue repo2docker building an image with data put where JupyterHub user home folders typically is mounted
Checkout this project's documentation for installation guide https://binderhub-service.readthedocs.io/en/latest.
Funded in part by GESIS in cooperation with NFDI4DS 460234259 and CESSDA.