Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
doku:jupyterhub [2021/11/08 19:46]
goldenberg [Jupyterhub]
doku:jupyterhub [2023/11/14 13:51] (current)
katrin [Necessary Packages]
Line 1: Line 1:
-====== Jupyterhub ======+====== JupyterHub ======
  
-The VSC offers a jupyterhub available for all VSC users at [[https://vsc.ac.at/jupyterhub]]+The VSC offers a JupyterHub service available for all VSC users at [[https://jupyterhub.vsc.ac.at]]
  
 Login works with any cluster user (both VSC3 and VSC4) and uses the OTP like on the cluster. A VPN connection is not needed. Login works with any cluster user (both VSC3 and VSC4) and uses the OTP like on the cluster. A VPN connection is not needed.
  
-===== start a server =====+Also make sure to checkout the [[doku:jupyterhub#FAQ|FAQ]] to see if your question was already answered. 
 + 
 + 
 +===== Important Information: Resource Allocation ===== 
 + 
 +The started Jupyter Server instance runs on a separate hardware partition ('jupyter') in each cluster in order to not interfere with the regular operation of VSC.  
 + 
 +Since the machines in this partition are shared between all users it is important to be aware of the memory requirements of the processing you are doing.  
 + 
 +In order to help the Jupyter users the VSC Team recently added a Memory Resources Monitor plugin to the JupyterLab IDE. It is displayed in the right upper corner of the JupyterLab IDE and shows the current memory consumption of the Jupyter Server instance.  
 + 
 +If your job goes out of memory it will affect your job as well as other users running on the same node. This is a hardware/system limitation of how slurm and linux work together. So make sure to have the right amount of memory selected for your purposes. 
 + 
 +<box 80% round orange|Important> Always make sure to select the right amount of memory suited to your requirements.</box> 
 + 
 +===== Start new Jupyter server =====
  
 choose a profile: choose a profile:
-  * VSC4 Singularity Image - a singularity image running on VSC4 (this is the default) +  * VSC-4 Singularity Image (this is the default) 
-  * VSC3 Singularity Image - a singularity image running on VSC3+ +  * VSC-4 python venv 
-  * VSC3 GPU nodes a singularity image with CUDA support running on GPU nodes of VSC3+ (currently only GTX1080) +  * VSC-4 conda python env 
-  * VSC4 python venv a python virtual environment running directly on VSC4 +  * VSC-3 Singularity Image 
-  * If you are participating in a course, there is most likely only a fixed profile available+  * VSC-GTX1080 GPU Singularity Image 
 +  * 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
  
 **Note:** You need a VSC4 user for the VSC4 profiles and a VSC3 user for the VSC3 profiles. You also need to have logged into the respective cluster via SSH at least once after getting a username. **Note:** You need a VSC4 user for the VSC4 profiles and a VSC3 user for the VSC3 profiles. You also need to have logged into the respective cluster via SSH at least once after getting a username.
Line 20: Line 38:
 For all the singularity profiles, you can choose between a predefined image (default) or a custom image: For all the singularity profiles, you can choose between a predefined image (default) or a custom image:
   * Predefined image gives a dropdown list of different singularity images. Each image shows a short description, a version, an author and a link to the image. The GPU option only has one predefined image. See also some examples [[https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html|here]]   * Predefined image gives a dropdown list of different singularity images. Each image shows a short description, a version, an author and a link to the image. The GPU option only has one predefined image. See also some examples [[https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html|here]]
-  * Custom image shows a line where the complete path to the image has to be entered. Note that the image has to reside on the cluster already. Web-upload is not possible.+  * Custom image shows a line where the complete path to the image has to be entered. Note that the image has to reside on the cluster already. Web-upload is not possible at the moment
  
-**Note:** course profiles usually do not allow for customization.+**Note:** training profiles usually do not allow for customization.
  
-Independent of the profile you can choose the number of CPUs, size of the RAMthe maximum running time.+Independent of the profile you can choose the number of CPUs, size of the RAM and the maximum running time.
  
 After everything is selected, press start - your server will start and show you the JupyterLab interface or the simpler Notebook interface. In both cases, there is a list of all files in your home directory, which includes previously created notebooks. After everything is selected, press start - your server will start and show you the JupyterLab interface or the simpler Notebook interface. In both cases, there is a list of all files in your home directory, which includes previously created notebooks.
  
-===== JupyterLab =====+ 
 +==== Working with JupterLab IDE ====
  
 Simply click on the desired notebook in your list - it will open in the main panel. Simply click on the desired notebook in your list - it will open in the main panel.
Line 36: Line 55:
 It is possible to log out of the system and leave the server running with File -> Log Out. Keep in mind that this also keeps the selected resources blocked for other users. It is possible to log out of the system and leave the server running with File -> Log Out. Keep in mind that this also keeps the selected resources blocked for other users.
  
-To stop the server, user File -> Hub Control Panel and choose 'Stop My Server'+To stop the server, user //File// -> //Hub Control Panel// 
  
 +On the page that opens click the button labelled 'Stop My Server'
  
-===== Jupyter Notebook ===== 
  
-Simply click on the desired notebook in your list - it will be opened in a new tab.+==== Working with Jupyter Notebook IDE ==== 
 + 
 +If you have chosen to work with the Jupyter Notebook IDE, simply click on the desired notebook in your list - it will be opened in a new tab.
  
 On first use, no notebook is present yet. To create one (or to create new ones), click on 'new' in the upper right area above the file list and choose the appropriate type. The new notebook will start in a new browser tab. It will show up as untitled in the file list, and can be renamed by selecting the checkbox to the left of the name and choose 'rename' at the top. On first use, no notebook is present yet. To create one (or to create new ones), click on 'new' in the upper right area above the file list and choose the appropriate type. The new notebook will start in a new browser tab. It will show up as untitled in the file list, and can be renamed by selecting the checkbox to the left of the name and choose 'rename' at the top.
Line 49: Line 70:
 To stop the server, click on 'Control Panel' at the top right and choose 'Stop My Server' To stop the server, click on 'Control Panel' at the top right and choose 'Stop My Server'
  
 +===== BYOI: Bring your own (Apptainer/Singularity) Image =====
 +
 +It is possible to use a custom apptainer/singularity image with our JupyterHub profiles. 
 +
 +==== Necessary Packages ====
 +
 +A good starting point for creating your own container is the documentation of the official JupyterHub Docker Stacks Images @ [[https://github.com/jupyter/docker-stacks|Docker-Stacks]] 
 +
 +Apart from adding your own software the image also needs to have at least the following packages for it to be able to run in our JupyterHub environment:
 +<code>
 +# This package pulls in all the necessary dependencies to start a jupyter server
 +# Make sure this always matches the current JupyterHub version used by VSC
 +jupyterhub==3.1.1        
 +
 +# This package provides functionality needed to run in the slurm environment of VSC (e.g. `batchspawner-singleuser` script).
 +git+https://github.com/katringoogoo/batchspawner.git@1.2.0+auth_fix        
 +</code>
 +
 +In addition we usually 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 (or jupyterlab_widgets in conda)
 +
 +**An up 2 date list of packages can always be found in our repo: [[https://gitlab.tuwien.ac.at/vsc/jupyterhub/jupyterhub-docker-stacks/-/blob/main/tools/requirements.txt|requirements.txt]]**
 +
 +=== Run hooks from /usr/local/bin/before-notebook.d ===
 +
 +If your image needs to run hooks before startup (e.g. the pyspark image depends on this [[https://github.com/jupyter/docker-stacks/blob/master/pyspark-notebook/Dockerfile|PySpark Dockerfile]]), the docker stack images provide a folderfor such startup scripts `/usr/local/bin/before-notebook.d`. 
 +
 +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.
 +
 +The script can be found at [[https://gitlab.tuwien.ac.at/vsc/vsc-jupyterhub-notebooks/-/blob/main/tools/vsc-singleuser.sh|vsc-singleuser.sh]]. 
 +
 +Note: Contact us to get read rights to the repository.
 +
 +==== Build your own custom image from a docker image ====
 +
 +[[https://docs.docker.com/engine/reference/builder/|Dockerfile Documentation]]
 +
 +If you already have a docker image you want to start from or if you are more familiar with docker image creation you can just use that image and create it into a singularity image after you are finished.
 +
 +Note: Make sure that you use the right versions for the current version of our JupyterHub (the version is displayed at the bottom of the [[http://jupyterhub.vsc.ac.at|jupyterhub page]] and was 3.1.1 at the time of writing).
 +
 +After selecting / building the docker image all that needs to be done is to convert it into a **singularity image**. 
 +
 +You can do this by executing the following lines (assuming your docker image is named "my_image")
 +<code>
 +singularity build my_image.sif docker://my_image
 +</code>
 +
 +See the documentation for more examples: [[https://apptainer.org/user-docs/3.8/build_a_container.html|Build a (singularity) container]]
 +
 +When the conversion process has finished make sure that the resulting ".sif" file is placed in a folder that is available from all compute nodes (e.g. home dir; data dir)
 +
 +Note: the conversion can be done on our cluster since we have singularity installed on our nodes. 
 +
 +==== Directly build a singularity/apptainer image ====
 +
 +Instead of starting with docker you can also directly build a singularity image that is ready to use with our JupyterHub instance.
 +
 +For this you need to create a so called ".def" file - see the singularity documentation for more information on this format: [[https://apptainer.org/user-docs/3.8/definition_files.html|Definition Files]]
 +
 +Here is a minimal example using the datascience docker stacks image as a basis:
 +<code>
 +BootStrap: docker
 +From: jupyter/datascience-notebook:hub-3.1.1
 +
 +%post
 +/opt/conda/bin/pip install jupyterhub==3.1.1 git+https://github.com/katringoogoo/batchspawner.git@1.2.0+auth_fix               
 +</code>
 +
 +If we save the file as "my_image.def" we can use the build command to build the image with singularity/apptainer. 
 +
 +Please not that you have to use apptainer if you want to build on the cluster, since the singularity version that comes installed on all nodes from the OS needs root rights to build an image.
 +
 +  * VSC4: module load --auto apptainer/1.1.9-gcc-12.2.0-vflkcfi
 +  * VSC5: module load --auto apptainer/1.1.6-gcc-12.2.0-xxfuqni
 +
 +
 +<code>
 +# load an apptainer module (see above)
 +module load --auto apptainer/<version>
 +
 +# build the image
 +apptainer build my_image.sif my_image.def
 +</code>
 +
 +If you cannot use the versions provided on VSC you can of course also build the image on your own machine and upload it the VSC.
 +
 +===== FAQ =====
 +
 +  * **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://jupyterhub.vsc.ac.at/hub/home]]. From there you can click 'Stop My Server' to stop the running instance (if there is any).
  
  
  • doku/jupyterhub.1636400769.txt.gz
  • Last modified: 2021/11/08 19:46
  • by goldenberg