ef60b8ffd7
The HP LeftHand Cinder driver was recently refactored to be HPE. The same refactoring is being done to the documentation with this patch. It is being done because the company managing the HP LeftHand Cinder driver is now Hewlett Packard Enterprise (HPE). Closes-Bug: #1517648 Change-Id: Ibe4d4ff73591348fcf5997984e89d0a895172f6b
310 lines
14 KiB
XML
310 lines
14 KiB
XML
<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>HPE LeftHand/StoreVirtual driver</title>
|
|
<para>
|
|
The
|
|
<filename>HPELeftHandISCSIDriver</filename>
|
|
is based on the
|
|
Block Storage service (Cinder) plug-in architecture. Volume operations
|
|
are run by communicating with the HPE LeftHand/StoreVirtual system over
|
|
HTTPS, or SSH connections. HTTPS communications use the
|
|
<package>python-lefthandclient</package>,
|
|
which is part of the Python standard library.
|
|
</para>
|
|
<para>
|
|
The
|
|
<filename>HPELeftHandISCSIDriver</filename>
|
|
can be configured
|
|
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="hpe-lefthand-rest-driver" />.
|
|
</para>
|
|
<para>For information about how to manage HPE LeftHand/StoreVirtual
|
|
storage systems, see the HPE LeftHand/StoreVirtual user documentation.
|
|
</para>
|
|
<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="hpe-lefthand-sys-reqs">
|
|
<title>System requirements</title>
|
|
<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 HPE
|
|
LeftHand/StoreVirtual storage system.
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Create a cluster group.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
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="hpe-lefthand-supported-ops-rest">
|
|
<title>Supported operations</title>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>Create, delete, attach, and detach volumes.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Create, list, and delete volume snapshots.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Create a volume from a snapshot.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Copy an image to a volume.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Copy a volume to an image.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Clone a volume.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Extend a volume.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Get volume statistics.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Migrate a volume with back-end assistance.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Retype a volume.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Manage and unmanage a volume.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>When you use back-end assisted volume
|
|
migration, both source and destination clusters must be in
|
|
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>
|
|
<para>
|
|
Volume type support for the driver includes the ability to set
|
|
the following capabilities in the OpenStack Cinder API
|
|
<filename>cinder.api.contrib.types_extra_specs</filename>
|
|
volume type extra specs extension module.
|
|
</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>
|
|
<literal>hpelh:provisioning</literal>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<literal>hpelh:ao</literal>
|
|
</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>
|
|
<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>'hpelh:'</literal>.
|
|
For information about how to set the key-value pairs and
|
|
associate them with a volume type, run the following
|
|
command:
|
|
</para>
|
|
<screen> <prompt>$</prompt> <userinput>cinder help type-key</userinput></screen>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>The following keys require the HPE LeftHand/StoreVirtual
|
|
storage array be configured for</para>
|
|
<variablelist>
|
|
<varlistentry><term>hpelh:ao</term>
|
|
<listitem><para>The HPE LeftHand/StoreVirtual storage array
|
|
must be configured for Adaptive Optimization.</para></listitem>
|
|
</varlistentry>
|
|
<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>
|
|
</variablelist>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<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>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>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>hpelh:data_pl</term>
|
|
<listitem><para>Defaults to
|
|
<literal>r-0</literal>,
|
|
Network RAID-0 (None), the valid values are,</para>
|
|
<para>
|
|
<literal>r-0</literal>,
|
|
Network RAID-0 (None)
|
|
</para>
|
|
<para>
|
|
<literal>r-5</literal>,
|
|
Network RAID-5 (Single Parity)
|
|
</para>
|
|
<para>
|
|
<literal>r-10-2</literal>,
|
|
Network RAID-10 (2-Way Mirror)
|
|
</para>
|
|
<para>
|
|
<literal>r-10-3</literal>,
|
|
Network RAID-10 (3-Way Mirror)
|
|
</para>
|
|
<para>
|
|
<literal>r-10-4</literal>,
|
|
Network RAID-10 (4-Way Mirror)
|
|
</para>
|
|
<para>
|
|
<literal>r-6</literal>,
|
|
Network RAID-6 (Dual Parity),
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</itemizedlist>
|
|
|
|
</section>
|
|
<section xml:id="enable-hpe-lefthand">
|
|
<title>Enable the HPE LeftHand/StoreVirtual iSCSI driver
|
|
</title>
|
|
<para>
|
|
The
|
|
<filename>HPELeftHandISCSIDriver</filename>
|
|
is installed with the OpenStack software.
|
|
</para>
|
|
<procedure>
|
|
<step>
|
|
<para>
|
|
Install the
|
|
<filename>python-lefthandclient</filename>
|
|
Python package on the OpenStack Block Storage system.
|
|
</para>
|
|
<screen><prompt>#</prompt> <userinput>pip install 'python-lefthandclient>=2.0,<2.0'</userinput></screen>
|
|
</step>
|
|
<step>
|
|
<para>If you are not using an existing cluster, create a
|
|
cluster on the HPE LeftHand storage system to be used as
|
|
the cluster for creating volumes.
|
|
</para>
|
|
</step>
|
|
<step>
|
|
<para>
|
|
Make the following changes in the
|
|
<filename>/etc/cinder/cinder.conf</filename>
|
|
file:
|
|
</para>
|
|
<programlisting><emphasis role="bold">## REQUIRED SETTINGS</emphasis>
|
|
|
|
# LeftHand WS API Server URL
|
|
hpelefthand_api_url=<replaceable>https://10.10.0.141:8081/lhos</replaceable>
|
|
|
|
# LeftHand Super user username
|
|
hpelefthand_username=<replaceable>lhuser</replaceable>
|
|
|
|
# LeftHand Super user password
|
|
hpelefthand_password=<replaceable>lhpass</replaceable>
|
|
|
|
# LeftHand cluster to use for volume creation
|
|
hpelefthand_clustername=<replaceable>ClusterLefthand</replaceable>
|
|
|
|
# LeftHand iSCSI driver
|
|
volume_driver=cinder.volume.drivers.hpe.hpe_lefthand_iscsi.HPELeftHandISCSIDriver
|
|
|
|
<emphasis role="bold">## OPTIONAL SETTINGS</emphasis>
|
|
|
|
# Should CHAPS authentication be used (default=false)
|
|
hpelefthand_iscsi_chap_enabled=false
|
|
|
|
# Enable HTTP debugging to LeftHand (default=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
|
|
# physical capacity.
|
|
max_over_subscription_ratio=20.0
|
|
|
|
# This flag represents the percentage of reserved back-end capacity.
|
|
reserved_percentage=15
|
|
</programlisting>
|
|
<para>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.
|
|
</para>
|
|
<para>
|
|
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 HPE LeftHand/StoreVirtual system. OpenStack Compute
|
|
nodes use these secrets when creating iSCSI connections.
|
|
<important>
|
|
<para>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.
|
|
</para>
|
|
</important>
|
|
<note>
|
|
<para>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.
|
|
</para>
|
|
</note>
|
|
</para>
|
|
</step>
|
|
<step>
|
|
<para>
|
|
Save the changes to the <filename>cinder.conf</filename>
|
|
file and restart the
|
|
<systemitem class="service">cinder-volume</systemitem>
|
|
service.
|
|
</para>
|
|
</step>
|
|
</procedure>
|
|
<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>
|
|
</section>
|
|
</section>
|
|
</section>
|