openstack/openstack-manuals
Code Issues Proposed changes

Refactoring HP 3PAR Manila Driver to be HPE

Browse Source 
The HP 3PAR Manila 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 3PAR Manila driver is now Hewlett Packard Enterprise (HPE).

Closes-Bug: #1517283
Change-Id: I0253a5fba8218960014d0b06cbc92baa6a775a2c
This commit is contained in:
Anthony Lee 2015-11-17 16:59:15 -08:00
parent b93354e5ba
commit 715d59c1a5
5 changed files with 60 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/common/tables/manila-hp3par.xml → doc/common/tables/manila-hpe3par.xml
View File

@ -21,8 +21,8 @@
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_manila_hp3par">
<caption>Description of HP 3PAR Share Driver configuration options</caption>
<table rules="all" xml:id="config_table_manila_hpe3par">
<caption>Description of HPE 3PAR Share Driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
@ -36,47 +36,47 @@
<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_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_fpg</option> = <replaceable>OpenStack</replaceable></td>
<td><option>hpe3par_fpg</option> = <replaceable>OpenStack</replaceable></td>
<td>(StrOpt) The File Provisioning Group (FPG) to use</td>
</tr>
<tr>
<td><option>hp3par_fstore_per_share</option> = <replaceable>False</replaceable></td>
<td><option>hpe3par_fstore_per_share</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use one filestore per share</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_san_ip</option> = <replaceable></replaceable></td>
<td><option>hpe3par_san_ip</option> = <replaceable></replaceable></td>
<td>(StrOpt) IP address of SAN controller</td>
</tr>
<tr>
<td><option>hp3par_san_login</option> = <replaceable></replaceable></td>
<td><option>hpe3par_san_login</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username for SAN controller</td>
</tr>
<tr>
<td><option>hp3par_san_password</option> = <replaceable></replaceable></td>
<td><option>hpe3par_san_password</option> = <replaceable></replaceable></td>
<td>(StrOpt) Password for SAN controller</td>
</tr>
<tr>
<td><option>hp3par_san_ssh_port</option> = <replaceable>22</replaceable></td>
<td><option>hpe3par_san_ssh_port</option> = <replaceable>22</replaceable></td>
<td>(IntOpt) SSH port to use with SAN</td>
</tr>
<tr>
<td><option>hp3par_share_ip_address</option> = <replaceable></replaceable></td>
<td><option>hpe3par_share_ip_address</option> = <replaceable></replaceable></td>
<td>(StrOpt) The IP address for shares not using a share server</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>

87
doc/config-reference/shared-file-systems/drivers/hp-3par-share-driver.xml → doc/config-reference/shared-file-systems/drivers/hpe-3par-share-driver.xml
View File

@ -1,15 +1,15 @@
<section xml:id="hp-3par-share-driver" xmlns="http://docbook.org/ns/docbook"
<section xml:id="hpe-3par-share-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 driver</title>
<title>HPE 3PAR driver</title>
<para>
The HP 3PAR driver provides NFS and CIFS shared file systems
to OpenStack using HP 3PAR's File Persona capabilities.
The HPE 3PAR driver provides NFS and CIFS shared file systems
to OpenStack using HPE 3PAR's File Persona capabilities.
</para>
<simplesect>
<title>Supported operations</title>
<para>
The following operations are supported with HP 3PAR File Persona:
The following operations are supported with HPE 3PAR File Persona:
</para>
<itemizedlist>
<listitem>
@ -124,17 +124,17 @@
<itemizedlist>
<listitem>
<para>
hp3parclient version 3.2.1 or newer from PyPI.
python-3parclient version 4.0.0 or newer from PyPI.
</para>
</listitem>
</itemizedlist>
<para>
On the HP 3PAR array:
On the HPE 3PAR array:
</para>
<itemizedlist>
<listitem>
<para>
HP 3PAR Operating System software version 3.2.1 MU3 or higher.
HPE 3PAR Operating System software version 3.2.1 MU3 or higher.
</para>
</listitem>
<listitem>
@ -151,11 +151,11 @@
</itemizedlist>
</simplesect>
<simplesect>
<title>Pre-configuration on the HP 3PAR</title>
<title>Pre-configuration on the HPE 3PAR</title>
<itemizedlist>
<listitem>
<para>
HP 3PAR File Persona must be initialized and started (startfs).
HPE 3PAR File Persona must be initialized and started (startfs).
</para>
</listitem>
<listitem>
@ -187,7 +187,7 @@
<title>Backend configuration</title>
<para>
The following parameters need to be configured in the Shared
File Systems service configuration file for the HP 3PAR driver:
File Systems service configuration file for the HPE 3PAR driver:
</para>
<itemizedlist>
<listitem>
@ -198,7 +198,7 @@
<listitem>
<para>
share_driver =
manila.share.drivers.hp.hp_3par_driver.HP3ParShareDriver
manila.share.drivers.hpe.hpe_3par_driver.HPE3ParShareDriver
</para>
</listitem>
<listitem>
@ -208,57 +208,57 @@
</listitem>
<listitem>
<para>
hp3par_fpg = &lt;FPG to use for share creation&gt;
hpe3par_fpg = &lt;FPG to use for share creation&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_share_ip_address = &lt;IP address to use for share
hpe3par_share_ip_address = &lt;IP address to use for share
export location&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_san_ip = &lt;IP address for SSH access to the SAN
hpe3par_san_ip = &lt;IP address for SSH access to the SAN
controller&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_api_url = &lt;3PAR WS API Server URL&gt;
hpe3par_api_url = &lt;3PAR WS API Server URL&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_username = &lt;3PAR username with the 'edit' role&gt;
hpe3par_username = &lt;3PAR username with the 'edit' role&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_password = &lt;3PAR password for the user specified in
hp3par_username&gt;
hpe3par_password = &lt;3PAR password for the user specified in
hpe3par_username&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_san_login = &lt;Username for SSH access to the SAN
hpe3par_san_login = &lt;Username for SSH access to the SAN
controller&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_san_password = &lt;Password for SSH access to the SAN
hpe3par_san_password = &lt;Password for SSH access to the SAN
controller&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_debug = &lt;False or True for extra debug logging&gt;
hpe3par_debug = &lt;False or True for extra debug logging&gt;
</para>
</listitem>
</itemizedlist>
<para>
The hp3par_share_ip_address must be a valid IP address for the
The hpe3par_share_ip_address must be a valid IP address for the
configured FPG's VFS. This IP address is used in export locations
for shares that are created. Networking must be configured to
allow connectivity from clients to shares.
@ -318,7 +318,7 @@
driver_handles_share_servers extra-spec. This ensures that the
share will be created on a back end that supports the requested
driver_handles_share_servers (share networks) capability. For the
HP 3PAR driver, this must be set to False.
HPE 3PAR driver, this must be set to False.
</para>
<para>
Another common Shared File Systems service extra-spec used to determine
@ -328,17 +328,17 @@
matching share_backend_name.
</para>
<para>
The HP 3PAR driver automatically reports capabilities based on the
The HPE 3PAR driver automatically reports capabilities based on the
FPG used for each back end. Share types with extra specs can be
created by an administrator to control which share types are
allowed to use FPGs with or without specific capabilities. The
following extra-specs are used with the capabilities filter and
the HP 3PAR driver:
the HPE 3PAR driver:
</para>
<itemizedlist>
<listitem>
<para>
hp3par_flash_cache = '&lt;is&gt; True' or '&lt;is&gt; False'
hpe3par_flash_cache = '&lt;is&gt; True' or '&lt;is&gt; False'
</para>
</listitem>
<listitem>
@ -353,7 +353,7 @@
</listitem>
</itemizedlist>
<para>
hp3par_flash_cache will be reported as True for back ends that have
hpe3par_flash_cache will be reported as True for back ends that have
3PAR's Adaptive Flash Cache enabled.
</para>
<para>
@ -369,26 +369,26 @@
<para>
Scoped extra-specs are used to influence vendor-specific
implementation details. Scoped extra-specs use a prefix followed
by a colon. For HP 3PAR these extra-specs have a prefix of hp3par.
by a colon. For HPE 3PAR these extra-specs have a prefix of hpe3par.
</para>
<para>
The following HP 3PAR extra-specs are used when creating CIFS
The following HPE 3PAR extra-specs are used when creating CIFS
(SMB) shares:
</para>
<itemizedlist>
<listitem>
<para>
hp3par:smb_access_based_enum = true or false
hpe3par:smb_access_based_enum = true or false
</para>
</listitem>
<listitem>
<para>
hp3par:smb_continuous_avail = true or false
hpe3par:smb_continuous_avail = true or false
</para>
</listitem>
<listitem>
<para>
hp3par:smb_cache = off, manual, optimized or auto
hpe3par:smb_cache = off, manual, optimized or auto
</para>
</listitem>
</itemizedlist>
@ -400,8 +400,7 @@
<para>
smb_continuous_avail (Continuous Availability) specifies if SMB3
continuous availability features should be enabled for this share.
If not specified, the default is true. This setting will be
ignored with hp3parclient 3.2.1 or earlier.
If not specified, the default is true.
</para>
<para>
smb_cache specifies client-side caching for offline files. Valid
@ -442,13 +441,13 @@
</listitem>
</itemizedlist>
<para>
The following HP 3PAR extra-specs are used when creating NFS
The following HPE 3PAR extra-specs are used when creating NFS
shares:
</para>
<itemizedlist>
<listitem>
<para>
hp3par:nfs_options = Comma separated list of NFS export
hpe3par:nfs_options = Comma separated list of NFS export
options.
</para>
</listitem>
@ -465,36 +464,36 @@
</listitem>
<listitem>
<para>
no_subtree_check and fsid are not allowed per HP 3PAR CLI
no_subtree_check and fsid are not allowed per HPE 3PAR CLI
support.
</para>
</listitem>
<listitem>
<para>
(in)secure and (no_)root_squash are not allowed because the
HP 3PAR driver controls those settings.
HPE 3PAR driver controls those settings.
</para>
</listitem>
</itemizedlist>
</blockquote>
<para>
All other NFS options are forwarded to the HP 3PAR as part of
share creation. The HP 3PAR will do additional validation at share
creation time. Refer to HP 3PAR CLI help for more details.
All other NFS options are forwarded to the HPE 3PAR as part of
share creation. The HPE 3PAR will do additional validation at share
creation time. Refer to HPE 3PAR CLI help for more details.
</para>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configuration options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-hp3par.xml"/>
<xi:include href="../../../common/tables/manila-hpe3par.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_hp3par"/>.
<xref linkend="config_table_manila_hpe3par"/>.
</para>
</simplesect>
</section>

2
doc/config-reference/shared-file-systems/section_manila-misc.xml
View File

@ -25,7 +25,7 @@
<xi:include href="../../common/tables/manila-gpfs.xml"/>
<xi:include href="../../common/tables/manila-hdfs.xml"/>
<xi:include href="../../common/tables/manila-hds_hnas.xml"/>
<xi:include href="../../common/tables/manila-hp3par.xml"/>
<xi:include href="../../common/tables/manila-hpe3par.xml"/>
<xi:include href="../../common/tables/manila-huawei.xml"/>
<xi:include href="../../common/tables/manila-logging.xml"/>
<xi:include href="../../common/tables/manila-netapp.xml"/>

2
doc/config-reference/shared-file-systems/section_share-drivers.xml
View File

@ -22,7 +22,7 @@
<xi:include href="drivers/glusterfs-driver.xml"/>
<xi:include href="drivers/glusterfs-native-driver.xml"/>
<xi:include href="drivers/hdfs-native-driver.xml"/>
<xi:include href="drivers/hp-3par-share-driver.xml"/>
<xi:include href="drivers/hpe-3par-share-driver.xml"/>
<xi:include href="drivers/huawei-nas-driver.xml"/>
<xi:include href="drivers/netapp-cluster-mode-driver.xml"/>
</section>

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

@ -13,7 +13,7 @@ glusterfs GlusterFS Share Drivers
gpfs IBM GPFS Share Driver
hdfs HDFS Share Driver
hds_hnas HDS NAS Share Driver
hp3par HP 3PAR Share Driver
hpe3par HPE 3PAR Share Driver
huawei Huawei Share Driver
logging Logging
netapp NetApp Share Drivers