Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
| doku:jupyterhub [2023/02/27 09:06] – [BYOI: Bring your own (Singularity) Image] katrin | doku:jupyterhub [2023/04/03 08:23] – [BYOI: Bring your own (Singularity) Image] katrin | ||
|---|---|---|---|
| Line 70: | Line 70: | ||
| To stop the server, click on ' | To stop the server, click on ' | ||
| - | ===== BYOI: Bring your own (Singularity) Image ===== | + | ===== BYOI: Bring your own (Apptainer/Singularity) Image ===== |
| - | It is possible to use a custom singularity image with our JupyterHub profiles. | + | It is possible to use a custom |
| - | A good starting point is to have a look at the official JupyterHub Docker Stacks Images @ [[https:// | + | ==== Necessary Packages ==== |
| - | In a nutshell | + | To get your custom image to run in our JupyterHub environment |
| < | < | ||
| - | jupyterhub==3.0.0 | + | # This package pulls in all the necessary dependencies to start a jupyter server |
| - | git+https:// | + | jupyterhub==3.1.1 |
| + | |||
| + | # This package provides functionality needed to run in the slurm environment of VSC (e.g. `batchspawner-singleuser` script). | ||
| + | git+https:// | ||
| </ | </ | ||
| - | In addition we also install the following jupyterlab extensions in our images but they are not strictly necessary and just provide extended functionality like memory monitoring for the user: | + | In addition we usually |
| * jupyterlab-system-monitor | * jupyterlab-system-monitor | ||
| * jupyterlab-git | * jupyterlab-git | ||
| * jupyterlab-widgets | * jupyterlab-widgets | ||
| - | **An up 2 date list of packages can always be found in our repo: [[https:// | + | **An up 2 date list of packages can always be found in our repo: [[https:// |
| - | In order to be able to use the image with JupyterHub you also have to make sure to convert it to a **singularity image** (or build it as a singularity image in the first place) and place it into a folder that is accessible from the VSC compute nodes. | + | ==== Via Docker Container ==== |
| + | |||
| + | A good starting point for your own container are the official JupyterHub Docker Stacks Images @ [[https:// | ||
| + | |||
| + | In order to be able to use the image with JupyterHub you also have to convert it to a **singularity image** (or build it as a singularity image in the first place) and place it into a folder that is accessible from the VSC compute nodes. | ||
| Building a singularity image from e.g. a docker container can easily be done with the `singularity build` command. See the singularity documentation for examples: [[https:// | Building a singularity image from e.g. a docker container can easily be done with the `singularity build` command. See the singularity documentation for examples: [[https:// | ||
| Line 107: | Line 114: | ||
| ===== FAQ ===== | ===== FAQ ===== | ||
| - | |||
| - | * **The OTP SMS says 'login at vsc3'? Is this an issue?** | ||
| - | |||
| - | No this is a current limitation of our OTP system and should not cause any problems. | ||
| * **My Server instance is stuck and I get a timeout when I try to reload the window. Going to the VSC jupyterhub website also results in a timeout.** | * **My Server instance is stuck and I get a timeout when I try to reload the window. Going to the VSC jupyterhub website also results in a timeout.** | ||