openstack/openstack-manuals
Code Issues Proposed changes

Merge "Refactoring HP 3PAR Cinder Driver to be HPE"

Browse Source
This commit is contained in:
Jenkins 2015-11-21 04:58:31 +00:00 committed by Gerrit Code Review
commit 89fcd8106a
6 changed files with 104 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/admin-guide-cloud/source/blockstorage_multi_backend.rst
View File

@ -79,14 +79,14 @@ provides more information. In addition, this example presents a
For Fiber Channel drivers that support multipath, the configuration group
requires the ``use_multipath_for_image_xfer=true`` option. In
the example below, you can see details for HP 3PAR and EMC Fiber
the example below, you can see details for HPE 3PAR and EMC Fiber
Channel drivers.
.. code-block:: ini
[3par]
use_multipath_for_image_xfer = true
volume_driver = cinder.volume.drivers.san.hp.hp_3par_fc.HP3PARFCDriver
volume_driver = cinder.volume.drivers.hpe.hpe_3par_fc.HPE3PARFCDriver
volume_backend_name = 3parfc
[emc]

2
doc/admin-guide-cloud/source/ts_non_existent_vlun.rst
View File

@ -17,6 +17,6 @@ created in a different Domain.
Solution
~~~~~~~~
The ``hp3par_domain`` configuration items either need to be updated to
The ``hpe3par_domain`` configuration items either need to be updated to
use the domain the 3PAR host currently resides in, or the 3PAR host
needs to be moved to the domain that the volume was created in.

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

@ -1915,43 +1915,43 @@
#
# Options defined in cinder.volume.drivers.san.hp.hp_3par_common
# Options defined in cinder.volume.drivers.hpe.hpe_3par_common
#
# 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
# (string value)
#hp3par_api_url=
#hpe3par_api_url=
# 3PAR Super user username (string value)
#hp3par_username=
# 3PAR username with the 'edit' role (string value)
#hpe3par_username=
# 3PAR Super user password (string value)
#hp3par_password=
# 3PAR password for the user specified in hpe3par_username (string value)
#hpe3par_password=
# List of the CPG(s) to use for volume creation (list value)
#hp3par_cpg=OpenStack
#hpe3par_cpg=OpenStack
# The CPG to use for Snapshots for volumes. If empty the
# userCPG will be used. (string value)
#hp3par_cpg_snap=
#hpe3par_cpg_snap=
# The time in hours to retain a snapshot. You can't delete it
# before this expires. (string value)
#hp3par_snapshot_retention=
#hpe3par_snapshot_retention=
# The time in hours when a snapshot expires and is deleted.
# This must be larger than expiration (string value)
#hp3par_snapshot_expiration=
#hpe3par_snapshot_expiration=
# Enable HTTP debugging to 3PAR (boolean value)
#hp3par_debug=false
#hpe3par_debug=false
# List of target iSCSI addresses to use. (list value)
#hp3par_iscsi_ips=
#hpe3par_iscsi_ips=
# Enable CHAP authentication for iSCSI connections. (boolean
# value)
#hp3par_iscsi_chap_enabled=false
#hpe3par_iscsi_chap_enabled=false
#

26
doc/common/tables/cinder-hp3par.xml → doc/common/tables/cinder-hpe3par.xml
View File

@ -21,8 +21,8 @@
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_cinder_hp3par">
<caption>Description of HP 3PAR Fibre Channel and iSCSI drivers configuration options</caption>
<table rules="all" xml:id="config_table_cinder_hpe3par">
<caption>Description of HPE 3PAR Fibre Channel and iSCSI drivers configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -36,43 +36,43 @@
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>hp3par_api_url</option> = <replaceable></replaceable></td>
<td><option>hpe3par_api_url</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR WSAPI Server Url like https://&lt;3par ip&gt;:8080/api/v1</td>
</tr>
<tr>
<td><option>hp3par_cpg</option> = <replaceable>OpenStack</replaceable></td>
<td><option>hpe3par_cpg</option> = <replaceable>OpenStack</replaceable></td>
<td>(ListOpt) List of the CPG(s) to use for volume creation</td>
</tr>
<tr>
<td><option>hp3par_cpg_snap</option> = <replaceable></replaceable></td>
<td><option>hpe3par_cpg_snap</option> = <replaceable></replaceable></td>
<td>(StrOpt) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.</td>
</tr>
<tr>
<td><option>hp3par_debug</option> = <replaceable>False</replaceable></td>
<td><option>hpe3par_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable HTTP debugging to 3PAR</td>
</tr>
<tr>
<td><option>hp3par_iscsi_chap_enabled</option> = <replaceable>False</replaceable></td>
<td><option>hpe3par_iscsi_chap_enabled</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable CHAP authentication for iSCSI connections.</td>
</tr>
<tr>
<td><option>hp3par_iscsi_ips</option> = <replaceable></replaceable></td>
<td><option>hpe3par_iscsi_ips</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of target iSCSI addresses to use.</td>
</tr>
<tr>
<td><option>hp3par_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR password for the user specified in hp3par_username</td>
<td><option>hpe3par_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR password for the user specified in hpe3par_username</td>
</tr>
<tr>
<td><option>hp3par_snapshot_expiration</option> = <replaceable></replaceable></td>
<td><option>hpe3par_snapshot_expiration</option> = <replaceable></replaceable></td>
<td>(StrOpt) The time in hours when a snapshot expires and is deleted. This must be larger than expiration</td>
</tr>
<tr>
<td><option>hp3par_snapshot_retention</option> = <replaceable></replaceable></td>
<td><option>hpe3par_snapshot_retention</option> = <replaceable></replaceable></td>
<td>(StrOpt) The time in hours to retain a snapshot. You can't delete it before this expires.</td>
</tr>
<tr>
<td><option>hp3par_username</option> = <replaceable></replaceable></td>
<td><option>hpe3par_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) 3PAR username with the 'edit' role</td>
</tr>
</tbody>

148
doc/config-reference/block-storage/drivers/hp-3par-driver.xml → doc/config-reference/block-storage/drivers/hpe-3par-driver.xml
View File

@ -1,30 +1,30 @@
<section xml:id="hp-3par-driver" xmlns="http://docbook.org/ns/docbook"
<section xml:id="hpe-3par-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 3PAR Fibre Channel and iSCSI drivers</title>
<para>The <filename>HP3PARFCDriver</filename> and
<filename>HP3PARISCSIDriver</filename> drivers, which are
<title>HPE 3PAR Fibre Channel and iSCSI drivers</title>
<para>The <filename>HPE3PARFCDriver</filename> and
<filename>HPE3PARISCSIDriver</filename> drivers, which are
based on the Block Storage service (Cinder) plug-in
architecture, run volume operations by communicating with the
HP 3PAR storage system over HTTP, HTTPS, and SSH connections.
HPE 3PAR storage system over HTTP, HTTPS, and SSH connections.
The HTTP and HTTPS communications use
<package>hp3parclient</package>, which is part of the
<package>python-3parclient</package>, which is part of the
Python standard library.</para>
<para>For information about how to manage HP 3PAR storage systems,
see the HP 3PAR user documentation.</para>
<section xml:id="hp-3par-sys-reqs">
<para>For information about how to manage HPE 3PAR storage systems,
see the HPE 3PAR user documentation.</para>
<section xml:id="hpe-3par-sys-reqs">
<title>System requirements</title>
<para>To use the HP 3PAR drivers, install the following
software and components on the HP 3PAR storage
<para>To use the HPE 3PAR drivers, install the following
software and components on the HPE 3PAR storage
system:</para>
<itemizedlist>
<listitem>
<para>HP 3PAR Operating System software version 3.1.3 MU1
<para>HPE 3PAR Operating System software version 3.1.3 MU1
or higher.</para>
<itemizedlist>
<listitem>
<para>Deduplication provisioning requires SSD disks
and HP 3PAR Operating System software version
and HPE 3PAR Operating System software version
3.2.1 MU1 or higher.</para>
</listitem>
<listitem>
@ -36,12 +36,12 @@
</para>
</listitem>
<listitem>
<para>HP 3PAR Operating System software version 3.2.1 MU2
<para>HPE 3PAR Operating System software version 3.2.1 MU2
or higher.
</para>
</listitem>
<listitem>
<para>hp3parclient version 3.2.0 or newer.
<para>python-3parclient version 4.0.0 or newer.
</para>
</listitem>
<listitem>
@ -80,7 +80,7 @@
</itemizedlist>
</listitem>
<listitem>
<para>HP 3PAR Web Services API Server must be enabled
<para>HPE 3PAR Web Services API Server must be enabled
and running</para>
</listitem>
<listitem>
@ -88,14 +88,14 @@
</listitem>
<listitem>
<para>Additionally, you must install the
<package>hp3parclient</package> version 3.1.1 or
<package>python-3parclient</package> version 4.0.0 or
newer from the Python standard library on the
system with the enabled Block Storage service
volume drivers.</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="hp-3par-supported-ops">
<section xml:id="hpe-3par-supported-ops">
<title>Supported operations</title>
<itemizedlist>
<listitem>
@ -129,39 +129,39 @@
<para>Manage and unmanage a volume.</para>
</listitem>
</itemizedlist>
<para>Volume type support for both HP 3PAR drivers includes
<para>Volume type support for both HPE 3PAR drivers includes
the ability to set the following capabilities in the
OpenStack Block Storage API
<filename>cinder.api.contrib.types_extra_specs</filename>
volume type extra specs extension module:</para>
<itemizedlist>
<listitem>
<para><literal>hp3par:cpg</literal></para>
<para><literal>hpe3par:cpg</literal></para>
<warning><para>This setting is ignored as of Kilo. Instead,
use the <literal>hp3par_cpg</literal> setting in <filename>
use the <literal>hpe3par_cpg</literal> setting in <filename>
cinder.conf</filename> to list the valid CPGs for a
backend. CPGs should now be controlled by configuring
separate backends with pools.</para></warning>
</listitem>
<listitem>
<para><literal>hp3par:snap_cpg</literal></para>
<para><literal>hpe3par:snap_cpg</literal></para>
</listitem>
<listitem>
<para><literal>hp3par:provisioning</literal></para>
<para><literal>hpe3par:provisioning</literal></para>
</listitem>
<listitem>
<para><literal>hp3par:persona</literal></para>
<para><literal>hpe3par:persona</literal></para>
</listitem>
<listitem>
<para><literal>hp3par:vvs</literal></para>
<para><literal>hpe3par:vvs</literal></para>
</listitem>
<listitem>
<para><literal>hp3par:flash_cache</literal></para>
<para><literal>hpe3par:flash_cache</literal></para>
</listitem>
</itemizedlist>
<para>To work with the default filter scheduler, the key
values are case sensitive and scoped with
<literal>hp3par:</literal>.
<literal>hpe3par:</literal>.
For information about how to set the key-value pairs and
associate them with a volume type, run the following
command:
@ -171,7 +171,7 @@
<para>Volumes that are cloned only support extra specs
keys cpg, snap_cpg, provisioning and vvs. The others
are ignored. In addition the comments section of the
cloned volume in the HP 3PAR StoreServ storage array
cloned volume in the HPE 3PAR StoreServ storage array
is not populated.</para>
</note>
<para>If volume types are not used or a particular key is not
@ -179,26 +179,26 @@
used:</para>
<itemizedlist>
<listitem>
<para><literal>hp3par:cpg</literal> - Defaults to the
<literal>hp3par_cpg</literal> setting in the
<para><literal>hpe3par:cpg</literal> - Defaults to the
<literal>hpe3par_cpg</literal> setting in the
<filename>cinder.conf</filename> file.</para>
</listitem>
<listitem>
<para><literal>hp3par:snap_cpg</literal> - Defaults to
the <literal>hp3par_snap</literal> setting in the
<para><literal>hpe3par:snap_cpg</literal> - Defaults to
the <literal>hpe3par_snap</literal> setting in the
<filename>cinder.conf</filename> file. If
<literal>hp3par_snap</literal> is not set, it
defaults to the <literal>hp3par_cpg</literal>
<literal>hpe3par_snap</literal> is not set, it
defaults to the <literal>hpe3par_cpg</literal>
setting.</para>
</listitem>
<listitem>
<para><literal>hp3par:provisioning</literal> -
<para><literal>hpe3par:provisioning</literal> -
Defaults to thin provisioning, the valid values
are <literal>thin</literal>, <literal>full</literal>,
and <literal>dedup</literal>.</para>
</listitem>
<listitem>
<para><literal>hp3par:persona</literal> - Defaults to
<para><literal>hpe3par:persona</literal> - Defaults to
the <literal>2 - Generic-ALUA</literal> persona. The
valid values are, <literal>1 - Generic</literal>,
<literal>2 - Generic-ALUA</literal>,
@ -212,13 +212,13 @@
and <literal>11 - WindowsServer</literal>.</para>
</listitem>
<listitem>
<para><literal>hp3par:flash_cache</literal> -
<para><literal>hpe3par:flash_cache</literal> -
Defaults to <literal>false</literal>, the valid values
are <literal>true</literal>
and <literal>false</literal>.</para>
</listitem>
</itemizedlist>
<para>QoS support for both HP 3PAR drivers includes
<para>QoS support for both HPE 3PAR drivers includes
the ability to set the following capabilities in the
OpenStack Block Storage API
<filename>cinder.api.contrib.qos_specs_manage</filename>
@ -253,16 +253,16 @@
<screen><prompt>$</prompt> <userinput>cinder help qos-associate</userinput></screen>
</para>
<para>The following keys require that the HP 3PAR StoreServ
<para>The following keys require that the HPE 3PAR StoreServ
storage array has a Priority Optimization license
installed.</para>
<itemizedlist>
<listitem>
<para><literal>hp3par:vvs</literal> - The virtual
<para><literal>hpe3par:vvs</literal> - The virtual
volume set name that has been predefined by the
Administrator with Quality of Service (QoS) rules
associated to it. If you specify extra_specs
<literal>hp3par:vvs</literal>, the
<literal>hpe3par:vvs</literal>, the
qos_specs <literal>minIOPS</literal>,
<literal>maxIOPS</literal>, <literal>minBWS</literal>,
and <literal>maxBWS</literal> settings are
@ -306,12 +306,12 @@
the other will be set to the same value.</para>
</note>
<para>The following keys require that the HP 3PAR StoreServ
<para>The following keys require that the HPE 3PAR StoreServ
storage array has an Adaptive Flash Cache license
installed.</para>
<itemizedlist>
<listitem>
<para><literal>hp3par:flash_cache</literal> - The
<para><literal>hpe3par:flash_cache</literal> - The
flash-cache policy, which can be turned on and off
by setting the value to <literal>true</literal> or
<literal>false</literal>.</para>
@ -319,30 +319,30 @@
</itemizedlist>
</section>
<section xml:id="enable-hp-3par-fibre-channel">
<title>Enable the HP 3PAR Fibre Channel and iSCSI
<section xml:id="enable-hpe-3par-fibre-channel">
<title>Enable the HPE 3PAR Fibre Channel and iSCSI
drivers</title>
<para>The <filename>HP3PARFCDriver</filename> and
<filename>HP3PARISCSIDriver</filename> are installed
<para>The <filename>HPE3PARFCDriver</filename> and
<filename>HPE3PARISCSIDriver</filename> are installed
with the OpenStack software.</para>
<procedure>
<step>
<para>Install the <filename>hp3parclient</filename>
<para>Install the <filename>python-3parclient</filename>
Python package on the OpenStack Block Storage
system.
<screen><prompt>#</prompt> <userinput>pip install 'hp3parclient&gt;=3.0,&lt;4.0'</userinput></screen>
<screen><prompt>#</prompt> <userinput>pip install 'python-3parclient&gt;=4.0,&lt;5.0'</userinput></screen>
</para>
</step>
<step>
<para>Verify that the HP 3PAR Web Services API server
is enabled and running on the HP 3PAR storage
<para>Verify that the HPE 3PAR Web Services API server
is enabled and running on the HPE 3PAR storage
system.</para>
<substeps>
<step>
<para>Log onto the HP 3PAR storage system with
<para>Log onto the HPE 3PAR storage system with
administrator
access.</para>
<screen><prompt>$</prompt> <userinput>ssh 3paradm@<replaceable>&lt;HP 3PAR IP Address&gt;</replaceable></userinput></screen>
<screen><prompt>$</prompt> <userinput>ssh 3paradm@<replaceable>&lt;HPE 3PAR IP Address&gt;</replaceable></userinput></screen>
</step>
<step>
<para>View the current state of the Web
@ -376,7 +376,7 @@ Enabled Active Enabled 8008 Enabled 8080 1.1</compu
</step>
<step>
<para>If you are not using an existing CPG, create a
CPG on the HP 3PAR storage system to be used as
CPG on the HPE 3PAR storage system to be used as
the default location for creating volumes.</para>
</step>
<step>
@ -385,16 +385,16 @@ Enabled Active Enabled 8008 Enabled 8080 1.1</compu
file.</para>
<programlisting language="ini"><emphasis role="bold">## REQUIRED SETTINGS</emphasis>
# 3PAR WS API Server URL
hp3par_api_url=https://10.10.0.141:8080/api/v1
hpe3par_api_url=https://10.10.0.141:8080/api/v1
# 3PAR username with the 'edit' role
hp3par_username=edit3par
hpe3par_username=edit3par
# 3PAR password for the user specified in hp3par_username
hp3par_password=3parpass
# 3PAR password for the user specified in hpe3par_username
hpe3par_password=3parpass
# 3PAR CPG to use for volume creation
hp3par_cpg=OpenStackCPG_RAID5_NL
hpe3par_cpg=OpenStackCPG_RAID5_NL
# IP address of SAN controller for SSH access to the array
san_ip=10.10.22.241
@ -406,33 +406,33 @@ san_login=3paradm
san_password=3parpass
# FIBRE CHANNEL(uncomment the next line to enable the FC driver)
# volume_driver=cinder.volume.drivers.san.hp.hp_3par_fc.HP3PARFCDriver
# volume_driver=cinder.volume.drivers.hpe.hpe_3par_fc.HPE3PARFCDriver
# iSCSI (uncomment the next line to enable the iSCSI driver and
# hp3par_iscsi_ips or iscsi_ip_address)
#volume_driver=cinder.volume.drivers.san.hp.hp_3par_iscsi.HP3PARISCSIDriver
# hpe3par_iscsi_ips or iscsi_ip_address)
#volume_driver=cinder.volume.drivers.hpe.hpe_3par_iscsi.HPE3PARISCSIDriver
# iSCSI multiple port configuration
# hp3par_iscsi_ips=10.10.220.253:3261,10.10.222.234
# hpe3par_iscsi_ips=10.10.220.253:3261,10.10.222.234
# Still available for single port iSCSI configuration
#iscsi_ip_address=10.10.220.253
<emphasis role="bold">## OPTIONAL SETTINGS</emphasis>
# Enable HTTP debugging to 3PAR
hp3par_debug=False
hpe3par_debug=False
# Enable CHAP authentication for iSCSI connections.
hp3par_iscsi_chap_enabled=false
hpe3par_iscsi_chap_enabled=false
# The CPG to use for Snapshots for volumes. If empty hp3par_cpg will be used.
hp3par_snap_cpg=OpenStackSNAP_CPG
# The CPG to use for Snapshots for volumes. If empty hpe3par_cpg will be used.
hpe3par_snap_cpg=OpenStackSNAP_CPG
# Time in hours to retain a snapshot. You can't delete it before this expires.
hp3par_snapshot_retention=48
hpe3par_snapshot_retention=48
# Time in hours when a snapshot expires and is deleted. This must be larger than retention.
hp3par_snapshot_expiration=72
hpe3par_snapshot_expiration=72
# 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
@ -451,7 +451,7 @@ reserved_percentage=15</programlisting>
<note>
<para>You can configure one or more iSCSI
addresses by using the
<option>hp3par_iscsi_ips</option> option.
<option>hpe3par_iscsi_ips</option> option.
When you configure multiple addresses, the
driver selects the iSCSI port with the fewest
active volumes at attach time. The IP address
@ -463,7 +463,7 @@ reserved_percentage=15</programlisting>
(<literal>,</literal>). The
<option>iscsi_ip_address</option>/<option>iscsi_port</option>
options might be used as an alternative to
<option>hp3par_iscsi_ips</option> for
<option>hpe3par_iscsi_ips</option> for
single port iSCSI configuration.</para>
</note>
</step>
@ -474,12 +474,12 @@ reserved_percentage=15</programlisting>
>cinder-volume</systemitem> service.</para>
</step>
</procedure>
<para>The HP 3PAR Fibre Channel and iSCSI drivers are now
<para>The HPE 3PAR Fibre Channel and iSCSI drivers are now
enabled on your OpenStack system. If you experience
problems, review the Block Storage service log files for
errors.</para>
<para>The following table contains all the configuration options
supported by the HP 3PAR Fibre Channel and iSCSI drivers.</para>
<xi:include href="../../../common/tables/cinder-hp3par.xml"/>
supported by the HPE 3PAR Fibre Channel and iSCSI drivers.</para>
<xi:include href="../../../common/tables/cinder-hpe3par.xml"/>
</section>
</section>

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

@ -27,7 +27,7 @@
<xi:include href="drivers/glusterfs-driver.xml"/>
<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/hpe-3par-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"/>