openstack/openstack-manuals
Code Issues Proposed changes
Files
c41dbfc0e2c0e67d4a06fc4c4b7afce98674b747
openstack-manuals/doc/config-reference/shared-file-systems/drivers/hp-3par-share-driver.xml
Mark Sturdevant c41dbfc0e2 Add Shared File Systems (manila) to Config Ref 
Shared File Systems service (manila) should be added to
the Config Ref similar to Block Storage (cinder).
The content would be similar to cinder in that it
would have sections to describe Intro, Drivers,
Log Files and Options.

Change-Id: I89fc64f8cd4fe880b36017139e7989f3a4100cc6
Implements: blueprint manila-config-ref
2015-09-22 15:21:28 -07:00

501 lines
15 KiB
XML
Raw Blame History

<section xml:id="hp-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>
<para>
The HP 3PAR driver provides NFS and CIFS shared file systems
to OpenStack using HP 3PAR's File Persona capabilities.
</para>
<simplesect>
<title>Supported operations</title>
<para>
The following operations are supported with HP 3PAR File Persona:
</para>
<itemizedlist>
<listitem>
<para>
Create/delete NFS and CIFS shares.
</para>
<itemizedlist>
<listitem>
<para>
Shares are not accessible until access rules allow access.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Allow/deny NFS share access.
</para>
<itemizedlist>
<listitem>
<para>
IP access rules are required for NFS share access.
</para>
</listitem>
<listitem>
<para>
User access rules are not allowed for NFS shares.
</para>
</listitem>
<listitem>
<para>
Access level (RW/RO) is ignored.
</para>
</listitem>
<listitem>
<para>
Shares created from snapshots are always read-only.
</para>
</listitem>
<listitem>
<para>
Shares not created from snapshots are read-write (and
subject to ACLs).
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Allow/deny CIFS share access.
</para>
<itemizedlist>
<listitem>
<para>
Both IP and user access rules are required for CIFS share
access.
</para>
</listitem>
<listitem>
<para>
User access requires a 3PAR local user (LDAP and AD is not
yet supported).
</para>
</listitem>
<listitem>
<para>
Access level (RW/RO) is ignored.
</para>
</listitem>
<listitem>
<para>
Shares created from snapshots are always read-only.
</para>
</listitem>
<listitem>
<para>
Shares not created from snapshots are read-write (and
subject to ACLs).
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Create/delete snapshots.
</para>
</listitem>
<listitem>
<para>
Create shares from snapshots.
</para>
<itemizedlist>
<listitem>
<para>
Shares created from snapshots are always read-only.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Share networks are not supported. Shares are created directly on
the 3PAR without the use of a share server or service VM. Network
connectivity is setup outside of the Shared File Systems service.
</para>
</simplesect>
<simplesect>
<title>Requirements</title>
<para>
On the system running the manila-share service:
</para>
<itemizedlist>
<listitem>
<para>
hp3parclient version 3.2.1 or newer from PyPI.
</para>
</listitem>
</itemizedlist>
<para>
On the HP 3PAR array:
</para>
<itemizedlist>
<listitem>
<para>
HP 3PAR Operating System software version 3.2.1 MU3 or higher.
</para>
</listitem>
<listitem>
<para>
A license that enables the File Persona feature.
</para>
</listitem>
<listitem>
<para>
The array class and hardware configuration must support File.
Persona
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Pre-configuration on the HP 3PAR</title>
<itemizedlist>
<listitem>
<para>
HP 3PAR File Persona must be initialized and started (startfs).
</para>
</listitem>
<listitem>
<para>
A File Provisioning Group (FPG) must be created for use with
the Shared File Systems service.
</para>
</listitem>
<listitem>
<para>
A Virtual File Server (VFS) must be created for the FPG.
</para>
</listitem>
<listitem>
<para>
The VFS must be configured with an appropriate share export IP
address.
</para>
</listitem>
<listitem>
<para>
A local user in the Administrators group is needed for CIFS
shares.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<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:
</para>
<itemizedlist>
<listitem>
<para>
share_backend_name = &lt;back end name to enable&gt;
</para>
</listitem>
<listitem>
<para>
share_driver =
manila.share.drivers.hp.hp_3par_driver.HP3ParShareDriver
</para>
</listitem>
<listitem>
<para>
driver_handles_share_servers = False
</para>
</listitem>
<listitem>
<para>
hp3par_fpg = &lt;FPG to use for share creation&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_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
controller&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_api_url = &lt;3PAR WS API Server URL&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_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;
</para>
</listitem>
<listitem>
<para>
hp3par_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
controller&gt;
</para>
</listitem>
<listitem>
<para>
hp3par_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
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.
</para>
<para>
Restart of manila-share service is needed for the configuration
changes to take effect.
</para>
</simplesect>
<simplesect>
<title>Network approach</title>
<para>
Connectivity between the storage array (SSH/CLI and WSAPI) and the
Shared File Systems service host is required for share management.
</para>
<para>
Connectivity between the clients and the VFS is required for
mounting and using the shares. This includes:
</para>
<itemizedlist>
<listitem>
<para>
Routing from the client to the external network
</para>
</listitem>
<listitem>
<para>
Assigning the client an external IP address (e.g., a floating
IP)
</para>
</listitem>
<listitem>
<para>
Configuring the Shared File Systems service host networking
properly for IP forwarding
</para>
</listitem>
<listitem>
<para>
Configuring the VFS networking properly for client subnets
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Share types</title>
<para>
When creating a share, a share type can be specified to determine
where and how the share will be created. If a share type is not
specified, the default_share_type set in the Shared File Systems
service configuration
file is used.
</para>
<para>
The Shared File Systems service requires that the share type
includes the
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.
</para>
<para>
Another common Shared File Systems service extra-spec used to determine
where a share
is created is share_backend_name. When this extra-spec is defined
in the share type, the share will be created on a back end with a
matching share_backend_name.
</para>
<para>
The HP 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:
</para>
<itemizedlist>
<listitem>
<para>
hp3par_flash_cache = '&lt;is&gt; True' or '&lt;is&gt; False'
</para>
</listitem>
<listitem>
<para>
thin_provisioning = '&lt;is&gt; True' or '&lt;is&gt; False'
</para>
</listitem>
<listitem>
<para>
dedupe = '&lt;is&gt; True' or '&lt;is&gt; False'
</para>
</listitem>
</itemizedlist>
<para>
hp3par_flash_cache will be reported as True for back ends that have
3PAR's Adaptive Flash Cache enabled.
</para>
<para>
thin_provisioning will be reported as True for back ends that use
thin provisioned volumes. FPGs that use fully provisioned volumes
will report False. Backends that use thin provisioning also
support the Shared File Systems service's over-subscription feature.
</para>
<para>
dedupe will be reported as True for back ends that use
deduplication technology.
</para>
<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.
</para>
<para>
The following HP 3PAR extra-specs are used when creating CIFS
(SMB) shares:
</para>
<itemizedlist>
<listitem>
<para>
hp3par:smb_access_based_enum = true or false
</para>
</listitem>
<listitem>
<para>
hp3par:smb_continuous_avail = true or false
</para>
</listitem>
<listitem>
<para>
hp3par:smb_cache = off, manual, optimized or auto
</para>
</listitem>
</itemizedlist>
<para>
smb_access_based_enum (Access Based Enumeration) specifies if
users can see only the files and directories to which they have
been allowed access on the shares. The default is false.
</para>
<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.
</para>
<para>
smb_cache specifies client-side caching for offline files. Valid
values are:
</para>
<itemizedlist>
<listitem>
<para>
`off`: The client must not cache any files from this share.
The share is configured to disallow caching.
</para>
</listitem>
<listitem>
<para>
`manual`: The client must allow only manual caching for the
files open from this share.
</para>
</listitem>
<listitem>
<para>
`optimized`: The client may cache every file that it opens
from this share. Also, the client may satisfy the file
requests from its local cache. The share is configured to
allow automatic caching of programs and documents.
</para>
</listitem>
<listitem>
<para>
`auto`: The client may cache every file that it opens from
this share. The share is configured to allow automatic caching
of documents.
</para>
</listitem>
<listitem>
<para>
If this is not specified, the default is manual.
</para>
</listitem>
</itemizedlist>
<para>
The following HP 3PAR extra-specs are used when creating NFS
shares:
</para>
<itemizedlist>
<listitem>
<para>
hp3par:nfs_options = Comma separated list of NFS export
options.
</para>
</listitem>
</itemizedlist>
<para>
The NFS export options have the following limitations:
</para>
<blockquote>
<itemizedlist>
<listitem>
<para>
ro and rw are not allowed (will be determined by the driver).
</para>
</listitem>
<listitem>
<para>
no_subtree_check and fsid are not allowed per HP 3PAR CLI
support.
</para>
</listitem>
<listitem>
<para>
(in)secure and (no_)root_squash are not allowed because the
HP 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.
</para>
</simplesect>
<!--
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to this driver.</para>
<xi:include href="../../../common/tables/manila-hp3par.xml"/>
</simplesect>
-->
<simplesect>
<title>Driver configuration options</title>
<para>
Configuration options specific to this driver are documented here:
<xref linkend="config_table_manila_hp3par"/>.
</para>
</simplesect>
</section>
View Git Blame Copy Permalink