diff --git a/doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml b/doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml
index 455757e9e0..f6371855d1 100644
--- a/doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml
+++ b/doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml
@@ -1,81 +1,453 @@
-
- HP / LeftHand SAN
- HP/LeftHand SANs are optimized for virtualized environments
- with VMware ESX & Microsoft Hyper-V, though the OpenStack
- integration provides additional support to various other
- virtualized environments, such as Xen, KVM, and OpenVZ, by
- exposing the volumes through ISCSI to connect to the
- instances.
- The HpSanISCSIDriver enables you to use a HP/Lefthand SAN
- that supports the Cliq interface. Every supported volume
- operation translates into a cliq call in the back-end.
- To use Cinder with HP/Lefthand SAN, you must set the
- following parameters in the cinder.conf
- file:
-
-
- Set
- volume_driver=cinder.volume.drivers.san.HpSanISCSIDriver.
-
-
- Set san_ip flag to the
- hostname or VIP of your Virtual Storage Appliance
- (VSA).
-
-
- Set san_login and
- san_password to the user
- name and password of the ssh user with all necessary
- privileges on the appliance.
-
-
- Set san_ssh_port=16022. The default is
- 22. However, the default for the VSA is usually
- 16022.
-
-
- Set san_clustername to the name of the
- cluster where the associated volumes are
- created.
-
-
- The following optional parameters have the following default
- values:
-
-
- san_thin_provision=True. To disable
- thin provisioning, set to False.
-
-
-
- san_is_local=False. Typically, this
- parameter is set to False for this
- driver. To configure the cliq commands to run locally
- instead of over ssh, set this parameter to
- True.
-
-
- In addition to configuring the cinder-volume service, you must configure
- the VSA to function in an OpenStack environment.
-
- To configure the VSA
-
- Configure Chap on each of the nova-compute
- nodes.
-
-
- Add Server associations on the VSA with the
- associated Chap and initiator information. The name
- should correspond to the 'hostname' of the nova-compute node.
- For Xen, this is the hypervisor host name. To do this,
- use either Cliq or the Centralized Management
- Console.
-
-
-
+
+ HP LeftHand/StoreVirtual driver
+
+ The
+ HPLeftHandISCSIDriver
+ is based on the
+ Block Storage Service (Cinder) plug-in architecture. Volume operations
+ are run by communicating with the HP LeftHand/StoreVirtual system over
+ HTTPS, or SSH connections. HTTPS communications use the
+ hplefthandclient,
+ which is part of the Python standard library.
+
+
+ The
+ HPLeftHandISCSIDriver
+ can be configured
+ to run in one of two possible modes, legacy mode which uses SSH/CLIQ to
+ communicate with the HP LeftHand/StoreVirtual array, or standard mode
+ which uses a new REST client to communicate with the array. No new
+ functionality has been, or will be, supported in legacy mode. For
+ performance improvements and new functionality, the driver must be
+ configured for standard mode, the hplefthandclient
+ must be downloaded, and HP LeftHand/StoreVirtual Operating System
+ software version 11.5 or
+ higher is required on the array. To configure
+ the driver in standard mode see section
+
+ HP LeftHand/StoreVirtual REST driver standard mode,
+ to configure the driver in legacy mode, see section
+
+ HP LeftHand/StoreVirtual CLIQ driver legacy mode.
+
+ For information about how to manage HP LeftHand/StoreVirtual
+ storage systems, see the HP LeftHand/StoreVirtual user documentation.
+
+
+ HP LeftHand/StoreVirtual REST driver standard mode
+ This section describes how to configure the HP
+ LeftHand/StoreVirtual Cinder driver in standard mode.
+
+
+ System requirements
+ To use the HP LeftHand/StoreVirtual driver in standard mode,
+ do the following:
+
+
+
+ Install LeftHand/StoreVirtual Operating System
+ software version 11.5 or higher on the HP
+ LeftHand/StoreVirtual storage system.
+
+
+
+ Create a cluster group.
+
+
+
+ Install the hplefthandclient version
+ 1.0.2 from the Python Package Index on the system with the
+ enabled Block Storage Service volume drivers.
+
+
+
+
+
+ Supported operations
+
+
+ Create volumes
+
+
+ Delete volumes
+
+
+ Extend volumes
+
+
+ Attach volumes
+
+
+ Detach volumes
+
+
+ Create snapshots
+
+
+ Delete snapshots
+
+
+ Create volumes from snapshots
+
+
+ Create cloned volumes
+
+
+ Copy images to volumes
+
+
+ Copy volumes to images
+
+
+ Backend assisted volume migration
+
+
+ Volume retype
+
+
+ When a volume is migrated, using Backend assisted volume
+ migration, both source and destination clusters must be in
+ the same HP LeftHand/StoreVirtual management group.
+ The HP LeftHand/StoreVirtual array will use native LeftHand
+ APIs to migrate the volume. The volume cannot be attached
+ or have snapshots to migrate.
+
+
+ Volume type support for the driver includes the ability to set
+ the following capabilities in the OpenStack Cinder API
+ cinder.api.contrib.types_extra_specs
+ volume type extra specs extension module.
+
+
+
+
+ hplh:provisioning
+
+
+
+
+ hplh:ao
+
+
+
+
+ hplh:data_pl
+
+
+
+
+ To work with the default filter scheduler, the key values
+ are case sensitive and scoped with
+ 'hplh:'.
+ For information about how to set the key-value pairs and
+ associate them with a volume type, run the following
+ command:
+
+$cinder help type-key
+
+
+ The following keys require that the HP LeftHand/StoreVirtual
+ storage array be configured for.
+
+ hplh:ao
+ The HP LeftHand/StoreVirtual storage array
+ must be configured for Adaptive Optimization.
+
+ hplh:data_pl
+ The HP LeftHand/StoreVirtual storage array
+ must be able to support the Data Protection level
+ specified by the extra spec.
+
+
+
+
+
+
+ If volume types are not used or a particular key is not
+ set for a volume type, the following defaults are used:
+
+ hplh:provisioning
+ Defaults to thin provisioning, the valid values are,
+ thin
+ and
+ full
+
+ hplh:ao
+ Defaults to true, the valid values are,
+ true
+ and
+ false.
+
+ hplh:data_pl
+ Defaults to
+ r-0,
+ Network RAID-0 (None), the valid values are,
+
+ r-0,
+ Network RAID-0 (None)
+
+
+ r-5,
+ Network RAID-5 (Single Parity)
+
+
+ r-10-2,
+ Network RAID-10 (2-Way Mirror)
+
+
+ r-10-3,
+ Network RAID-10 (3-Way Mirror)
+
+
+ r-10-4,
+ Network RAID-10 (4-Way Mirror)
+
+
+ r-6,
+ Network RAID-6 (Dual Parity),
+
+
+
+
+
+
+
+
+
+ Enable the HP LeftHand/StoreVirtual iSCSI driver in standard mode
+
+
+ The
+ HPLeftHandISCSIDriver
+ is installed with the OpenStack software.
+
+
+
+
+ Install the
+ hplefthandclient
+ Python package on the OpenStack Block Storage system.
+
+$sudo pip install 'hplefthandclient>=1.0.2,<2.0'
+
+
+ If you are not using an existing cluster, create a
+ cluster on the HP LeftHand storage system to be used as
+ the cluster for creating volumes.
+
+
+
+
+ Make the following changes in the
+ /etc/cinder/cinder.conf
+ file:
+
+ ## REQUIRED SETTINGS
+
+# LeftHand WS API Server URL
+hplefthand_api_url=https://10.10.0.141:8081/lhos
+
+# LeftHand Super user username
+hplefthand_username=lhuser
+
+# LeftHand Super user password
+hplefthand_password=lhpass
+
+# LeftHand cluster to use for volume creation
+hplefthand_clustername=ClusterLefthand
+
+# LeftHand iSCSI driver
+volume_driver=cinder.volume.drivers.san.hp.hp_lefthand_iscsi.HPLeftHandISCSIDriver
+
+## OPTIONAL SETTINGS
+
+# Should CHAPS authentication be used (default=false)
+hplefthand_iscsi_chap_enabled=false
+
+# Enable HTTP debugging to LeftHand (default=false)
+hplefthand_debug=false
+
+ You can enable only one driver on each
+ cinder instance unless you enable multiple
+ back-end support. See the Cinder multiple
+ back-end support instructions to enable this
+ feature.
+
+
+ If the
+ is set to true, the driver will
+ associate randomly-generated CHAP secrets with all
+ hosts on the HP LeftHand/StoreVirtual system. OpenStack Compute
+ nodes use these secrets when creating iSCSI connections.
+
+ CHAP secrets are passed from OpenStack Block
+ Storage to Compute in clear text. This
+ communication should be secured to
+ ensure that CHAP secrets are not discovered.
+
+
+
+ CHAP secrets are added to existing hosts as
+ well as newly-created ones. If the CHAP option
+ is enabled, hosts will not be able to access
+ the storage without the generated secrets.
+
+
+
+
+
+
+ Save the changes to the cinder.conf
+ file and restart the
+ cinder-volume
+ service.
+
+
+
+ The HP LeftHand/StoreVirtual driver is now enabled in
+ standard mode on your OpenStack system. If you experience
+ problems, review the Block Storage Service log files for errors.
+
+
+
+
+ HP LeftHand/StoreVirtual CLIQ driver legacy mode
+ This section describes how to configure the HP
+ LeftHand/StoreVirtual Cinder driver in legacy mode.
+
+ The
+ HPLeftHandISCSIDriver
+ allows you to use a HP Lefthand/StoreVirtual SAN that supports the
+ CLIQ interface. Every supported volume operation translates into a
+ CLIQ call in the back-end.
+
+
+ Supported operations
+
+
+ Create volumes
+
+
+ Delete volumes
+
+
+ Extend volumes
+
+
+ Attach volumes
+
+
+ Detach volumes
+
+
+ Create snapshots.
+
+
+ Delete snapshots
+
+
+ Create volumes from snapshots
+
+
+ Copy images to volumes
+
+
+ Copy volumes to images
+
+
+
+
+ Enable the HP LeftHand/StoreVirtual iSCSI driver in legacy mode
+
+
+ The
+ HPLeftHandISCSIDriver
+ is installed with the OpenStack software.
+
+
+
+ If you are not using an existing cluster, create a
+ cluster on the HP Lefthand storage system to be used as
+ the cluster for creating volumes.
+
+
+
+
+ Make the following changes in the
+ /etc/cinder/cinder.conf
+ file.
+
+## REQUIRED SETTINGS
+
+# VIP of your Virtual Storage Appliance (VSA).
+san_ip=10.10.0.141
+
+# LeftHand Super user username
+san_login=lhuser
+
+# LeftHand Super user password
+san_password=lhpass
+
+# LeftHand ssh port, the default for the VSA is usually 16022.
+san_ssh_port=16022
+
+# LeftHand cluster to use for volume creation
+san_clustername=ClusterLefthand
+
+# LeftHand iSCSI driver
+volume_driver=cinder.volume.drivers.san.hp.hp_lefthand_iscsi.HPLeftHandISCSIDriver
+
+## OPTIONAL SETTINGS
+
+# LeftHand provisioning, to disable thin provisioning, set to
+# set to False.
+san_thin_provision=True
+
+# Typically, this parameter is set to False, for this driver.
+# To configure the CLIQ commands to run locally instead of over ssh,
+# set this parameter to True
+san_is_local=False
+
+
+
+
+ Save the changes to the
+ cinder.conf
+ file and restart the
+ cinder-volume
+ service.
+
+
+
+ The HP LeftHand/StoreVirtual driver is now enabled in
+ legacy mode on your OpenStack system. If you experience
+ problems, review the Block Storage Service log files for errors.
+
+ To configure the VSA
+
+
+
+ Configure CHAP on each of the
+ nova-compute
+ nodes.
+
+
+
+
+ Add server associations on the VSA with the associated
+ CHAPS and initiator information. The name should
+ correspond to the
+ hostname
+ of the
+ nova-compute
+ node. For Xen, this is the hypervisor host name. To do
+ this, use either CLIQ or the Centralized Management
+ Console.
+
+
+
+
+
+
\ No newline at end of file