Adding new jupyterlab image (#378)

## Overview
Add a jupyterlab image to be launch from jupyterhub containing mlflow,
this image can be found under
https://github.com/bird-house/pavics-jupyter-base/tree/mlflow-proxy

## Changes
**Non-breaking changes**
- Changes jupyterhub version from 1.4.0-20210506 to 4.0.2-20230816
- Add an image to the list of images that can be launched from
JupyterHub which will be used to start an instance of MLflow.

## Related Issue / Discussion

- Resolves [DAC-573](https://crim-ca.atlassian.net/browse/DAC-573) 

Notes
jupyter lab google drive extension is not supported with this image

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.31.3
+current_version = 1.32.0
 commit = True
 tag = False
 tag_name = {new_version}
@@ -30,11 +30,11 @@ search = {current_version}
 replace = {new_version}
 
 [bumpversion:file:RELEASE.txt]
-search = {current_version} 2023-09-21T01:15:38Z
+search = {current_version} 2023-09-22T16:09:24Z
 replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ}
 
 [bumpversion:part:releaseTime]
-values = 2023-09-21T01:15:38Z
+values = 2023-09-22T16:09:24Z
 
 [bumpversion:file(version):birdhouse/config/canarie-api/docker_configuration.py.template]
 search = 'version': '{current_version}'

CHANGES.md

@@ -17,6 +17,18 @@
 
 [//]: # (list changes here, using '-' for each new entry, remove this when items are added)
 
+[1.32.0](https://github.com/bird-house/birdhouse-deploy/tree/1.32.0) (2023-09-22)
+------------------------------------------------------------------------------------------------------------------
+
+## Changes
+
+- Changes `JUPYTERHUB_VERSION` from `1.4.0-20210506` to `4.0.2-20230816`.
+  - This upgrade is needed to resolve a compatibility issue when using `Spawner.disable_user_config = True` in Jupyterhub 
+    config and the new image which run `jupyter-server 2.7.3`.
+
+- Add an image to the list of images that can be launched from JupyterHub which will be used to start an instance of MLflow.
+  - Note that the jupyter lab google drive extension is not supported with this image.
+
 [1.31.3](https://github.com/bird-house/birdhouse-deploy/tree/1.31.3) (2023-09-21)
 ------------------------------------------------------------------------------------------------------------------
 

Makefile

@@ -1,7 +1,7 @@
 # Generic variables
 override SHELL       := bash
 override APP_NAME    := birdhouse-deploy
-override APP_VERSION := 1.31.3
+override APP_VERSION := 1.32.0
 
 # utility to remove comments after value of an option variable
 override clean_opt = $(shell echo "$(1)" | $(_SED) -r -e "s/[ '$'\t'']+$$//g")

README.rst

@@ -14,13 +14,13 @@ for a full-fledged production platform.
     * - releases
       - | |latest-version| |commits-since|
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/1.31.3.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/1.32.0.svg
     :alt: Commits since latest release
-    :target: https://github.com/bird-house/birdhouse-deploy/compare/1.31.3...master
+    :target: https://github.com/bird-house/birdhouse-deploy/compare/1.32.0...master
 
-.. |latest-version| image:: https://img.shields.io/badge/tag-1.31.3-blue.svg?style=flat
+.. |latest-version| image:: https://img.shields.io/badge/tag-1.32.0-blue.svg?style=flat
     :alt: Latest Tag
-    :target: https://github.com/bird-house/birdhouse-deploy/tree/1.31.3
+    :target: https://github.com/bird-house/birdhouse-deploy/tree/1.32.0
 
 .. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest
     :alt: ReadTheDocs Build Status (latest version)

RELEASE.txt

@@ -1 +1 @@
-1.31.3 2023-09-21T01:15:38Z
+1.32.0 2023-09-22T16:09:24Z

birdhouse/config/canarie-api/docker_configuration.py.template

@@ -109,8 +109,8 @@ SERVICES = {
             # NOTE:
             #   Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
             #   Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
-            'version': '1.31.3',
-            'releaseTime': '2023-09-21T01:15:38Z',
+            'version': '1.32.0',
+            'releaseTime': '2023-09-22T16:09:24Z',
             'institution': 'Ouranos',
             'researchSubject': 'Climatology',
             'supportEmail': '${SUPPORT_EMAIL}',
@@ -142,8 +142,8 @@ PLATFORMS = {
             # NOTE:
             #   Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
             #   Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
-            'version': '1.31.3',
-            'releaseTime': '2023-09-21T01:15:38Z',
+            'version': '1.32.0',
+            'releaseTime': '2023-09-22T16:09:24Z',
             'institution': 'Ouranos',
             'researchSubject': 'Climatology',
             'supportEmail': '${SUPPORT_EMAIL}',

birdhouse/config/jupyterhub/default.env

@@ -5,7 +5,7 @@
 # are applied and must be added to the list of DELAYED_EVAL.
 
 export JUPYTERHUB_DOCKER=pavics/jupyterhub
-export JUPYTERHUB_VERSION=1.4.0-20210506
+export JUPYTERHUB_VERSION=4.0.2-20230816
 
 # 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:230601"

birdhouse/config/jupyterhub/docker-compose-extra.yml

@@ -40,6 +40,8 @@ services:
     # the Hub and the rest of the stack are on network 'default'
       - default
       - jupyterhub_network
+    # ensure the deployment does not fail when upgrading Jupyterhub version
+    command: bash -c "jupyterhub upgrade-db && jupyterhub"
     restart: always
     logging: *default-logging
 

birdhouse/env.local.example

@@ -242,7 +242,8 @@ export GEOSERVER_ADMIN_PASSWORD=geoserverpass
 # Jupyter single-user server images
 #export DOCKER_NOTEBOOK_IMAGES="pavics/workflow-tests:210216 \
 #                               pavics/crim-jupyter-eo:0.3.0 \
-#                               pavics/crim-jupyter-nlp:0.4.0"
+#                               pavics/crim-jupyter-nlp:0.4.0 \
+#                               birdhouse/pavics-jupyter-base:mlflow-proxy"
 
 # 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,
@@ -252,14 +253,16 @@ export GEOSERVER_ADMIN_PASSWORD=geoserverpass
 # excluded when mounting the corresponding directory.
 #export JUPYTERHUB_IMAGE_SELECTION_NAMES="pavics \
 #                                         eo-crim:0.3.0 \
-#                                         nlp-crim"
+#                                         nlp-crim \
+#                                         mlflow-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 = {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],
+#                                   os.environ['JUPYTERHUB_IMAGE_SELECTION_NAMES'].split()[3]: os.environ['DOCKER_NOTEBOOK_IMAGES'].split()[3],
 #                                   'jupyter/scipy-notebook': 'jupyter/scipy-notebook',
 #                                   'jupyter/r-notebook': 'jupyter/r-notebook',
 #                                   'jupyter/tensorflow-notebook': 'jupyter/tensorflow-notebook',

docs/source/conf.py

@@ -69,9 +69,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.31.3'
+version = '1.32.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.31.3'
+release = '1.32.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.