Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
doku:jupyterhub [2023/03/22 18:58] – [BYOI: Bring your own (Singularity) Image] katrin | doku:jupyterhub [2023/11/14 13:51] (current) – [Necessary Packages] 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 it is only necessary | + | A good starting point for creating your own container |
+ | |||
+ | Apart from adding your own software the image also needs to have at least the following packages | ||
< | < | ||
- | jupyterhub==3.0.0 | + | # This package pulls in all the necessary dependencies to start a jupyter server |
- | git+https:// | + | # 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:// | ||
</ | </ | ||
- | 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. | + | === Run hooks from / |
- | + | ||
- | 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:// | + | |
- | + | ||
- | ==== Run hooks from / | + | |
If your image needs to run hooks before startup (e.g. the pyspark image depends on this [[https:// | If your image needs to run hooks before startup (e.g. the pyspark image depends on this [[https:// | ||
Line 103: | Line 105: | ||
Note: Contact us to get read rights to the repository. | Note: Contact us to get read rights to the repository. | ||
+ | ==== Build your own custom image from a docker image ==== | ||
+ | [[https:// | ||
+ | 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. | ||
- | ===== FAQ ===== | + | 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:// |
- | | + | After selecting / building the docker image all that needs to be done is to convert it into a **singularity image**. |
- | No this is a current limitation | + | You can do this by executing the following lines (assuming your docker image is named " |
+ | < | ||
+ | singularity build my_image.sif docker:// | ||
+ | </ | ||
+ | |||
+ | See the documentation for more examples: [[https:// | ||
+ | |||
+ | When the conversion process has finished make sure that the resulting " | ||
+ | |||
+ | Note: the conversion can be done on our cluster since we have singularity installed on our nodes. | ||
+ | |||
+ | ==== Directly build a singularity/ | ||
+ | |||
+ | Instead | ||
+ | |||
+ | For this you need to create a so called " | ||
+ | |||
+ | Here is a minimal example using the datascience docker stacks image as a basis: | ||
+ | < | ||
+ | BootStrap: docker | ||
+ | From: jupyter/ | ||
+ | |||
+ | %post | ||
+ | / | ||
+ | </ | ||
+ | |||
+ | If we save the file as " | ||
+ | |||
+ | Please | ||
+ | |||
+ | * VSC4: module load --auto apptainer/ | ||
+ | * VSC5: module load --auto apptainer/ | ||
+ | |||
+ | |||
+ | < | ||
+ | # load an apptainer module (see above) | ||
+ | module load --auto apptainer/< | ||
+ | |||
+ | # build the image | ||
+ | apptainer build my_image.sif my_image.def | ||
+ | </ | ||
+ | |||
+ | 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.** | * **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.** |