JupyterHub BaseSpawner class. Enables remote single-user server.
Project description
ForwardBaseSpawner
The ForwardBaseSpawner is a base class, which can be used by any Spawner that creats the singleuser notebook server on a remote system. The ForwardBaseSpawner itself cannot start anything. The actual logic of starting / stopping must be implemented in a subclass.
Overview
The JupyterHub ForwardBaseSpawner offers a variety of useful functions, to enable and manage the communication between JupyterHub and a singleuser notebook servers, which runs on a remote machine. It covers the following functionalities:
- Manage ssh port forwarding process from JupyterHub to singleuser notebook server
- Manage ssh port forwarding process from singleuser notebook server to JupyterHub
- Manage Kubernetes Service Resource to make singleuser notebook server reachable for JupyterHub
- Adds cancel function. Allows the user to cancel an ongoing spawn process
- Start process of remote singleuser notebook servers may send their current progress to SpawnEventsAPIHandler, which shows it to the user
- SetupTunnelAPIHandler allows to define the ssh jump node between JupyterHub and singleuser notebook server during the spawn process
- ListServersAPIHandler returns all running UserID-servername combinations. Gives remote systems the chance to compare their running servers with the JupyterHub ones
- SSHNodeRestartedAPIHandler enables a recreation of all port forwarding process to a specific jump node. Required when a jump node was restarted
For more information and the usage have a look at the JupyterHub OutpostSpawner documentation. It's a subclass of the ForwardBaseSpawner and enables a central JupyterHub to start singleuser notebook-server on multiple remote systems.
You can find a few examples and configurations over there.
Requirements
At least one JupyterHub running on a Kubernetes Cluster (recommended is the use of Zero2JupyterHub). A subclass of the ForwardBaseSpawner which implements the actual start/stop logic for singleuser notebook servers.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyterhub_forwardbasespawner-1.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85a8f01de6e5274f674161576beddd74d250b2277bb3018363e4b965791bccc8 |
|
MD5 | eff6a7569d088131ed44043d30a007c0 |
|
BLAKE2b-256 | 67f55648036c7f19109e0d77499d57dc1054d5859aa81e19a81f2774bbd7911f |
Hashes for jupyterhub_forwardbasespawner-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4170bb347f6fa14277a04a61c163f12716f765afaf2c17f60238b63c03fbe0b1 |
|
MD5 | f7a5ab75a76a095483c9c6dd827aed9a |
|
BLAKE2b-256 | 99c01e72f71c75c66ad797a00e74b8781ac7cfb40600c05b848ff6f5782f0d80 |