Merge pull request 2i2c-org#455 from yuvipanda/nfs-share-creator

Add inline comments to nfs-share-creator
consideRatio · Jun 8, 2021 · 76a72d2 · 76a72d2
2 parents 95af9d0 + 4157f25
commit 76a72d2
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/hub-templates/basehub/templates/nfs-share-creator.yaml b/hub-templates/basehub/templates/nfs-share-creator.yaml
@@ -33,15 +33,19 @@ spec:
           command:
             - /bin/sh
             - -c
-            # ${NFS_SHARE_NAME} starts with `/`
             - "mkdir -p /mnt${NFS_SHARE_NAME} && chown 1000:1000 /mnt${NFS_SHARE_NAME} && mount && ls -la /mnt/"
           volumeMounts:
+            # Mount the the base of the filesystem (which must be "/" on EFS as
+            # it will hang if trying to mount a path that isn't created
+            # already).
             - name: home-base
-              # Put this under /mnt, in case baseShareName is just / (like in EFS)
               mountPath: /mnt{{ .Values.nfsPVC.nfs.baseShareName }}
       volumes:
+        # Directly references the NFS server in order to create folders and
+        # update permissions. Note that this does not rely on the PV or PVC
+        # objects to be created.
         - name: home-base
           nfs:
-            server: {{ .Values.nfsPVC.nfs.serverIP | quote}}
-            path: {{ .Values.nfsPVC.nfs.baseShareName | quote}}
+            server: {{ .Values.nfsPVC.nfs.serverIP | quote }}
+            path: {{ .Values.nfsPVC.nfs.baseShareName | quote }}
 {{ end }}