Support dict values for volumes, volume_mounts and other list based configs that support dict values #3690

sunu · 2025-06-12T08:37:24Z

KubeSpawner now supports dict values for volumes, volume_mounts etc. This allows for easy overriding when required. ref: jupyterhub/kubespawner#843 and jupyterhub/kubespawner#845

This PR makes sure jupyterhub_config.py also support defining these values as dictionaries and changes the default of these list based configurations to be dict.

for more information, see https://pre-commit.ci

… chart locally

docs/source/jupyterhub/customizing/user-storage.md

docs/source/jupyterhub/customizing/user-resources.md

Co-authored-by: Angus Hollands <[email protected]>

jupyterhub/files/hub/jupyterhub_config.py

Co-authored-by: Angus Hollands <[email protected]>

jupyterhub/files/hub/jupyterhub_config.py

Co-authored-by: Angus Hollands <[email protected]>

agoose77 · 2025-08-19T13:42:24Z

Thanks for the PR @sunu!

@GeorgianaElena and I took a look at reviewing this and merging it. We changed a few small details with code-style (mainly replacing .update with assignment, and loops with .update), and update the docs to clarify that they keys are not required to match the volume/mount names.

We wanted to note explicitly that if users already had extraVolumes whose names shadow e.g. files or home, then these will now clobber the definitions instead of being passed through to k8s. We think this represents a new feature -- that existing configurations are not valid if they define duplicate volumes.

jupyterhub/zero-to-jupyterhub-k8s#3690 Merge pull request #3690 from sunu/volume-volumemounts-as-dict

Set volume and volume mount as dict

2ed7e98

sunu mentioned this pull request Jun 12, 2025

Objective JH-1: Group shared folders NASA-IMPACT/veda-jupyterhub#66

Closed

2 tasks

sunu and others added 5 commits June 16, 2025 06:12

Add tests for defining extraVolumes and extraVolumeMounts as dict

c5c315e

Update schema documentation

dadf1fa

Fix upgrade tests

f245164

[pre-commit.ci] auto fixes from pre-commit.com hooks

8cfa5a2

for more information, see https://pre-commit.ci

Include dev-config-local-chart-extra-config.yaml while installing the…

96a2ece

… chart locally

sunu marked this pull request as ready for review June 16, 2025 07:44

yuvipanda mentioned this pull request Aug 5, 2025

Review https://github.com/jupyterhub/zero-to-jupyterhub-k8s/pull/3690 2i2c-org/infrastructure#6504

Closed

2 tasks

agoose77 mentioned this pull request Aug 12, 2025

Add support for dict-based profile list definitions to zero-to-jupyterhub-k8s 2i2c-org/infrastructure#6552

Open

4 tasks

yuvipanda added this to PR triage (experimental) Aug 14, 2025

yuvipanda moved this to Backlog in PR triage (experimental) Aug 14, 2025