JupyterHub: update jupyterhub component default version to 5.2.1 (#493

)

## Overview


  This implements all changes between JupyterHub version 
[4.1.6 and
5.2.1](https://jupyterhub.readthedocs.io/en/stable/reference/changelog.html).

  This update requires the following manual upgrade steps:

- If your local environment file sets the
`c.DockerSpawner.image_whitelist` config option in the
`JUPYTERHUB_ENABLE_MULTI_NOTEBOOKS` environnment variable. Change
`c.DockerSpawner.image_whitelist`
    to `c.DockerSpawner.allowed_images`.
- Update the jupyterhub database with the following command after you
have started up the stack:
    ```
    birdhouse compose exec jupyterhub jupyterhub upgrade-db
    ```
You can also simply delete the `jupyterhub_data_persistence` volume if
you're not storing any custom
information there and if you haven't manually set
`c.Authenticator.allow_all` to `False` (ensure that
the stack is stopped and all jupyterlab containers have been stopped and
removed first).
 
If you have changed any of the default `jupyterhub` settings you may
need to consult the [JupyterHub upgrade
guide](https://jupyterhub.readthedocs.io/en/latest/howto/upgrading-v5.html)
to see if any of those settings have been changed.

## Changes

**Non-breaking changes**
- New component version jupyterhub:5.2.1-20241114

**Breaking changes**
- Depending on your custom jupyterhub settings, this might require some
manual updates (see migration guide)

## Related Issue / Discussion

## Additional Information

## CI Operations

<!--
The test suite can be run using a different DACCS config with
``birdhouse_daccs_configs_branch: branch_name`` in the PR description.
To globally skip the test suite regardless of the commit message use
``birdhouse_skip_ci`` set to ``true`` in the PR description.

Using ``[<cmd>]`` (with the brackets) where ``<cmd> = skip ci`` in the
commit message will override ``birdhouse_skip_ci`` from the PR
description.
Such commit command can be used to override the PR description behavior
for a specific commit update.
However, a commit message cannot 'force run' a PR which the description
turns off the CI.
To run the CI, the PR should instead be updated with a ``true`` value,
and a running message can be posted in following PR comments to trigger
tests once again.
-->

birdhouse_daccs_configs_branch: master
birdhouse_skip_ci: false

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.8.2
+current_version = 2.9.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} 2025-01-30T16:43:57Z
+search = {current_version} 2025-02-03T15:44:17Z
 replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ}
 
 [bumpversion:part:releaseTime]
-values = 2025-01-30T16:43:57Z
+values = 2025-02-03T15:44:17Z
 
 [bumpversion:file(version):birdhouse/components/canarie-api/docker_configuration.py.template]
 search = 'version': '{current_version}'

CHANGES.md

@@ -17,6 +17,26 @@
 
 [//]: # (list changes here, using '-' for each new entry, remove this when items are added)
 
+[2.9.0](https://github.com/bird-house/birdhouse-deploy/tree/2.9.0) (2025-02-03)
+------------------------------------------------------------------------------------------------------------------
+
+## Changes
+
+- JupyterHub: update `jupyterhub` component default version to [5.2.1](https://github.com/Ouranosinc/jupyterhub/releases/tag/5.2.1-20241114)
+
+  This implements all changes between JupyterHub version 
+  [4.1.6 and 5.2.1](https://jupyterhub.readthedocs.io/en/stable/reference/changelog.html).
+
+  **Breaking backward incompatible change**: This update requires the following manual upgrade steps:
+
+  - If your local environment file sets the `c.DockerSpawner.image_whitelist` config option in the 
+    `JUPYTERHUB_ENABLE_MULTI_NOTEBOOKS` environnment variable. Change `c.DockerSpawner.image_whitelist` 
+    to `c.DockerSpawner.allowed_images`.
+
+  If you have changed any of the default `jupyterhub` settings you may need to consult the [JupyterHub upgrade
+  guide](https://jupyterhub.readthedocs.io/en/latest/howto/upgrading-v5.html) to see if any of those settings
+  have been changed.
+
 [2.8.2](https://github.com/bird-house/birdhouse-deploy/tree/2.8.2) (2025-01-30)
 ------------------------------------------------------------------------------------------------------------------
 

Makefile

@@ -1,7 +1,7 @@
 # Generic variables
 override SHELL       := bash
 override APP_NAME    := birdhouse-deploy
-override APP_VERSION := 2.8.2
+override APP_VERSION := 2.9.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

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

RELEASE.txt

@@ -1 +1 @@
-2.8.2 2025-01-30T16:43:57Z
+2.9.0 2025-02-03T15:44:17Z

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

@@ -108,8 +108,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': '2.8.2',
-            'releaseTime': '2025-01-30T16:43:57Z',
+            'version': '2.9.0',
+            'releaseTime': '2025-02-03T15:44:17Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',
@@ -141,8 +141,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': '2.8.2',
-            'releaseTime': '2025-01-30T16:43:57Z',
+            'version': '2.9.0',
+            'releaseTime': '2025-02-03T15:44:17Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',

birdhouse/components/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=4.1.5-20240426
+export JUPYTERHUB_VERSION=5.2.1-20241114
 export JUPYTERHUB_IMAGE='${JUPYTERHUB_DOCKER}:${JUPYTERHUB_VERSION}'
 export JUPYTERHUB_IMAGE_URI='registry.hub.docker.com/${JUPYTERHUB_IMAGE}'