Skip to content

Commit b3fbe7d

Browse files
authored
Rename Shared FileSystem VM to Shared FileSystem Instance (#435)
1 parent 8149c09 commit b3fbe7d

File tree

4 files changed

+17
-18
lines changed

4 files changed

+17
-18
lines changed
7.64 KB
Loading
17.4 KB
Loading

source/adminguide/storage.rst

+14-15
Original file line numberDiff line numberDiff line change
@@ -1551,7 +1551,7 @@ Click on Create Shared FileSystem, provide the following details and then click
15511551
#. Zone
15521552
#. Format: Filesystem format (XFS, EXT4) which will be installed on the Shared FileSystem.
15531553
#. Network: Guest network to which the Shared FileSystem will be attached.
1554-
#. Compute offering: Offering using which the Shared FileSystem VM will be deployed.
1554+
#. Compute offering: Offering using which the Shared FileSystem Instance will be deployed.
15551555
#. Disk offering: Offering used by the underlying data volume.
15561556
#. Size, MinIops and MaxIos: Displayed only when the disk offering takes custom size and custom iops.
15571557
@@ -1573,56 +1573,55 @@ Supported lifecycle operations are :
15731573
15741574
#. Update name and description of the Shared FileSystem
15751575
1576-
#. Stop/Start Shared FileSystem - This will Stop and Start the Shared FileSystem VM
1576+
#. Stop/Start Shared FileSystem - This will Stop and Start the Shared FileSystem Instance
15771577
1578-
#. Restart Shared FileSystem - Reboots the Shared FileSystem VM. If Cleanup option is provided then the
1579-
VM state is cleaned up and restored to the original template. Configurations related to setting up the
1580-
NFS export will be done again. This will not affect the data on the VM.
1581-
Shared FileSystem.
1578+
#. Restart Shared FileSystem - Reboots the Shared FileSystem Instance. If Cleanup option is provided then the
1579+
Instance state is cleaned up and restored to the original template. Configurations related to setting up the
1580+
NFS export will be done again. This will not affect the data on the volume attached to the Instance.
15821581
|restart-sharedfs.png|
15831582
15841583
#. Change Disk Offering - The disk offering of the underlying volume can be changed. Whether live resize
15851584
is supported or not depends on the hyervisor.
15861585
Please note that the size of the Shared FileSystem can only be increased.
15871586
1588-
#. Change Service Offering - The service offering of the Shared FileSystem VM can be changed as required.
1587+
#. Change Service Offering - The service offering of the Shared FileSystem Instance can be changed as required.
15891588
This can only be done when the Shared FileSystem is in Stopped state.
15901589
15911590
#. Add/Remove Network - Guest networks can be added to or removed from the Shared FileSystem.
1592-
NFS share is exported to all networks. So VMs on different networks can mount the
1591+
NFS share is exported to all networks. So instances on different networks can mount the
15931592
same share using the respective IP addresses as given on the Access tab.
15941593
APIs serving these operations are addNicToVirtualMachine and removeNicToVirtualMachine
1595-
called with the Shared FileSystem VM ID.
1594+
called with the Shared FileSystem Instance ID.
15961595
Please note that the added networks must not be on overlapping CIDR ranges.
15971596
|add-remove-sharedfs-network.png|
15981597
15991598
#. Destroy Shared FileSystem - The Shared FileSystem will be destroyed. It can be recovered before it automatically gets expunged.
16001599
Expunge timeout is given by the global setting 'sharedfs.cleanup.delay'.
16011600
16021601
1603-
Shared FileSystem VM
1602+
Shared FileSystem Instance
16041603
~~~~~~~~~~~~~~
1605-
The Shared FileSystem VM is stateless and HA enabled. A new VM is deployed and will start
1604+
The Shared FileSystem Instance is stateless and HA enabled. A new instance is deployed and will start
16061605
serving the NFS share if the host or VM goes down.
16071606
The VM is installed with the SystemVM template which is also used by the CPVM and SSVM.
16081607
1609-
The Shared FileSystem VM can be seen in the Instance Tab as well. It's name is prefixed by the
1610-
Shared FileSystem name. Actions that might interfere with Shared FileSystem operations are blocked or not shown.
1608+
The Shared FileSystem Instance can be seen in the Instances Tab as well. It's name is prefixed by the string
1609+
"sharedfs-" plus the Shared FileSystem name. Actions that might interfere with Shared FileSystem operations are blocked or not shown.
16111610
Basic operaions like Start, Stop and Reboot are allowed for troubleshooting.
16121611
Users can access the VM using the 'View Console' button for troubleshooting although it is not
16131612
required during normal operations.
16141613
16151614
Service Offering
16161615
~~~~~~~~~~~~~~~~
16171616
There are two global settings that control what should be the minimum RAM size and minimum
1618-
CPU count for the Shared FileSystem VM : 'sharedfsvm.min.cpu.count' and 'sharedfsvm.min.ram.size`.
1617+
CPU count for the Shared FileSystem Instance : 'sharedfsvm.min.cpu.count' and 'sharedfsvm.min.ram.size`.
16191618
Only those offerings which meet these settings and have HA enabled are shown in the create form.
16201619
16211620
Shared FileSystem Data Volume
16221621
~~~~~~~~~~~~~~~~~~~~~~
16231622
The data volume is also visible to the users. It is recommended to use the Shared FileSystem UI/API to
16241623
manage the data but users or admin can perform actions directly on the data volume or the root volume
1625-
as well if they wish. Attaching and detaching a disk is not allowed on a Shared FileSystem VM.
1624+
as well if they wish. Attaching and detaching a disk is not allowed on a Shared FileSystem Instance.
16261625
16271626
.. |AttachDiskButton.png| image:: /_static/images/attach-disk-icon.png
16281627
:alt: Attach Disk Button.

source/conceptsandterminology/concepts.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -539,11 +539,11 @@ About Shared FileSystems
539539
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
540540
CloudStack users can setup CloudStack managed Shared FileSystems which can be mounted via NFS.
541541
Users can choose the service offering, disk offering, filesystem format and network.
542-
The Shared FileSystem is deployed on a VM with the specified service offering.
543-
A data volume is created using the given disk offering and attached to the VM.
542+
The Shared FileSystem is deployed on an Instance with the specified service offering.
543+
A data volume is created using the given disk offering and attached to the Instance.
544544
User can specify which filesystem to use (XFS, EXT4).
545545
The filesystem is created on the data volume and exported via NFS.
546-
All VMs in the guest network can mount and read/write to the Shared FileSystem.
546+
All Instances in the guest network can mount and read/write to the Shared FileSystem.
547547

548548
About Physical Networks
549549
~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)