Ctrl+K

OutpostSpawner

OutpostSpawner#

The OutpostSpawner in combination with the JupyterHub Outpost service enables JupyterHub to spawn single-user notebook servers on heterogenous remote resources. It is a subclass of the JupyterHub ForwardBaseSpawner.

Overview#

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

While Spawners like the SSHSpawner can already spawn single-user servers on remote systems, they are not able to utilize system-specific features like KubeSpawner or BatchSpawner.

The OutpostSpawner in combination with the JupyterHub Outpost service enables a single JupyterHub to spawn single-user notebook servers using a variety of Spawners on a variety of remote systems.

  • Use one JupyterHub to offer single-user servers on multiple systems of potentially different types.

  • Each (remote) system may use a different JupyterHub Spawner.

  • Forward spawn 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).

  • Integrated SSH port forwarding solution to reach otherwise isolated remote single-user servers.

  • Supports the JupyterHub internal_ssl feature.

  • One JupyterHub Outpost can be connected to multiple JupyterHubs without interfering with each other.

Requirements#

At least one JupyterHub running on a Kubernetes Cluster (recommended is the use of Zero2JupyterHub). It is not necessary that the JupyterHub Outpost service runs on Kubernetes, but recommended.
The JupyterHub Outpost must fulfill the requirements of the configured Spawner class.

License#

BSD 3-Clause License

Copyright (c) 2023, Forschungszentrum Juelich GmbH

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

General

Usage

Spawners

Contents