Merge pull request #3748 from consideRatio/pr/add-comment

basehub: add comment to prevent an issue from arising

helm-charts/basehub/values.yaml

@@ -69,6 +69,14 @@ jupyterhub:
     singleuserAdmin:
       extraEnv: {}
       extraVolumeMounts:
+        # IMPORTANT: What is added to this list is copied to other locations
+        #            that wants to add an element to this list. This is done
+        #            because when Helm config files are merged, lists get
+        #            replaced rather than appended. So, if this is to be
+        #            updated, we should update all those copies as well. An easy
+        #            to way find such copies is to search for "singleuserAdmin:"
+        #            in this repo.
+        #
         - name: home
           mountPath: /home/jovyan/shared-readwrite
           subPath: _shared
@@ -214,6 +222,18 @@ jupyterhub:
   singleuser:
     # Need to explicitly fix ownership here, as otherwise these directories will be owned
     # by root on most NFS filesystems - neither EFS nor Google Filestore support anonuid
+    #
+    # This has to be done _once_ for each directory we mount _from_ the NFS
+    # server. We do it all the time since we don't know for sure it has been done once
+    # already.
+    #
+    # Note that we don't have to chown both the shared and shared-readwrite
+    # folder since they are both mounting the same folder on the NFS server.
+    #
+    # For details about this, see notes at:
+    # - https://github.com/2i2c-org/infrastructure/issues/2953#issuecomment-1672025545
+    # - https://github.com/2i2c-org/infrastructure/issues/2946#issuecomment-1671691248
+    #
     initContainers:
       - name: volume-mount-ownership-fix
         image: busybox:1.36.1