openstack/openstack-manuals
Code Issues Proposed changes

Merge "Refactoring HP LeftHand Cinder Driver to be HPE"

Browse Source
This commit is contained in:
Jenkins 2015-11-20 09:29:37 +00:00 committed by Gerrit Code Review
commit 9a45431e83
7 changed files with 83 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/common/samples/cinder.conf.sample
View File

@ -1955,28 +1955,28 @@
#
# Options defined in cinder.volume.drivers.san.hp.hp_lefthand_rest_proxy
# Options defined in cinder.volume.drivers.hpe.hpe_lefthand_rest_proxy
#
# HP LeftHand WSAPI Server Url like https://<LeftHand
# HPE LeftHand WSAPI Server Url like https://<LeftHand
# ip>:8081/lhos (string value)
#hplefthand_api_url=<None>
#hpelefthand_api_url=<None>
# HP LeftHand Super user username (string value)
#hplefthand_username=<None>
# HPE LeftHand Super user username (string value)
#hpelefthand_username=<None>
# HP LeftHand Super user password (string value)
#hplefthand_password=<None>
# HPE LeftHand Super user password (string value)
#hpelefthand_password=<None>
# HP LeftHand cluster name (string value)
#hplefthand_clustername=<None>
# HPE LeftHand cluster name (string value)
#hpelefthand_clustername=<None>
# Configure CHAP authentication for iSCSI connections
# (Default: Disabled) (boolean value)
#hplefthand_iscsi_chap_enabled=false
#hpelefthand_iscsi_chap_enabled=false
# Enable HTTP debugging to LeftHand (boolean value)
#hplefthand_debug=false
#hpelefthand_debug=false
#

24
doc/common/tables/cinder-hplefthand.xml → doc/common/tables/cinder-hpelefthand.xml
View File

@ -21,8 +21,8 @@
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hplefthand">
<caption>Description of HP LeftHand/StoreVirtual driver configuration options</caption>
<table rules="all" xml:id="config_table_cinder_hpelefthand">
<caption>Description of HPE LeftHand/StoreVirtual driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -36,28 +36,28 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hplefthand_api_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HP LeftHand WSAPI Server Url like https://&lt;LeftHand ip&gt;:8081/lhos</td>
<td><option>hpelefthand_api_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPE LeftHand WSAPI Server Url like https://&lt;LeftHand ip&gt;:8081/lhos</td>
</tr>
<tr>
<td><option>hplefthand_clustername</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HP LeftHand cluster name</td>
<td><option>hpelefthand_clustername</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPE LeftHand cluster name</td>
</tr>
<tr>
<td><option>hplefthand_debug</option> = <replaceable>False</replaceable></td>
<td><option>hpelefthand_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
</tr>
<tr>
<td><option>hplefthand_iscsi_chap_enabled</option> = <replaceable>False</replaceable></td>
<td><option>hpelefthand_iscsi_chap_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
</tr>
<tr>
<td><option>hplefthand_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HP LeftHand Super user password</td>
<td><option>hpelefthand_password</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPE LeftHand Super user password</td>
</tr>
<tr>
<td><option>hplefthand_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HP LeftHand Super user username</td>
<td><option>hpelefthand_username</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) HPE LeftHand Super user username</td>
</tr>
</tbody>
</table>

103
doc/config-reference/block-storage/drivers/hp-lefthand-driver.xml → doc/config-reference/block-storage/drivers/hpe-lefthand-driver.xml
View File

@ -1,47 +1,46 @@
<section xml:id="HP-LeftHand-StoreVirtual-driver" xmlns="http://docbook.org/ns/docbook"
<section xml:id="HPE-LeftHand-StoreVirtual-driver" xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0">
<title>HP LeftHand/StoreVirtual driver</title>
<title>HPE LeftHand/StoreVirtual driver</title>
<para>
The
<filename>HPLeftHandISCSIDriver</filename>
<filename>HPELeftHandISCSIDriver</filename>
is based on the
Block Storage service (Cinder) plug-in architecture. Volume operations
are run by communicating with the HP LeftHand/StoreVirtual system over
are run by communicating with the HPE LeftHand/StoreVirtual system over
HTTPS, or SSH connections. HTTPS communications use the
<package>hplefthandclient</package>,
<package>python-lefthandclient</package>,
which is part of the Python standard library.
</para>
<para>
The
<filename>HPLeftHandISCSIDriver</filename>
<filename>HPELeftHandISCSIDriver</filename>
can be configured
to run using a 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 <package>hplefthandclient</package>
to run using a REST client to communicate with the array. For
performance improvements and new functionality the <package>python-lefthandclient</package>
must be downloaded, and HP LeftHand/StoreVirtual Operating System
software version 11.5 or
higher is required on the array. To configure
the driver see
<xref linkend="hp-lefthand-rest-driver" />.
the driver, see
<xref linkend="hpe-lefthand-rest-driver" />.
</para>
<para>For information about how to manage HP LeftHand/StoreVirtual
storage systems, see the HP LeftHand/StoreVirtual user documentation.
<para>For information about how to manage HPE LeftHand/StoreVirtual
storage systems, see the HPE LeftHand/StoreVirtual user documentation.
</para>
<section xml:id="hp-lefthand-rest-driver">
<title>HP LeftHand/StoreVirtual REST driver</title>
<para>This section describes how to configure the HP
<section xml:id="hpe-lefthand-rest-driver">
<title>HPE LeftHand/StoreVirtual REST driver</title>
<para>This section describes how to configure the HPE
LeftHand/StoreVirtual Cinder driver.
</para>
<section xml:id="hp-lefthand-sys-reqs">
<section xml:id="hpe-lefthand-sys-reqs">
<title>System requirements</title>
<para>To use the HP LeftHand/StoreVirtual driver,
<para>To use the HPE LeftHand/StoreVirtual driver,
do the following:
</para>
<itemizedlist>
<listitem>
<para>Install LeftHand/StoreVirtual Operating System
software version 11.5 or higher on the HP
software version 11.5 or higher on the HPE
LeftHand/StoreVirtual storage system.
</para>
</listitem>
@ -50,14 +49,14 @@
</listitem>
<listitem>
<para>
Install the <package>hplefthandclient</package> version
1.0.2 from the Python Package Index on the system with the
Install the <package>python-lefthandclient</package> version
2.0.0 from the Python Package Index on the system with the
enabled Block Storage service volume drivers.
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="hp-lefthand-supported-ops-rest">
<section xml:id="hpe-lefthand-supported-ops-rest">
<title>Supported operations</title>
<itemizedlist>
<listitem>
@ -96,8 +95,8 @@
</itemizedlist>
<para>When you use back-end 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
the same HPE LeftHand/StoreVirtual management group.
The HPE LeftHand/StoreVirtual array will use native LeftHand
APIs to migrate the volume. The volume cannot be attached
or have snapshots to migrate.
</para>
@ -110,24 +109,24 @@
<itemizedlist>
<listitem>
<para>
<literal>hplh:provisioning</literal>
<literal>hpelh:provisioning</literal>
</para>
</listitem>
<listitem>
<para>
<literal>hplh:ao</literal>
<literal>hpelh:ao</literal>
</para>
</listitem>
<listitem>
<para>
<literal>hplh:data_pl</literal>
<literal>hpelh:data_pl</literal>
</para>
</listitem>
</itemizedlist>
<para>
To work with the default filter scheduler, the key-value pairs
are case-sensitive and scoped with
<literal>'hplh:'</literal>.
<literal>'hpelh:'</literal>.
For information about how to set the key-value pairs and
associate them with a volume type, run the following
command:
@ -135,15 +134,15 @@
<screen> <prompt>$</prompt> <userinput>cinder help type-key</userinput></screen>
<itemizedlist>
<listitem>
<para>The following keys require the HP LeftHand/StoreVirtual
<para>The following keys require the HPE LeftHand/StoreVirtual
storage array be configured for</para>
<variablelist>
<varlistentry><term>hplh:ao</term>
<listitem><para>The HP LeftHand/StoreVirtual storage array
<varlistentry><term>hpelh:ao</term>
<listitem><para>The HPE LeftHand/StoreVirtual storage array
must be configured for Adaptive Optimization.</para></listitem>
</varlistentry>
<varlistentry><term>hplh:data_pl</term>
<listitem><para>The HP LeftHand/StoreVirtual storage array
<varlistentry><term>hpelh:data_pl</term>
<listitem><para>The HPE LeftHand/StoreVirtual storage array
must be able to support the Data Protection level
specified by the extra spec.</para></listitem>
</varlistentry>
@ -155,19 +154,19 @@
<para>If volume types are not used or a particular key is not
set for a volume type, the following defaults are used:</para>
<variablelist>
<varlistentry><term>hplh:provisioning</term>
<varlistentry><term>hpelh:provisioning</term>
<listitem><para>Defaults to <literal>thin</literal> provisioning, the valid values are,
<literal>thin</literal>
and
<literal>full</literal></para></listitem>
</varlistentry>
<varlistentry><term>hplh:ao</term>
<varlistentry><term>hpelh:ao</term>
<listitem><para>Defaults to <literal>true</literal>, the valid values are,
<literal>true</literal>
and
<literal>false</literal>.</para></listitem>
</varlistentry>
<varlistentry><term>hplh:data_pl</term>
<varlistentry><term>hpelh:data_pl</term>
<listitem><para>Defaults to
<literal>r-0</literal>,
Network RAID-0 (None), the valid values are,</para>
@ -202,26 +201,26 @@
</itemizedlist>
</section>
<section xml:id="enable-hp-lefthand">
<title>Enable the HP LeftHand/StoreVirtual iSCSI driver
<section xml:id="enable-hpe-lefthand">
<title>Enable the HPE LeftHand/StoreVirtual iSCSI driver
</title>
<para>
The
<filename>HPLeftHandISCSIDriver</filename>
<filename>HPELeftHandISCSIDriver</filename>
is installed with the OpenStack software.
</para>
<procedure>
<step>
<para>
Install the
<filename>hplefthandclient</filename>
<filename>python-lefthandclient</filename>
Python package on the OpenStack Block Storage system.
</para>
<screen><prompt>#</prompt> <userinput>pip install 'hplefthandclient&gt;=1.0.2,&lt;2.0'</userinput></screen>
<screen><prompt>#</prompt> <userinput>pip install 'python-lefthandclient&gt;=2.0,&lt;2.0'</userinput></screen>
</step>
<step>
<para>If you are not using an existing cluster, create a
cluster on the HP LeftHand storage system to be used as
cluster on the HPE LeftHand storage system to be used as
the cluster for creating volumes.
</para>
</step>
@ -234,27 +233,27 @@
<programlisting><emphasis role="bold">## REQUIRED SETTINGS</emphasis>
# LeftHand WS API Server URL
hplefthand_api_url=<replaceable>https://10.10.0.141:8081/lhos</replaceable>
hpelefthand_api_url=<replaceable>https://10.10.0.141:8081/lhos</replaceable>
# LeftHand Super user username
hplefthand_username=<replaceable>lhuser</replaceable>
hpelefthand_username=<replaceable>lhuser</replaceable>
# LeftHand Super user password
hplefthand_password=<replaceable>lhpass</replaceable>
hpelefthand_password=<replaceable>lhpass</replaceable>
# LeftHand cluster to use for volume creation
hplefthand_clustername=<replaceable>ClusterLefthand</replaceable>
hpelefthand_clustername=<replaceable>ClusterLefthand</replaceable>
# LeftHand iSCSI driver
volume_driver=cinder.volume.drivers.san.hp.hp_lefthand_iscsi.HPLeftHandISCSIDriver
volume_driver=cinder.volume.drivers.hpe.hpe_lefthand_iscsi.HPELeftHandISCSIDriver
<emphasis role="bold">## OPTIONAL SETTINGS</emphasis>
# Should CHAPS authentication be used (default=false)
hplefthand_iscsi_chap_enabled=false
hpelefthand_iscsi_chap_enabled=false
# Enable HTTP debugging to LeftHand (default=false)
hplefthand_debug=false
hpelefthand_debug=false
# The ratio of oversubscription when thin provisioned volumes are involved.
# Default ratio is 20.0, this means that a provisioned capacity can be 20 times of the total
@ -271,10 +270,10 @@ reserved_percentage=15
feature.
</para>
<para>
If the <option>hplefthand_iscsi_chap_enabled</option>
If the <option>hpelefthand_iscsi_chap_enabled</option>
is set to <literal>true</literal>, the driver will
associate randomly-generated CHAP secrets with all
hosts on the HP LeftHand/StoreVirtual system. OpenStack Compute
hosts on the HPE LeftHand/StoreVirtual system. OpenStack Compute
nodes use these secrets when creating iSCSI connections.
<important>
<para>CHAP secrets are passed from OpenStack Block
@ -301,7 +300,7 @@ reserved_percentage=15
</para>
</step>
</procedure>
<para>The HP LeftHand/StoreVirtual driver is now enabled on your
<para>The HPE LeftHand/StoreVirtual driver is now enabled on your
OpenStack system. If you experience problems, review the Block
Storage service log files for errors.
</para>

2
doc/config-reference/block-storage/section_misc.xml
View File

@ -28,7 +28,7 @@
<xi:include href="../../common/tables/cinder-emc.xml"/>
<xi:include href="../../common/tables/cinder-flashsystem.xml"/>
<xi:include href="../../common/tables/cinder-hgst.xml"/>
<xi:include href="../../common/tables/cinder-hplefthand.xml"/>
<xi:include href="../../common/tables/cinder-hpelefthand.xml"/>
<xi:include href="../../common/tables/cinder-hpxp.xml"/>
<xi:include href="../../common/tables/cinder-huawei.xml"/>
<xi:include href="../../common/tables/cinder-images.xml"/>

2
doc/config-reference/block-storage/section_volume-drivers.xml
View File

@ -28,7 +28,7 @@
<xi:include href="drivers/hds-hnas-driver.xml"/>
<xi:include href="drivers/hitachi-storage-volume-driver.xml"/>
<xi:include href="drivers/hp-3par-driver.xml"/>
<xi:include href="drivers/hp-lefthand-driver.xml"/>
<xi:include href="drivers/hpe-lefthand-driver.xml"/>
<xi:include href="drivers/hp-msa-driver.xml"/>
<xi:include href="drivers/huawei-storage-driver.xml"/>
<xi:include href="drivers/ibm-gpfs-volume-driver.xml"/>

12
tools/autogenerate-config-flagmappings/cinder.flagmappings
View File

@ -203,12 +203,12 @@ hpe3par_password hpe3par
hpe3par_snapshot_expiration hpe3par
hpe3par_snapshot_retention hpe3par
hpe3par_username hpe3par
hplefthand_api_url hplefthand
hplefthand_clustername hplefthand
hplefthand_debug hplefthand
hplefthand_iscsi_chap_enabled hplefthand
hplefthand_password hplefthand
hplefthand_username hplefthand
hpelefthand_api_url hpelefthand
hpelefthand_clustername hpelefthand
hpelefthand_debug hpelefthand
hpelefthand_iscsi_chap_enabled hpelefthand
hpelefthand_password hpelefthand
hpelefthand_username hpelefthand
hpmsa_api_protocol hpmsa
hpmsa_backend_name hpmsa
hpmsa_backend_type hpmsa

2
tools/autogenerate-config-flagmappings/cinder.headers
View File

@ -21,7 +21,7 @@ hds-hus HDS HUS iSCSI driver
hgst HGST volume driver
hitachi-hbsd Hitachi storage volume driver
hpe3par HPE 3PAR Fibre Channel and iSCSI drivers
hplefthand HP LeftHand/StoreVirtual driver
hpelefthand HPE LeftHand/StoreVirtual driver
hpmsa HP MSA volume driver
hpxp HP XP volume driver
huawei Huawei storage driver