openstack-manuals/doc/config-reference/block-storage/drivers/violin-v7000-driver.xml

<section xml:id="violin-v7000-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 7000 Series FSP volume driver</title>
  <para>
    The OpenStack V7000 driver package from Violin Memory adds block
    storage service support for Violin 7300 Flash Storage Platforms
    (FSPs) and 7700 FSP controllers.
  </para>
  <para>
    The driver package release can be used with any OpenStack Liberty
    deployment for all 7300 FSPs and 7700 FSP controllers running
    Concerto 7.5.3 and later using Fibre Channel HBAs.
  </para>

  <section xml:id="violin-v7k-sys-reqs">
    <title>System requirements</title>
    <para>To use the Violin driver, the following are required:</para>
    <itemizedlist>
      <listitem>
        <para>Violin 7300/7700 series FSP with:
          <itemizedlist>
            <listitem>
              <para>Concerto OS version 7.5.3 or later</para>
            </listitem>
            <listitem>
              <para>Fibre channel host interfaces</para>
            </listitem>
          </itemizedlist>
        </para>
      </listitem>
      <listitem>
        <para>
          The Violin block storage driver: This driver implements the
          block storage API calls.  The driver 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 on <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-v7k-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>
        Listed operations are supported for thick, thin, and dedup
        luns, with the exception of cloning.  Cloning operations are
        supported only on thick luns.
      </para>
    </note>
  </section>

  <section xml:id="violin-v7k-driver-cfg">
    <title>Driver configuration</title>
    <para>
      Once the array is configured per the installation guide, it is
      simply a matter of editing the cinder configuration file to add
      or modify the parameters.  The driver currently only supports
      fibre channel configuration.
    </para>

    <section xml:id="vioin-v7k-fc-cfg">
      <title>Fibre channel configuration</title>
      <para>
        Set the following in your <filename>cinder.conf</filename>
        configuration file, replacing the variables using the guide in
        the following section:
      </para>
      <programlisting language="ini">
volume_driver = cinder.volume.drivers.violin.v7000_fcp.V7000FCPDriver
volume_backend_name = vmem_violinfsp
extra_capabilities = <replaceable>VMEM_CAPABILITIES</replaceable>
san_ip = <replaceable>VMEM_MGMT_IP</replaceable>
san_login = <replaceable>VMEM_USER_NAME</replaceable>
san_password = <replaceable>VMEM_PASSWORD</replaceable>
use_multipath_for_image_xfer = true
      </programlisting>
    </section>

    <section xml:id="violin-v7k-cfg-vars">
      <title>Configuration parameters</title>
      <para>
        Description of configuration value placeholders:
      </para>
      <variablelist>
        <varlistentry>
          <term>VMEM_CAPABILITIES</term>
          <listitem>
            <para>
              User defined capabilities, a JSON formatted string
              specifying key/value pairs (string value). The ones
              particularly supported are dedup and thin.  Only these two
              capabilities are listed here in cinder.conf, indicating
              this backend be selected for creating luns which have
              a volume type associated with them that have 'dedup' or
              'thin' extra_specs specified.  For example, if the FSP is
              configured to support dedup luns, set the associated driver
              capabilities to: {"dedup":"True","thin":"True"}.
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>VMEM_MGMT_IP</term>
          <listitem>
            <para>
              External IP address or hostname of the Violin 7300
              Memory Gateway.  This 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 7300 Memory Gateway or
              7700 FSP controller.  This user must have administrative
              rights on the array or controller.
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term>VMEM_PASSWORD</term>
          <listitem>
            <para>
              Log-in user's password.
            </para>
          </listitem>
        </varlistentry>
      </variablelist>
    </section>
  </section>

</section>