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 [2022/05/23 12:22] – katrin | doku:jupyterhub [2023/02/27 09:03] – [BYOI: Bring your own (Singularity) Image] katrin | ||
---|---|---|---|
Line 24: | Line 24: | ||
choose a profile: | choose a profile: | ||
* VSC-4 Singularity Image (this is the default) | * VSC-4 Singularity Image (this is the default) | ||
+ | * VSC-4 python venv | ||
+ | * VSC-4 conda python env | ||
* VSC-3 Singularity Image | * VSC-3 Singularity Image | ||
- | * VSC-3 GPU nodes - a singularity image with CUDA support (currently only GTX1080) | + | * VSC-3 GTX1080 |
- | * VSC-4 python venv - a python virtual environment | + | * VSC-3 A40 GPU Singularity Image |
* If you are participating in a training, there is most likely only a single fixed profile or special training profiles available | * If you are participating in a training, there is most likely only a single fixed profile or special training profiles available | ||
Line 73: | Line 76: | ||
A good starting point is to have a look at the official JupyterHub Docker Stacks Images @ [[https:// | A good starting point is to have a look at the official JupyterHub Docker Stacks Images @ [[https:// | ||
- | In a nutshell | + | In a nutshell |
+ | * jupyterhub==3.0.0 - This package pulls in all the necessary dependencies to start a jupyter server | ||
+ | * git+https://github.com/katringoogoo/ | ||
+ | |||
+ | 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: | ||
+ | * jupyterlab-system-monitor | ||
+ | * jupyterlab-git | ||
+ | * jupyterlab-widgets | ||
+ | |||
+ | **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. | ||
+ | |||
+ | 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:// | ||
- | Optionally: If your image needs to run hooks before starting the script the original docker stacks provide a folder for such startup scripts `/ | + | ==== Run hooks from / |
- | Unfortunately the batchspawner package has not been updated yet so in order to restore this functionality we are using an (optional) startscript called `vsc-singleuser.sh`. All it does is to run the hooks from `/ | + | If your image needs to run hooks before startup |
- | The script can be found at [[https:// | + | Unfortunately the batchspawner package does not source them so we are using a custom startscript in our images called `vsc-singleuser.sh`. All it does is to run the hooks from `/usr/local/bin/before-notebook.d` before executing the `batchspawner-singleuser` script. |
- | In addition we also install the following jupyterlab extensions in our images: | + | The script can be found at [[https:// |
- | * jupyterlab-system-monitor | + | |
- | * jupyterlab-git | + | |
- | * jupyterlab-widgets | + | |
- | An up 2 date list of packages can always be found in our repo: [[https:// | + | Note: Contact us to get read rights to the repository. |
- | In order to then use the image with JupyterHub you have to convert it to a singularity image 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:// | ||
Line 101: | Line 112: | ||
* **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.** | ||
- | In order to to control the running instance, navigate directly to the following URL: [[https:// | + | In order to to control the running instance, navigate directly to the following URL: [[https://jupyterhub.vsc.ac.at/ |