Custom notebooks

birdhouse/config/jupyterhub/jupyterhub_config.py.template

@@ -3,6 +3,8 @@ from os.path import join
 import logging
 import subprocess
 
+from dockerspawner import DockerSpawner
+
 c = get_config()  # noqa  # can be called directy without import because injected by IPython
 
 c.JupyterHub.bind_url = 'http://:8000/jupyter'
@@ -20,7 +22,27 @@ c.JupyterHub.db_url = '/persist/jupyterhub.sqlite'
 
 c.JupyterHub.template_paths = ['/custom_templates']
 
-c.JupyterHub.spawner_class = 'dockerspawner.DockerSpawner'
+class CustomDockerSpawner(DockerSpawner):
+    def start(self):
+        if(os.environ['MOUNT_IMAGE_SPECIFIC_NOTEBOOKS'] == 'true'):
+            host_dir = join(os.environ['JUPYTERHUB_USER_DATA_DIR'], 'tutorial-notebooks-specific-images')
+
+            # Mount a volume with a tutorial-notebook subfolder corresponding to the image name, if it exists
+            image_name = self.user_options.get('image')
+            if(os.path.isdir(join(host_dir, image_name))):
+                self.volumes[join(host_dir, image_name)] = {
+                    "bind": '/notebook_dir/tutorial-notebooks',
+                    "mode": "ro"
+                }
+        else:
+            # Mount the entire tutorial-notebooks directory
+            self.volumes[join(os.environ['JUPYTERHUB_USER_DATA_DIR'], "tutorial-notebooks")] = {
+                "bind": "/notebook_dir/tutorial-notebooks",
+                "mode": "ro"
+            }
+        return super().start()
+
+c.JupyterHub.spawner_class = CustomDockerSpawner
 
 # Selects the first image from the list by default
 c.DockerSpawner.image = os.environ['DOCKER_NOTEBOOK_IMAGES'].split()[0]
@@ -49,13 +71,6 @@ if len(host_gdrive_settings_path) > 0:
         "mode": "ro"
     }
 
-host_tutorial_notebooks_dir = join(jupyterhub_data_dir, "tutorial-notebooks")
-c.DockerSpawner.volumes[host_tutorial_notebooks_dir] = {
-    "bind": join(notebook_dir, "tutorial-notebooks"),
-    "mode": "ro"
-}
-
-
 readme = os.environ['JUPYTERHUB_README']
 if os.path.exists(readme):
     c.DockerSpawner.volumes[readme] = {
@@ -86,7 +101,7 @@ c.Spawner.disable_user_config = True
 c.DockerSpawner.default_url = '/lab'
 c.DockerSpawner.remove = True  # delete containers when servers are stopped
 ${ENABLE_JUPYTERHUB_MULTI_NOTEBOOKS}    # noqa
-c.DockerSpawner.pull_policy = "always"  # for images not using pinned version
+# c.DockerSpawner.pull_policy = "always"  # for images not using pinned version
 c.DockerSpawner.debug = True
 c.JupyterHub.log_level = logging.DEBUG
 

birdhouse/default.env

@@ -4,13 +4,25 @@
 # Jupyter single-user server images, can be overriden in env.local to have a space separated list of multiple images
 export DOCKER_NOTEBOOK_IMAGES="pavics/workflow-tests:210216"
 
+# Name of the image displayed on the JupyterHub image selection page
+# Can be overriden in env.local to have a space separated list of multiple images, the name order must correspond
+# to the order of the DOCKER_NOTEBOOK_IMAGES variable
+export JUPYTERHUB_IMAGE_SELECTION_NAMES="pavics"
+
 export FINCH_IMAGE="birdhouse/finch:version-0.7.1"
 
 export THREDDS_IMAGE="unidata/thredds-docker:4.6.15"
 
 # Folder on the host to persist Jupyter user data (noteboooks, HOME settings)
 export JUPYTERHUB_USER_DATA_DIR="/data/jupyterhub_user_data"
 
+# Log directory used for the various scheduler tasks
+# TODO: use this variable for other references of the log path (only used in the pavics-jupyter-base's .env file for now)
+export PAVICS_LOG_DIR=/var/log/PAVICS
+
+# Activates mounting a tutorial-notebooks subfolder that has the same name as the spawned image on JupyterHub
+export MOUNT_IMAGE_SPECIFIC_NOTEBOOKS=false
+
 # Path to the file containing the clientID for the google drive extension for jupyterlab
 export JUPYTER_GOOGLE_DRIVE_SETTINGS=""
 

birdhouse/docker-compose.yml

@@ -350,6 +350,7 @@ services:
       - "8800:8000"
     environment:
       DOCKER_NOTEBOOK_IMAGES: ${DOCKER_NOTEBOOK_IMAGES}
+      JUPYTERHUB_IMAGE_SELECTION_NAMES: ${JUPYTERHUB_IMAGE_SELECTION_NAMES}
       DOCKER_NETWORK_NAME: jupyterhub_network
       JUPYTERHUB_USER_DATA_DIR: ${JUPYTERHUB_USER_DATA_DIR}
       JUPYTERHUB_ADMIN_USERS: ${JUPYTERHUB_ADMIN_USERS}
@@ -358,6 +359,7 @@ services:
       JUPYTER_DEMO_USER_CPU_LIMIT: ${JUPYTER_DEMO_USER_CPU_LIMIT}
       JUPYTER_GOOGLE_DRIVE_SETTINGS: ${JUPYTER_GOOGLE_DRIVE_SETTINGS}
       JUPYTERHUB_README: ${JUPYTERHUB_README}
+      MOUNT_IMAGE_SPECIFIC_NOTEBOOKS: ${MOUNT_IMAGE_SPECIFIC_NOTEBOOKS}
     volumes:
       - ./config/jupyterhub/jupyterhub_config.py:/srv/jupyterhub/jupyterhub_config.py:ro
       - ./config/jupyterhub/custom_templates:/custom_templates:ro

birdhouse/env.local.example

@@ -211,12 +211,19 @@ export POSTGRES_MAGPIE_PASSWORD=postgres-qwerty
 #                               pavics/crim-jupyter-eo:0.1.0 \
 #                               pavics/crim-jupyter-nlp:0.1.0"
 
+# Name of the images displayed on the JupyterHub image selection page
+# The name order must correspond to the order of the DOCKER_NOTEBOOK_IMAGES variable,
+# and both variables should have the same number of entries.
+#export JUPYTERHUB_IMAGE_SELECTION_NAMES="pavics \
+#                                         eo-crim \
+#                                         nlp-crim"
+
 # allow jupyterhub user selection of which notebook image to run
 # see https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html
 #export ENABLE_JUPYTERHUB_MULTI_NOTEBOOKS="
-#c.DockerSpawner.image_whitelist = {'pavics': os.environ['DOCKER_NOTEBOOK_IMAGES'].split()[0],
-#                                   'eo-crim': os.environ['DOCKER_NOTEBOOK_IMAGES'].split()[1],
-#                                   'nlp-crim': os.environ['DOCKER_NOTEBOOK_IMAGES'].split()[2],
+#c.DockerSpawner.image_whitelist = {os.environ['JUPYTERHUB_IMAGE_SELECTION_NAMES'].split()[0]: os.environ['DOCKER_NOTEBOOK_IMAGES'].split()[0],
+#                                   os.environ['JUPYTERHUB_IMAGE_SELECTION_NAMES'].split()[1]: os.environ['DOCKER_NOTEBOOK_IMAGES'].split()[1],
+#                                   os.environ['JUPYTERHUB_IMAGE_SELECTION_NAMES'].split()[2]: os.environ['DOCKER_NOTEBOOK_IMAGES'].split()[2],
 #                                   'jupyter/scipy-notebook': 'jupyter/scipy-notebook',
 #                                   'jupyter/r-notebook': 'jupyter/r-notebook',
 #                                   'jupyter/tensorflow-notebook': 'jupyter/tensorflow-notebook',
@@ -226,6 +233,28 @@ export POSTGRES_MAGPIE_PASSWORD=postgres-qwerty
 #                                   }
 #"
 
+# Load jobs to automatically deploy the custom notebooks from the specific images
+#
+# Ensure we always use the "latest" version of the "cronjob generation code"
+# Path to a checked out repo of "pavics-jupyter-base" (https://github.com/bird-house/pavics-jupyter-base)
+# which contains the config required for the cronjob generation
+#CHECKOUT_PAVICS_JUPYTER_BASE="/path/to/checkout/pavics-jupyter-base"
+#export AUTODEPLOY_EXTRA_REPOS="$AUTODEPLOY_EXTRA_REPOS $CHECKOUT_PAVICS_JUPYTER_BASE"
+
+# Config for the generation of cronjobs, found on external repo
+#DEPLOY_DATA_PAVICS_JUPYTER_ENV="$CHECKOUT_PAVICS_JUPYTER_BASE/scheduler-jobs/deploy_data_pavics_jupyter.env"
+
+# Generates a cronjob for each image found in DOCKERNOTEBOOK_IMAGES
+#if [ -f "$DEPLOY_DATA_PAVICS_JUPYTER_ENV" ]; then
+#  . $DEPLOY_DATA_PAVICS_JUPYTER_ENV
+#fi
+
+# Activates mounting a tutorial-notebooks subfolder that has the same name as the spawned image on JupyterHub
+# This variable is only useful if there are more than one image in DOCKER_NOTEBOOK_IMAGES
+# and ENABLE_JUPYTERHUB_MULTI_NOTEBOOKS is set with a proper c.DockerSpawner.image_whitelist
+# matching the images in DOCKER_NOTEBOOK_IMAGES and their corresponding JUPYTERHUB_IMAGE_SELECTION_NAMES.
+# export MOUNT_IMAGE_SPECIFIC_NOTEBOOKS=true
+
 # The parent folder where all the user notebooks will be stored.
 # For example, a user named "bob" will have his data in $JUPYTERHUB_USER_DATA_DIR/bob
 # and this folder will be mounted when he logs into JupyterHub.
@@ -307,4 +336,4 @@ export POSTGRES_MAGPIE_PASSWORD=postgres-qwerty
 # To enable emu: add './optional-components/emu' to EXTRA_CONF_DIRS above.
 
 # Emu WPS service image if that testing component is enabled
-#export EMU_IMAGE="tlvu/emu:watchdog"
+#export EMU_IMAGE="tlvu/emu:watchdog"