openstack/openstack-manuals
Code Issues Proposed changes

Add VMEM v6000 block storage config page

Browse Source 
Adds configuration reference page for Violin Memory's v6000 Cinder
block-storage driver.

Change-Id: I86657a4c2ba448a9d4c459fff9b67becd779c533
backport: kilo
Closes-Bug: 1438940
This commit is contained in:
Ryan Lucio 2015-10-09 15:00:39 -07:00
parent 2875f14c3d
commit 53a8d17d94
3 changed files with 252 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

251
doc/config-reference/block-storage/drivers/violin-v6000-driver.xml Normal file
View File

@ -0,0 +1,251 @@
<?xml version="1.0"?>
<section xml:id="violin-v6000-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>Violin Memory 6000 series AFA volume driver</title>
<para>
The OpenStack V6000 driver package from Violin Memory adds block
storage service support for Violin 6000 Series All Flash Arrays.
</para>
<para>
The driver package release can be used with any OpenStack Liberty
deployment for all 6000 series all-flash arrays for release 6.3.1
and later using either Fibre Channel or iSCSI HBAs.
</para>
<warning>
<para>
The Violin 6000 series AFA driver is recommended as an
evaluation product only, for existing 6000 series customers.
The driver will be deprecated or removed in the next OpenStack
release. Future development and support will be focused on the
7000 series FSP driver only.
</para>
</warning>
<section xml:id="violin-v6k-sys-reqs">
<title>System requirements</title>
<para>To use the Violin driver, the following are required:</para>
<itemizedlist>
<listitem>
<para>Violin 6000 series AFA with:
<itemizedlist>
<listitem>
<para>Concerto OS version 6.3.1 or later</para>
</listitem>
<listitem>
<para>iSCSI or FC host interfaces</para>
</listitem>
<listitem>
<para>Storage network connectivity between all target and
initiator ports</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
The Violin volume driver: The driver implements the
Block Storage API calls. Both FC and iSCSI driver support
is included with the OpenStack Liberty release.
</para>
</listitem>
<listitem>
<para>
The vmemclient library: This is the Violin Array
Communications library to the Flash Storage Platform through
a REST-like interface. The client can be installed using
the python 'pip' installer tool. Further information on
vmemclient can be found here: <link
xlink:href="https://pypi.python.org/pypi/vmemclient/">PyPI
</link>.
</para>
<programlisting language="ini">
pip install vmemclient
</programlisting>
</listitem>
</itemizedlist>
</section>
<section xml:id="violin-v6k-supported-ops">
<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>
</itemizedlist>
<note>
<para>
All listed operations are supported for both thick and
thin luns. However, over-subscription is not supported.
</para>
</note>
</section>
<section xml:id="violin-v6k-array-cfg">
<title>Array configuration</title>
<para>
After installing and configuring your V6000 array per the
installation guide provided with your array, please follow these
additional steps to prepare your array for use with OpenStack.
</para>
<procedure>
<step>
<para>
Ensure your client initiator interfaces are all zoned or
VLAN'd so that they can communicate with ALL of the target
ports on the array. See your array installation or user
guides for more information.
</para>
</step>
<step>
<para>Set the array's provisioning threshold value.</para>
<programlisting language="ini">
container set name <replaceable>CONTAINER_NAME</replaceable> provision-threshold hard 100
</programlisting>
</step>
<step>
<para>Set the array's used-space threshold value.</para>
<programlisting language="ini">
container set name <replaceable>CONTAINER_NAME</replaceable> usedspace-threshold hard 0
</programlisting>
</step>
</procedure>
</section>
<section xml:id="violin-v6k-driver-cfg">
<title>Driver configuration</title>
<para>
Once the array is configured, it is simply a matter of editing
the cinder configuration file to add or modify the parameters.
Contents will differ depending on whether you are setting up a
fibre channel or iSCSI environment.
</para>
<section xml:id="vioin-fc-cfg">
<title>Fibre channel configuration</title>
<para>
Set the following in your <filename>cinder.conf</filename>
configuration file for setup of a Fibre channel array,
replacing the variables using the guide in the following
section:
</para>
<programlisting language="ini">
volume_driver = cinder.volume.drivers.violin.v6000_fcp.V6000FCPDriver
san_thin_provision = True
san_ip = <replaceable>VMEM_MGMT_IP</replaceable>
san_login = <replaceable>VMEM_USER_NAME</replaceable>
san_password = <replaceable>VMEM_PASSWORD</replaceable>
gateway_mga = <replaceable>VMEM_MGA_IP</replaceable>
gateway_mgb = <replaceable>VMEM_MGB_IP</replaceable>
</programlisting>
</section>
<section xml:id="violin-v6k-iscsi-cfg">
<title>iSCSI configuration</title>
<para>
Set the following in your <filename>cinder.conf</filename>
configuration file for setup of an iSCSI array, replacing the
variables using the guide in the following section:
</para>
<programlisting language="ini">
volume_driver = cinder.volume.drivers.violin.v6000_iscsi.V6000ISCSIDriver
san_thin_provision = True
san_ip = <replaceable>VMEM_MGMT_IP</replaceable>
san_login = <replaceable>VMEM_USER_NAME</replaceable>
san_password = <replaceable>VMEM_PASSWORD</replaceable>
iscsi_target_prefix = iqn.2004-02.com.vmem:
iscsi_port = 3260
iscsi_ip_address = <replaceable>CINDER_INITIATOR_IP</replaceable>
gateway_mga = <replaceable>VMEM_MGA_IP</replaceable>
gateway_mgb = <replaceable>VMEM_MGB_IP</replaceable>
</programlisting>
</section>
<section xml:id="violin-v6k-cfg-vars">
<title>Configuration parameters</title>
<para>
Description of configuration value placeholders:
</para>
<variablelist>
<varlistentry>
<term>VMEM_MGMT_IP</term>
<listitem>
<para>
Cluster master IP address or hostname of the Violin 6000
Array. Can be an IP address or hostname.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VMEM_USER_NAME</term>
<listitem>
<para>
Log-in user name for the Violin 6000 Memory Gateways.
This user must have administrative rights on the array.
Typically this is the 'admin' user.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VMEM_PASSWORD</term>
<listitem>
<para>
Log-in user's password.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>CINDER_INITIATOR_IP</term>
<listitem>
<para>
The IP address assigned to the primary iSCSI interface on
the cinder-volume client. This IP address must be able to
communicate with all target ports that are active on the
array.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VMEM_MGA_IP</term>
<listitem>
<para>
The IP or hostname of the gateway node marked 'A', commonly
referred to as 'MG-A'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VMEM_MGB_IP</term>
<listitem>
<para>
The IP or hostname of the gateway node marked 'B', commonly
referred to as 'MG-B'.
</para>
</listitem>
</varlistentry>
</variablelist>
<xi:include href="../../../common/tables/cinder-violin.xml"/>
</section>
</section>
</section>

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

@ -50,7 +50,6 @@
<xi:include href="../../common/tables/cinder-srb.xml"/>
<xi:include href="../../common/tables/cinder-storage.xml"/>
<xi:include href="../../common/tables/cinder-storpool.xml"/>
<xi:include href="../../common/tables/cinder-violin.xml"/>
<xi:include href="../../common/tables/cinder-vzstorage.xml"/>
<xi:include href="../../common/tables/cinder-zeromq.xml"/>
<xi:include href="../../common/tables/cinder-zones.xml"/>

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

@ -47,6 +47,7 @@
<xi:include href="drivers/smbfs-volume-driver.xml"/>
<xi:include href="drivers/solidfire-volume-driver.xml"/>
<xi:include href="drivers/tintri-volume-driver.xml"/>
<xi:include href="drivers/violin-v6000-driver.xml"/>
<xi:include href="drivers/violin-v7000-driver.xml"/>
<xi:include href="drivers/vmware-vmdk-driver.xml"/>
<xi:include href="drivers/windows-iscsi-volume-driver.xml"/>