source: server/major/nfs-utils.xml@ a16cb066

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY nfs-utils-download-http "http://ftp.kernel.org/pub/linux/utils/nfs/nfs-utils-&nfs-utils-version;.tar.gz">
  <!ENTITY nfs-utils-download-ftp  "ftp://ftp.kernel.org/pub/linux/utils/nfs/nfs-utils-&nfs-utils-version;.tar.gz">
  <!ENTITY nfs-utils-md5sum        "8f863120261cd572ad320a9152581e11">
  <!ENTITY nfs-utils-size          "396 KB">
  <!ENTITY nfs-utils-buildsize     "5.8 MB">
  <!ENTITY nfs-utils-time          "0.2 SBU">
]>

<sect1 id="nfs-utils" xreflabel="NFS Utilities-&nfs-utils-version;">
<sect1info>
  <othername>$LastChangedBy$</othername>
  <date>$Date$</date>
</sect1info>

<?dbhtml filename="nfs-utils.html"?>
<title>NFS Utilities-&nfs-utils-version;</title>

<indexterm zone="nfs-utils">
  <primary sortas="a-nfs-utils">NFS Utilities</primary>
</indexterm>

<sect2>
<title>Introduction to <application>nfs-utils</application></title>

<para>The <application>nfs-utils</application> package contains the userspace 
server and client tools necessary to use the kernel's nfs-abilities. 
<acronym>NFS</acronym> is a protocol that allows sharing file systems over the 
network.</para>

<bridgehead renderas="sect3">Package information</bridgehead>
<itemizedlist spacing='compact'>
  <listitem><para>Download (HTTP): <ulink url="&nfs-utils-download-http;"/></para></listitem>
  <listitem><para>Download (FTP): <ulink url="&nfs-utils-download-ftp;"/></para></listitem>
  <listitem><para>Download MD5 sum: &nfs-utils-md5sum;</para></listitem>
  <listitem><para>Download size: &nfs-utils-size;</para></listitem>
  <listitem><para>Estimated disk space required: &nfs-utils-buildsize;</para></listitem>
  <listitem><para>Estimated build time: &nfs-utils-time;</para></listitem>
</itemizedlist>

<bridgehead renderas="sect3">nfs-utils Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>

<para><xref linkend="portmap"/></para>

<bridgehead renderas="sect4">Optional</bridgehead>
<para><ulink url="http://www.monkey.org/~provos/libevent/">libevent</ulink>
and <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/libnfsidmap/">libnsfidmap</ulink>
for nfsv4 support, and kerberos-5 development libraries for gss (RPC Security) support.
</para>

</sect2>

<sect2 id='nfs-utils-kernel'>
<title>Kernel Configuration</title>

<para>Enable the following options in the kernel configuration
and recompile the kernel if neccessary:</para>

<screen>File systems:
  Network File Systems:
    NFS File System Support: M or Y
    NFS Server Support: M or Y</screen>

<para>Select the appropriate sub-options that appear when the above options
are selected.</para>

<indexterm zone="nfs-utils nfs-utils-kernel">
  <primary sortas="d-nfs-utils">NFS Utilities</primary>
</indexterm>
</sect2>

<sect2>
<title>Installation of nfs-utils</title>

<para>Before you compile the program, you need to be sure the "nobody"
user and "nogroup" group are available. You can add these by
running the following commands as the root user:</para>

<screen><userinput><command>groupadd -g 99 nogroup &amp;&amp;
useradd -c nobody -d /home -g nogroup -s /bin/bash -u 99 nobody</command></userinput></screen>

<note><para>The classic uid and gid values are 65534 which is also -2 when 
interpreted as a signed 16-bit number.  These values impact other files on
some filesystems that do not have support for sparse files.  The nobody
and nogroup values have small impact.  The impact on a server is nil if the
exports file is configured correctly.  If it is misconfigured, the impact is
that a ls -l or ps listing will show a uid or gid number of 65534 instead
of a name. The client uses nobody only as the user running rpc.statd.</para></note>

<para>Install nfs-utils by running the following commands:</para>

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
    --disable-nfsv4 --disable-gss &amp;&amp;
make</userinput></screen>

<para>Now, as the root user:</para>

<screen role='root'><userinput>make install</userinput></screen>

<note><para>If your <filename>/usr</filename> directory is NFS mounted,
you should install the executables in <filename>/sbin</filename> by passing
an additional parameter <command>--sbindir=/sbin</command> to the above
<command>./configure</command> command.</para></note>

</sect2>

<sect2 role="commands">
<title>Command Explanations</title>

<para><parameter>--disable-nfsv4</parameter>: Disbles support  
for NFS Version 4.</para>

<para><parameter>--disable-gss</parameter>: Disbles support for 
RPCSEC GSS (RPC Security).</para>

</sect2>

<sect2>
<title>Configuring nfs-utils</title>

<bridgehead renderas="sect3">Server Configutation</bridgehead>

<para id='nfs-utils-server-config'><filename>/etc/exports</filename> contains
the exported directories on NFS servers. Refer to the exports manual page for
the syntax of this file. Also refer to the NFS HowTo available at <ulink
url="http://nfs.sourceforge.net/nfs-howto/"/> on how to configure the servers
and clients in a secure manner. For example, for sharing the
<filename>/home</filename> directory over the local network, the following line
may be added:</para>

<screen><userinput>/home 192.168.0.0/255.255.255.0(rw,anonuid=99,anongid=99)</userinput></screen>

<indexterm zone="nfs-utils nfs-utils-server-config">
  <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
</indexterm>

<para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename> init script
included in the <xref linkend="intro-important-bootscripts"/> package to start
the server at boot.</para>

<screen><userinput><command>make install-nfs-server</command></userinput></screen>

<indexterm zone="nfs-utils nfs-utils-server-config">
  <primary sortas="f-nfs-server">nfs-server</primary>
</indexterm>
  
<para>Now create the <filename>/etc/sysconfig/nfs-server</filename> 
configuration file:</para>

<screen><userinput><command>cat &gt; /etc/sysconfig/nfs-server &lt;&lt; "EOF"</command>
PORT="2049"
PROCESSES="8"
QUOTAS="no"
KILLDELAY="10"
<command>EOF</command></userinput></screen>

<indexterm zone="nfs-utils nfs-utils-server-config">
  <primary sortas="e-etc-sysconfig-nfs-server">/etc/sysconfig/nfs-server</primary>
</indexterm>

<bridgehead renderas="sect3">Client Configutation</bridgehead>

<para id='nfs-utils-client-config'><filename>/etc/fstab</filename> contains the
directories that are to be mounted on the client. Alternately the partitions
can be mounted by using the <command>mount</command> command with the proper
options. To mount the <filename>/home</filename> and <filename>/usr</filename>
partitions, add the following to the <filename>/etc/fstab</filename>:</para>

<screen><userinput>&lt;server-name&gt;:/home  /home nfs   rw,_netdev,rsize=8192,wsize=8192 0 0
&lt;server-name&gt;:/usr   /usr  nfs   ro,_netdev,rsize=8192            0 0</userinput></screen>

<indexterm zone="nfs-utils nfs-utils-client-config">
  <primary sortas="e-etc-fstab">/etc/fstab</primary>
</indexterm>


<para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename>
init script included in the
<xref linkend="intro-important-bootscripts"/> package to 
start the client services at boot.</para>

<screen><userinput><command>make install-nfs-client</command></userinput></screen>

<indexterm zone="nfs-utils nfs-utils-client-config">
  <primary sortas="f-nfs-client">nfs-client</primary>
</indexterm>

<para>To automatically mount nfs filesystems, clients will also need to install 
the netfs bootscript as described in <xref linkend='postlfs-config-netfs'/>.</para>

<indexterm zone="nfs-utils nfs-utils-client-config">
  <primary sortas="f-netfs">netfs</primary>
</indexterm>

</sect2>

<sect2>
<title>Contents</title>
<segmentedlist>
  <segtitle>Installed Programis</segtitle>
  <segtitle>Installed Libraries</segtitle>
  <segtitle>Installed Directories</segtitle>
 
  <seglistitem>
    <seg>exportfs, nfsstat, nhfsgraph, nhfsnums, nhfsrun, nhfsstone,
         rpc.lockd, rpc.mountd, rpc.nfsd, rpc.rquotad, rpc.statd, showmount</seg>
    <seg>None</seg>
    <seg>/var/lib/nfs</seg>
  </seglistitem>
</segmentedlist>

<variablelist>
  <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  <?dbfo list-presentation="list"?>
  <?dbhtml list-presentation="table"?>

<varlistentry id="exportfs">
  <term><command>exportfs</command></term>
  <listitem>
    <para>maintains a list of NFS exported file systems.</para>
    <indexterm zone="nfs-utils exportfs">
      <primary sortas="b-exportfs">exportfs</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="nfsstat">
  <term><command>nfsstat</command></term>
  <listitem>
    <para>prints NFS statistics.</para>
    <indexterm zone="nfs-utils nfsstat">
      <primary sortas="b-nfsstat">nfsstat</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="nhfsgraph">
  <term><command>nhfsgraph</command></term>
  <listitem>
    <para>runs nhfsstone over multiple loads.</para>
    <indexterm zone="nfs-utils nhfsgraph">
      <primary sortas="b-nhfsgraph">nhfsgraph</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="nhfsnums">
  <term><command>nhfsnums</command></term>
  <listitem>
    <para>converts raw numbers from nhfsstone output into plot format.</para>
    <indexterm zone="nfs-utils nhfsnums">
      <primary sortas="b-nhfsnums">nhfsnums</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="nhfsrun">
  <term><command>nhfsrun</command></term>
  <listitem>
    <para>executes nhfsstone with a range of different loads.</para>
    <indexterm zone="nfs-utils nhfsrun">
      <primary sortas="b-nhfsrun">nhfsrun</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="nhfsstone">
  <term><command>nhfsstone</command></term>
  <listitem>
    <para>is used on a NFS client to generate an artificial load with a 
          particular mix of NFS operations.</para>
    <indexterm zone="nfs-utils nhfsstone">
      <primary sortas="b-nhfsstone">nhfsstone</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="rpclockd">
  <term><command>rpc.lockd</command></term>
  <listitem>
    <para>starts the NFS lock manager (NLM) on kernels that don't
       start it automatically.  However, since most kernels do start it 
       automatically it is usually not required.</para>
    <indexterm zone="nfs-utils rpclockd">
      <primary sortas="b-rpclockd">rpc.lockd</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="rpcmountd">
  <term><command>rpc.mountd</command></term>
  <listitem>
    <para>implements the NFS mount protocol on an NFS server.</para>
    <indexterm zone="nfs-utils rpcmountd">
      <primary sortas="b-rpcmountd">rpc.mountd</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="rpcnfsd">
  <term><command>rpc.nfsd</command></term>
  <listitem>
    <para>implements the user level part of the NFS service on the server.</para>
    <indexterm zone="nfs-utils rpcnfsd">
      <primary sortas="b-rpcnfsd">rpc.nfsd</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="rpcrquotad">
  <term><command>rpc.rquotad</command></term>
  <listitem>
    <para>is an rpc server which returns quotas for a user of a local file
       system which is mounted by a remote machine over the NFS.</para>
    <indexterm zone="nfs-utils rpcrquotad">
      <primary sortas="b-rpcrquotad">rpc.rquotad</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="rpcstatd">
  <term><command>rpc.statd</command></term>
  <listitem>
    <para>is used by the NFS file locking service, rpc.lockd, to implement 
       lock recovery when the NFS server machine crashes and reboots. Runs
       on the NFS server only.</para>
    <indexterm zone="nfs-utils rpcstatd">
      <primary sortas="b-rpcstatd">rpc.statd</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="showmount">
  <term><command>showmount</command></term>
  <listitem>
    <para>displays mount information for an NFS server.</para>
    <indexterm zone="nfs-utils showmount">
      <primary sortas="b-showmount">showmount</primary>
    </indexterm>
  </listitem>
</varlistentry>


</variablelist>

</sect2>
</sect1>