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

<section xml:id="hdfs-native-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>HDFS native driver</title>
  <para>
    HDFS native driver is a plug-in based on the Shared File Systems
    service, which uses Hadoop distributed file system (HDFS), a
    distributed file system designed to hold very large amounts of data,
    and provide high-throughput access to the data.
  </para>
  <para>
    A Shared File Systems service share in this driver is a subdirectory
    in hdfs root
    directory. Instances talk directly to the HDFS storage back end with
    'hdfs' protocol. And access to each share is allowed by user based
    access type, which is aligned with HDFS ACLs to support access
    control of multiple users and groups.
  </para>
  <simplesect>
    <title>Network configuration</title>
    <para>
      The storage back end and Shared File Systems service hosts should
      be in a flat network,
      otherwise, the L3 connectivity between them should exist.
    </para>
  </simplesect>
  <simplesect>
    <title>Supported shared filesystems</title>
    <itemizedlist>
      <listitem>
        <para>
          HDFS (authentication by user)
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Supported operations</title>
    <itemizedlist>
      <listitem>
        <para>
          Create HDFS share.
        </para>
      </listitem>
      <listitem>
        <para>
          Delete HDFS share.
        </para>
      </listitem>
      <listitem>
        <para>
          Allow HDFS share access.
        </para>
        <itemizedlist>
          <listitem>
            <para>
              Only support user access type.
            </para>
          </listitem>
        </itemizedlist>
        <para>
          * Support level of access (ro/rw).
        </para>
      </listitem>
      <listitem>
        <para>
          Deny HDFS 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>
  </simplesect>
  <simplesect>
    <title>Requirements</title>
    <itemizedlist>
      <listitem>
        <para>
          Install HDFS package, version &gt;= 2.4.x, on the storage
          back end.
        </para>
      </listitem>
      <listitem>
        <para>
          To enable access control, the HDFS file system must have ACLs
          enabled.
        </para>
      </listitem>
      <listitem>
        <para>
          Establish network connection between the Shared File Systems
          service host and storage back end.
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Shared File Systems service driver configuration</title>
    <itemizedlist>
      <listitem>
        <para>
          share_driver =
          manila.share.drivers.hdfs.hdfs_native.HDFSNativeShareDriver
        </para>
      </listitem>
      <listitem>
        <variablelist>
          <varlistentry>
            <term>
              hdfs_namenode_ip = the IP address of the HDFS namenode,
              and only single
            </term>
            <listitem>
              <para>
                namenode is supported now
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
      </listitem>
      <listitem>
        <para>
          hdfs_namenode_port = the port of the HDFS namenode service
        </para>
      </listitem>
      <listitem>
        <para>
          hdfs_ssh_port = HDFS namenode SSH port
        </para>
      </listitem>
      <listitem>
        <para>
          hdfs_ssh_name = HDFS namenode SSH login name
        </para>
      </listitem>
      <listitem>
        <variablelist>
          <varlistentry>
            <term>
              hdfs_ssh_pw = HDFS namenode SSH login password, this
              parameter is not
            </term>
            <listitem>
              <para>
                necessary, if the following hdfs_ssh_private_key is
                configured
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
      </listitem>
      <listitem>
        <para>
          hdfs_ssh_private_key = Path to the HDFS namenode private key
          to ssh login
        </para>
      </listitem>
    </itemizedlist>
  </simplesect>
  <simplesect>
    <title>Known restrictions</title>
    <itemizedlist>
      <listitem>
        <para>
          This driver does not support network segmented multi-tenancy
          model. Instead multi-tenancy is supported by the tenant
          specific user authentication.
        </para>
      </listitem>
      <listitem>
        <para>
          Only support for single HDFS namenode in Kilo release.
        </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-hdfs.xml"/>
  </simplesect>
  -->
  <simplesect>
        <title>Driver configuration options</title>
        <para>
            Configuration options specific to this driver are documented here:
            <xref linkend="config_table_manila_hdfs"/>.
        </para>
  </simplesect>
</section>