openstack-manuals/doc/config-reference/shared-file-systems/drivers/ibm-gpfs-driver.xml

<section xml:id="gpfs-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>IBM GPFS driver</title>
  <para>
    GPFS driver uses IBM General Parallel File System (GPFS), a
    high-performance, clustered file system, developed by IBM, as the
    storage back end for serving file shares to the Shared File Systems
    service clients.
  </para>
  <simplesect>
    <title>Supported shared filesystems</title>
    <itemizedlist>
      <listitem>
        <para>
          NFS (access by IP)
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Supported operations</title>
    <itemizedlist>
      <listitem>
        <para>
          Create NFS share.
        </para>
      </listitem>
      <listitem>
        <para>
          Delete NFS share.
        </para>
      </listitem>
      <listitem>
        <para>
          Create share snapshot.
        </para>
      </listitem>
      <listitem>
        <para>
          Delete share snapshot.
        </para>
      </listitem>
      <listitem>
        <para>
          Create share from a share snapshot.
        </para>
      </listitem>
      <listitem>
        <para>
          Allow NFS share access.
        </para>
        <itemizedlist>
          <listitem>
            <para>
              Currently only 'rw' access level is supported.
            </para>
          </listitem>
        </itemizedlist>
      </listitem>
      <listitem>
        <para>
          Deny NFS share access.
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Requirements</title>
    <itemizedlist>
      <listitem>
        <para>
          Install GPFS with server license, version &gt;= 2.0, on the
          storage back end.
        </para>
      </listitem>
      <listitem>
        <para>
          Install Kernel NFS or Ganesha NFS server on the storage
          back-end servers.
        </para>
      </listitem>
      <listitem>
        <para>
          If using Ganesha NFS, currently NFS Ganesha v1.5 and v2.0 are
          supported.
        </para>
      </listitem>
      <listitem>
        <para>
          Create a GPFS cluster and create a filesystem on the cluster,
          that will be used to create the Shared File Systems service shares.
        </para>
      </listitem>
      <listitem>
        <para>
          Enable quotas for the GPFS file system (mmchfs -Q yes).
        </para>
      </listitem>
      <listitem>
        <para>
          Establish network connection between the Shared File Systems
          Service host and the storage back end.
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Shared File Systems service driver configuration setting</title>
    <para>
      The following parameters in the Shared File Systems service
      configuration file need to be set:
    </para>
    <itemizedlist>
      <listitem>
        <para>
          share_driver = manila.share.drivers.ibm.gpfs.GPFSShareDriver
        </para>
      </listitem>
      <listitem>
        <para>
          gpfs_share_export_ip = &lt;IP to be added to GPFS export
          string&gt;
        </para>
      </listitem>
      <listitem>
        <para>
          If the back-end GPFS server is not running on the Shared File
          Systems service host
          machine, the following options are required to SSH to the
          remote GPFS back-end server:
        </para>
        <itemizedlist>
          <listitem>
            <para>
              gpfs_ssh_login = &lt;GPFS server SSH login name&gt;
            </para>
            <para>
              and one of the following settings is required to execute
              commands over SSH:
            </para>
          </listitem>
          <listitem>
            <para>
              gpfs_ssh_private_key = &lt;path to GPFS server SSH private
              key for login&gt;
            </para>
          </listitem>
          <listitem>
            <para>
              gpfs_ssh_password = &lt;GPFS server SSH login password&gt;
            </para>
          </listitem>
        </itemizedlist>
      </listitem>
    </itemizedlist>
    <para>
      The following configuration parameters are optional:
    </para>
    <itemizedlist>
      <listitem>
        <para>
          gpfs_mount_point_base = &lt;base folder where exported shares
          are located&gt;
        </para>
      </listitem>
      <listitem>
        <para>
          gpfs_nfs_server_type = &lt;KNFS|GNFS&gt;
        </para>
      </listitem>
      <listitem>
        <para>
          gpfs_nfs_server_list = &lt;list of the fully qualified NFS
          server names&gt;
        </para>
      </listitem>
      <listitem>
        <para>
          gpfs_ssh_port = &lt;ssh port number&gt;
        </para>
      </listitem>
      <listitem>
        <variablelist>
          <varlistentry>
            <term>
              knfs_export_options = &lt;options to use when creating a
              share using kernel&gt;
            </term>
            <listitem>
              <para>
                &lt;NFS server&gt;
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
      </listitem>
    </itemizedlist>
    <para>
      Restart of manila-share service is needed for the configuration
      changes to take effect.
    </para>
  </simplesect>
  <simplesect>
    <title>Known restrictions</title>
    <itemizedlist>
      <listitem>
        <para>
          The driver does not support a segmented-network multi-tenancy
          model but instead works over a flat network where the tenants
          share a network.
        </para>
      </listitem>
      <listitem>
        <para>
          While using remote GPFS node, with Ganesha NFS,
          'gpfs_ssh_private_key' for remote login to the GPFS node must
          be specified and there must be a passwordless authentication
          already setup between the manila-share service and the remote
          GPFS node.
        </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-gpfs.xml"/>
  </simplesect>
  -->
  <simplesect>
        <title>Driver configuration options</title>
        <para>
            Configuration options specific to this driver are documented here:
            <xref linkend="config_table_manila_gpfs"/>.
        </para>
  </simplesect>
</section>