DockerSpawner persistant volume per user and per image

CalvinMT · August 29, 2023, 8:00am

Hi!

Is it possible to create multiple persistant volumes per user and per image when using DockerSpawner?

Under section “Volume mapping”, we can see an example where the username of the user can be used in the name of the Docker volume using the {username} tag.

However, when using DockerSpawner, it is possible for a user to run an instance of more than one image at the same time. Thus, needing one persistant volume per user and per image, not only per user.

So, I was wondering if using another tag like {image}, {server} or {environment} is possible or if there is another solution which haven’t crossed my mind.

manics · August 29, 2023, 9:38am

These are the supported template tags:

github.com

jupyterhub/dockerspawner/blob/c749ff0a61e9b5387707f4b43db1b62f275ec2f8/dockerspawner/dockerspawner.py#L871C9-L883


      
          def template_namespace(self):
              escaped_image = self.image.replace("/", "-")
              server_name = getattr(self, "name", "")
              safe_server_name = self.escape(server_name.lower())
              return {
                  "username": self.escaped_name,
                  "safe_username": self.escaped_name,
                  "raw_username": self.user.name,
                  "imagename": escaped_image,
                  "servername": safe_server_name,
                  "raw_servername": server_name,
                  "prefix": self.prefix,
              }

but you can extend that by defining your own function to generate the name
https://jupyterhub-dockerspawner.readthedocs.io/en/latest/api/index.html#dockerspawner.DockerSpawner.format_volume_name

CalvinMT · August 29, 2023, 1:56pm

Thanks!
I guess that’s what I was looking for.

It’s a shame that JupyterHub’s documentation is in such a mess and lacking contributions.

manics · August 29, 2023, 2:36pm

If you’re interested in improving the DockerSpawner documentation the files are in the docs directory of the GitHub repository:

Topic		Replies	Views
Having multiple single-user docker images discuss jupyterhub , docker	2	1987	September 7, 2020
Facing permisson issue while creating an ipynb file on a volume attached to a container spawn by DockerSpawner JupyterHub jupyterhub , help-wanted , docker	2	707	March 8, 2024
How to dynamically chose DockerSpawner image based on user and container name in jupyterhub_config? JupyterHub docker	0	939	February 3, 2022
Adding docker volume mounts with SystemUserSpawner? JupyterHub jupyterhub , help-wanted	1	910	July 27, 2020
Is it possible to get different docker image for each user? JupyterHub	2	1134	April 26, 2019

DockerSpawner persistant volume per user and per image

Related topics