openstack-manuals/doc/config-reference/block-storage/drivers/nimble-volume-driver.xml

<?xml version="1.0" encoding="UTF-8"?>
<section 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"
    xml:id="nimble-storage-volume-driver">
    <title>Nimble Storage volume driver</title>
    <?dbhtml stop-chunking?>
    <para>Nimble Storage fully integrates with the OpenStack platform through
     the Nimble Cinder driver, allowing a host to configure and manage Nimble
      Storage array features through Block Storage interfaces.</para>
    <para>Support for the Liberty release is available from Nimble OS 2.3.8 or
       later.</para>
  <section xml:id="nimble-storage-driver-supported-operations">
    <title>Supported operations</title>
    <itemizedlist>
      <listitem>
      <para>Create, delete, clone, attach, and detach volumes</para>
    </listitem>
    <listitem>
      <para>Create 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>Extend a volume</para>
    </listitem>
    <listitem>
      <para>Get volume statistics</para>
    </listitem>
    <listitem>
      <para>Manage and unmanage a volume</para>
    </listitem>
    <listitem>
      <para>Enable encryption and default performance policy for a volume-type
       using extra-specs</para>
    </listitem>
    </itemizedlist>
    <note>
      <para>The Nimble Storage implementation uses iSCSI only. Fibre Channel
       is not supported.</para>
    </note>
  </section>
  <section xml:id="nimble-storage-driver-configuration">
    <title>Nimble Storage driver configuration</title>
    <para>Update the file <filename>/etc/cinder/cinder.conf</filename> with
     the given configuration.</para>
    <para>In case of a basic (single back-end) configuration, add the
       parameters within the <literal>[default]</literal> section as follows.
     </para>
    <programlisting language="ini">
[default]
san_ip = <replaceable>NIMBLE_MGMT_IP</replaceable>
san_login = <replaceable>NIMBLE_USER</replaceable>
san_password = <replaceable>NIMBLE_PASSWORD</replaceable>
volume_driver = cinder.volume.drivers.nimble.NimbleISCSIDriver
    </programlisting>
    <para>In case of multi back-end configuration, for example, configuration
       which supports multiple Nimble Storage arrays or a single Nimble Storage
       array with arrays from other vendors, use the following parameters.
    </para>
    <programlisting language="ini">
[default]
enabled_backends = Nimble-Cinder

[Nimble-Cinder]
san_ip = <replaceable>NIMBLE_MGMT_IP</replaceable>
san_login = <replaceable>NIMBLE_USER</replaceable>
san_password = <replaceable>NIMBLE_PASSWORD</replaceable>
volume_driver = cinder.volume.drivers.nimble.NimbleISCSIDriver
volume_backend_name = <replaceable>NIMBLE_BACKEND_NAME</replaceable>
    </programlisting>
    <para>In case of multi back-end configuration, Nimble Storage volume-type
       is created and associated with a back-end name as follows.</para>
    <note>
      <para>Single back-end configuration users do not need to create the
         volume-type.</para>
    </note>
    <screen><prompt>$</prompt> <userinput>cinder type-create <replaceable>
    NIMBLE_VOLUME_TYPE</replaceable></userinput>
<prompt>$</prompt> <userinput>cinder type-key <replaceable>NIMBLE_VOLUME_TYPE
</replaceable> set volume_backend_name=<replaceable>NIMBLE_BACKEND_NAME
</replaceable></userinput></screen>
    <para>This section explains the variables used above:</para>
    <variablelist>
      <varlistentry>
        <term>NIMBLE_MGMT_IP</term>
        <listitem>
          <para>Management IP address of Nimble Storage array/group.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>NIMBLE_USER</term>
        <listitem>
          <para>Nimble Storage account login with minimum "power user"(admin)
           privilege if RBAC is used.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>NIMBLE_PASSWORD</term>
        <listitem>
          <para>Password of the admin account for nimble array.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>NIMBLE_BACKEND_NAME</term>
        <listitem>
          <para>A volume back-end name which is specified in <filename>
            cinder.conf</filename>. This is also used while assigning a back-
            end name to the Nimble volume-type.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>NIMBLE_VOLUME_TYPE</term>
        <listitem>
          <para>The Nimble volume-type which is created from the CLI and
             associated with <replaceable>NIMBLE_BACKEND_NAME</replaceable>.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
    <note>
      <para>Restart the cinder-api, cinder-scheduler, and cinder-volume
         services after updating the <filename>cinder.conf</filename>.</para>
    </note>
  </section>
  <section xml:id="nimble-storage-driver-extra-specs">
    <title>Nimble driver extra spec options</title>
    <para>The Nimble volume driver also supports the following extra spec
       options:
    </para>
    <variablelist>
      <varlistentry>
        <term>'nimble:encryption'='yes'</term>
        <listitem>
          <para>Used to enable encryption for a volume-type</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>'nimble:perfpol-name'=<replaceable>PERF_POL_NAME</replaceable>
        </term>
        <listitem>
          <para>PERF_POL_NAME is the name of a performance policy which exists
             on the Nimble array and should be enabled for every volume in a
              volume-type</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>'nimble:multi-initiator'='true'</term>
        <listitem>
          <para>Used to enable multi-initiator access for a volume-type</para>
        </listitem>
      </varlistentry>
    </variablelist>
    <para>These extra-specs can be enabled by using the following command:
    </para>
    <screen><prompt>$</prompt> <userinput>cinder type-key <replaceable>\
    VOLUME_TYPE</replaceable> set <replaceable>KEY</replaceable>=<replaceable>\
    VALUE</replaceable></userinput></screen>
    <para>VOLUME_TYPE is the Nimble volume-type and KEY and VALUE are the
       options mentioned above.</para>
  </section>
  <section xml:id="nimble-storage-configuration-options">
    <title>Configuration options</title>
    <para>The Nimble storage driver supports these configuration options:
    </para>
    <xi:include href="../../../common/tables/cinder-nimble.xml"/>
  </section>
</section>