From 4dc2cd5ed44fd906ee8a9c85adfbf1dac045dc00 Mon Sep 17 00:00:00 2001 From: s-shiono Date: Mon, 23 Jan 2017 09:22:56 +0900 Subject: [PATCH] Add the configuration reference document for NEC cinder volume drivers. Closes-Bug: #1657609 Change-Id: Ibe33788ec7df1e81546f79a3b3a3c8a42cdf28e0 --- .../drivers/nec-storage-m-series-driver.rst | 293 ++++++++++++++++++ .../source/block-storage/volume-drivers.rst | 1 + 2 files changed, 294 insertions(+) create mode 100644 doc/config-reference/source/block-storage/drivers/nec-storage-m-series-driver.rst diff --git a/doc/config-reference/source/block-storage/drivers/nec-storage-m-series-driver.rst b/doc/config-reference/source/block-storage/drivers/nec-storage-m-series-driver.rst new file mode 100644 index 0000000000..d38eb2cadb --- /dev/null +++ b/doc/config-reference/source/block-storage/drivers/nec-storage-m-series-driver.rst @@ -0,0 +1,293 @@ +=========================== +NEC Storage M series driver +=========================== + +NEC Storage M series are dual-controller disk arrays which support +online maintenance. +This driver supports both iSCSI and Fibre Channel. + +System requirements +~~~~~~~~~~~~~~~~~~~ +Supported models: + +- NEC Storage M110, M310, M510 and M710 (SSD/HDD hybrid) +- NEC Storage M310F and M710F (all flash) + +Requirements: + +- Storage control software (firmware) revision 0950 or later +- NEC Storage DynamicDataReplication license +- (Optional) NEC Storage IO Load Manager license for QoS + + +Supported operations +~~~~~~~~~~~~~~~~~~~~ + + +- Create, delete, attach, and detach volumes. +- Create, list, and delete volume snapshots. +- Create a volume from a snapshot. +- Copy an image to a volume. +- Clone a volume. +- Extend a volume. +- Get volume statistics. + + +Preparation +~~~~~~~~~~~ + +Below is minimum preparation to a disk array. +For details of each command, see the NEC Storage Manager Command Reference +(IS052). + +- Common (iSCSI and Fibre Channel) + + #. Initial setup + + * Set IP addresses for management and BMC with the network configuration + tool. + * Enter license keys. (iSMcfg licenserelease) + #. Create pools + + * Create pools for volumes. (iSMcfg poolbind) + * Create pools for snapshots. (iSMcfg poolbind) + #. Create system volumes + + * Create a Replication Reserved Volume (RSV) in one of pools. + (iSMcfg ldbind) + * Create Snapshot Reserve Areas (SRAs) in each snapshot pool. + (iSMcfg srabind) + #. (Optional) Register SSH public key + + +- iSCSI only + + #. Set IP addresses of each iSCSI port. (iSMcfg setiscsiport) + #. Create a LD Set with setting multi-target mode on. (iSMcfg addldset) + #. Register initiator names of each node. (iSMcfg addldsetinitiator) + + +- Fibre Channel only + + #. Start access control. (iSMcfg startacc) + #. Create a LD Set. (iSMcfg addldset) + #. Register WWPNs of each node. (iSMcfg addldsetpath) + + +Configuration +~~~~~~~~~~~~~ + + +Set the following in your ``cinder.conf``, and use the following options +to configure it. + +If you use Fibre Channel: + +.. code-block:: ini + + [Storage1] + volume_driver = cinder.volume.drivers.nec.volume.MStorageFCDriver + +.. end + + +If you use iSCSI: + +.. code-block:: ini + + [Storage1] + volume_driver = cinder.volume.drivers.nec.volume.MStorageISCSIDriver + +.. end + +Also, set ``volume_backend_name``. + +.. code-block:: ini + + [DEFAULT] + volume_backend_name = Storage1 + +.. end + + +This table shows configuration options for NEC Storage M series driver. + +.. include:: ../../tables/cinder-nec_m.rst + + + +Required options +---------------- + + +- ``nec_ismcli_fip`` + FIP address of M-Series Storage. + +- ``nec_ismcli_user`` + User name for M-Series Storage iSMCLI. + +- ``nec_ismcli_password`` + Password for M-Series Storage iSMCLI. + +- ``nec_ismcli_privkey`` + RSA secret key file name for iSMCLI (for public key authentication only). + Encrypted RSA secret key file cannot be specified. + +- ``nec_diskarray_name`` + Diskarray name of M-Series Storage. + This parameter must be specified to configure multiple groups + (multi back end) by using the same storage device (storage + device that has the same ``nec_ismcli_fip``). Specify the disk + array name targeted by the relevant config-group for this + parameter. + +- ``nec_backup_pools`` + Specify a pool number where snapshots are created. + + +Timeout configuration +--------------------- + + +- ``rpc_response_timeout`` + Set the timeout value in seconds. If three or more volumes can be created + at the same time, the reference value is 30 seconds multiplied by the + number of volumes created at the same time. + Also, Specify nova parameters below in ``nova.conf`` file. + + .. code-block:: ini + + [DEFAULT] + block_device_allocate_retries = 120 + block_device_allocate_retries_interval = 10 + + .. end + + +- ``timeout server (HAProxy configuration)`` + In addition, you need to edit the following value in the HAProxy + configuration file (``/etc/haproxy/haproxy.cfg``) in an environment where + HAProxy is used. + + .. code-block:: ini + + timeout server = 600 #Specify a value greater than rpc_response_timeout. + + .. end + + Run the :command:`service haproxy reload` command after editing the + value to reload the HAProxy settings. + + .. note:: + + The OpenStack environment set up using Red Hat OpenStack Platform + Director may be set to use HAProxy. + + +Configuration example for /etc/cinder/cinder.conf +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When using one config-group +--------------------------- + +- When using ``nec_ismcli_password`` to authenticate iSMCLI + (Password authentication): + + .. code-block:: ini + + [DEFAULT] + enabled_backends = Storage1 + + [Storage1] + volume_driver = cinder.volume.drivers.nec.volume.MStorageISCSIDriver + volume_backend_name = Storage1 + nec_ismcli_fip = 192.168.1.10 + nec_ismcli_user = sysadmin + nec_ismcli_password = sys123 + nec_pools = 0 + nec_backup_pools = 1 + + .. end + + +- When using ``nec_ismcli_privkey`` to authenticate iSMCLI + (Public key authentication): + + .. code-block:: ini + + [DEFAULT] + enabled_backends = Storage1 + + [Storage1] + volume_driver = cinder.volume.drivers.nec.volume.MStorageISCSIDriver + volume_backend_name = Storage1 + nec_ismcli_fip = 192.168.1.10 + nec_ismcli_user = sysadmin + nec_ismcli_privkey = /etc/cinder/id_rsa + nec_pools = 0 + nec_backup_pools = 1 + + .. end + + +When using multi config-group (multi-backend) +--------------------------------------------- + +- Four config-groups (backends) + + Storage1, Storage2, Storage3, Storage4 + +- Two disk arrays + + 200000255C3A21CC(192.168.1.10) + Example for using config-group, Storage1 and Storage2 + + 2000000991000316(192.168.1.20) + Example for using config-group, Storage3 and Storage4 + + .. code-block:: ini + + [DEFAULT] + enabled_backends = Storage1,Storage2,Storage3,Storage4 + + [Storage1] + volume_driver = cinder.volume.drivers.nec.volume.MStorageISCSIDriver + volume_backend_name = Gold + nec_ismcli_fip = 192.168.1.10 + nec_ismcli_user = sysadmin + nec_ismcli_password = sys123 + nec_pools = 0 + nec_backup_pools = 2 + nec_diskarray_name = 200000255C3A21CC + + [Storage2] + volume_driver = cinder.volume.drivers.nec.volume.MStorageISCSIDriver + volume_backend_name = Silver + nec_ismcli_fip = 192.168.1.10 + nec_ismcli_user = sysadmin + nec_ismcli_password = sys123 + nec_pools = 1 + nec_backup_pools = 3 + nec_diskarray_name = 200000255C3A21CC + + [Storage3] + volume_driver = cinder.volume.drivers.nec.volume.MStorageISCSIDriver + volume_backend_name = Gold + nec_ismcli_fip = 192.168.1.20 + nec_ismcli_user = sysadmin + nec_ismcli_password = sys123 + nec_pools = 0 + nec_backup_pools = 2 + nec_diskarray_name = 2000000991000316 + + [Storage4] + volume_driver = cinder.volume.drivers.nec.volume.MStorageISCSIDriver + volume_backend_name = Silver + nec_ismcli_fip = 192.168.1.20 + nec_ismcli_user = sysadmin + nec_ismcli_password = sys123 + nec_pools = 1 + nec_backup_pools = 3 + nec_diskarray_name = 2000000991000316 + + .. end diff --git a/doc/config-reference/source/block-storage/volume-drivers.rst b/doc/config-reference/source/block-storage/volume-drivers.rst index d7155e2ef5..ad60692fa6 100644 --- a/doc/config-reference/source/block-storage/volume-drivers.rst +++ b/doc/config-reference/source/block-storage/volume-drivers.rst @@ -41,6 +41,7 @@ Volume drivers drivers/itri-disco-driver.rst drivers/kaminario-driver.rst drivers/lenovo-driver.rst + drivers/nec-storage-m-series-driver.rst drivers/netapp-volume-driver.rst drivers/nimble-volume-driver.rst drivers/nexentastor4-driver.rst