OutpostSpawner

The OutpostSpawner in combination with the JupyterHub Outpost service enables JupyterHub to spawn single-user notebook servers on multiple remote resources.

Documentation

Link to documentation.

Overview

The JupyterHub community created many useful JupyterHub Spawner over the past years, to allow JupyterHub to use the specific resources of different systems. For most of these Spawners JupyterHub has to run at the system itself. The OutpostSpawner enables the use of these Spawners on remote systems.

Other Spawners like SSHSpawner can spawn single-user servers on remote systems, but are not able to use system-specific features like KubeSpawner or BatchSpawner.

The JupyterHub Outpost service in combination with the OutpostSpawner enables a single JupyterHub to offer multiple remote systems of different types.

• Use one JupyterHub to offer single-user servers on multiple systems.
• Each system may use a different JupyterHub Spawner.
• Integrated SSH port forwarding solution to reach remote single-user server.
• supports the JupyterHub internal_ssl feature.
• shows events gathered by the remote Spawner to the user.
• Users can override the configuration of the remote Spawner at runtime (e.g. to select a different Docker Image).
• One JupyterHub Outpost can be connected to multiple JupyterHubs, without interfering with each other.

Requirements

JupyterHub must run on a Kubernetes Cluster (recommended is the use of Zero2JupyterHub).
The JupyterHub Outpost must fulfill the requirements of the configured Spawner class.