diff --git a/doc/config-reference/source/block-storage/drivers/falconstor-fss-driver.rst b/doc/config-reference/source/block-storage/drivers/falconstor-fss-driver.rst new file mode 100644 index 0000000000..92aa9b524a --- /dev/null +++ b/doc/config-reference/source/block-storage/drivers/falconstor-fss-driver.rst @@ -0,0 +1,117 @@ +======================================================= +FalconStor FSS Storage Fibre Channel and iSCSI drivers +======================================================= + +The ``FSSISCSIDriver`` and ``FSSFCDriver`` drivers run volume operations +by communicating with the FalconStor FSS storage system over HTTP. + +System requirements +~~~~~~~~~~~~~~~~~~~ + +To use the FalconStor FSS drivers, the following are required: + +- FalconStor FSS storage with: + + - iSCSI or FC host interfaces + + - FSS-8.00-8865 or later + +Supported operations +~~~~~~~~~~~~~~~~~~~~ + +The FalconStor volume driver provides the following Cinder +volume operations: + +* Create, delete, attach, and detach volumes. + +* Create, list, and delete volume snapshots. + +* Create a volume from a snapshot. + +* Clone a volume. + +* Extend a volume. + +* Get volume statistics. + +* Create and delete consistency group. + +* Create and delete consistency group snapshots. + +* Modify consistency groups. + +* Manage and unmanage a volume. + +iSCSI configuration +~~~~~~~~~~~~~~~~~~~ + +Use the following instructions to update the configuration file for iSCSI: + +.. code-block:: ini + + default_volume_type = FSS + enabled_backends = FSS + + [FSS] + + # IP address of FSS server + san_ip = 172.23.0.1 + # FSS server user name + san_login = Admin + # FSS server password + san_password = secret + # FSS server storage pool id list + fss_pools=P:2,O:3 + # Name to give this storage back-end + volume_backend_name = FSSISCSIDriver + # The iSCSI driver to load + volume_driver = cinder.volume.drivers.falconstor.iscsi.FSSISCSIDriver + + + # ==Optional settings== + + # Enable FSS log message + fss_debug = true + # Enable FSS thin provision + san_thin_provision=true + +Fibre Channel configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Use the following instructions to update the configuration file for fibre +channel: + +.. code-block:: ini + + default_volume_type = FSSFC + enabled_backends = FSSFC + + [FSSFC] + # IP address of FSS server + san_ip = 172.23.0.2 + # FSS server user name + san_login = Admin + # FSS server password + san_password = secret + # FSS server storage pool id list + fss_pools=A:1 + # Name to give this storage back-end + volume_backend_name = FSSFCDriver + # The FC driver to load + volume_driver = cinder.volume.drivers.falconstor.fc.FSSFCDriver + + + # ==Optional settings== + + # Enable FSS log message + fss_debug = true + # Enable FSS thin provision + san_thin_provision=true + +Driver options +~~~~~~~~~~~~~~ + +The following table contains the configuration options specific to the +FalconStor FSS storage volume driver. + +.. include:: ../../tables/cinder-falconstor.rst diff --git a/doc/config-reference/source/block-storage/volume-drivers.rst b/doc/config-reference/source/block-storage/volume-drivers.rst index e2419fdeac..1a787c1a79 100644 --- a/doc/config-reference/source/block-storage/volume-drivers.rst +++ b/doc/config-reference/source/block-storage/volume-drivers.rst @@ -26,6 +26,7 @@ Volume drivers drivers/emc-vmax-driver.rst drivers/emc-vnx-driver.rst drivers/emc-xtremio-driver.rst + drivers/falconstor-fss-driver.rst drivers/fujitsu-eternus-dx-driver.rst drivers/hds-hnas-driver.rst drivers/hitachi-storage-volume-driver.rst diff --git a/doc/config-reference/source/tables/cinder-falconstor.rst b/doc/config-reference/source/tables/cinder-falconstor.rst index 2530c2ac11..d131ef8970 100644 --- a/doc/config-reference/source/tables/cinder-falconstor.rst +++ b/doc/config-reference/source/tables/cinder-falconstor.rst @@ -22,7 +22,9 @@ - (String) FSS additional retry list, separate by ; * - ``fss_debug`` = ``False`` - (Boolean) Enable HTTP debugging to FSS - * - ``fss_pool`` = - - (Integer) FSS pool id in which FalconStor volumes are stored. + * - ``fss_pools`` = ``{}`` + - (Dict) FSS pool ID list in which FalconStor volumes are stored. If you have only one pool, use ``A:``. You can also have up to two storage pools, P for primary and O for all supporting devices. The usage is ``P:,O:`` * - ``fss_san_secondary_ip`` = - (String) Specifies FSS secondary management IP to be used if san_ip is invalid or becomes inaccessible. + * - ``san_thin_provision`` = + - (Boolean) Enable FSS thin provision.