Updates doc for NFS attachment
Set up on Ubuntu [Link](https://help.ubuntu.com/community/SettingUpNFSHowTo)
-### Create and deploy a Configmap with nfs server properties
+### Create a Configmap with nfs server properties
-```nfs-configmap.yaml
+```mount-config.yaml
kind: ConfigMap
apiVersion: v1
metadata:
- name: nfs-configmap
-nfs:
- # Configuration values can be set as key-value properties
- server: nfs-server.domain-name.com
+ name: mount-config
+ namespace: azureml
+data:
+ mounts.yaml: |
+ mountPoints:
+ - mountPath: /nfs_share
+ mountType: nfs
+ name: nfs-name
path: /path/to/shared-folder
-
- kubectl apply -f nfs-configmap.yaml
+ server: nfs-server.domain-name.com
```
-### How AML will use the mount for jobs
+### Apply the Configmap
-#### Phase 1
-All jobs will look for the 'nfs-configmap' config-map
+`kubectl apply -f mount-config.yaml`
-Alternatively, we can allow for any name for the configmap and then have it set up in the profile config
+### Documentation on Specific Fields
+* `mountPath`: defines the path that the NFS volume will be mounted into inside your job
+* `mountType`: must be `nfs`
+* `name`: arbitrary symbolic name for your mount. If you define multiple mounts then this must be unique per mount
+* `path`: path (on the server) to the folder you want to mount
+* `server`: NFS server address
+
+Multiple NFS mounts may be defined under `mountPoints`
+
+The rest of the `mount-config.yaml` file must be exactly as above
+
+### How AML will use the mount for jobs
+
+All jobs will look for the 'mount-config' ConfigMap. If this ConfigMap is missing or malformed then no mounts will be applied.
-#### Phase 2
-Per Job configmap setup
-```
-compute:
- # target is a Kubernetes Cluster
- #if NOT specified , it will go to the default VC linked to the WS
- target: azureml:some_k8s_cluster OR a VC
-
-resources:
- #0 default AML will find suitable resources in the cluster
- configmap: <name-of-configmap>
-```
