Merge pull request #3468 from benz0li/subpath-on-dynamic-storage

Add `singleuser.storage.dynamic.subPath` config
jupyterhub · Jul 30, 2024 · 21e929d · 21e929d
2 parents f1a6066 + 1e6f98f
commit 21e929d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/jupyterhub/files/hub/jupyterhub_config.py b/jupyterhub/files/hub/jupyterhub_config.py
@@ -282,6 +282,7 @@ def camelCaseify(s):
         {
             "mountPath": get_config("singleuser.storage.homeMountPath"),
             "name": volume_name_template,
+            "subPath": get_config("singleuser.storage.dynamic.subPath"),
         }
     ]
 elif storage_type == "static":

diff --git a/jupyterhub/values.schema.yaml b/jupyterhub/values.schema.yaml
@@ -2373,6 +2373,14 @@ properties:
 
                   There is of a default StorageClass available in k8s clusters
                   for use if this is unspecified.
+              subPath: &subPath-spec
+                type: [string, "null"]
+                description: |
+                  Configures the `subPath` field of a
+                  `KubeSpawner.volume_mounts` entry added by the Helm chart.
+
+                  Path within the volume from which the container's volume
+                  should be mounted. Defaults to "" (volume's root).
               volumeNameTemplate:
                 type: [string, "null"]
                 description: |
@@ -2402,14 +2410,7 @@ properties:
                 description: |
                   Configures `KubeSpawner.pvc_claim_name` to reference
                   pre-existing storage.
-              subPath:
-                type: [string, "null"]
-                description: |
-                  Configures the `subPath` field of a
-                  `KubeSpawner.volume_mounts` entry added by the Helm chart.
-
-                  Path within the volume from which the container's volume
-                  should be mounted.
+              subPath: *subPath-spec
           type:
             enum: [dynamic, static, none]
             description: |

diff --git a/jupyterhub/values.yaml b/jupyterhub/values.yaml
@@ -395,6 +395,7 @@ singleuser:
       pvcNameTemplate: claim-{username}{servername}
       volumeNameTemplate: volume-{username}{servername}
       storageAccessModes: [ReadWriteOnce]
+      subPath:
   image:
     name: quay.io/jupyterhub/k8s-singleuser-sample
     tag: "set-by-chartpress"