From 23d441a65f6c6c34c851bce585ac779f1c094a94 Mon Sep 17 00:00:00 2001 From: Deepti Navale Date: Mon, 18 Aug 2014 11:22:13 +1000 Subject: [PATCH] Updated Dell EqualLogic volume driver section in the Config reference Added updates to Dell EQL driver documentation. Partial-bug: #1348665 Change-Id: I39fcbdf71d12463ef4a9c0e87bad5086319ce393 --- .../drivers/dell-equallogic-driver.xml | 151 ++++++++++++++---- 1 file changed, 120 insertions(+), 31 deletions(-) diff --git a/doc/config-reference/block-storage/drivers/dell-equallogic-driver.xml b/doc/config-reference/block-storage/drivers/dell-equallogic-driver.xml index ddd132a994..d63f6ce2a2 100644 --- a/doc/config-reference/block-storage/drivers/dell-equallogic-driver.xml +++ b/doc/config-reference/block-storage/drivers/dell-equallogic-driver.xml @@ -1,34 +1,123 @@
- Dell EqualLogic volume driver - The Dell EqualLogic volume driver interacts with configured - EqualLogic arrays and supports various operations, such as - volume creation and deletion, volume attachment and - detachment, snapshot creation and deletion, and clone - creation. - To configure and use a Dell EqualLogic array with Block - Storage, modify your cinder.conf as - follows. - Set the option to the Dell - EqualLogic volume driver: - volume_driver=cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver - Set the option to the IP address to - reach the EqualLogic Group through SSH: - san_ip=10.10.72.53 - Set the option to the user name - to login to the Group manager: - san_login=grpadmin - Set the option to the password - to login the Group manager with: - san_password=password - Optionally set the - option to false to disable creation of thin-provisioned - volumes: - san_thin_provision=false - The following table describes additional options that the - driver supports: - + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:xlink="http://www.w3.org/1999/xlink" + xml:id="dell-equallogic-driver" version="5.0"> + Dell EqualLogic volume driver + The Dell EqualLogic volume driver interacts with configured + EqualLogic arrays and supports various operations, including: + + Volume creation and deletion + Volume attachment and detachment + Snapshot creation and deletion + Clone creation + + The OpenStack Block Storage service supports the following: + + Multiple instances of Dell EqualLogic Groups or Dell + EqualLogic Group Storage Pools and multiple pools on a single array. + + Multiple instances of Dell EqualLogic Groups or Dell + EqualLogic Group Storage Pools or multiple pools on a single array. + + + The Dell EqualLogic volume driver's ability to access the EqualLogic + Group is dependent upon the generic block storage driver's SSH settings + in the /etc/cinder/cinder.conf file (see for reference). + + The following sample /etc/cinder/cinder.conf + configuration lists the relevant settings for a typical Block Storage + service using a single Dell EqualLogic Group: + Default (single-instance) configuration +[DEFAULT] +#Required settings + +volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver +san_ip = IP_EQLX +san_login = SAN_UNAME +san_password = SAN_PW +eqlx_group_name = EQLX_GROUP +eqlx_pool = EQLX_POOL + +#Optional settings + +san_thin_provision = true|false +eqlx_use_chap = true|false +eqlx_chap_login = EQLX_UNAME +eqlx_chap_password = EQLX_PW +eqlx_cli_timeout = 30 +eqlx_cli_max_retries = 5 +san_ssh_port = 22 +ssh_conn_timeout = 30 +san_private_key = SAN_KEY_PATH +ssh_min_pool_conn = 1 +ssh_max_pool_conn = 5 + + In this example, replace the following variables accordingly: + + + IP_EQLX + + The IP address used to reach the Dell EqualLogic Group through + SSH. This field has no default value. + + + + SAN_UNAME + + The user name to login to the Group manager via SSH at + the san_ip. Default user name is grpadmin. + + + + SAN_PW + + The corresponding password of SAN_UNAME. + Not used when san_private_key is set. Default + password is password. + + + + EQLX_GROUP + + The group to be used for a pool where the Block Storage service + will create volumes and snapshots. Default group is group-0. + + + + EQLX_POOL + + The pool where the Block Storage service will create volumes + and snapshots. Default pool is default. This + option cannot be used for multiple pools utilized by the Block + Storage service on a single Dell EqualLogic Group. + + + + EQLX_UNAME + + The CHAP login account for each + volume in a pool, if eqlx_use_chap is set + to true. Default account name is chapadmin. + + + + EQLX_PW + + The corresponding password of EQLX_UNAME. + The default password is randomly generated in hexadecimal, so you + must set this password manually. + + + + SAN_KEY_PATH (optional) + + The filename of the private key used + for SSH authentication. This provides password-less login to the + EqualLogic Group. Not used when san_password + is set. There is no default value. + + +