openstack-manuals/doc/config-reference/shared-file-systems/drivers/emc-vnx-driver.xml

<section xml:id="vnx-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>EMC VNX driver</title>
  <para>
    EMC Shared File Systems service driver framework (EMCShareDriver)
    utilizes the EMC storage products to provide the shared file systems
    to OpenStack. The EMC driver is a plug-in based driver which is designed
    to use different plug-ins to manage different EMC storage products.
  </para>
  <para>
    VNX plug-in is the plug-in which manages the VNX to provide shared
    filesystems. EMC driver framework with VNX plug-in is referred to as
    VNX driver in this document.
  </para>
  <para>
    This driver performs the operations on VNX by XMLAPI and the File
    command line. Each back end manages one Data Mover of VNX. Multiple
    Shared File Systems service back ends need to be configured to manage
    multiple Data Movers.
  </para>
  <simplesect>
    <title>Requirements</title>
    <itemizedlist>
      <listitem>
        <para>
          VNX OE for File version 7.1 or higher
        </para>
      </listitem>
      <listitem>
        <para>
          VNX Unified, File only, or Gateway system with single storage
          back end
        </para>
      </listitem>
      <listitem>
        <para>
          The following licenses should be activated on VNX for File:
        </para>
        <itemizedlist>
          <listitem>
            <para>
              CIFS
            </para>
          </listitem>
          <listitem>
            <para>
              NFS
            </para>
          </listitem>
          <listitem>
            <para>
              SnapSure (for snapshot)
            </para>
          </listitem>
          <listitem>
            <para>
              ReplicationV2 (for create share from snapshot)
            </para>
          </listitem>
        </itemizedlist>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Supported operations</title>
    <para>
      The following operations will be supported on VNX array:
    </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>
      <listitem>
        <para>
          Create share from snapshot.
        </para>
      </listitem>
    </itemizedlist>
    <para>
      While the generic driver creates shared filesystems based on
      cinder volumes attached to nova VMs, the VNX driver performs
      similar operations using the Data Movers on the array.
    </para>
  </simplesect>
  <simplesect>
    <title>Pre-configurations on VNX</title>
    <orderedlist numeration="arabic">
      <listitem>
        <para>
          Enable Unicode on Data Mover.
        </para>
      </listitem>
    </orderedlist>
    <para>
      VNX driver requires that the Unicode is enabled on Data Mover.
    </para>
    <caution><para>
      CAUTION: After enabling Unicode, you cannot disable it. If there
      are some filesystems created before Unicode is enabled on the VNX,
      consult the storage administrator before enabling Unicode.
    </para></caution>
    <para>
      To check the Unicode status on Data Mover, use the following VNX
      File command on VNX control station:
    </para>
    <blockquote>
      <para>
        server_cifs &lt;mover_name&gt; | head where: mover_name =
        &lt;name of the Data Mover&gt;
      </para>
    </blockquote>
    <para>
      Check the value of I18N mode field. UNICODE mode is shown as
      I18N mode =
      UNICODE
    </para>
    <para>
      To enable the Unicode for Data Mover:
    </para>
    <blockquote>
      <para>
        uc_config -on -mover &lt;mover_name&gt; where: mover_name =
        &lt;name of the Data Mover&gt;
      </para>
    </blockquote>
    <para>
      Refer to the document
      Using International Character Sets on VNX for File on [EMC support
      site](<link xlink:href="http://support.emc.com">http://support.emc.com</link>)
      for more information.
    </para>
    <orderedlist numeration="arabic">
      <listitem override="2">
        <para>
          Enable CIFS service on Data Mover.
        </para>
      </listitem>
    </orderedlist>
    <para>
      Ensure the CIFS service is enabled on the Data Mover which is
      going to be managed by VNX driver.
    </para>
    <para>
      To start the CIFS service, use the following command:
    </para>
    <blockquote>
      <para>
        server_setup &lt;mover_name&gt; -Protocol cifs -option start
        [=&lt;n&gt;] where: &lt;mover_name&gt; = &lt;name of the Data
        Mover&gt; [=&lt;n&gt;] = &lt;number of threads for CIFS
        users&gt;
      </para>
    </blockquote>
    <note><para>
      Note: If there is 1 GB of memory on the Data Mover, the default is
      96 threads; however, if there is over 1 GB of memory, the default
      number of threads is 256.
    </para></note>
    <para>
      To check the CIFS service status, use this command:
    </para>
    <blockquote>
      <para>
        server_cifs &lt;mover_name&gt; | head where: &lt;mover_name&gt;
        = &lt;name of the Data Mover&gt;
      </para>
    </blockquote>
    <para>
      The command output will show the number of CIFS threads started.
    </para>
    <orderedlist numeration="arabic">
      <listitem override="3">
        <para>
          NTP settings on Data Mover.
        </para>
      </listitem>
    </orderedlist>
    <para>
      VNX driver only supports CIFS share creation with share network
      which has an Active Directory security-service associated.
    </para>
    <para>
      Creating CIFS share requires that the time on the Data Mover is in
      sync with the Active Directory domain so that the CIFS server can
      join the domain. Otherwise, the domain join will fail when
      creating share with this security service. There is a limitation
      that the time of the domains used by security-services even for
      different tenants and different share networks should be in sync.
      Time difference should be less than 10 minutes.
    </para>
    <para>
      It is recommended to set the NTP server to the same public NTP
      server on both the Data Mover and domains used in security
      services to ensure the time is in sync everywhere.
    </para>
    <para>
      Check the date and time on Data Mover:
    </para>
    <blockquote>
      <para>
        server_date &lt;mover_name&gt; where: mover_name = &lt;name of
        the Data Mover&gt;
      </para>
    </blockquote>
    <para>
      Set the NTP server for Data Mover:
    </para>
    <blockquote>
      <para>
        server_date &lt;mover_name&gt; timesvc start ntp &lt;host&gt;
        [&lt;host&gt; ...] where: mover_name = &lt;name of the Data
        Mover&gt; host = &lt;IP address of the time server host&gt;
      </para>
    </blockquote>
    <note><para>
      Note: The host must be running the NTP protocol. Only 4 host
      entries are allowed.
    </para></note>
    <orderedlist numeration="arabic">
      <listitem override="4">
        <para>
          Configure User Mapping on the Data Mover.
        </para>
      </listitem>
    </orderedlist>
    <para>
      Before creating CIFS share using VNX driver, you must select a
      method of mapping Windows SIDs to UIDs and GIDs. EMC recommends
      using usermapper in single protocol (CIFS) environment which is
      enabled on VNX by default.
    </para>
    <para>
      To check usermapper status, use this command syntax:
    </para>
    <blockquote>
      <para>
        server_usermapper &lt;movername&gt; where: &lt;movername&gt; =
        &lt;name of the Data Mover&gt;
      </para>
    </blockquote>
    <para>
      If usermapper is not started, the following command can be used to
      start the usermapper:
    </para>
    <blockquote>
      <para>
        server_usermapper &lt;movername&gt; -enable where:
        &lt;movername&gt; = &lt;name of the Data Mover&gt;
      </para>
    </blockquote>
    <para>
      For multiple protocol environment, refer to
      Configuring VNX User Mapping on [EMC support
      site](<link xlink:href="http://support.emc.com">http://support.emc.com</link>)
      for additional information.
    </para>
    <orderedlist numeration="arabic">
      <listitem override="5">
        <para>
          Network Connection.
        </para>
      </listitem>
    </orderedlist>
    <para>
      In the current release, the share created by VNX driver uses the
      first network device (physical port on NIC) of Data Mover to
      access the network.
    </para>
    <para>
      Go to Unisphere to check the device list: Settings -&gt; Network
      -&gt; Settings for File (Unified system only) -&gt; Device.
    </para>
  </simplesect>
  <simplesect>
    <title>Backend configuration</title>
    <para>
      The following parameters need to be configured in
      /etc/manila/manila.conf for the VNX driver:
    </para>
    <blockquote>
      <para>
        emc_share_backend = vnx emc_nas_server = &lt;IP address&gt;
        emc_nas_password = &lt;password&gt; emc_nas_login = &lt;user&gt;
        emc_nas_server_container = &lt;Data Mover name&gt;
        emc_nas_pool_name = &lt;pool name&gt; share_driver =
        manila.share.drivers.emc.driver.EMCShareDriver
      </para>
    </blockquote>
    <itemizedlist>
      <listitem>
        <para>
          emc_share_backend is the plug-in name. Set it to
          <literal>vnx</literal> for the VNX driver.
        </para>
      </listitem>
      <listitem>
        <para>
          emc_nas_server is the control station IP address of the VNX
          system to be managed.
        </para>
      </listitem>
      <listitem>
        <para>
          emc_nas_password and emc_nas_login fields are used to provide
          credentials to the VNX system. Only local users of VNX File is
          supported.
        </para>
      </listitem>
      <listitem>
        <para>
          emc_nas_server_container field is the name of the Data Mover
          to serve the share service.
        </para>
      </listitem>
      <listitem>
        <para>
          emc_nas_pool_name is the pool name user wants to create volume
          from. The pools can be created using Unisphere for VNX.
        </para>
      </listitem>
    </itemizedlist>
    <para>
      Restart of manila-share service is needed for the configuration
      changes to take effect.
    </para>
  </simplesect>
  <simplesect>
    <title>Restrictions</title>
    <para>
      The VNX 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 FLAT network and VLAN network are supported.
        </para>
      </listitem>
      <listitem>
        <para>
          VLAN network is supported with limitations. The neutron
          subnets in different VLANs that are used to create share
          networks cannot have overlapped address spaces. Otherwise, VNX
          may have a problem to communicate with the hosts in the VLANs.
          To create shares for different VLANs with same subnet address,
          use different Data Movers.
        </para>
      </listitem>
      <listitem>
        <para>
          The 'Active Directory' security service is the only supported
          security service type and it is required to create CIFS
          shares.
        </para>
      </listitem>
      <listitem>
        <para>
          Only one security service can be configured for each share
          network.
        </para>
      </listitem>
      <listitem>
        <para>
          Active Directory domain name of the 'active_directory'
          security service should be unique even for different tenants.
        </para>
      </listitem>
      <listitem>
        <para>
          The time on Data Mover and the Active Directory domains used
          in security services should be in sync (time difference should
          be less than 10 minutes). It is recommended to use same NTP
          server on both the Data Mover and Active Directory domains.
        </para>
      </listitem>
      <listitem>
        <para>
          On VNX the snapshot is stored in the SavVols. VNX system
          allows the space used by SavVol to be created and extended
          until the sum of the space consumed by all SavVols on the
          system exceeds the default 20% of the total space available on
          the system. If the 20% threshold value is reached, an alert
          will be generated on VNX. Continuing to create snapshot will
          cause the old snapshot to be inactivated (and the snapshot
          data to be abandoned). The limit percentage value can be
          changed manually by storage administrator based on the storage
          needs. Administrator is recommended to configure the
          notification on the SavVol usage. Refer to Using VNX SnapSure
          document on [EMC support
          site](<link xlink:href="http://support.emc.com">http://support.emc.com</link>)
          for more information.
        </para>
      </listitem>
      <listitem>
        <para>
          VNX has limitations on the overall numbers of Virtual Data
          Movers, filesystems, shares, checkpoints, etc. Virtual
          Data Mover(VDM) is created by the VNX driver on the VNX to
          serve as the Shared File Systems service share server.
          Similarly, filesystem is
          created, mounted, and exported from the VDM over CIFS or NFS
          protocol to serve as the Shared File Systems service share.
          The VNX checkpoint serves as the Shared File Systems service
          share snapshot. Refer to the
          NAS Support Matrix document on [EMC support
          site](<link xlink:href="http://support.emc.com">http://support.emc.com</link>)
          for the limitations and configure the quotas accordingly.
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
        <title>Driver configuration options</title>
        <para>
            Configuration options specific to this driver are documented here:
            <xref linkend="config_table_manila_emc"/>.
        </para>
  </simplesect>
</section>