source: networking/netprogs/nfs-utils-systemd.xml@ 36aff45

systemd-13485
Last change on this file since 36aff45 was cb0bbd2, checked in by Douglas R. Reno <renodr@…>, 9 years ago

Update to gjs-1.43.3
Update to libsecret-0.18.3
Update to sqlite-3.8.11.1
Update to nss-3.19.3
Update to gsettings-desktop-schemas-3.16.1
Update to firefox-40.0.2
Added some short descriptions by Denis.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16346 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 21.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY nfs-utils-download-http "&sourceforge-repo;/nfs/nfs-utils-&nfs-utils-version;.tar.bz2">
8 <!ENTITY nfs-utils-download-ftp " ">
9 <!ENTITY nfs-utils-md5sum "1e2f3c1ed468dee02d00c534c002ea10">
10 <!ENTITY nfs-utils-size "772 KB">
11 <!ENTITY nfs-utils-buildsize "16 MB">
12 <!ENTITY nfs-utils-time "0.1 SBU">
13]>
14
15<sect1 id="nfs-utils" xreflabel="NFS-Utils-&nfs-utils-version;">
16 <?dbhtml filename="nfs-utils.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>NFS-Utils-&nfs-utils-version;</title>
24
25 <indexterm zone="nfs-utils">
26 <primary sortas="a-NFS-Utils">NFS-Utils</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to NFS Utilities</title>
31
32 <para>
33 The <application>NFS Utilities</application> package contains the
34 userspace server and client tools necessary to use the kernel's
35 NFS abilities. NFS is a protocol that allows sharing file systems
36 over the network.
37 </para>
38
39 &lfs77_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing='compact'>
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&nfs-utils-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&nfs-utils-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &nfs-utils-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &nfs-utils-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &nfs-utils-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &nfs-utils-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">NFS Utilities Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="libtirpc"/>
80 </para>
81
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended">
84 <xref linkend="libevent"/>,
85 <xref linkend="libnfsidmap"/> and
86 <xref linkend="sqlite"/> (for NFSv4 support) and
87 <xref linkend="lvm2"/> (for NFSv4.1 support)
88 </para>
89
90 <bridgehead renderas="sect4">Optional</bridgehead>
91 <para role="optional">
92 <xref linkend="keyutils"/>,
93 <xref linkend="python2"/> (for <command>mountstats</command> and
94 <command>nfsiostat</command>),
95 <xref linkend="mitkrb"/> or
96 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink> and
97 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">librpcsecgss</ulink> (for GSS and RPC security support)
98 </para>
99
100 <bridgehead renderas="sect4">Required (runtime)</bridgehead>
101 <para role="required">
102 <xref linkend="rpcbind"/>
103 </para>
104
105 <para condition="html" role="usernotes">User Notes:
106 <ulink url="&blfs-wiki;/nfs-utils"/>
107 </para>
108 </sect2>
109
110 <sect2 role="kernel" id="nfs-utils-kernel">
111 <title>Kernel Configuration</title>
112
113 <para>
114 Enable the following options in the kernel configuration
115 and recompile the kernel if necessary:
116 </para>
117
118<screen><literal>File systems ---&gt;
119 [*] Network File Systems ---&gt; [CONFIG_NETWORK_FILESYSTEMS]
120 &lt;*/M&gt; NFS client support [CONFIG_NFS_FS]
121 &lt;*/M&gt; NFS server support [CONFIG_NFSD]</literal></screen>
122
123 <para>
124 Select the appropriate sub-options that appear when the
125 above options are selected.
126 </para>
127
128 <indexterm zone="nfs-utils nfs-utils-kernel">
129 <primary sortas="d-NFS-Utils">NFS-Utils</primary>
130 </indexterm>
131
132 </sect2>
133
134 <sect2 role="installation">
135 <title>Installation of NFS Utilities</title>
136
137 <para>
138 Fix an issue that would prevent <command>rpc.statd</command>
139 from starting:
140 </para>
141
142<screen><userinput>sed -i "/daemon_init/s:\!::" utils/statd/statd.c</userinput></screen>
143
144 <para>
145 Install <application>NFS Utilities</application> by running
146 the following commands:
147 </para>
148
149<screen><userinput>./configure --prefix=/usr \
150 --sysconfdir=/etc \
151 --sbindir=/sbin \
152 --enable-libmount-mount \
153 --without-tcp-wrappers \
154 --disable-gss &amp;&amp;
155make</userinput></screen>
156
157 <para>
158 To test the results, issue: <command>make check</command>.
159 </para>
160
161 <para>
162 Now, as the <systemitem class="username">root</systemitem> user:
163 </para>
164
165<!-- dev note: make statduser=$(whoami) DESTDIR=<DESTDIR> install -->
166<screen role="root"><userinput>make install &amp;&amp;
167install -v -m644 utils/mount/nfsmount.conf /etc/nfsmount.conf</userinput></screen>
168
169 <para>
170 If the NFSv4 support was not disabled, run the
171 following commands while still as the <systemitem
172 class="username">root</systemitem> user:
173 </para>
174
175<screen role="root"><userinput>install -v -dm555 /var/lib/nfs/rpc_pipefs &amp;&amp;
176install -v -dm755 /var/lib/nfs/v4recovery &amp;&amp;
177cat &gt; /etc/idmapd.conf &lt;&lt; "EOF"
178<literal>[General]
179Verbosity = 0
180Pipefs-Directory = /var/lib/nfs/rpc_pipefs
181Domain = localdomain
182
183[Mapping]
184Nobody-User = nobody
185Nobody-Group = nogroup
186
187[Translation]
188Method = nsswitch</literal>
189EOF</userinput></screen>
190
191 </sect2>
192
193 <sect2 role="commands">
194 <title>Command Explanations</title>
195
196 <para>
197 <parameter>--enable-libmount-mount</parameter>: This switch
198 enables linking of the <command>mount.nfs</command> program
199 with the <filename>libmount</filename> library.
200 </para>
201
202 <para>
203 <parameter>--without-tcp-wrappers</parameter>: This switch
204 disables TCP Wrappers support because it is not part of BLFS.
205 </para>
206
207 <para>
208 <parameter>--disable-gss</parameter>: This switch disables
209 support for RPCSEC GSS (RPC Security). Remove it if you have
210 installed optional dependencies.
211 </para>
212
213 <para>
214 <option>--disable-nfsv4</option>: Tis switch disables support
215 for NFS version 4. Use it if you have not installed
216 recommended dependencies. It implies
217 <option>--disable-nfsv41</option>.
218 </para>
219
220 <para>
221 <option>--disable-nfsv41</option>: Tis switch disables support
222 for NFS version 4.1. Use it if you have not installed
223 <application>LVM2</application> but stil wish to enable
224 support for NFS version 4.
225 </para>
226
227 </sect2>
228
229 <sect2 role="configuration">
230 <title>Configuring NFS Utilities</title>
231
232 <sect3 id="nfs-utils-server-config">
233 <title>NFS Server Configuration</title>
234
235 <para>
236 <filename>/etc/exports</filename> contains the exported directories
237 on NFS servers. Refer to the <filename>exports.5</filename> manual page
238 for the syntax of this file. Also refer to the "NFS HowTo" available at
239 <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
240 how to configure the servers and clients in a secure manner.
241 </para>
242
243 <para>
244 For sharing the <filename class="directory">/home</filename> directory
245 over the local network using NFSv3, add the following line to
246 <filename>/etc/exports</filename>:
247 </para>
248
249<screen role="root"><userinput>/home <replaceable>192.168.0.0/24</replaceable>(rw,no_subtree_check,anonuid=99,anongid=99)</userinput></screen>
250
251 <para>
252 NFSv4 exports exist in a single pseudo filesystem, where the real
253 directories are mounted with the <option>--bind</option> option.
254 In order to share <filename class="directory">/home</filename> over
255 NFSv4, you need to bind mount it into a pseudo filesystem you are
256 going to export (in this example we will use <filename
257 class="directory">/srv/nfsv4</filename>, in which case the <filename
258 class="directory">/home</filename> directory will become <filename
259 class="directory">/srv/nfsv4/home</filename>).
260 </para>
261
262<screen role="root"><userinput>install -v -dm755 /srv/nfsv4/home &amp;&amp;
263mount -v --bind /home /srv/nfsv4/home</userinput></screen>
264
265 <para>
266 To make the above change permanent, you can add the following line
267 to your <filename>/etc/fstab</filename>:
268 </para>
269
270<screen role="root"><userinput>/home /srv/nfsv4/home none bind 0 0</userinput></screen>
271
272 <para>
273 Update <filename>/etc/exports</filename> to export your NFSv4 share:
274 </para>
275
276<screen role="root"><userinput>/srv/nfsv4 <replaceable>192.168.0.0/24</replaceable>(rw,fsid=0,no_subtree_check)
277/srv/nfsv4/home <replaceable>192.168.0.0/24</replaceable>(rw,nohide,insecure,no_subtree_check)</userinput></screen>
278
279 <note>
280 <para>
281 Be sure to replace the directory, network address and prefix above
282 to match your network. The only space in the lines above should be
283 between the directory and the network address.
284 </para>
285 </note>
286
287 <indexterm zone="nfs-utils nfs-utils-server-config">
288 <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
289 </indexterm>
290
291 <sect4 id="nfs-utils-server-init">
292 <title>Systemd Units</title>
293
294 <para>
295 To start the NFS server daemons at boot,
296 install the systemd units from the <xref linkend="bootscripts"/>
297 package by running the following command as the
298 <systemitem class="username">root</systemitem> user:
299 </para>
300
301<screen role="root"><userinput>make install-nfsv4-server</userinput></screen>
302
303 <para>
304 If you have disabled NFSv4 support, run the following
305 command as the <systemitem
306 class="username">root</systemitem> user to omit the NFSv4
307 specific systemd units:
308 </para>
309
310<screen role="root"><userinput>make install-nfs-server</userinput></screen>
311
312 <indexterm zone="nfs-utils nfs-utils-server-init">
313 <primary sortas="f-nfs-server">nfs-server</primary>
314 </indexterm>
315
316 <para>
317 You can edit the <filename>/etc/default/nfs-utils</filename>
318 file to change the startup options for NFS daemons. Defaults
319 should be fine for most use cases.
320 </para>
321
322 <indexterm zone="nfs-utils nfs-utils-server-init">
323 <primary sortas="e-etc-default-nfs-utils">/etc/default/nfs-utils</primary>
324 </indexterm>
325
326 </sect4>
327
328 </sect3>
329
330 <sect3 id="nfs-utils-client-config">
331 <title>Client Configuration</title>
332
333 <para>
334 <filename>/etc/fstab</filename> contains the directories that
335 are to be mounted on the client. Alternately the partitions can be
336 mounted by using the <command>mount</command> command with the proper
337 options. To mount the <filename class="directory">/home</filename>
338 and <filename class="directory">/usr</filename> partitions, add the
339 following to the <filename>/etc/fstab</filename>:
340 </para>
341
342<screen role="root"><userinput><replaceable>&lt;server-name&gt;</replaceable>:/home /home nfs rw,x-systemd.automount,x-systemd.device-timeout=10,timeo=14 0 0
343<replaceable>&lt;server-name&gt;</replaceable>:/usr /usr nfs ro,x-systemd.automount,x-systemd.device-timeout=10,timeo=14 0 0</userinput></screen>
344
345 <para>
346 The options which can be used are specified in <command>man 5 nfs</command>.
347 If both the client and server are running recent versions of Linux, most of the
348 options will be negotiated. You can specify either <literal>rw</literal> or
349 <literal>ro</literal>, <literal>x-systemd.automount</literal> if the filesystem
350 is to be automatically mounted at boot, or <literal>noauto</literal> (and perhaps
351 <literal>user</literal>) for other filesystems.
352 </para>
353
354 <para>
355 If the fileserver is not running a recent version of Linux, you may need to
356 specifiy other options.
357 </para>
358
359 <indexterm zone="nfs-utils nfs-utils-client-config">
360 <primary sortas="e-etc-fstab">/etc/fstab</primary>
361 </indexterm>
362
363 <sect4 id="nfs-utils-client-init">
364 <title>Systemd Units</title>
365
366 <note>
367 <para>
368 The following systemd unis are not required if the
369 nfs-server units were previously installed.
370 </para>
371 </note>
372
373 <para>
374 To start the NFS client services at boot,
375 install the systemd units from the <xref linkend="bootscripts"/>
376 package by running the following command as the
377 <systemitem class="username">root</systemitem> user:
378 </para>
379
380<screen role="root"><userinput>make install-nfs-client</userinput></screen>
381
382 <indexterm zone="nfs-utils nfs-utils-client-config">
383 <primary sortas="f-nfs-client">nfs-client</primary>
384 </indexterm>
385
386 </sect4>
387
388 </sect3>
389
390 </sect2>
391
392 <sect2 role="content">
393 <title>Contents</title>
394 <segmentedlist>
395 <segtitle>Installed Programs</segtitle>
396 <segtitle>Installed Libraries</segtitle>
397 <segtitle>Installed Directories</segtitle>
398
399 <seglistitem>
400 <seg>
401 blkmapd, exportfs, mount.nfs, mount.nfs4 (link to mount.nfs),
402 mountstats, nfsdcltrack, nfsiostat, nfsstat, osd_login,
403 rpcdebug, rpc.idmapd, rpc.mountd, rpc.nfsd, rpc.statd, showmount,
404 sm-notify, start-statd, umount.nfs (link to mount.nfs) and
405 umount.nfs4 (link to mount.nfs)
406 </seg>
407 <seg>
408 None
409 </seg>
410 <seg>
411 /var/lib/nfs
412 </seg>
413 </seglistitem>
414 </segmentedlist>
415
416 <variablelist>
417 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
418 <?dbfo list-presentation="list"?>
419 <?dbhtml list-presentation="table"?>
420
421 <varlistentry id="blkmapd">
422 <term><command>blkmapd</command></term>
423 <listitem>
424 <para>
425 is used to perform device discovery and mapping
426 for the parallel NFS (pNFS) block layout client.
427 </para>
428 <indexterm zone="nfs-utils blkmapd">
429 <primary sortas="b-blkmapd">blkmapd</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="exportfs">
435 <term><command>exportfs</command></term>
436 <listitem>
437 <para>
438 is used to maintain a list of NFS exported file
439 systems.
440 </para>
441 <indexterm zone="nfs-utils exportfs">
442 <primary sortas="b-exportfs">exportfs</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="mount.nfs">
448 <term><command>mount.nfs</command></term>
449 <listitem>
450 <para>
451 is used to mount a network share using NFS.
452 </para>
453 <indexterm zone="nfs-utils mount.nfs">
454 <primary sortas="b-mount.nfs">mount.nfs</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="mount.nfs4">
460 <term><command>mount.nfs4</command></term>
461 <listitem>
462 <para>
463 is used to mount a network share using NFSv4.
464 </para>
465 <indexterm zone="nfs-utils mount.nfs4">
466 <primary sortas="b-mount.nfs4">mount.nfs4</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry id="mountstats">
472 <term><command>mountstats</command></term>
473 <listitem>
474 <para>
475 is used to display NFS client per-mount statistics.
476 </para>
477 <indexterm zone="nfs-utils mountstats">
478 <primary sortas="b-mountstats">mountstats</primary>
479 </indexterm>
480 </listitem>
481 </varlistentry>
482
483 <varlistentry id="nfsdcltrack">
484 <term><command>nfsdcltrack</command></term>
485 <listitem>
486 <para>
487 is the NFSv4 client tracking callout program.
488 </para>
489 <indexterm zone="nfs-utils nfsdcltrack">
490 <primary sortas="b-nfsdcltrack">nfsdcltrack</primary>
491 </indexterm>
492 </listitem>
493 </varlistentry>
494
495 <varlistentry id="nfsiostat-nfs-utils">
496 <term><command>nfsiostat</command></term>
497 <listitem>
498 <para>
499 is used to report input/output statistics for
500 network filesystems.
501 </para>
502 <indexterm zone="nfs-utils nfsiostat-nfs-utils">
503 <primary sortas="b-nfsiostat-nfs-utils">nfsiostat</primary>
504 </indexterm>
505 </listitem>
506 </varlistentry>
507
508 <varlistentry id="nfsstat">
509 <term><command>nfsstat</command></term>
510 <listitem>
511 <para>
512 is used to display statistics kept about NFS
513 client and server activity.
514 </para>
515 <indexterm zone="nfs-utils nfsstat">
516 <primary sortas="b-nfsstat">nfsstat</primary>
517 </indexterm>
518 </listitem>
519 </varlistentry>
520
521 <varlistentry id="rpcdebug">
522 <term><command>rpcdebug</command></term>
523 <listitem>
524 <para>
525 is used to set or clear the kernel's NFS client and
526 server debug flags.
527 </para>
528 <indexterm zone="nfs-utils rpcdebug">
529 <primary sortas="b-rpcdebug">rpcdebug</primary>
530 </indexterm>
531 </listitem>
532 </varlistentry>
533
534 <varlistentry id="rpc.idmapd">
535 <term><command>rpc.idmapd</command></term>
536 <listitem>
537 <para>
538 implements the NFSv4 ID &lt;-&gt; name mapping daemon.
539 </para>
540 <indexterm zone="nfs-utils rpc.idmapd">
541 <primary sortas="b-rpc.idmapd">rpc.idmapd</primary>
542 </indexterm>
543 </listitem>
544 </varlistentry>
545
546 <varlistentry id="osd_login">
547 <term><command>osd_login</command></term>
548 <listitem>
549 <para>is a script that is a part f the autologin feature
550 mandated by the pnfs-objects standard.</para>
551 <indexterm zone="nfs-utils osd_login">
552 <primary sortas="b-osd_login">osd_login</primary>
553 </indexterm>
554 </listitem>
555 </varlistentry>
556
557
558 <varlistentry id="rpc.mountd">
559 <term><command>rpc.mountd</command></term>
560 <listitem>
561 <para>
562 implements the NFS mount protocol on an NFS server.
563 </para>
564 <indexterm zone="nfs-utils rpc.mountd">
565 <primary sortas="b-rpc.mountd">rpc.mountd</primary>
566 </indexterm>
567 </listitem>
568 </varlistentry>
569
570 <varlistentry id="rpc.nfsd">
571 <term><command>rpc.nfsd</command></term>
572 <listitem>
573 <para>
574 implements the user level part of the NFS
575 service on the server.
576 </para>
577 <indexterm zone="nfs-utils rpc.nfsd">
578 <primary sortas="b-rpc.nfsd">rpc.nfsd</primary>
579 </indexterm>
580 </listitem>
581 </varlistentry>
582
583 <varlistentry id="rpc.statd">
584 <term><command>rpc.statd</command></term>
585 <listitem>
586 <para>
587 is used by the NFS file locking service. Run on both
588 sides, client as well as server, when you want file
589 locking enabled.
590 </para>
591 <indexterm zone="nfs-utils rpc.statd">
592 <primary sortas="b-rpc.statd">rpc.statd</primary>
593 </indexterm>
594 </listitem>
595 </varlistentry>
596
597 <varlistentry id="showmount">
598 <term><command>showmount</command></term>
599 <listitem>
600 <para>
601 is used to display mount information for an NFS server.
602 </para>
603 <indexterm zone="nfs-utils showmount">
604 <primary sortas="b-showmount">showmount</primary>
605 </indexterm>
606 </listitem>
607 </varlistentry>
608
609 <varlistentry id="sm-notify">
610 <term><command>sm-notify</command></term>
611 <listitem>
612 <para>
613 is used to send Network Status Monitor reboot messages.
614 </para>
615 <indexterm zone="nfs-utils sm-notify">
616 <primary sortas="b-sm-notify">sm-notify</primary>
617 </indexterm>
618 </listitem>
619 </varlistentry>
620
621 <varlistentry id="start-statd">
622 <term><command>start-statd</command></term>
623 <listitem>
624 <para>
625 is a script called by nfsmount when mounting a filesystem
626 with locking enabled, if statd does not appear to be running.
627 It can be customised with whatever flags are appropriate for
628 the site.
629 </para>
630 <indexterm zone="nfs-utils start-statd">
631 <primary sortas="b-start-statd">start-statd</primary>
632 </indexterm>
633 </listitem>
634 </varlistentry>
635
636 <varlistentry id="umount.nfs">
637 <term><command>umount.nfs</command></term>
638 <listitem>
639 <para>
640 is used to unmount a network share using NFS.
641 </para>
642 <indexterm zone="nfs-utils umount.nfs">
643 <primary sortas="b-umount.nfs">umount.nfs</primary>
644 </indexterm>
645 </listitem>
646 </varlistentry>
647
648 <varlistentry id="umount.nfs4">
649 <term><command>umount.nfs4</command></term>
650 <listitem>
651 <para>
652 is used to unmount a network share using NFSv4.
653 </para>
654 <indexterm zone="nfs-utils umount.nfs4">
655 <primary sortas="b-umount.nfs4">umount.nfs4</primary>
656 </indexterm>
657 </listitem>
658 </varlistentry>
659
660 </variablelist>
661
662 </sect2>
663
664</sect1>
Note: See TracBrowser for help on using the repository browser.