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

<section xml:id="glusterfs-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>GlusterFS driver</title>
  <para>
    GlusterFS driver uses GlusterFS, an open source distributed file
    system, as the storage back end for serving file shares to the
    Shared File Systems 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>
          Allow NFS share access.
        </para>
        <itemizedlist>
          <listitem>
            <para>
              only 'rw' access
            </para>
          </listitem>
        </itemizedlist>
      </listitem>
      <listitem>
        <para>
          Deny NFS share access.
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Requirements</title>
    <itemizedlist>
      <listitem>
        <para>
          Install glusterfs-server package, version &gt;= 3.5.x, on the
          storage back end.
        </para>
      </listitem>
      <listitem>
        <para>
          Install NFS-Ganesha, version &gt;=2.1, if using NFS-Ganesha as
          the NFS server for the GlusterFS back end.
        </para>
      </listitem>
      <listitem>
        <para>
          Install glusterfs and glusterfs-fuse package, version
          &gt;=3.5.x, on the Shared File Systems service host.
        </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's
      configuration file need to be set:
    </para>
    <itemizedlist>
      <listitem>
        <para>
          share_driver =
          manila.share.drivers.glusterfs.GlusterfsShareDriver
        </para>
      </listitem>
      <listitem>
        <para>
          If the back-end GlusterFS server runs on the Shared File Systems
          service host machine,
        </para>
        <itemizedlist>
          <listitem>
            <para>
              glusterfs_target =
              &lt;glustervolserver&gt;:/&lt;glustervolid&gt;
            </para>
          </listitem>
        </itemizedlist>
        <para>
          And if the back-end GlusterFS server runs remotely,
        </para>
        <itemizedlist>
          <listitem>
            <para>
              glusterfs_target =
              &lt;username&gt;@&lt;glustervolserver&gt;:/&lt;glustervolid&gt;
            </para>
          </listitem>
        </itemizedlist>
      </listitem>
    </itemizedlist>
    <para>
      The following configuration parameters are optional:
    </para>
    <itemizedlist>
      <listitem>
        <variablelist>
          <varlistentry>
            <term>
              glusterfs_nfs_server_type =
            </term>
            <listitem>
              <para>
                &lt;NFS server type used by the GlusterFS
                back end, Gluster or Ganesha. Gluster is the default
                type&gt;
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
      </listitem>
      <listitem>
        <variablelist>
          <varlistentry>
            <term>
              glusterfs_mount_point_base =
            </term>
            <listitem>
              <para>
                &lt;base path of GlusterFS volume mounted on the
                Shared File Systems service host&gt;
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
      </listitem>
      <listitem>
        <para>
          glusterfs_path_to_private_key = &lt;path to Shared File Systems
          service host's private key file&gt;
        </para>
      </listitem>
      <listitem>
        <para>
          glusterfs_server_password = &lt;password of remote GlusterFS
          server machine&gt;
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Known restrictions</title>
    <itemizedlist>
      <listitem>
        <para>
          The driver does not support network segmented multi-tenancy
          model, but instead works over a flat network, where the
          tenants share a network.
        </para>
      </listitem>
      <listitem>
        <para>
          If NFS Ganesha is the NFS server used by the GlusterFS
          back end, then the shares can be accessed by NFSv3 and v4
          protocols. However, if Gluster NFS is used by the GlusterFS
          back end, then the shares can only be accessed by NFSv3
          protocol.
        </para>
      </listitem>
      <listitem>
        <para>
          All Shared File Systems service shares, which map to
          subdirectories within a
          GlusterFS volume, are currently created within a single
          GlusterFS volume of a GlusterFS storage pool.
        </para>
      </listitem>
      <listitem>
        <para>
          The driver does not provide read-only access level for shares.
        </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-glusterfs.xml"/>
  </simplesect>
  -->
  <simplesect>
        <title>Driver configuration options</title>
        <para>
            Configuration options specific to this driver are documented here:
            <xref linkend="config_table_manila_glusterfs"/>.
        </para>
  </simplesect>
</section>