Welcome to FirecRESTSpawner’s documentation!

FirecRESTSpawner is a JupyterHub spawner plugin that allows users to launch Jupyter notebook servers on High-Performance Computing (HPC) systems via the FirecREST REST API.

It is developed by adapting the architecture of batchspawner, replacing traditional scheduler-based job submission (e.g. Slurm commands) with FirecREST-powered remote job control via PyFirecREST.

Installation

The repository must be cloned and installed with pip

git clone https://github.com/eth-cscs/firecrestspawner.git
cd firecrestspawner
pip install .

Content:

• Authentication
  • Oveview
  • Authorization Code Flow
  • Client Credentials Flow
  • Enabling JupyterHub’s authentication state
• Deployment
  • Reference deployment at CSCS
  • FirecREST’s Docker Compose demo
  • Testing JupyterHub deployments
• Reference
  • Spawners
  • Single-user server
  • Chart Values

Contact

In case of questions/bugs/feature requests feel free to open issues in the Github repository.