Skip to content

Commit 404c299

Browse files
authored
Merge pull request #302090 from tfitzmac/0701edit2
copy edit
2 parents 855f92d + c7bae99 commit 404c299

File tree

10 files changed

+297
-320
lines changed

10 files changed

+297
-320
lines changed

articles/cyclecloud/how-to/mount-disk.md

Lines changed: 42 additions & 42 deletions
Large diffs are not rendered by default.

articles/cyclecloud/how-to/mount-fileserver.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,38 @@
22
title: Network File System Options
33
description: Learn to mount and configure a simple network file system (NFS) within Azure CycleCloud. Also learn about default shares and how to disable an NFS mount.
44
author: KimliW
5-
ms.date: 02/21/2020
5+
ms.date: 07/01/2025
66
ms.author: adjohnso
77
---
88

9-
# Configure NFS Mounts
9+
# Configure NFS mounts
1010

1111
Azure CycleCloud provides built-in support for mounting a simple Network File System (NFS).
12-
The NFS can be another resource managed by CycleCloud or an external resource.
12+
CycleCloud can manage the NFS as a resource, or the NFS can be an external resource.
1313

1414
::: moniker range=">=cyclecloud-8"
1515
## Default Templates - Network Attached Storage Settings
1616

17-
The default cluster templates for each scheduler includes a section for configuring NFS options when creating a clsuter.
17+
The default cluster templates for each scheduler include a section for configuring NFS options when creating a cluster.
1818

1919
![New Cluster Network Attached Storage Settings screen](../images/version-8/quickstart-network-attached-storage-settings.png)
2020

2121
The `/shared/` directory for each cluster is an NFS share by default. The `NFS Type` dropdown in this configuration section provides options for this NFS share to be either exported from the cluster headnode (the `Builtin` option), or mounted from an NFS server.
2222

23-
If `Builtin` is selected, the NFS share is created on a Azure Managed Disk([Standard SSD](/azure/virtual-machines/disks-types#standard-ssd)) mounted onto the headnode of the cluster, and the `Size` option specifies the size of the provisioned disk.
23+
If you select `Builtin`, you create the NFS share on an Azure Managed Disk ([Standard SSD](/azure/virtual-machines/disks-types#standard-ssd)) mounted onto the headnode of the cluster. Use the `Size` option to specify the size of the provisioned disk.
2424

25-
Alternatively, if the `External NFS` option is specified, additional fields appear for specifying the IP address (or hostname) of the NFS server, as well as other NFS mount options. This `External NFS` option can be used to mount endpoints such as [NFS on Azure Files Storage](/azure/storage/files/storage-files-quick-create-use-linux), [Azure HPC Cache](/azure/hpc-cache/hpc-cache-overview), [Azure NetApp Files](/azure/azure-netapp-files/azure-netapp-files-introduction), or [NFS on Azure Blob Storage](/azure/storage/blobs/network-file-system-protocol-support).
25+
If you specify the `External NFS` option, you see extra fields where you can enter the IP address or hostname of the NFS server and other NFS mount options. Use the `External NFS` option to mount endpoints such as [NFS on Azure Files Storage](/azure/storage/files/storage-files-quick-create-use-linux), [Azure HPC Cache](/azure/hpc-cache/hpc-cache-overview), [Azure NetApp Files](/azure/azure-netapp-files/azure-netapp-files-introduction), or [NFS on Azure Blob Storage](/azure/storage/blobs/network-file-system-protocol-support).
2626

2727
![Mount an external NFS to /shared](../images/external-nfs-options.png)
2828

29-
If another NFS mount point is required, for example as a `/data` resource for all users, selecting the `Add NFS Mount` option brings up additional fields add another mount.
29+
If you need another NFS mount point, such as a `/data` resource for all users, select the `Add NFS Mount` option. You see extra fields where you can add another mount.
3030

3131
![Add an another NFS mountpoint](../images/additional-nfs-options.png)
3232
::: moniker-end
3333

34-
## Mount an NFS Filesystem
34+
## Mount an NFS filesystem
3535

36-
To mount an existing NFS filesystem:
36+
To mount an existing NFS filesystem, use the following code:
3737

3838
``` ini
3939
[[[configuration cyclecloud.mounts.nfs_data]]]
@@ -42,7 +42,7 @@ mountpoint = /mnt/exports/nfs_data
4242
export_path = /mnt/exports/data
4343
```
4444

45-
The `export_path` is the path on the server, and the `mountpoint` is the path to mount the share on the client. The mounted NFS filesystem may be exported from a node in the same CycleCloud cluster, exported from a node in another CycleCloud cluster, or a separate NFS filesystem that allows simple mounts. If the filesystem is exported from a node in the local cluster, then CycleCloud will use search to discover the address automatically. If the filesystem is exported from a different CycleCloud cluster, then the mount configuration may specify attribute `cluster_name` to instruct CycleCloud to search the cluster with that name:
45+
The `export_path` is the path on the server. The `mountpoint` is the path where you mount the share on the client. You can export the mounted NFS filesystem from a node in the same CycleCloud cluster, a node in another CycleCloud cluster, or a separate NFS filesystem that allows simple mounts. If a node in the local cluster exports the filesystem, CycleCloud uses search to discover the address automatically. If a node in a different CycleCloud cluster exports the filesystem, you can specify the `cluster_name` attribute in the mount configuration to instruct CycleCloud to search the cluster with that name:
4646

4747
``` ini
4848
[[[configuration cyclecloud.mounts.other_cluster_fs]]]
@@ -52,7 +52,7 @@ export_path = /mnt/exports/data
5252
cluster_name = filesystem_cluster
5353
```
5454

55-
To specify the location of the filesystem explicitly (required for mounting non-CycleCloud filesystems), the mount configuration may specify the attribute `address` with the hostname or IP of the filesystem:
55+
To specify the location of the filesystem explicitly (required for mounting non-CycleCloud filesystems), add the `address` attribute with the hostname or IP of the filesystem in the mount configuration:
5656

5757
``` ini
5858
[[[configuration cyclecloud.mounts.external_filer]]]
@@ -61,17 +61,17 @@ mountpoint = /mnt/exports/external_filer
6161
address = 54.83.20.2
6262
```
6363

64-
## Default Shares
64+
## Default shares
6565

6666
By default, most CycleCloud cluster types include at least one shared drive mounted at _/shared_ and _/mnt/exports/shared_. For clusters that need a simple shared filesystem, this mount is often sufficient.
6767

68-
Many cluster types also include a second NFS mount at _/sched_ and _/mnt/exports/sched_ which is reserved for use by the chosen scheduler. In general, this mount should not be accessed by applications.
68+
Many cluster types also include a second NFS mount at _/sched_ and _/mnt/exports/sched_ which is reserved for use by the chosen scheduler. In general, applications shouldn't access this mount.
6969

70-
The mount configurations for the default shares reserve filesystem names `cyclecloud.mounts.shared` and `cyclecloud.mounts.sched`. Modifying the default configurations for these shares is possible, but may result in unexpected behavior since many cluster types rely on the default mounts.
70+
The mount configurations for the default shares reserve filesystem names `cyclecloud.mounts.shared` and `cyclecloud.mounts.sched`. You can modify the default configurations for these shares, but changing them might cause unexpected behavior because many cluster types rely on the default mounts.
7171

72-
## Disabling NFS Mounts
72+
## Disabling NFS mounts
7373

74-
Azure CycleCloud NFS mounts may be disabled by setting the `disabled` attribute to true. The default shares may also be disabled this way:
74+
You can disable Azure CycleCloud NFS mounts by setting the `disabled` attribute to true. You can also disable the default shares this way:
7575

7676
``` ini
7777
[[[configuration]]]
@@ -80,8 +80,7 @@ Azure CycleCloud NFS mounts may be disabled by setting the `disabled` attribute
8080
cshared.server.legacy_links_disabled = true
8181
```
8282

83-
Many clusters assume a shared storage device to be available cluster-wide at _/shared_. Therefore if you use these configurations
84-
enable a fileserver and mount it on each cluster node with:
83+
Many clusters assume a shared storage device is available cluster-wide at _/shared_. If you use these configurations, enable a file server and mount it on each cluster node with:
8584

8685
``` ini
8786
[[[configuration cyclecloud.mounts.external_shared]]]
@@ -96,7 +95,7 @@ enable a fileserver and mount it on each cluster node with:
9695

9796
Azure CycleCloud clusters have built-in support for mounting Azure Managed Lustre.
9897

99-
To create a new Azure Managed Lustre Filesystem (AMLFS) for use in your cluster, follow the [AMLFS documentation](/azure/azure-managed-lustre/amlfs-overview).
98+
To create a new Azure Managed Lustre Filesystem (AMLFS) for use in your cluster, see the [AMLFS documentation](/azure/azure-managed-lustre/amlfs-overview).
10099

101100
To mount an existing AMLFS:
102101

@@ -107,13 +106,13 @@ address = 10.4.0.14
107106
mountpoint = /lustre_data
108107
```
109108

110-
The required `address` attribute specifies the the hostname or IP of the AMLFS.
109+
The required `address` attribute specifies the hostname or IP of the AMLFS.
111110
The required `mountpoint` attribute specifies the path to mount the AMLFS on the cluster nodes.
112111

113112

114-
Optionally, you may use the `export_path` attribute to mount existing sub-directories within the AMLFS. For a newly created AMLFS, the only existing path will be `/`. If `export_path` is not set, it will default to `tcp:/lustrefs/` (AMLFS mount points must be prefixed with `tcp:/lustrefs`)
113+
Optionally, use the `export_path` attribute to mount existing subdirectories within the AMLFS. For a newly created AMLFS, the only existing path is `/`. If you don't set `export_path`, it defaults to `tcp:/lustrefs/` (AMLFS mount points must be prefixed with `tcp:/lustrefs`).
115114

116-
For example, assuming the path `/data` has been created in your lustre filesystem, you can mount `data` as follows:
115+
For example, if you create the `/data` path in your Lustre filesystem, you can mount `data` as follows:
117116

118117
``` ini
119118
[[[configuration cyclecloud.mounts.lustre_data]]]
@@ -124,28 +123,28 @@ export_path = tcp:/lustrefs/data/
124123
options = noatime, flock
125124
```
126125

127-
The optional `options` attribute may be used to add mount options for an AMLFS mount. `options` defaults to `noatime, flock` if not specified.
126+
Use the optional `options` attribute to add mount options for an AMLFS mount. If you don't specify `options`, it defaults to `noatime, flock`.
128127
::: moniker-end
129128

130129
[!NOTE]
131-
Lustre performs best if nodes unmount prior to shutdown, so it is strongly recommended to enable [Termination Notifications](~/articles/cyclecloud/how-to/scheduled-events.md#terminate-notification) for nodes which will mount an AMLFS filesystem. CycleCloud will register a shutdown script to cleanly unmount the filesystem upon node termination that will be called if Termination Notifications are enabled.
130+
Lustre performs best if nodes unmount the filesystem before shutting down. We strongly recommend that you enable [Termination Notifications](~/articles/cyclecloud/how-to/scheduled-events.md#terminate-notification) for nodes that mount an AMLFS filesystem. CycleCloud registers a shutdown script that cleanly unmounts the filesystem when a node terminates. The script runs if you enable Termination Notifications.
132131

133132

134133

135-
## Mount Configuration Options
134+
## Mount configuration options
136135

137136
| Option | Definition |
138137
| ------ | ---------- |
139-
| type | *REQUIRED* The type attribute must be set to `nfs` for NFS mounts or `lustre` for AMLFS mounts to differentiate from volume mounts and other shared filesystem types. |
140-
| export_path | The location of the export on the remote filesystem. The export_path must already exist on the remote filesystem. If an export_path is not specified, the mountpoint of the mount will be used as the export_path. |
141-
| mountpoint | The location where the filesystem will be mounted after any additional configuration is applied. If the directory does not already exist, it will be created. |
142-
| cluster_name | The name of the CycleCloud cluster which exports the filesystem. If not set, the node's local cluster is assumed. |
143-
| address | The explicit hostname or IP address of the filesystem. If not set, search will attempt to find the filesystem in a CycleCloud cluster. |
138+
| type | *REQUIRED* Set the type attribute to `nfs` for NFS mounts or `lustre` for AMLFS mounts. This setting differentiates these mounts from volume mounts and other shared filesystem types. |
139+
| export_path | Set the location of the export on the remote filesystem. The export_path must already exist on the remote filesystem. If you don't specify an export_path, the mountpoint of the mount is used as the export_path. |
140+
| mountpoint | Set the location where the filesystem is mounted after applying any additional configuration. If the directory doesn't already exist, it's created. |
141+
| cluster_name | Set the name of the CycleCloud cluster that exports the filesystem. If you don't set this option, the node's local cluster is assumed. |
142+
| address | The explicit hostname or IP address of the filesystem. If you don't set this value, the search process tries to find the filesystem in a CycleCloud cluster. |
144143
| options | Any non-default options to use when mounting the filesystem. |
145-
| disabled | If set to `true`, the node will not mount the filesystem. |
144+
| disabled | If set to `true`, the node doesn't mount the filesystem. |
146145

147146
> [!NOTE]
148-
> Changing the hostname scheme is not supported for most schedulers.
147+
> Most schedulers don't support changing the hostname scheme.
149148
150149
## Further Reading
151150

0 commit comments

Comments
 (0)