JupyterHub Batch Spawner for GLiCID

JupyterHub spawner config

In jupyterhub_config.py, add:

c.JupyterHub.spawner_class = "glicid-spawner"

Custom parameters can be added with c.GlicidSpawner.req_<my_parameter> = .... The complete list of configurable parameters are available in spawner.py.

JupyterHub authenticator config

The spawner also contains a custom Authentik authenticator based on Jupyter generic OAuth authenticator. This configuration is optional but can be setup like this:

c.JupyterHub.authenticator_class = "authentik"

c.AuthentikAuthenticator.base_url = "https://authentik.example.org"
c.AuthentikAuthenticator.client_id = "abcdef"
c.AuthentikAuthenticator.client_secret = "xxxxxx"
c.AuthentikAuthenticator.callback_base_url = "https://jupyter.example.org"
c.AuthentikAuthenticator.allowed_groups = { "jupyter-users" }
c.AuthentikAuthenticator.admin_groups = { "jupyter-admins" }

Contribution

This package is managed by Poetry:

git clone https://gitlab.univ-nantes.fr/glicid/jupyter/spawner glicid-spawner
cd glicid-spawner
poetry install
poetry run pre-commit install

To test the spawner:

poetry run pytest

To lint and format the source code:

poetry run ruff check . --fix
poetry run ruff format

To render the form template (with live reload):

poetry run python -m render [--single-cluster]

To activate the virtual environement globally:

source .venv/bin/activate

Bump to a new version:

poetry run tbump Major.Patch

External resources

• https://jupyterhub.readthedocs.io/en/stable/reference/spawners.html
• https://github.com/jupyterhub/batchspawner
• https://gitlab.com/idris-cnrs/jupyter/jupyter-jeanzay-spawner/
• https://gitlab.com/ifb-elixirfr/cluster/utils/slurmspawner/
• https://getbootstrap.com/docs/3.4/