Merge "add docs and release note for sandstone iscsi driver Partially-implements: bp add-sandstone-driver"

doc/source/configuration/block-storage/drivers/sandstone-storage-driver.rst

@@ -0,0 +1,96 @@
+======================
+SandStone iSCSI Driver
+======================
+
+SandStone USP volume can be used as a block storage resource in
+the OpenStack Block Storage driver that supports iSCSI protocols.
+
+Before to go,  you should have installed `SandStoneUSP <http:
+//www.szsandstone.com>`_.
+
+System requirements
+~~~~~~~~~~~~~~~~~~~
+
++-----------------+--------------------+
+| Cluster         | version            |
++=================+====================+
+| SandStone USP   | 3.2.3+             |
++-----------------+--------------------+
+
+To use the SandStone driver, the following are required:
+
+- Network connectivity between the OpenStack host and the SandStone
+  USP management interfaces.
+
+- HTTPS or HTTP must be enabled on the array.
+
+When creating a volume from image, add the following
+configuration keys in the ``[DEFAULT]``
+configuration group of the ``/etc/cinder/cinder.conf`` file:
+
+Configuration example
+~~~~~~~~~~~~~~~~~~~~~
+
+The following table contains the configuration options supported by
+the SandStone driver.
+
+.. code-block:: ini
+
+   [DEFAULT]
+   enabled_backends = sds-iscsi
+
+   [sds-iscsi]
+   volume_driver = cinder.volume.drivers.sandstone.sds_driver.SdsISCSIDriver
+   volume_backend_name = sds-iscsi
+   san_ip = 10.10.16.21
+   san_login = admin
+   san_password = admin
+   default_sandstone_target_ips = 10.10.16.21,10.10.16.22,10.10.16.23
+   chap_username = 123456789123
+   chap_password = 1234567891234
+   sandstone_pool = vms
+   initiator_assign_sandstone_target_ip = {"iqn.1993-08.org.debian:01:3a9cd5c484a": "10.10.16.21"}
+
+General parameters
+~~~~~~~~~~~~~~~~~~
+
++----------------------+-------------------------------------+
+| Parameter            | Description                         |
++======================+=====================================+
+| volume_driver        | Indicates the loaded driver         |
++----------------------+-------------------------------------+
+| volume_backend_name  | Indicates the name of the backend   |
++----------------------+-------------------------------------+
+| san_ip               | IP addresses of the management      |
+|                      | interfaces of SandStone USP         |
++----------------------+-------------------------------------+
+| san_login            | Storage system user name            |
++----------------------+-------------------------------------+
+| san_password         | Storage system password             |
++----------------------+-------------------------------------+
+| default_sandstone    | Default IP address of the iSCSI     |
+| _target_ips          | target port that is provided for    |
+|                      | compute nodes                       |
++----------------------+-------------------------------------+
+| chap_username        | CHAP authentication username        |
++----------------------+-------------------------------------+
+| chap_password        | CHAP authentication password        |
++----------------------+-------------------------------------+
+| sandstone_pool       | SandStone storage pool resource name|
++----------------------+-------------------------------------+
+| initiator_assign     | Initiator assign target with assign |
+| _sandstone_target_ip | ip                                  |
++----------------------+-------------------------------------+
+
+
+#. After modifying the ``cinder.conf`` file, restart the ``cinder-volume``
+   service.
+
+#. Create and use volume types.
+
+   **Create and use sds-iscsi volume types**
+
+   .. code-block:: console
+
+      $ openstack volume type create sandstone
+      $ openstack volume type set --property volume_backend_name=sds-iscsi sandstone

doc/source/reference/support-matrix.ini

@@ -153,6 +153,9 @@ title=Quobyte Storage Driver (quobyte)
 [driver.rbd]
 title=RBD (Ceph) Storage Driver (RBD)
 
+[driver.sandstone]
+title=SandStone Storage Driver (iSCSI)
+
 [driver.seagate]
 title=Seagate Driver (iSCSI, FC)
 
@@ -239,6 +242,7 @@ driver.pure=complete
 driver.qnap=complete
 driver.quobyte=complete
 driver.rbd=complete
+driver.sandstone=complete
 driver.seagate=complete
 driver.storpool=complete
 driver.synology=complete
@@ -301,6 +305,7 @@ driver.pure=complete
 driver.qnap=complete
 driver.quobyte=complete
 driver.rbd=complete
+driver.sandstone=complete
 driver.seagate=complete
 driver.storpool=complete
 driver.synology=complete
@@ -363,6 +368,7 @@ driver.pure=missing
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=missing
+driver.sandstone=missing
 driver.seagate=missing
 driver.storpool=missing
 driver.synology=missing
@@ -428,6 +434,7 @@ driver.pure=missing
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=missing
+driver.sandstone=complete
 driver.seagate=missing
 driver.storpool=missing
 driver.synology=missing
@@ -492,6 +499,7 @@ driver.pure=complete
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=complete
+driver.sandstone=complete
 driver.seagate=missing
 driver.storpool=complete
 driver.synology=missing
@@ -557,6 +565,7 @@ driver.pure=complete
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=missing
+driver.sandstone=missing
 driver.seagate=missing
 driver.storpool=missing
 driver.synology=missing
@@ -621,6 +630,7 @@ driver.pure=complete
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=complete
+driver.sandstone=complete
 driver.seagate=missing
 driver.storpool=complete
 driver.synology=missing
@@ -686,6 +696,7 @@ driver.pure=missing
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=missing
+driver.sandstone=missing
 driver.seagate=missing
 driver.storpool=complete
 driver.synology=missing
@@ -751,6 +762,7 @@ driver.pure=complete
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=complete
+driver.sandstone=complete
 driver.seagate=complete
 driver.storpool=complete
 driver.synology=missing
@@ -813,6 +825,7 @@ driver.pure=missing
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=complete
+driver.sandstone=complete
 driver.seagate=missing
 driver.storpool=missing
 driver.synology=missing
@@ -879,6 +892,7 @@ driver.pure=missing
 driver.qnap=missing
 driver.quobyte=missing
 driver.rbd=complete
+driver.sandstone=complete
 driver.seagate=missing
 driver.storpool=missing
 driver.synology=missing

releasenotes/notes/sandstone-iscsi-driver-31ed72d5657a4307.yaml

@@ -0,0 +1,3 @@
+---
+features:
+  - Added SandStone driver that allows cinder to manage volumes in ISCSI environment.