openstack-manuals/doc/config-reference/shared-file-systems/drivers/huawei-nas-driver.xml

<section xml:id="huawei-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>Huawei driver</title>
  <para>
    Huawei NAS driver is a plug-in based the Shared File Systems service.
    The Huawei NAS driver can be used to provide functions such as the
    share and snapshot for virtual machines(instances) in OpenStack.
    Huawei NAS driver enables the OceanStor V3 series V300R002 storage
    system to provide only network filesystems for OpenStack.
  </para>
  <simplesect>
    <title>Requirements</title>
    <itemizedlist>
      <listitem>
        <para>
          The OceanStor V3 series V300R002 storage system.
        </para>
      </listitem>
      <listitem>
        <para>
          The following licenses should be activated on V3 for File:
        </para>
        <itemizedlist>
          <listitem>
            <para>
              CIFS
            </para>
          </listitem>
          <listitem>
            <para>
              NFS
            </para>
          </listitem>
          <listitem>
            <para>
              HyperSnap License (for snapshot)
            </para>
          </listitem>
        </itemizedlist>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Supported operations</title>
    <para>
      The following operations is supported on V3 storage:
    </para>
    <itemizedlist>
      <listitem>
        <para>
          Create CIFS/NFS share.
        </para>
      </listitem>
      <listitem>
        <para>
          Delete CIFS/NFS share.
        </para>
      </listitem>
      <listitem>
        <para>
          Allow CIFS/NFS share access.
        </para>
        <itemizedlist>
          <listitem>
            <para>
              Only IP access type is supported for NFS.
            </para>
          </listitem>
        </itemizedlist>
        <para>
          * Only USER access type is supported for CIFS.
        </para>
      </listitem>
      <listitem>
        <para>
          Deny CIFS/NFS share access.
        </para>
      </listitem>
      <listitem>
        <para>
          Create snapshot.
        </para>
      </listitem>
      <listitem>
        <para>
          Delete snapshot.
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Pre-configurations on Huawei</title>
    <para>
      1. Create a driver configuration file. The driver configuration
      file name must be the same as the manila_huawei_conf_file item in
      the manila_conf configuration file.
    </para>
    <para>
      2. Configure Product. Product indicates the storage system type.
      For the OceanStor V3 series V300R002 storage systems, the driver
      configuration file is as follows:
    </para>
    <programlisting>
&lt;?xml version='1.0' encoding='UTF-8'?&gt;
&lt;Config&gt;
    &lt;Storage&gt;
        &lt;Product&gt;V3&lt;/Product&gt;
        &lt;LogicalPortIP&gt;x.x.x.x&lt;/LogicalPortIP&gt;
        &lt;RestURL&gt;https://x.x.x.x:8088/deviceManager/rest/&lt;/RestURL&gt;
        &lt;UserName&gt;xxxxxxxxx&lt;/UserName&gt;
        &lt;UserPassword&gt;xxxxxxxxx&lt;/UserPassword&gt;
    &lt;/Storage&gt;
    &lt;Filesystem&gt;
        &lt;AllocType&gt;Thin&lt;/AllocType&gt;
        &lt;StoragePool&gt;xxxxxxxxx&lt;/StoragePool&gt;
        &lt;WaitInterval&gt;3&lt;/WaitInterval&gt;
        &lt;Timeout&gt;60&lt;/Timeout&gt;
    &lt;/Filesystem&gt;
&lt;/Config&gt;
</programlisting>
    <itemizedlist>
      <listitem>
        <para>
          Product is a type of a storage product. Set it to V3.
        </para>
      </listitem>
      <listitem>
        <para>
          LogicalPortIP is a IP address of the logical port.
        </para>
      </listitem>
      <listitem>
        <para>
          RestURL is a access address of the REST interface.
        </para>
      </listitem>
      <listitem>
        <para>
          UserName is a user name of an administrator.
        </para>
      </listitem>
      <listitem>
        <para>
          UserPassword is a password of an administrator.
        </para>
      </listitem>
      <listitem>
        <para>
          AllocType is a type of file system space allocation. Valid
          values are Thick or Thin.
        </para>
      </listitem>
      <listitem>
        <para>
          StoragePool is a name of a storage pool to be used.
        </para>
      </listitem>
      <listitem>
        <para>
          WaitInterval is the interval time of querying the file system
          status.
        </para>
      </listitem>
      <listitem>
        <para>
          Timeout is the timeout period for waiting command execution of
          a device to complete.
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Backend configuration</title>
    <para>
      1. Modify the manila.conf Shared File Systems service configuration
      file and add
      share_driver and manila_huawei_conf_file items. Example for
      configuring a storage system:
    </para>
    <itemizedlist>
      <listitem>
        <para>
          share_driver =
          manila.share.drivers.huawei.huawei_nas.HuaweiNasDriver
        </para>
      </listitem>
      <listitem>
        <para>
          manila_huawei_conf_file = /etc/manila/manila_huawei_conf.xml
        </para>
      </listitem>
      <listitem>
        <para>
          driver_handles_share_servers = False
        </para>
      </listitem>
    </itemizedlist>
    <blockquote>
      <note><para>
        As far as the Shared File Systems service requires share type
        for creation of shares, make sure that
        used share type has extra spec
        driver_handles_share_servers set to False otherwise Huawei
        back end will be filtered by manila-scheduler. If you do
        not provide share type with share creation request then
        default share type and its extra specs will be used.
      </para></note>
    </blockquote>
    <para>
      Restart of manila-share service is needed for the configuration
      changes to take effect.
    </para>
  </simplesect>
  <simplesect>
    <title>Restrictions</title>
    <para>
      The Huawei driver has the following restrictions:
    </para>
    <itemizedlist>
      <listitem>
        <para>
          Only IP access type is supported for NFS.
        </para>
      </listitem>
      <listitem>
        <para>
          Only USER access type is supported for CIFS.
        </para>
      </listitem>
      <listitem>
        <para>
          Only one StoragePool can be configured in the configuration
          file.
        </para>
      </listitem>
    </itemizedlist>
  </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-huawei.xml"/>
  </simplesect>
  -->
  <simplesect>
        <title>Driver configuration options</title>
        <para>
            Configuration options specific to this driver are documented here:
            <xref linkend="config_table_manila_huawei"/>.
        </para>
  </simplesect>
</section>