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

<?xml version="1.0"?>
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="xio-volume-driver" version="5.0">
  <title>X-IO volume driver</title>
  <para>The X-IO volume driver for OpenStack Block Storage enables ISE products to be managed by
    OpenStack Block Storage nodes. This driver can be configured to work with iSCSI and Fibre
    Channel storage protocols. The X-IO volume driver allows the cloud operator to take advantage of
    ISE features like Quality of Service and Continous Adaptive Data Placement (CADP). It also
    supports creating thin volumes and specifying volume media affinity.</para>
  <section xml:id="xio-volume-driver-requirements">
    <title>Requirements</title>
    <para>ISE FW 2.8.0 or ISE FW 3.1.0 is required for OpenStack Block Storage support. The X-IO
      volume driver will not work with older ISE FW.</para>
  </section>
  <?dbhtml stop-chunking?>
  <section xml:id="xio-volume-driver-supported-operations">
    <title>Supported operations</title>
    <itemizedlist>
      <listitem>
        <para>Create, delete, attach, detach, retype, clone, and extend volumes.</para>
      </listitem>
      <listitem>
        <para>Create a volume from snapshot.</para>
      </listitem>
      <listitem>
        <para>Create, list, and delete volume snapshots.</para>
      </listitem>
      <listitem>
        <para>Manage and unmanage a volume.</para>
      </listitem>
      <listitem>
        <para>Get volume statistics.</para>
      </listitem>
      <listitem>
        <para>Create a thin provisioned volume.</para>
      </listitem>
      <listitem>
        <para>Create volumes with QoS specifications.</para>
      </listitem>
    </itemizedlist>
  </section>
  <section xml:id="xio-volume-driver-configure">
    <title>Configure X-IO Volume driver</title>
    <para>To configure the use of an ISE product with OpenStack Block Storage, modify your
        <filename>cinder.conf</filename> file as follows. Be careful to use the one that matches the
      storage protocol in use:</para>
    <section xml:id="xio-volume-driver-configure-fc">
      <title>Fibre Channel</title>
      <programlisting>volume_driver = cinder.volume.drivers.xio.XIOISEFCDriver
san_ip = 1.2.3.4              # the address of your ISE REST management interface
san_login = administrator     # your ISE management admin login
san_password = password       # your ISE management admin password</programlisting>
    </section>
    <section xml:id="xio-volume-driver-configure-iscsi">
      <title>iSCSI</title>
      <programlisting>volume_driver = cinder.volume.drivers.xio.XIOISEISCSIDriver
san_ip = 1.2.3.4              # the address of your ISE REST management interface
san_login = administrator     # your ISE management admin login
san_password = password       # your ISE management admin password
iscsi_ip_address = ionet_ip   # ip address to one ISE port connected to the IONET</programlisting>
    </section>
    <section xml:id="xio-volume-driver-configure-optional">
      <title>Optional configuration parameters</title>
      <xi:include href="../../../common/tables/cinder-xio.xml"/>
    </section>
    <section xml:id="xio-volume-driver-configure-multipath">
      <title>Multipath</title>
      <para>The X-IO ISE supports a multipath configuration, but multipath must be enabled on the
        compute node (see <emphasis role="italic">ISE Storage Blade Best Practices
        Guide</emphasis>). For more information, see <link xlink:href="http://www.openstack.org/"
            ><emphasis role="italic">www.openstack.org</emphasis></link>.</para>
    </section>
    <section xml:id="xio-volume-driver-configure-volume-types">
      <title>Volume types</title>
      <para>OpenStack Block Storage uses volume types to help the administrator specify attributes
        for volumes. These attributes are called extra-specs. The X-IO volume driver support the
        following extra-specs.<table frame="all">
          <title>Extra specs</title>
          <tgroup cols="3">
            <colspec colname="c1" colnum="1" colwidth="1.0*"/>
            <colspec colname="c2" colnum="2" colwidth="1.0*"/>
            <colspec colname="c3" colnum="3" colwidth="1.0*"/>
            <thead>
              <row>
                <entry>Extra-specs name</entry>
                <entry>Valid values</entry>
                <entry>Description</entry>
              </row>
            </thead>
            <tbody>
              <row>
                <entry>Feature:Raid</entry>
                <entry>1, 5</entry>
                <entry>RAID level for volume.</entry>
              </row>
              <row>
                <entry>Feature:Pool</entry>
                <entry>1 - n (n being number of pools on ISE)</entry>
                <entry>Pool to create volume in.</entry>
              </row>
              <row>
                <entry>Affinity:Type</entry>
                <entry>cadp, flash, hdd</entry>
                <entry>Volume media affinity type.</entry>
              </row>
              <row>
                <entry>Alloc:Type</entry>
                <entry>0 (thick), 1 (thin)</entry>
                <entry>Allocation type for volume. Thick or thin</entry>
              </row>
              <row>
                <entry>QoS:minIOPS</entry>
                <entry>n (value less than maxIOPS)</entry>
                <entry>Minimum IOPS setting for volume.</entry>
              </row>
              <row>
                <entry>QoS:maxIOPS</entry>
                <entry>n (value bigger than minIOPS)</entry>
                <entry>Maximum IOPS setting for volume.</entry>
              </row>
              <row>
                <entry>QoS:burstIOPS</entry>
                <entry>n (value bigger than minIOPS)</entry>
                <entry>Burst IOPS setting for volume.</entry>
              </row>
            </tbody>
          </tgroup>
        </table></para>
      <section xml:id="xio-volume-driver-configure-examples">
        <title>Examples</title>
        <para>Create a volume type called xio1-flash for volumes that should reside on ssd
          storage:
<screen><prompt>$</prompt> <userinput>cinder type-create xio1-flash</userinput>
<prompt>$</prompt> <userinput>cinder type-key xio1-flash set Affinity:Type=flash</userinput></screen>
        </para>
        <para>Create a volume type called xio1 and set QoS min and
          max:
<screen><prompt>$</prompt> <userinput>cinder type-create xio1</userinput>
<prompt>$</prompt> <userinput>cinder type-key xio1 set QoS:minIOPS=20</userinput>
<prompt>$</prompt> <userinput>cinder type-key xio1 set QoS:maxIOPS=5000</userinput></screen>
        </para>
      </section>
    </section>
  </section>
</section>