xml-doc-building-glue-20090527
[openafs.git] / doc / xml / QuickStartUnix / auqbg005.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <chapter id="HDRWQ17">
3   <title>Installing the First AFS Machine</title>
4
5   <indexterm>
6     <primary>file server machine</primary>
7
8     <seealso>first AFS machine</seealso>
9
10     <seealso>file server machine, additional</seealso>
11   </indexterm>
12
13   <indexterm>
14     <primary>instructions</primary>
15
16     <secondary>first AFS machine</secondary>
17   </indexterm>
18
19   <indexterm>
20     <primary>installing</primary>
21
22     <secondary>first AFS machine</secondary>
23   </indexterm>
24
25   <para>This chapter describes how to install the first AFS machine in your cell, configuring it as both a file server machine and a
26   client machine. After completing all procedures in this chapter, you can remove the client functionality if you wish, as described
27   in <link linkend="HDRWQ98">Removing Client Functionality</link>.</para>
28
29   <para>To install additional file server machines after completing this chapter, see <link linkend="HDRWQ99">Installing Additional
30   Server Machines</link>.</para>
31
32   <para>To install additional client machines after completing this chapter, see <link linkend="HDRWQ133">Installing Additional
33   Client Machines</link>. <indexterm>
34       <primary>requirements</primary>
35
36       <secondary>first AFS machine</secondary>
37     </indexterm></para>
38
39   <sect1 id="Header_29">
40     <title>Requirements and Configuration Decisions</title>
41
42     <para>The instructions in this chapter assume that you meet the following requirements. 
43       <itemizedlist>
44         <listitem>
45           <para>You are logged onto the machine's console as the local superuser <emphasis role="bold">root</emphasis></para>
46         </listitem>
47
48         <listitem>
49           <para>A standard version of one of the operating systems supported by the current version of AFS is running on the
50           machine</para>
51         </listitem>
52
53         <listitem>
54           <para>You have either installed the provided OpenAFS packages for 
55           your system, have access to a binary distribution tarball, or have 
56           successfully built OpenAFS from source</para>
57         </listitem>
58
59         <listitem>
60           <para>You have a Kerberos v5 realm running for your site. If you are
61           working with an existing cell which uses 
62           <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for
63           authentication, please see 
64           <link linkend="KAS001">kaserver and Legacy Kerberos v4 Authentication</link>
65           for the modifications required to this installation procedure.</para>
66         </listitem>
67
68         <listitem>
69           <para>You have a NTP, or similar, time service deployed to ensure 
70           rough clock syncronistation between your clients and servers. If you
71           wish to use AFS's built in timeservice (which is deprecated) please
72           see Appendix B for the necessary modifications to this installation
73           procedure.</para>
74         </listitem>
75       </itemizedlist></para>
76
77     <para>You must make the following configuration decisions while installing the first AFS machine. To speed the installation
78     itself, it is best to make the decisions before beginning. See the chapter in the <emphasis>OpenAFS Administration
79     Guide</emphasis> about issues in cell administration and configuration for detailed guidelines. <indexterm>
80         <primary>cell name</primary>
81
82         <secondary>choosing</secondary>
83       </indexterm> <indexterm>
84         <primary>AFS filespace</primary>
85
86         <secondary>deciding how to configure</secondary>
87       </indexterm> <indexterm>
88         <primary>filespace</primary>
89
90         <see>AFS filespace</see>
91       </indexterm> <itemizedlist>
92         <listitem>
93           <para>Select the first AFS machine</para>
94         </listitem>
95
96         <listitem>
97           <para>Select the cell name</para>
98         </listitem>
99
100         <listitem>
101           <para>Decide which partitions or logical volumes to configure as AFS server partitions, and choose the directory names on
102           which to mount them</para>
103         </listitem>
104
105         <listitem>
106           <para>Decide how big to make the client cache</para>
107         </listitem>
108
109         <listitem>
110           <para>Decide how to configure the top levels of your cell's AFS filespace</para>
111         </listitem>
112       </itemizedlist></para>
113
114     <para>This chapter is divided into three large sections corresponding to the three parts of installing the first AFS machine.
115     Perform all of the steps in the order they appear. Each functional section begins with a summary of the procedures to perform.
116     The sections are as follows: <itemizedlist>
117         <listitem>
118           <para>Installing server functionality (begins in <link linkend="HDRWQ18">Overview: Installing Server
119           Functionality</link>)</para>
120         </listitem>
121
122         <listitem>
123           <para>Installing client functionality (begins in <link linkend="HDRWQ63">Overview: Installing Client
124           Functionality</link>)</para>
125         </listitem>
126
127         <listitem>
128           <para>Configuring your cell's filespace, establishing further security mechanisms, and enabling access to foreign cells
129           (begins in <link linkend="HDRWQ71">Overview: Completing the Installation of the First AFS Machine</link>)</para>
130         </listitem>
131       </itemizedlist></para>
132
133     <indexterm>
134       <primary>overview</primary>
135
136       <secondary>installing server functionality on first AFS machine</secondary>
137     </indexterm>
138
139     <indexterm>
140       <primary>first AFS machine</primary>
141
142       <secondary>server functionality</secondary>
143     </indexterm>
144
145     <indexterm>
146       <primary>installing</primary>
147
148       <secondary>server functionality</secondary>
149
150       <tertiary>first AFS machine</tertiary>
151     </indexterm>
152   </sect1>
153
154   <sect1 id="HDRWQ18">
155     <title>Overview: Installing Server Functionality</title>
156
157     <para>In the first phase of installing your cell's first AFS machine, you install file server and database server functionality
158     by performing the following procedures: 
159     <orderedlist>
160         <listitem>
161           <para>Choose which machine to install as the first AFS machine</para>
162         </listitem>
163
164         <listitem>
165           <para>Create AFS-related directories on the local disk</para>
166         </listitem>
167
168         <listitem>
169           <para>Incorporate AFS modifications into the machine's kernel</para>
170         </listitem>
171
172         <listitem>
173           <para>Configure partitions or logical volumes for storing AFS volumes</para>
174         </listitem>
175
176         <listitem>
177           <para>On some system types, install and configure an AFS-modified version of the <emphasis role="bold">fsck</emphasis>
178           program</para>
179         </listitem>
180
181         <listitem>
182           <para>If the machine is to remain a client machine, incorporate AFS into its authentication system</para>
183         </listitem>
184
185         <listitem>
186           <para>Start the Basic OverSeer (BOS) Server</para>
187         </listitem>
188
189         <listitem>
190           <para>Define the cell name and the machine's cell membership</para>
191         </listitem>
192
193         <listitem>
194           <para>Start the database server processes: Backup Server, Protection Server, and Volume Location
195           (VL) Server</para>
196         </listitem>
197
198         <listitem>
199           <para>Configure initial security mechanisms</para>
200         </listitem>
201
202         <listitem>
203           <para>Start the <emphasis role="bold">fs</emphasis> process, which incorporates three component processes: the File
204           Server, Volume Server, and Salvager</para>
205         </listitem>
206
207         <listitem>
208           <para>Start the server portion of the Update Server</para>
209         </listitem>
210
211       </orderedlist></para>
212   </sect1>
213
214   <sect1 id="HDRWQ19">
215     <title>Choosing the First AFS Machine</title>
216
217     <para>The first AFS machine you install must have sufficient disk space to store AFS volumes. To take best advantage of AFS's
218     capabilities, store client-side binaries as well as user files in volumes. When you later install additional file server
219     machines in your cell, you can distribute these volumes among the different machines as you see fit.</para>
220
221     <para>These instructions configure the first AFS machine as a <emphasis>database server machine</emphasis>, the <emphasis>binary
222     distribution machine</emphasis> for its system type, and the cell's <emphasis>system control machine</emphasis>. For a
223     description of these roles, see the <emphasis>OpenAFS Administration Guide</emphasis>.</para>
224
225     <para>Installation of additional machines is simplest if the first machine has the lowest IP address of any database server
226     machine you currently plan to install. If you later install database server functionality on a machine with a lower IP address,
227     you must first update the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on all of your cell's client machines.
228     For more details, see <link linkend="HDRWQ114">Installing Database Server Functionality</link>.</para>
229   </sect1>
230
231   <sect1 id="Header_32">
232     <title>Creating AFS Directories</title>
233
234     <indexterm>
235       <primary>usr/afs directory</primary>
236
237       <secondary>first AFS machine</secondary>
238     </indexterm>
239
240     <indexterm>
241       <primary>first AFS machine</primary>
242
243       <secondary>/usr/afs directory</secondary>
244     </indexterm>
245
246     <indexterm>
247       <primary>creating</primary>
248
249       <secondary>/usr/afs directory</secondary>
250
251       <tertiary>first AFS machine</tertiary>
252     </indexterm>
253
254     <indexterm>
255       <primary>usr/vice/etc directory</primary>
256
257       <secondary>first AFS machine</secondary>
258     </indexterm>
259
260     <indexterm>
261       <primary>first AFS machine</primary>
262
263       <secondary>/usr/vice/etc directory</secondary>
264     </indexterm>
265
266     <indexterm>
267       <primary>creating</primary>
268
269       <secondary>/usr/vice/etc directory</secondary>
270
271       <tertiary>first AFS machine</tertiary>
272     </indexterm>
273
274     <indexterm>
275       <primary>/ as start to file and directory names</primary>
276
277       <secondary>see alphabetized entries without initial slash</secondary>
278     </indexterm>
279
280     <para>If you are installing from packages (such as Debian .deb or 
281     Fedora/SuSe .rpm files), you should now install all of the available 
282     OpenAFS packages for your system type. Typically, these will include 
283     packages for client and server functionality, and a seperate package 
284     containing a suitable kernel module for your running kernel. Consult 
285     the package lists on the OpenAFS website to determine the packages 
286     appropriate for your system.</para>
287
288     <para>If you are installing from a tarfile, or from a locally compiled 
289     source tree you should create the <emphasis role="bold">/usr/afs</emphasis>
290     and <emphasis role="bold">/usr/vice/etc</emphasis> directories on the
291     local disk, to house server and client files respectively. Subsequent 
292     instructions copy files from the distribution tarfile into them. </para>
293 <programlisting>
294    # <emphasis role="bold">mkdir /usr/afs</emphasis>
295    # <emphasis role="bold">mkdir /usr/vice</emphasis>
296    # <emphasis role="bold">mkdir /usr/vice/etc</emphasis>
297 </programlisting>
298   </sect1>
299
300   <sect1 id="HDRWQ20">
301     <title>Performing Platform-Specific Procedures</title>
302
303     <para>Several of the initial procedures for installing a file server machine differ for each system type. For convenience, the
304     following sections group them together for each system type: <itemizedlist>
305         <indexterm>
306           <primary>kernel extensions</primary>
307
308           <see>AFS kernel extensions</see>
309         </indexterm>
310
311         <indexterm>
312           <primary>loading AFS kernel extensions</primary>
313
314           <see>incorporating</see>
315         </indexterm>
316
317         <indexterm>
318           <primary>building</primary>
319
320           <secondary>AFS extensions into kernel</secondary>
321
322           <see>incorporating AFS kernel extensions</see>
323         </indexterm>
324
325         <listitem>
326           <para>Incorporate AFS modifications into the kernel.</para>
327
328           <para>The kernel on every AFS client machine and, on some systems, 
329           the AFS fileservers, must incorporate AFS extensions. On machines 
330           that use a dynamic kernel module loader, it is conventional to 
331           alter the machine's initialization script to load the AFS extensions
332           at each reboot. <indexterm>
333               <primary>AFS server partition</primary>
334
335               <secondary>mounted on /vicep directory</secondary>
336             </indexterm> <indexterm>
337               <primary>partition</primary>
338
339               <see>AFS server partition</see>
340             </indexterm> <indexterm>
341               <primary>logical volume</primary>
342
343               <see>AFS server partition</see>
344             </indexterm> <indexterm>
345               <primary>requirements</primary>
346
347               <secondary>AFS server partition name and location</secondary>
348             </indexterm> <indexterm>
349               <primary>naming conventions for AFS server partition</primary>
350             </indexterm> <indexterm>
351               <primary>vicep<emphasis>xx</emphasis> directory</primary>
352
353               <see>AFS server partition</see>
354             </indexterm> <indexterm>
355               <primary>directories</primary>
356
357               <secondary>/vicep<emphasis>xx</emphasis></secondary>
358
359               <see>AFS server partition</see>
360             </indexterm></para>
361         </listitem>
362
363         <listitem>
364           <para>Configure server partitions or logical volumes to house AFS volumes.</para>
365
366           <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes
367           (for convenience, the documentation hereafter refers to partitions only). Each server partition is mounted at a directory
368           named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where <replaceable>xx</replaceable> is one or
369           two lowercase letters. By convention, the first 26 partitions are mounted on the directories called <emphasis
370           role="bold">/vicepa</emphasis> through <emphasis role="bold">/vicepz</emphasis>, the 27th one is mounted on the <emphasis
371           role="bold">/vicepaa</emphasis> directory, and so on through <emphasis role="bold">/vicepaz</emphasis> and <emphasis
372           role="bold">/vicepba</emphasis>, continuing up to the index corresponding to the maximum number of server partitions
373           supported in the current version of AFS (which is specified in the <emphasis>OpenAFS Release Notes</emphasis>).</para>
374
375           <para>The <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server
376           machine's root directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is
377           not an acceptable directory location).</para>
378
379           <para>You can also add or remove server partitions on an existing file server machine. For instructions, see the chapter
380           in the <emphasis>OpenAFS Administration Guide</emphasis> about maintaining server machines.</para>
381
382           <note>
383             <para>Not all file system types supported by an operating system are necessarily supported as AFS server partitions. For
384             possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
385           </note>
386         </listitem>
387
388         <listitem>
389           <para>On some system types, install and configure a modified <emphasis role="bold">fsck</emphasis> program which
390           recognizes the structures that the File Server uses to organize volume data on AFS server partitions. The <emphasis
391           role="bold">fsck</emphasis> program provided with the operating system does not understand the AFS data structures, and so
392           removes them to the <emphasis role="bold">lost+found</emphasis> directory.</para>
393         </listitem>
394
395         <listitem>
396           <para>If the machine is to remain an AFS client machine, modify the machine's authentication system so that users obtain
397           an AFS token as they log into the local file system. Using AFS is simpler and more convenient for your users if you make
398           the modifications on all client machines. Otherwise, users must perform a two or three step login procedure (login to the local
399           system, then obtain Kerberos credentials, and then issue the <emphasis role="bold">aklog</emphasis> command). For further discussion of AFS
400           authentication, see the chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and
401           administration issues.</para>
402         </listitem>
403       </itemizedlist></para>
404
405     <para>To continue, proceed to the appropriate section: <itemizedlist>
406         <listitem>
407           <para><link linkend="HDRWQ21">Getting Started on AIX Systems</link></para>
408         </listitem>
409
410         <listitem>
411           <para><link linkend="HDRWQ31">Getting Started on HP-UX Systems</link></para>
412         </listitem>
413
414         <listitem>
415           <para><link linkend="HDRWQ36">Getting Started on IRIX Systems</link></para>
416         </listitem>
417
418         <listitem>
419           <para><link linkend="HDRWQ41">Getting Started on Linux Systems</link></para>
420         </listitem>
421
422         <listitem>
423           <para><link linkend="HDRWQ45">Getting Started on Solaris Systems</link></para>
424         </listitem>
425       </itemizedlist></para>
426   </sect1>
427
428   <sect1 id="HDRWQ21">
429     <title>Getting Started on AIX Systems</title>
430
431     <para>Begin by running the AFS initialization script to call the AIX kernel extension facility, which dynamically loads AFS
432     modifications into the kernel. Then use the <emphasis role="bold">SMIT</emphasis> program to configure partitions for storing
433     AFS volumes, and replace the AIX <emphasis role="bold">fsck</emphasis> program helper with a version that correctly handles AFS
434     volumes. If the machine is to remain an AFS client machine, incorporate AFS into the AIX secondary authentication system.
435     <indexterm>
436         <primary>incorporating AFS kernel extensions</primary>
437
438         <secondary>first AFS machine</secondary>
439
440         <tertiary>AIX</tertiary>
441       </indexterm> <indexterm>
442         <primary>AFS kernel extensions</primary>
443
444         <secondary>on first AFS machine</secondary>
445
446         <tertiary>AIX</tertiary>
447       </indexterm> <indexterm>
448         <primary>first AFS machine</primary>
449
450         <secondary>AFS kernel extensions</secondary>
451
452         <tertiary>on AIX</tertiary>
453       </indexterm> <indexterm>
454         <primary>AIX</primary>
455
456         <secondary>AFS kernel extensions</secondary>
457
458         <tertiary>on first AFS machine</tertiary>
459       </indexterm></para>
460
461     <sect2 id="HDRWQ22">
462       <title>Loading AFS into the AIX Kernel</title>
463
464       <para>The AIX kernel extension facility is the dynamic kernel loader
465       provided by IBM Corporation.  AIX does not support incorporation of
466       AFS modifications during a kernel build.</para>
467
468       <para>For AFS to function correctly, the kernel extension facility must run each time the machine reboots, so the AFS
469       initialization script (included in the AFS distribution) invokes it automatically. In this section you copy the script to the
470       conventional location and edit it to select the appropriate options depending on whether NFS is also to run.</para>
471
472       <para>After editing the script, you run it to incorporate AFS into the kernel. In later sections you verify that the script
473       correctly initializes all AFS components, then configure the AIX <emphasis role="bold">inittab</emphasis> file so that the
474       script runs automatically at reboot. <orderedlist>
475           <listitem>
476             <para>Unpack the distribution tarball. The examples below assume 
477             that you have unpacked the files into the 
478             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
479             pick a different location, substitute this in all of the following 
480             examples. Once you have unpacked the distribution, 
481             change directory as indicated.
482 <programlisting>
483    # <emphasis role="bold">cd /tmp/afsdist/rs_aix42/root.client/usr/vice/etc</emphasis>
484 </programlisting></para>
485           </listitem>
486
487           <listitem>
488             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/dkload</emphasis> directory,
489             and the AFS initialization script to the <emphasis role="bold">/etc</emphasis> directory. <programlisting>
490    # <emphasis role="bold">cp -rp  dkload  /usr/vice/etc</emphasis>
491    # <emphasis role="bold">cp -p  rc.afs  /etc/rc.afs</emphasis>
492 </programlisting></para>
493           </listitem>
494
495           <listitem>
496             <para>Edit the <emphasis role="bold">/etc/rc.afs</emphasis> script, setting the <computeroutput>NFS</computeroutput>
497             variable as indicated.</para>
498
499             <para>If the machine is not to function as an NFS/AFS Translator, set the <computeroutput>NFS</computeroutput> variable
500             as follows.</para>
501
502             <programlisting>
503    NFS=$NFS_NONE
504 </programlisting>
505
506             <para>If the machine is to function as an NFS/AFS Translator and is running AIX 4.2.1 or higher, set the
507             <computeroutput>NFS</computeroutput> variable as follows. Note that NFS must already be loaded into the kernel, which
508             happens automatically on systems running AIX 4.1.1 and later, as long as the file <emphasis
509             role="bold">/etc/exports</emphasis> exists.</para>
510
511             <programlisting>
512    NFS=$NFS_IAUTH
513 </programlisting>
514           </listitem>
515
516           <listitem>
517             <para>Invoke the <emphasis role="bold">/etc/rc.afs</emphasis> script to load AFS modifications into the kernel. You can
518             ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS client.
519             <programlisting>
520    # <emphasis role="bold">/etc/rc.afs</emphasis>
521 </programlisting></para>
522           </listitem>
523         </orderedlist></para>
524
525       <indexterm>
526         <primary>configuring</primary>
527
528         <secondary>AFS server partition on first AFS machine</secondary>
529
530         <tertiary>AIX</tertiary>
531       </indexterm>
532
533       <indexterm>
534         <primary>AFS server partition</primary>
535
536         <secondary>configuring on first AFS machine</secondary>
537
538         <tertiary>AIX</tertiary>
539       </indexterm>
540
541       <indexterm>
542         <primary>first AFS machine</primary>
543
544         <secondary>AFS server partition</secondary>
545
546         <tertiary>on AIX</tertiary>
547       </indexterm>
548
549       <indexterm>
550         <primary>AIX</primary>
551
552         <secondary>AFS server partition</secondary>
553
554         <tertiary>on first AFS machine</tertiary>
555       </indexterm>
556     </sect2>
557
558     <sect2 id="HDRWQ23">
559       <title>Configuring Server Partitions on AIX Systems</title>
560
561       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
562       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
563       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
564       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
565       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
566       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific
567       Procedures</link>.</para>
568
569       <para>To configure server partitions on an AIX system, perform the following procedures: <orderedlist>
570           <listitem>
571             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
572             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
573    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
574 </programlisting></para>
575           </listitem>
576
577           <listitem>
578             <para>Use the <emphasis role="bold">SMIT</emphasis> program to create a journaling file system on each partition to be
579             configured as an AFS server partition.</para>
580           </listitem>
581
582           <listitem>
583             <para>Mount each partition at one of the <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>
584             directories. Choose one of the following three methods: <itemizedlist>
585                 <listitem>
586                   <para>Use the <emphasis role="bold">SMIT</emphasis> program</para>
587                 </listitem>
588
589                 <listitem>
590                   <para>Use the <emphasis role="bold">mount -a</emphasis> command to mount all partitions at once</para>
591                 </listitem>
592
593                 <listitem>
594                   <para>Use the <emphasis role="bold">mount</emphasis> command on each partition in turn</para>
595                 </listitem>
596               </itemizedlist></para>
597
598             <para>Also configure the partitions so that they are mounted automatically at each reboot. For more information, refer
599             to the AIX documentation.</para>
600           </listitem>
601         </orderedlist></para>
602
603       <indexterm>
604         <primary>replacing fsck program</primary>
605
606         <secondary>first AFS machine</secondary>
607
608         <tertiary>AIX</tertiary>
609       </indexterm>
610
611       <indexterm>
612         <primary>fsck program</primary>
613
614         <secondary>on first AFS machine</secondary>
615
616         <tertiary>AIX</tertiary>
617       </indexterm>
618
619       <indexterm>
620         <primary>first AFS machine</primary>
621
622         <secondary>fsck program</secondary>
623
624         <tertiary>on AIX</tertiary>
625       </indexterm>
626
627       <indexterm>
628         <primary>AIX</primary>
629
630         <secondary>fsck program</secondary>
631
632         <tertiary>on first AFS machine</tertiary>
633       </indexterm>
634     </sect2>
635
636     <sect2 id="HDRWQ24">
637       <title>Replacing the fsck Program Helper on AIX Systems</title>
638
639       <note><para>The AFS modified fsck program is not required on AIX 5.1 
640       systems, and the <emphasis role="bold">v3fshelper</emphasis> program
641       refered to below is not shipped for these systems.</para></note>
642       
643       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
644       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
645       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
646       it removes all of the data. To repeat:</para>
647
648       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS
649       volumes.</emphasis></para>
650
651       <para>On AIX systems, you do not replace the <emphasis role="bold">fsck</emphasis> binary itself, but rather the
652       <emphasis>program helper</emphasis> file included in the AIX distribution as <emphasis
653       role="bold">/sbin/helpers/v3fshelper</emphasis>. <orderedlist>
654           <listitem>
655             <para>Move the AIX <emphasis role="bold">fsck</emphasis> program helper to a safe location and install the version from
656             the AFS distribution in its place. 
657 <programlisting>
658    # <emphasis role="bold">cd /sbin/helpers</emphasis>
659    # <emphasis role="bold">mv v3fshelper v3fshelper.noafs</emphasis>
660    # <emphasis role="bold">cp -p /tmp/afsdist/rs_aix42/root.server/etc/v3fshelper v3fshelper</emphasis>
661 </programlisting></para>
662           </listitem>
663
664           <listitem>
665             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
666             linkend="HDRWQ25">Enabling AFS Login on AIX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
667             BOS Server</link>.</para>
668           </listitem>
669         </orderedlist></para>
670
671       <indexterm>
672         <primary>enabling AFS login</primary>
673
674         <secondary>file server machine</secondary>
675
676         <tertiary>AIX</tertiary>
677       </indexterm>
678
679       <indexterm>
680         <primary>AFS login</primary>
681
682         <secondary>on file server machine</secondary>
683
684         <tertiary>AIX</tertiary>
685       </indexterm>
686
687       <indexterm>
688         <primary>first AFS machine</primary>
689
690         <secondary>AFS login</secondary>
691
692         <tertiary>on AIX</tertiary>
693       </indexterm>
694
695       <indexterm>
696         <primary>AIX</primary>
697
698         <secondary>AFS login</secondary>
699
700         <tertiary>on file server machine</tertiary>
701       </indexterm>
702
703       <indexterm>
704         <primary>secondary authentication system (AIX)</primary>
705
706         <secondary>server machine</secondary>
707       </indexterm>
708     </sect2>
709
710     <sect2 id="HDRWQ25">
711       <title>Enabling AFS Login on AIX Systems</title>
712
713       <note>
714         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
715         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
716       </note>
717
718       <para>In modern AFS installations, you should be using Kerberos v5
719       for user login, and obtaining AFS tokens following this authentication
720       step.</para>
721       
722       <para>There are currently no instructions available on configuring AIX to
723       automatically obtain AFS tokens at login. Following login, users can 
724       obtain tokens by running the <emphasis role="bold">aklog</emphasis> 
725       command</para>
726      
727       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
728       or external Kerberos v4 authentication should consult 
729       <link linkend="KAS012">Enabling kaserver based AFS login on AIX systems</link>
730       for details of how to enable AIX login.</para>
731       
732       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link> 
733       (or if referring to these instructions while installing an additional 
734       file server machine, return to <link linkend="HDRWQ108">Starting Server
735       Programs</link>).</para>
736     </sect2>
737   </sect1>
738
739   <sect1 id="HDRWQ31">
740     <title>Getting Started on HP-UX Systems</title>
741
742     <para>Begin by building AFS modifications into a new kernel; HP-UX
743     does not support dynamic loading. Then create partitions for storing
744     AFS volumes, and install and configure the AFS-modified <emphasis
745     role="bold">fsck</emphasis> program to run on AFS server
746     partitions. If the machine is to remain an AFS client machine,
747     incorporate AFS into the machine's Pluggable Authentication Module
748     (PAM) scheme. <indexterm>
749         <primary>incorporating AFS kernel extensions</primary>
750
751         <secondary>first AFS machine</secondary>
752
753         <tertiary>HP-UX</tertiary>
754       </indexterm> <indexterm>
755         <primary>AFS kernel extensions</primary>
756
757         <secondary>on first AFS machine</secondary>
758
759         <tertiary>HP-UX</tertiary>
760       </indexterm> <indexterm>
761         <primary>first AFS machine</primary>
762
763         <secondary>AFS kernel extensions</secondary>
764
765         <tertiary>on HP-UX</tertiary>
766       </indexterm> <indexterm>
767         <primary>HP-UX</primary>
768
769         <secondary>AFS-modified kernel</secondary>
770
771         <tertiary>on first AFS machine</tertiary>
772       </indexterm></para>
773
774     <sect2 id="HDRWQ32">
775       <title>Building AFS into the HP-UX Kernel</title>
776
777       <para>Use the following instructions to build AFS modifications into the kernel on an HP-UX system. <orderedlist>
778           <listitem>
779             <para>Move the existing kernel-related files to a safe location. <programlisting>
780    # <emphasis role="bold">cp /stand/vmunix /stand/vmunix.noafs</emphasis>
781    # <emphasis role="bold">cp /stand/system /stand/system.noafs</emphasis>
782 </programlisting></para>
783           </listitem>
784
785           <listitem>
786             <para>Unpack the OpenAFS HP-UX distribution tarball. The examples 
787             below assume that you have unpacked the files into the 
788             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
789             pick a different location, substitute this in all of the following 
790             examples. Once you have unpacked the distribution, change directory 
791             as indicated.
792             <programlisting>
793    # <emphasis role="bold">cd /tmp/afsdist/hp_ux110/root.client</emphasis>
794 </programlisting></para>
795           </listitem>
796
797           <listitem>
798             <para>Copy the AFS initialization file to the local directory for initialization files (by convention, <emphasis
799             role="bold">/sbin/init.d</emphasis> on HP-UX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
800             extension as you copy the file. <programlisting>
801    # <emphasis role="bold">cp usr/vice/etc/afs.rc  /sbin/init.d/afs</emphasis>
802 </programlisting></para>
803           </listitem>
804
805           <listitem>
806             <para>Copy the file <emphasis role="bold">afs.driver</emphasis> to the local <emphasis
807             role="bold">/usr/conf/master.d</emphasis> directory, changing its name to <emphasis role="bold">afs</emphasis> as you
808             do. <programlisting>
809    # <emphasis role="bold">cp  usr/vice/etc/afs.driver  /usr/conf/master.d/afs</emphasis>
810 </programlisting></para>
811           </listitem>
812
813           <listitem>
814             <para>Copy the AFS kernel module to the local <emphasis role="bold">/usr/conf/lib</emphasis> directory.</para>
815
816             <para>If the machine's kernel supports NFS server functionality:</para>
817
818             <programlisting>
819    # <emphasis role="bold">cp bin/libafs.a /usr/conf/lib</emphasis>   
820 </programlisting>
821
822             <para>If the machine's kernel does not support NFS server functionality, change the file's name as you copy it:</para>
823
824             <programlisting>
825    # <emphasis role="bold">cp bin/libafs.nonfs.a /usr/conf/lib/libafs.a</emphasis>
826 </programlisting>
827           </listitem>
828
829           <listitem>
830             <para>Incorporate the AFS driver into the kernel, either using the <emphasis role="bold">SAM</emphasis> program or a
831             series of individual commands. <itemizedlist>
832                 <listitem>
833                   <para>To use the <emphasis role="bold">SAM</emphasis> program: <orderedlist>
834                       <listitem>
835                         <para>Invoke the <emphasis role="bold">SAM</emphasis> program, specifying the hostname of the local machine
836                         as <replaceable>local_hostname</replaceable>. The <emphasis role="bold">SAM</emphasis> graphical user
837                         interface pops up. <programlisting>
838    # <emphasis role="bold">sam -display</emphasis> <replaceable>local_hostname</replaceable><emphasis role="bold">:0</emphasis> 
839 </programlisting></para>
840                       </listitem>
841
842                       <listitem>
843                         <para>Choose the <emphasis role="bold">Kernel Configuration</emphasis> icon, then the <emphasis
844                         role="bold">Drivers</emphasis> icon. From the list of drivers, select <emphasis
845                         role="bold">afs</emphasis>.</para>
846                       </listitem>
847
848                       <listitem>
849                         <para>Open the pull-down <emphasis role="bold">Actions</emphasis> menu and choose the <emphasis
850                         role="bold">Add Driver to Kernel</emphasis> option.</para>
851                       </listitem>
852
853                       <listitem>
854                         <para>Open the <emphasis role="bold">Actions</emphasis> menu again and choose the <emphasis
855                         role="bold">Create a New Kernel</emphasis> option.</para>
856                       </listitem>
857
858                       <listitem>
859                         <para>Confirm your choices by choosing <emphasis role="bold">Yes</emphasis> and <emphasis
860                         role="bold">OK</emphasis> when prompted by subsequent pop-up windows. The <emphasis
861                         role="bold">SAM</emphasis> program builds the kernel and reboots the system.</para>
862                       </listitem>
863
864                       <listitem>
865                         <para>Login again as the superuser <emphasis role="bold">root</emphasis>. <programlisting>
866    login: <emphasis role="bold">root</emphasis>
867    Password: <replaceable>root_password</replaceable>
868 </programlisting></para>
869                       </listitem>
870                     </orderedlist></para>
871                 </listitem>
872
873                 <listitem>
874                   <para>To use individual commands: <orderedlist>
875                       <listitem>
876                         <para>Edit the file <emphasis role="bold">/stand/system</emphasis>, adding an entry for <emphasis
877                         role="bold">afs</emphasis> to the <computeroutput>Subsystems</computeroutput> section.</para>
878                       </listitem>
879
880                       <listitem>
881                         <para>Change to the <emphasis role="bold">/stand/build</emphasis> directory and issue the <emphasis
882                         role="bold">mk_kernel</emphasis> command to build the kernel. <programlisting>
883    # <emphasis role="bold">cd /stand/build</emphasis>
884    # <emphasis role="bold">mk_kernel</emphasis>
885 </programlisting></para>
886                       </listitem>
887
888                       <listitem>
889                         <para>Move the new kernel to the standard location (<emphasis role="bold">/stand/vmunix</emphasis>), reboot
890                         the machine to start using it, and login again as the superuser <emphasis role="bold">root</emphasis>.
891                         <programlisting>
892    # <emphasis role="bold">mv /stand/build/vmunix_test /stand/vmunix</emphasis>
893    # <emphasis role="bold">cd /</emphasis>
894    # <emphasis role="bold">shutdown -r now</emphasis>             
895    login: <emphasis role="bold">root</emphasis>
896    Password: <replaceable>root_password</replaceable>
897 </programlisting></para>
898                       </listitem>
899                     </orderedlist></para>
900                 </listitem>
901               </itemizedlist></para>
902           </listitem>
903         </orderedlist></para>
904
905       <indexterm>
906         <primary>configuring</primary>
907
908         <secondary>AFS server partition on first AFS machine</secondary>
909
910         <tertiary>HP-UX</tertiary>
911       </indexterm>
912
913       <indexterm>
914         <primary>AFS server partition</primary>
915
916         <secondary>configuring on first AFS machine</secondary>
917
918         <tertiary>HP-UX</tertiary>
919       </indexterm>
920
921       <indexterm>
922         <primary>first AFS machine</primary>
923
924         <secondary>AFS server partition</secondary>
925
926         <tertiary>on HP-UX</tertiary>
927       </indexterm>
928
929       <indexterm>
930         <primary>HP-UX</primary>
931
932         <secondary>AFS server partition</secondary>
933
934         <tertiary>on first AFS machine</tertiary>
935       </indexterm>
936     </sect2>
937
938     <sect2 id="HDRWQ33">
939       <title>Configuring Server Partitions on HP-UX Systems</title>
940
941       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
942       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
943       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
944       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
945       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
946       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
947       <orderedlist>
948           <listitem>
949             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
950             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
951    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
952 </programlisting></para>
953           </listitem>
954
955           <listitem>
956             <para>Use the <emphasis role="bold">SAM</emphasis> program to create a file system on each partition. For instructions,
957             consult the HP-UX documentation.</para>
958           </listitem>
959
960           <listitem>
961             <para>On some HP-UX systems that use logical volumes, the <emphasis role="bold">SAM</emphasis> program automatically
962             mounts the partitions. If it has not, mount each partition by issuing either the <emphasis role="bold">mount
963             -a</emphasis> command to mount all partitions at once or the <emphasis role="bold">mount</emphasis> command to mount
964             each partition in turn.</para>
965           </listitem>
966         </orderedlist></para>
967
968       <indexterm>
969         <primary>replacing fsck program</primary>
970
971         <secondary>first AFS machine</secondary>
972
973         <tertiary>HP-UX</tertiary>
974       </indexterm>
975
976       <indexterm>
977         <primary>fsck program</primary>
978
979         <secondary>on first AFS machine</secondary>
980
981         <tertiary>HP-UX</tertiary>
982       </indexterm>
983
984       <indexterm>
985         <primary>first AFS machine</primary>
986
987         <secondary>fsck program</secondary>
988
989         <tertiary>on HP-UX</tertiary>
990       </indexterm>
991
992       <indexterm>
993         <primary>HP-UX</primary>
994
995         <secondary>fsck program</secondary>
996
997         <tertiary>on first AFS machine</tertiary>
998       </indexterm>
999     </sect2>
1000
1001     <sect2 id="HDRWQ34">
1002       <title>Configuring the AFS-modified fsck Program on HP-UX Systems</title>
1003
1004       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
1005       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
1006       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
1007       it removes all of the data. To repeat:</para>
1008
1009       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS
1010       volumes.</emphasis></para>
1011
1012       <para>On HP-UX systems, there are several configuration files to install in addition to the AFS-modified <emphasis
1013       role="bold">fsck</emphasis> program (the <emphasis role="bold">vfsck</emphasis> binary). <orderedlist>
1014           <listitem>
1015             <para>Create the command configuration file <emphasis role="bold">/sbin/lib/mfsconfig.d/afs</emphasis>. Use a text
1016             editor to place the indicated two lines in it: <programlisting>
1017    format_revision 1
1018    fsck            0        m,P,p,d,f,b:c:y,n,Y,N,q,
1019 </programlisting></para>
1020           </listitem>
1021
1022           <listitem>
1023             <para>Create and change directory to an AFS-specific command directory called <emphasis
1024             role="bold">/sbin/fs/afs</emphasis>. <programlisting>
1025    # <emphasis role="bold">mkdir /sbin/fs/afs</emphasis>
1026    # <emphasis role="bold">cd  /sbin/fs/afs</emphasis>
1027 </programlisting></para>
1028           </listitem>
1029
1030           <listitem>
1031             <para>Copy the AFS-modified version of the <emphasis role="bold">fsck</emphasis> program (the <emphasis
1032             role="bold">vfsck</emphasis> binary) and related files from the distribution directory to the new AFS-specific command
1033             directory. <programlisting>
1034    # <emphasis role="bold">cp -p /tmp/afsdist/hp_ux110/root.server/etc/*  .</emphasis>
1035 </programlisting></para>
1036           </listitem>
1037
1038           <listitem>
1039             <para>Change the <emphasis role="bold">vfsck</emphasis> binary's name to <emphasis role="bold">fsck</emphasis> and set
1040             the mode bits appropriately on all of the files in the <emphasis role="bold">/sbin/fs/afs</emphasis> directory.
1041             <programlisting>
1042    # <emphasis role="bold">mv  vfsck  fsck</emphasis>
1043    # <emphasis role="bold">chmod  755  *</emphasis>
1044 </programlisting></para>
1045           </listitem>
1046
1047           <listitem>
1048             <para>Edit the <emphasis role="bold">/etc/fstab</emphasis> file, changing the file system type for each AFS server
1049             partition from <computeroutput>hfs</computeroutput> to <computeroutput>afs</computeroutput>. This ensures that the
1050             AFS-modified <emphasis role="bold">fsck</emphasis> program runs on the appropriate partitions.</para>
1051
1052             <para>The sixth line in the following example of an edited file shows an AFS server partition, <emphasis
1053             role="bold">/vicepa</emphasis>.</para>
1054
1055             <programlisting>
1056    /dev/vg00/lvol1 / hfs defaults 0 1
1057    /dev/vg00/lvol4 /opt hfs defaults 0 2
1058    /dev/vg00/lvol5 /tmp hfs defaults 0 2
1059    /dev/vg00/lvol6 /usr hfs defaults 0 2
1060    /dev/vg00/lvol8 /var hfs defaults 0 2
1061    /dev/vg00/lvol9 /vicepa afs defaults 0 2
1062    /dev/vg00/lvol7 /usr/vice/cache hfs defaults 0 2
1063 </programlisting>
1064           </listitem>
1065
1066           <listitem>
1067             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1068             linkend="HDRWQ35">Enabling AFS Login on HP-UX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1069             BOS Server</link>.</para>
1070           </listitem>
1071         </orderedlist></para>
1072
1073       <indexterm>
1074         <primary>enabling AFS login</primary>
1075
1076         <secondary>file server machine</secondary>
1077
1078         <tertiary>HP-UX</tertiary>
1079       </indexterm>
1080
1081       <indexterm>
1082         <primary>AFS login</primary>
1083
1084         <secondary>on file server machine</secondary>
1085
1086         <tertiary>HP-UX</tertiary>
1087       </indexterm>
1088
1089       <indexterm>
1090         <primary>first AFS machine</primary>
1091
1092         <secondary>AFS login</secondary>
1093
1094         <tertiary>on HP-UX</tertiary>
1095       </indexterm>
1096
1097       <indexterm>
1098         <primary>HP-UX</primary>
1099
1100         <secondary>AFS login</secondary>
1101
1102         <tertiary>on file server machine</tertiary>
1103       </indexterm>
1104
1105       <indexterm>
1106         <primary>PAM</primary>
1107
1108         <secondary>on HP-UX</secondary>
1109
1110         <tertiary>file server machine</tertiary>
1111       </indexterm>
1112
1113       <indexterm>
1114         <primary>Pluggable Authentication Module</primary>
1115
1116         <see>PAM</see>
1117       </indexterm>
1118     </sect2>
1119
1120     <sect2 id="HDRWQ35">
1121       <title>Enabling AFS Login on HP-UX Systems</title>
1122
1123       <note><para>If you plan to remove client functionality from this machine after completing the installation, skip this section and proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para></note>
1124
1125       <para>At this point you incorporate AFS into the operating system's
1126       Pluggable Authentication Module (PAM) scheme. PAM integrates all
1127       authentication mechanisms on the machine, including login, to
1128       provide the security infrastructure for authenticated access to and
1129       from the machine.</para>
1130
1131       <para>In modern AFS installations, you should be using Kerberos v5
1132       for user login, and obtaining AFS tokens subsequent to this
1133       authentication step. OpenAFS does not currently distribute a PAM
1134       module allowing AFS tokens to be automatically gained at
1135       login. Whilst there are a number of third party modules providing
1136       this functionality, it is not know if these have been tested with
1137       HP/UX.</para>
1138       
1139       <para>Following login, users can obtain tokens by running the
1140       <emphasis role="bold">aklog</emphasis> command</para>
1141
1142       <para>Sites which still require <emphasis
1143       role="bold">kaserver</emphasis> or external Kerberos v4
1144       authentication should consult <link linkend="KAS013">Enabling
1145       kaserver based AFS login on HP-UX systems</link> for details of how
1146       to enable HP-UX login.</para>
1147
1148       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
1149       Server</link> (or if referring to these instructions while
1150       installing an additional file server machine, return to <link
1151       linkend="HDRWQ108">Starting Server Programs</link>).</para>
1152     </sect2>
1153   </sect1>
1154
1155   <sect1 id="HDRWQ36">
1156     <title>Getting Started on IRIX Systems</title>
1157
1158     <indexterm>
1159       <primary>incorporating AFS kernel extensions</primary>
1160
1161       <secondary>first AFS machine</secondary>
1162
1163       <tertiary>IRIX</tertiary>
1164     </indexterm>
1165
1166     <indexterm>
1167       <primary>AFS kernel extensions</primary>
1168
1169       <secondary>on first AFS machine</secondary>
1170
1171       <tertiary>IRIX</tertiary>
1172     </indexterm>
1173
1174     <indexterm>
1175       <primary>first AFS machine</primary>
1176
1177       <secondary>AFS kernel extensions</secondary>
1178
1179       <tertiary>on IRIX</tertiary>
1180     </indexterm>
1181
1182     <indexterm>
1183       <primary>replacing fsck program</primary>
1184
1185       <secondary>not necessary on IRIX</secondary>
1186     </indexterm>
1187
1188     <indexterm>
1189       <primary>fsck program</primary>
1190
1191       <secondary>on first AFS machine</secondary>
1192
1193       <tertiary>IRIX</tertiary>
1194     </indexterm>
1195
1196     <indexterm>
1197       <primary>first AFS machine</primary>
1198
1199       <secondary>fsck program</secondary>
1200
1201       <tertiary>on IRIX</tertiary>
1202     </indexterm>
1203
1204     <indexterm>
1205       <primary>IRIX</primary>
1206
1207       <secondary>fsck program replacement not necessary</secondary>
1208     </indexterm>
1209
1210     <para>To incorporate AFS into the kernel on IRIX systems, choose one of two methods: <itemizedlist>
1211         <listitem>
1212           <para>Run the AFS initialization script to invoke the <emphasis role="bold">ml</emphasis> program distributed by Silicon
1213           Graphics, Incorporated (SGI), which dynamically loads AFS modifications into the kernel</para>
1214         </listitem>
1215
1216         <listitem>
1217           <para>Build a new static kernel</para>
1218         </listitem>
1219       </itemizedlist></para>
1220
1221     <para>Then create partitions for storing AFS volumes. You do not need to replace the IRIX <emphasis role="bold">fsck</emphasis>
1222     program because SGI has already modified it to handle AFS volumes properly. If the machine is to remain an AFS client machine,
1223     verify that the IRIX login utility installed on the machine grants an AFS token.</para>
1224
1225     <para>In preparation for either dynamic loading or kernel building, perform the following procedures: <orderedlist>
1226         <listitem>
1227           <para>Unpack the OpenAFS IRIX distribution tarball. The examples
1228           below assume that you have unpacked the files into the 
1229           <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
1230           pick a different location, substitue this in all of the following
1231           examples. Once you have unpacked the distribution, change directory
1232           as indicated.
1233 <programlisting>
1234    # <emphasis role="bold">cd  /tmp/afsdist/sgi_65/root.client</emphasis>
1235 </programlisting></para>
1236         </listitem>
1237
1238         <listitem>
1239           <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1240           role="bold">/etc/init.d</emphasis> on IRIX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1241           extension as you copy the script. <programlisting>
1242    # <emphasis role="bold">cp -p   usr/vice/etc/afs.rc  /etc/init.d/afs</emphasis>
1243 </programlisting></para>
1244         </listitem>
1245
1246         <listitem>
1247           <para>Issue the <emphasis role="bold">uname -m</emphasis> command to determine the machine's CPU board type. The <emphasis
1248           role="bold">IP</emphasis><replaceable>xx</replaceable> value in the output must match one of the supported CPU board types
1249           listed in the <emphasis>OpenAFS Release Notes</emphasis> for the current version of AFS. <programlisting>
1250    # <emphasis role="bold">uname -m</emphasis>
1251 </programlisting></para>
1252         </listitem>
1253
1254         <listitem>
1255           <para>Proceed to either <link linkend="HDRWQ37">Loading AFS into the IRIX Kernel</link> or <link
1256           linkend="HDRWQ38">Building AFS into the IRIX Kernel</link>.</para>
1257         </listitem>
1258       </orderedlist></para>
1259
1260     <indexterm>
1261       <primary>IRIX</primary>
1262
1263       <secondary>AFS kernel extensions</secondary>
1264
1265       <tertiary>on first AFS machine</tertiary>
1266     </indexterm>
1267
1268     <indexterm>
1269       <primary>afsml variable (IRIX)</primary>
1270
1271       <secondary>first AFS machine</secondary>
1272     </indexterm>
1273
1274     <indexterm>
1275       <primary>variables</primary>
1276
1277       <secondary>afsml (IRIX)</secondary>
1278
1279       <tertiary>first AFS machine</tertiary>
1280     </indexterm>
1281
1282     <indexterm>
1283       <primary>IRIX</primary>
1284
1285       <secondary>afsml variable</secondary>
1286
1287       <tertiary>first AFS machine</tertiary>
1288     </indexterm>
1289
1290     <indexterm>
1291       <primary>afsxnfs variable (IRIX)</primary>
1292
1293       <secondary>first AFS machine</secondary>
1294     </indexterm>
1295
1296     <indexterm>
1297       <primary>variables</primary>
1298
1299       <secondary>afsxnfs (IRIX)</secondary>
1300
1301       <tertiary>first AFS machine</tertiary>
1302     </indexterm>
1303
1304     <indexterm>
1305       <primary>IRIX</primary>
1306
1307       <secondary>afsxnfs variable</secondary>
1308
1309       <tertiary>first AFS machine</tertiary>
1310     </indexterm>
1311
1312     <sect2 id="HDRWQ37">
1313       <title>Loading AFS into the IRIX Kernel</title>
1314
1315       <para>The <emphasis role="bold">ml</emphasis> program is the dynamic kernel loader provided by SGI for IRIX systems. If you
1316       use it rather than building AFS modifications into a static kernel, then for AFS to function correctly the <emphasis
1317       role="bold">ml</emphasis> program must run each time the machine reboots. Therefore, the AFS initialization script (included
1318       on the AFS CD-ROM) invokes it automatically when the <emphasis role="bold">afsml</emphasis> configuration variable is
1319       activated. In this section you activate the variable and run the script.</para>
1320
1321       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
1322       incorporate AFS into the IRIX startup and shutdown sequence. <orderedlist>
1323           <listitem>
1324             <para>Create the local <emphasis role="bold">/usr/vice/etc/sgiload</emphasis> directory to house the AFS kernel library
1325             file. <programlisting>
1326    # <emphasis role="bold">mkdir /usr/vice/etc/sgiload</emphasis>
1327 </programlisting></para>
1328           </listitem>
1329
1330           <listitem>
1331             <para>Copy the appropriate AFS kernel library file to the <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
1332             directory. The <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable> portion of the library file name must
1333             match the value previously returned by the <emphasis role="bold">uname -m</emphasis> command. Also choose the file
1334             appropriate to whether the machine's kernel supports NFS server functionality (NFS must be supported for the machine to
1335             act as an NFS/AFS Translator). Single- and multiprocessor machines use the same library file.</para>
1336
1337             <para>(You can choose to copy all of the kernel library files into the <emphasis
1338             role="bold">/usr/vice/etc/sgiload</emphasis> directory, but they require a significant amount of space.)</para>
1339
1340             <para>If the machine's kernel supports NFS server functionality:</para>
1341
1342             <programlisting>
1343    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.o  /usr/vice/etc/sgiload</emphasis>   
1344 </programlisting>
1345
1346             <para>If the machine's kernel does not support NFS server functionality:</para>
1347
1348             <programlisting>
1349    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.o</emphasis>   \
1350                    <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
1351 </programlisting>
1352           </listitem>
1353
1354           <listitem>
1355             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
1356             role="bold">afsml</emphasis> configuration variable. <programlisting>
1357    # <emphasis role="bold">/etc/chkconfig -f afsml on</emphasis>   
1358 </programlisting></para>
1359
1360             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1361             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1362
1363             <programlisting>
1364    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1365 </programlisting>
1366           </listitem>
1367
1368           <listitem>
1369             <para>Run the <emphasis role="bold">/etc/init.d/afs</emphasis> script to load AFS extensions into the kernel. The script
1370             invokes the <emphasis role="bold">ml</emphasis> command, automatically determining which kernel library file to use
1371             based on this machine's CPU type and the activation state of the <emphasis role="bold">afsxnfs</emphasis>
1372             variable.</para>
1373
1374             <para>You can ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS
1375             client.</para>
1376
1377             <programlisting>
1378    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
1379 </programlisting>
1380           </listitem>
1381
1382           <listitem>
1383             <para>Proceed to <link linkend="HDRWQ39">Configuring Server Partitions on IRIX Systems</link>.</para>
1384           </listitem>
1385         </orderedlist></para>
1386
1387       <indexterm>
1388         <primary>IRIX</primary>
1389
1390         <secondary>AFS-modified kernel</secondary>
1391
1392         <tertiary>on first AFS machine</tertiary>
1393       </indexterm>
1394     </sect2>
1395
1396     <sect2 id="HDRWQ38">
1397       <title>Building AFS into the IRIX Kernel</title>
1398
1399       <para>Use the following instructions to build AFS modifications into the kernel on an IRIX system. <orderedlist>
1400           <listitem>
1401             <para>Copy the kernel initialization file <emphasis role="bold">afs.sm</emphasis> to the local <emphasis
1402             role="bold">/var/sysgen/system</emphasis> directory, and the kernel master file <emphasis role="bold">afs</emphasis> to
1403             the local <emphasis role="bold">/var/sysgen/master.d</emphasis> directory. <programlisting>
1404    # <emphasis role="bold">cp -p  bin/afs.sm  /var/sysgen/system</emphasis>
1405    # <emphasis role="bold">cp -p  bin/afs  /var/sysgen/master.d</emphasis>
1406 </programlisting></para>
1407           </listitem>
1408
1409           <listitem>
1410             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
1411             role="bold">/var/sysgen/boot/afs.a</emphasis>; the <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable>
1412             portion of the library file name must match the value previously returned by the <emphasis role="bold">uname
1413             -m</emphasis> command. Also choose the file appropriate to whether the machine's kernel supports NFS server
1414             functionality (NFS must be supported for the machine to act as an NFS/AFS Translator). Single- and multiprocessor
1415             machines use the same library file.</para>
1416
1417             <para>If the machine's kernel supports NFS server functionality:</para>
1418
1419             <programlisting>
1420    # <emphasis role="bold">cp -p   bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.a   /var/sysgen/boot/afs.a</emphasis>   
1421 </programlisting>
1422
1423             <para>If the machine's kernel does not support NFS server functionality:</para>
1424
1425             <programlisting>
1426    # <emphasis role="bold">cp -p  bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.a  /var/sysgen/boot/afs.a</emphasis>
1427 </programlisting>
1428           </listitem>
1429
1430           <listitem>
1431             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
1432             role="bold">afsml</emphasis> configuration variable. <programlisting>
1433    # <emphasis role="bold">/etc/chkconfig -f afsml off</emphasis>   
1434 </programlisting></para>
1435
1436             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1437             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1438
1439             <programlisting>
1440    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1441 </programlisting>
1442           </listitem>
1443
1444           <listitem>
1445             <para>Copy the existing kernel file, <emphasis role="bold">/unix</emphasis>, to a safe location. Compile the new kernel,
1446             which is created in the file <emphasis role="bold">/unix.install</emphasis>. It overwrites the existing <emphasis
1447             role="bold">/unix</emphasis> file when the machine reboots in the next step. <programlisting>
1448    # <emphasis role="bold">cp /unix /unix_noafs</emphasis>
1449    # <emphasis role="bold">autoconfig</emphasis>
1450 </programlisting></para>
1451           </listitem>
1452
1453           <listitem>
1454             <para>Reboot the machine to start using the new kernel, and login again as the superuser <emphasis
1455             role="bold">root</emphasis>. <programlisting>
1456    # <emphasis role="bold">cd /</emphasis>
1457    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
1458    login: <emphasis role="bold">root</emphasis>
1459    Password: <replaceable>root_password</replaceable>
1460 </programlisting></para>
1461           </listitem>
1462         </orderedlist></para>
1463
1464       <indexterm>
1465         <primary>configuring</primary>
1466
1467         <secondary>AFS server partition on first AFS machine</secondary>
1468
1469         <tertiary>IRIX</tertiary>
1470       </indexterm>
1471
1472       <indexterm>
1473         <primary>AFS server partition</primary>
1474
1475         <secondary>configuring on first AFS machine</secondary>
1476
1477         <tertiary>IRIX</tertiary>
1478       </indexterm>
1479
1480       <indexterm>
1481         <primary>first AFS machine</primary>
1482
1483         <secondary>AFS server partition</secondary>
1484
1485         <tertiary>on IRIX</tertiary>
1486       </indexterm>
1487
1488       <indexterm>
1489         <primary>IRIX</primary>
1490
1491         <secondary>AFS server partition</secondary>
1492
1493         <tertiary>on first AFS machine</tertiary>
1494       </indexterm>
1495     </sect2>
1496
1497     <sect2 id="HDRWQ39">
1498       <title>Configuring Server Partitions on IRIX Systems</title>
1499
1500       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1501       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1502       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1503       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1504       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1505       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific
1506       Procedures</link>.</para>
1507
1508       <para>AFS supports use of both EFS and XFS partitions for housing AFS volumes. SGI encourages use of XFS partitions.
1509       <orderedlist>
1510           <listitem>
1511             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1512             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1513    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1514 </programlisting></para>
1515           </listitem>
1516
1517           <listitem>
1518             <para>Add a line with the following format to the file systems registry file, <emphasis
1519             role="bold">/etc/fstab</emphasis>, for each partition (or logical volume created with the XLV volume manager) to be
1520             mounted on one of the directories created in the previous step.</para>
1521
1522             <para>For an XFS partition or logical volume:</para>
1523
1524             <programlisting>
1525    /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  xfs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0   
1526 </programlisting>
1527
1528             <para>For an EFS partition:</para>
1529
1530             <programlisting>
1531    /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  efs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0   
1532 </programlisting>
1533
1534             <para>The following are examples of an entry for each file system type:</para>
1535
1536             <programlisting>
1537    /dev/dsk/dks0d2s6 /vicepa  xfs rw,raw=/dev/rdsk/dks0d2s6  0 0
1538    /dev/dsk/dks0d3s1 /vicepb  efs rw,raw=/dev/rdsk/dks0d3s1  0 0
1539 </programlisting>
1540           </listitem>
1541
1542           <listitem>
1543             <para>Create a file system on each partition that is to be mounted on a <emphasis
1544             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following commands are probably appropriate,
1545             but consult the IRIX documentation for more information. In both cases, <replaceable>raw_device</replaceable> is a raw
1546             device name like <emphasis role="bold">/dev/rdsk/dks0d0s0</emphasis> for a single disk partition or <emphasis
1547             role="bold">/dev/rxlv/xlv0</emphasis> for a logical volume.</para>
1548
1549             <para>For XFS file systems, include the indicated options to configure the partition or logical volume with inodes large
1550             enough to accommodate AFS-specific information:</para>
1551
1552             <programlisting>
1553    # <emphasis role="bold">mkfs -t xfs -i size=512 -l size=4000b</emphasis> <replaceable>raw_device</replaceable>   
1554 </programlisting>
1555
1556             <para>For EFS file systems:</para>
1557
1558             <programlisting>
1559    # <emphasis role="bold">mkfs -t efs</emphasis> <replaceable>raw_device</replaceable>
1560 </programlisting>
1561           </listitem>
1562
1563           <listitem>
1564             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1565             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1566           </listitem>
1567
1568           <listitem>
1569             <para><emphasis role="bold">(Optional)</emphasis> If you have configured partitions or logical volumes to use XFS, issue
1570             the following command to verify that the inodes are configured properly (are large enough to accommodate AFS-specific
1571             information). If the configuration is correct, the command returns no output. Otherwise, it specifies the command to run
1572             in order to configure each partition or logical volume properly. <programlisting>
1573    # <emphasis role="bold">/usr/afs/bin/xfs_size_check</emphasis>
1574 </programlisting></para>
1575           </listitem>
1576
1577           <listitem>
1578             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1579             linkend="HDRWQ40">Enabling AFS Login on IRIX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1580             BOS Server</link>.</para>
1581           </listitem>
1582         </orderedlist></para>
1583
1584       <indexterm>
1585         <primary>enabling AFS login</primary>
1586
1587         <secondary>file server machine</secondary>
1588
1589         <tertiary>IRIX</tertiary>
1590       </indexterm>
1591
1592       <indexterm>
1593         <primary>AFS login</primary>
1594
1595         <secondary>on file server machine</secondary>
1596
1597         <tertiary>IRIX</tertiary>
1598       </indexterm>
1599
1600       <indexterm>
1601         <primary>first AFS machine</primary>
1602
1603         <secondary>AFS login</secondary>
1604
1605         <tertiary>on IRIX</tertiary>
1606       </indexterm>
1607
1608       <indexterm>
1609         <primary>IRIX</primary>
1610
1611         <secondary>AFS login</secondary>
1612       </indexterm>
1613     </sect2>
1614
1615     <sect2 id="HDRWQ40">
1616       <title>Enabling AFS Login on IRIX Systems</title>
1617
1618       <note>
1619         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
1620         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1621       </note>
1622
1623       <para>Whilst the standard IRIX command-line 
1624       <emphasis role="bold">login</emphasis> program and the 
1625       graphical <emphasis role="bold">xdm</emphasis> login program both have
1626       the ability to grant AFS tokens, this ability relies upon the deprecated
1627       kaserver authentication system.</para>
1628         
1629       <para>Users who have been successfully authenticated via Kerberos 5
1630       authentication may obtain AFS tokens following login by running the
1631       <emphasis role="bold">aklog</emphasis> command.</para>
1632
1633       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
1634       or external Kerberos v4 authentication should consult 
1635       <link linkend="KAS014">Enabling kaserver based AFS Login on IRIX Systems</link>
1636       for details of how to enable IRIX login.</para>       
1637
1638       <para>After taking any necessary action, proceed to 
1639       <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1640     </sect2>
1641   </sect1>
1642
1643   <sect1 id="HDRWQ41">
1644     <title>Getting Started on Linux Systems</title>
1645
1646     <indexterm>
1647       <primary>replacing fsck program</primary>
1648
1649       <secondary>not necessary on Linux</secondary>
1650     </indexterm>
1651
1652     <indexterm>
1653       <primary>fsck program</primary>
1654
1655       <secondary>on first AFS machine</secondary>
1656
1657       <tertiary>Linux</tertiary>
1658     </indexterm>
1659
1660     <indexterm>
1661       <primary>first AFS machine</primary>
1662
1663       <secondary>fsck program</secondary>
1664
1665       <tertiary>on Linux</tertiary>
1666     </indexterm>
1667
1668     <indexterm>
1669       <primary>Linux</primary>
1670
1671       <secondary>fsck program replacement not necessary</secondary>
1672     </indexterm>
1673
1674     <para>Since this guide was originally written, the procedure for starting 
1675     OpenAFS has diverged significantly between different Linux distributions. 
1676     The instructions that follow are appropriate for both the Fedora and 
1677     RedHat Enterprise Linux packages distributed by OpenAFS. Additional 
1678     instructions are provided for those building from source.</para>
1679
1680     <para>Begin by running the AFS client startup scripts, which call the
1681     <emphasis role="bold">modprobe</emphasis> program, which dynamically
1682     loads AFS modifications into the kernel. Then create partitions for
1683     storing AFS volumes. You do not need to replace the Linux <emphasis
1684     role="bold">fsck</emphasis> program. If the machine is to remain an
1685     AFS client machine, incorporate AFS into the machine's Pluggable
1686     Authentication Module (PAM) scheme. <indexterm>
1687         <primary>incorporating AFS kernel extensions</primary>
1688
1689         <secondary>first AFS machine</secondary>
1690
1691         <tertiary>Linux</tertiary>
1692       </indexterm> <indexterm>
1693         <primary>AFS kernel extensions</primary>
1694
1695         <secondary>on first AFS machine</secondary>
1696
1697         <tertiary>Linux</tertiary>
1698       </indexterm> <indexterm>
1699         <primary>first AFS machine</primary>
1700
1701         <secondary>AFS kernel extensions</secondary>
1702
1703         <tertiary>on Linux</tertiary>
1704       </indexterm> <indexterm>
1705         <primary>Linux</primary>
1706
1707         <secondary>AFS kernel extensions</secondary>
1708
1709         <tertiary>on first AFS machine</tertiary>
1710       </indexterm></para>
1711
1712     <sect2 id="HDRWQ42">
1713       <title>Loading AFS into the Linux Kernel</title>
1714
1715       <para>The <emphasis role="bold">modprobe</emphasis> program is the dynamic kernel loader for Linux. Linux does not support
1716       incorporation of AFS modifications during a kernel build.</para>
1717
1718       <para>For AFS to function correctly, the <emphasis role="bold">modprobe</emphasis> program must run each time the machine
1719       reboots, so your distribution's AFS initialization script invokes it automatically. The script also includes
1720       commands that select the appropriate AFS library file automatically. In this section you run the script.</para>
1721
1722       <para>In later sections you verify that the script correctly initializes all AFS components, then activate a configuration
1723       variable, which results in the script being incorporated into the Linux startup and shutdown sequence.</para> 
1724       
1725       <para>The procedure for starting up OpenAFS depends upon your distribution</para>
1726       <sect3>
1727         <title>Fedora and RedHat Enterprise Linux</title>
1728         <para>OpenAFS ship RPMS for all current Fedora and RHEL releases.
1729         <orderedlist>
1730           <listitem>
1731             <para>Download and install the RPM set for your operating system.
1732             RPMs are available from the OpenAFS web site. You will need the 
1733             <emphasis role="bold">openafs</emphasis>
1734             <emphasis role="bold">openafs-client></emphasis>
1735             <emphasis role="bold">openafs-server</emphasis> packages, along with
1736             an <emphasis role="bold">openafs-kernel</emphasis> package matching
1737             your current, running, kernel.</para>
1738             <para>You can find the version of your current kernel by running
1739 <programlisting>
1740   # uname -r
1741 <replaceable>2.6.20-1.2933.fc6</replaceable>
1742 </programlisting></para>
1743             <para>Once downloaded, the packages may be installed with the
1744             <emphasis role="bold">rpm</emphasis> command
1745 <programlisting>
1746   # rpm -U openafs-* openafs-client-* openafs-server-* openafs-kernel-*
1747 </programlisting></para>
1748           </listitem>
1749 <!-- If you do this with current RHEL and Fedora releases you end up with
1750      a dynroot'd client running - this breaks setting up the root.afs volume
1751      as described later in this guide
1752           <listitem>
1753             <para>Run the AFS initialization script to load AFS extensions into 
1754             the kernel. You can ignore any error messages about the inability 
1755             to start the BOS Server or the Cache Manager or AFS client.</para>
1756 <programlisting>
1757    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
1758 </programlisting>
1759           </listitem>
1760 -->
1761         </orderedlist>
1762       </para>
1763       </sect3>
1764       <sect3>
1765          <title>Systems packaged as tar files</title>
1766          <para>If you are running a system where the OpenAFS Binary Distribution
1767          is provided as a tar file, or where you have built the system from
1768          source yourself, you need to install the relevant components by hand
1769          </para>
1770          <orderedlist>
1771            
1772           <listitem>
1773             <para>Unpack the distribution tarball. The examples below assume
1774             that you have unpacked the files into the
1775             <emphasis role="bold">/tmp/afsdist</emphasis>directory. If you
1776             pick a different location, substitute this in all of the following
1777             examples. Once you have unpacked the distribution,
1778             change directory as indicated.
1779 <programlisting>
1780   # <emphasis role="bold">cd /tmp/afsdist/linux/root.client/usr/vice/etc</emphasis>
1781 </programlisting></para>
1782           </listitem>
1783           
1784           <listitem>
1785             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/modload</emphasis> directory.
1786             The filenames for the libraries have the format <emphasis
1787             role="bold">libafs-</emphasis><replaceable>version</replaceable><emphasis role="bold">.o</emphasis>, where
1788             <replaceable>version</replaceable> indicates the kernel build level. The string <emphasis role="bold">.mp</emphasis> in
1789             the <replaceable>version</replaceable> indicates that the file is appropriate for machines running a multiprocessor
1790             kernel. <programlisting>
1791    # <emphasis role="bold">cp -rp  modload  /usr/vice/etc</emphasis>
1792 </programlisting></para>
1793           </listitem>
1794
1795           <listitem>
1796             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1797             role="bold">/etc/rc.d/init.d</emphasis> on Linux machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1798             extension as you copy the script. <programlisting>
1799    # <emphasis role="bold">cp -p   afs.rc  /etc/rc.d/init.d/afs</emphasis> 
1800 </programlisting></para>
1801           </listitem>
1802
1803 <!-- I don't think we need to do this for Linux, and it complicates things if
1804      dynroot is enabled ...
1805           <listitem>
1806             <para>Run the AFS initialization script to load AFS extensions into the kernel. You can ignore any error messages about
1807             the inability to start the BOS Server or the Cache Manager or AFS client.</para>
1808 <programlisting>
1809    # <emphasis role="bold">/etc/rc.d/init.d/afs start</emphasis>
1810 </programlisting>
1811           </listitem>
1812 -->
1813         </orderedlist>
1814
1815       <indexterm>
1816         <primary>configuring</primary>
1817    
1818         <secondary>AFS server partition on first AFS machine</secondary>
1819
1820         <tertiary>Linux</tertiary>
1821       </indexterm>
1822
1823       <indexterm>
1824         <primary>AFS server partition</primary>
1825
1826         <secondary>configuring on first AFS machine</secondary>
1827
1828         <tertiary>Linux</tertiary>
1829       </indexterm>
1830
1831       <indexterm>
1832         <primary>first AFS machine</primary>
1833
1834         <secondary>AFS server partition</secondary>
1835
1836         <tertiary>on Linux</tertiary>
1837       </indexterm>
1838
1839       <indexterm>
1840         <primary>Linux</primary>
1841
1842         <secondary>AFS server partition</secondary>
1843
1844         <tertiary>on first AFS machine</tertiary>
1845       </indexterm>
1846     </sect3>
1847     </sect2>
1848
1849     <sect2 id="HDRWQ43">
1850       <title>Configuring Server Partitions on Linux Systems</title>
1851
1852       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1853       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1854       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1855       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1856       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1857       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
1858       <orderedlist>
1859           <listitem>
1860             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1861             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1862    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1863 </programlisting></para>
1864           </listitem>
1865
1866           <listitem>
1867             <para>Add a line with the following format to the file systems registry file, <emphasis
1868             role="bold">/etc/fstab</emphasis>, for each directory just created. The entry maps the directory name to the disk
1869             partition to be mounted on it. <programlisting>
1870    /dev/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  ext2  defaults  0  2   
1871 </programlisting></para>
1872
1873             <para>The following is an example for the first partition being configured.</para>
1874
1875             <programlisting>
1876    /dev/sda8 /vicepa ext2 defaults 0 2
1877 </programlisting>
1878           </listitem>
1879
1880           <listitem>
1881             <para>Create a file system on each partition that is to be mounted at a <emphasis
1882             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
1883             consult the Linux documentation for more information. <programlisting>
1884    # <emphasis role="bold">mkfs -v /dev/</emphasis><replaceable>disk</replaceable>
1885 </programlisting></para>
1886           </listitem>
1887
1888           <listitem>
1889             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1890             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1891           </listitem>
1892
1893           <listitem>
1894             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1895             linkend="HDRWQ44">Enabling AFS Login on Linux Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1896             BOS Server</link>.</para>
1897           </listitem>
1898         </orderedlist></para>
1899
1900       <indexterm>
1901         <primary>enabling AFS login</primary>
1902
1903         <secondary>file server machine</secondary>
1904
1905         <tertiary>Linux</tertiary>
1906       </indexterm>
1907
1908       <indexterm>
1909         <primary>AFS login</primary>
1910
1911         <secondary>on file server machine</secondary>
1912
1913         <tertiary>Linux</tertiary>
1914       </indexterm>
1915
1916       <indexterm>
1917         <primary>first AFS machine</primary>
1918
1919         <secondary>AFS login</secondary>
1920
1921         <tertiary>on Linux</tertiary>
1922       </indexterm>
1923
1924       <indexterm>
1925         <primary>Linux</primary>
1926
1927         <secondary>AFS login</secondary>
1928
1929         <tertiary>on file server machine</tertiary>
1930       </indexterm>
1931
1932       <indexterm>
1933         <primary>PAM</primary>
1934
1935         <secondary>on Linux</secondary>
1936
1937         <tertiary>file server machine</tertiary>
1938       </indexterm>
1939     </sect2>
1940
1941     <sect2 id="HDRWQ44">
1942       <title>Enabling AFS Login on Linux Systems</title>
1943
1944       <note>
1945         <para>If you plan to remove client functionality from this machine
1946         after completing the installation, skip this section and proceed
1947         to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1948       </note>
1949
1950       <para>At this point you incorporate AFS into the operating system's
1951       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
1952       authentication mechanisms on the machine, including login, to provide
1953       the security infrastructure for authenticated access to and from the
1954       machine.</para>
1955
1956       <para>You should first configure your system to obtain Kerberos v5
1957       tickets as part of the authentication process, and then run an AFS PAM
1958       module to obtain tokens from those tickets after authentication.  Many
1959       Linux distributions come with a Kerberos v5 PAM module (usually called
1960       pam-krb5 or pam_krb5), or you can download and install <ulink
1961       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
1962       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
1963       See the instructions of whatever PAM module you use for how to
1964       configure it.</para>
1965
1966       <para>Some Kerberos v5 PAM modules do come with native AFS support
1967       (usually requiring the Heimdal Kerberos implementation rather than the
1968       MIT Kerberos implementation).  If you are using one of those PAM
1969       modules, you can configure it to obtain AFS tokens.  It's more common,
1970       however, to separate the AFS token acquisition into a separate PAM
1971       module.</para>
1972
1973       <para>The recommended AFS PAM module is <ulink
1974       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
1975       Allbery's pam-afs-session module</ulink>.  It should work with any of
1976       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
1977       often only need to add configuration to the session group:</para>
1978
1979       <example>
1980         <title>Linux PAM session example</title>
1981         <literallayout>session  required  pam_afs_session.so</literallayout>
1982       </example>
1983
1984       <para>If you also want to obtain AFS tokens for <command>scp</command>
1985       and similar commands that don't open a session, you will also need to
1986       add the AFS PAM module to the auth group so that the PAM
1987       <function>setcred</function> call will obtain tokens.  The
1988       <literal>pam_afs_session</literal> module will always return success
1989       for authentication so that it can be added to the auth group only for
1990       <function>setcred</function>, so make sure that it's not marked as
1991       <literal>sufficient</literal>.</para>
1992
1993       <example>
1994         <title>Linux PAM auth example</title>
1995 <literallayout>auth  [success=ok default=1]  pam_krb5.so
1996 auth  [default=done]          pam_afs_session.so
1997 auth  required                pam_unix.so try_first_pass</literallayout>
1998       </example>
1999
2000       <para>This example will work if you want to try Kerberos v5 first and
2001       then fall back to regular Unix authentication.
2002       <literal>success=ok</literal> for the Kerberos PAM module followed by
2003       <literal>default=done</literal> for the AFS PAM module will cause a
2004       successful Kerberos login to run the AFS PAM module and then skip the
2005       Unix authentication module.  <literal>default=1</literal> on the
2006       Kerberos PAM module causes failure of that module to skip the next
2007       module (the AFS PAM module) and fall back to the Unix module.  If you
2008       want to try Unix authentication first and rearrange the order, be sure
2009       to use <literal>default=die</literal> instead.</para>
2010
2011       <para>The PAM configuration is stored in different places in different
2012       Linux distributions.  On Red Hat, look in
2013       <filename>/etc/pam.d/system-auth</filename>.  On Debian and
2014       derivatives, look in <filename>/etc/pam.d/common-session</filename>
2015       and <filename>/etc/pam.d/common-auth</filename>.</para>
2016
2017       <para>For additional configuration examples and the configuration
2018       options of the AFS PAM module, see its documentation.  For more
2019       details on the available options for the PAM configuration, see the
2020       Linux PAM documentation.</para>
2021
2022       <para>Sites which still require <command>kaserver</command> or
2023       external Kerberos v4 authentication should consult <link
2024       linkend="KAS015">Enabling kaserver based AFS Login on Linux
2025       Systems</link> for details of how to enable AFS login on Linux.</para>
2026       
2027       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
2028       Server</link> (or if referring to these instructions while installing
2029       an additional file server machine, return to <link
2030       linkend="HDRWQ108">Starting Server Programs</link>).</para>
2031     </sect2>
2032   </sect1>
2033
2034   <sect1 id="HDRWQ45">
2035     <title>Getting Started on Solaris Systems</title>
2036
2037     <para>Begin by running the AFS initialization script to call the <emphasis role="bold">modload</emphasis> program distributed by
2038     Sun Microsystems, which dynamically loads AFS modifications into the kernel. Then create partitions for storing AFS volumes, and
2039     install and configure the AFS-modified <emphasis role="bold">fsck</emphasis> program to run on AFS server partitions. If the
2040     machine is to remain an AFS client machine, incorporate AFS into the machine's Pluggable Authentication Module (PAM) scheme.
2041     <indexterm>
2042         <primary>incorporating AFS kernel extensions</primary>
2043
2044         <secondary>first AFS machine</secondary>
2045
2046         <tertiary>Solaris</tertiary>
2047       </indexterm> <indexterm>
2048         <primary>AFS kernel extensions</primary>
2049
2050         <secondary>on first AFS machine</secondary>
2051
2052         <tertiary>Solaris</tertiary>
2053       </indexterm> <indexterm>
2054         <primary>first AFS machine</primary>
2055
2056         <secondary>AFS kernel extensions</secondary>
2057
2058         <tertiary>on Solaris</tertiary>
2059       </indexterm> <indexterm>
2060         <primary>Solaris</primary>
2061
2062         <secondary>AFS kernel extensions</secondary>
2063
2064         <tertiary>on first AFS machine</tertiary>
2065       </indexterm></para>
2066
2067     <sect2 id="HDRWQ46">
2068       <title>Loading AFS into the Solaris Kernel</title>
2069
2070       <para>The <emphasis role="bold">modload</emphasis> program is the dynamic kernel loader provided by Sun Microsystems for
2071       Solaris systems. Solaris does not support incorporation of AFS modifications during a kernel build.</para>
2072
2073       <para>For AFS to function correctly, the <emphasis role="bold">modload</emphasis> program must run each time the machine
2074       reboots, so the AFS initialization script (included on the AFS CD-ROM) invokes it automatically. In this section you copy the
2075       appropriate AFS library file to the location where the <emphasis role="bold">modload</emphasis> program accesses it and then
2076       run the script.</para>
2077
2078       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
2079       incorporate AFS into the Solaris startup and shutdown sequence. <orderedlist>
2080           <listitem>
2081             <para>Unpack the OpenAFS Solaris distribution tarball. The examples
2082             below assume that you have unpacked the files into the 
2083             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
2084             pick a diferent location, substitute this in all of the following
2085             exmaples. Once you have unpacked the distribution, change directory
2086             as indicated. 
2087 <programlisting>
2088    # <emphasis role="bold">cd  /tmp/afsdist/sun4x_56/root.client/usr/vice/etc</emphasis>
2089 </programlisting></para>
2090           </listitem>
2091
2092           <listitem>
2093             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
2094             role="bold">/etc/init.d</emphasis> on Solaris machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
2095             extension as you copy the script. <programlisting>
2096    # <emphasis role="bold">cp -p  afs.rc  /etc/init.d/afs</emphasis>
2097 </programlisting></para>
2098           </listitem>
2099
2100           <listitem>
2101             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
2102             role="bold">/kernel/fs/afs</emphasis>.</para>
2103
2104             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, its kernel supports NFS server
2105             functionality, and the <emphasis role="bold">nfsd</emphasis> process is running:</para>
2106
2107             <programlisting>
2108    # <emphasis role="bold">cp -p modload/libafs.o /kernel/fs/afs</emphasis>   
2109 </programlisting>
2110
2111             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, and its kernel does not support NFS
2112             server functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2113
2114             <programlisting>
2115    # <emphasis role="bold">cp -p modload/libafs.nonfs.o /kernel/fs/afs</emphasis>   
2116 </programlisting>
2117
2118             <para>If the machine is running the 64-bit version of Solaris 7, its kernel supports NFS server functionality, and the
2119             <emphasis role="bold">nfsd</emphasis> process is running:</para>
2120
2121             <programlisting>
2122    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/sparcv9/afs</emphasis>   
2123 </programlisting>
2124
2125             <para>If the machine is running the 64-bit version of Solaris 7, and its kernel does not support NFS server
2126             functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2127
2128             <programlisting>
2129    # <emphasis role="bold">cp -p modload/libafs64.nonfs.o /kernel/fs/sparcv9/afs</emphasis>
2130 </programlisting>
2131           </listitem>
2132
2133           <listitem>
2134             <para>Run the AFS initialization script to load AFS modifications into the kernel. You can ignore any error messages
2135             about the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
2136    # <emphasis role="bold">/etc/init.d/afs start</emphasis>   
2137 </programlisting></para>
2138
2139             <para>When an entry called <computeroutput>afs</computeroutput> does not already exist in the local <emphasis
2140             role="bold">/etc/name_to_sysnum</emphasis> file, the script automatically creates it and reboots the machine to start
2141             using the new version of the file. If this happens, log in again as the superuser <emphasis role="bold">root</emphasis>
2142             after the reboot and run the initialization script again. This time the required entry exists in the <emphasis
2143             role="bold">/etc/name_to_sysnum</emphasis> file, and the <emphasis role="bold">modload</emphasis> program runs.</para>
2144
2145             <programlisting>
2146    login: <emphasis role="bold">root</emphasis>
2147    Password: <replaceable>root_password</replaceable>
2148    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2149 </programlisting>
2150           </listitem>
2151         </orderedlist></para>
2152
2153       <indexterm>
2154         <primary>replacing fsck program</primary>
2155
2156         <secondary>first AFS machine</secondary>
2157
2158         <tertiary>Solaris</tertiary>
2159       </indexterm>
2160
2161       <indexterm>
2162         <primary>fsck program</primary>
2163
2164         <secondary>on first AFS machine</secondary>
2165
2166         <tertiary>Solaris</tertiary>
2167       </indexterm>
2168
2169       <indexterm>
2170         <primary>first AFS machine</primary>
2171
2172         <secondary>fsck program</secondary>
2173
2174         <tertiary>on Solaris</tertiary>
2175       </indexterm>
2176
2177       <indexterm>
2178         <primary>Solaris</primary>
2179
2180         <secondary>fsck program</secondary>
2181
2182         <tertiary>on first AFS machine</tertiary>
2183       </indexterm>
2184     </sect2>
2185
2186     <sect2 id="HDRWQ47">
2187       <title>Configuring the AFS-modified fsck Program on Solaris Systems</title>
2188
2189       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
2190       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
2191       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
2192       it removes all of the data. To repeat:</para>
2193
2194       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS volumes.</emphasis>
2195       <orderedlist>
2196           <listitem>
2197             <para>Create the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory to house the AFS-modified <emphasis
2198             role="bold">fsck</emphasis> program and related files. <programlisting>
2199    # <emphasis role="bold">mkdir /usr/lib/fs/afs</emphasis>
2200    # <emphasis role="bold">cd /usr/lib/fs/afs</emphasis>  
2201 </programlisting></para>
2202           </listitem>
2203
2204           <listitem>
2205             <para>Copy the <emphasis role="bold">vfsck</emphasis> binary to the newly created directory, changing the name as you do
2206             so. <programlisting>
2207    # <emphasis role="bold">cp  /tmp/afsdist/sun4x_56/root.server/etc/vfsck  fsck</emphasis>
2208 </programlisting></para>
2209           </listitem>
2210
2211           <listitem>
2212             <para>Working in the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory, create the following links to Solaris
2213             libraries: <programlisting>
2214    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/clri</emphasis>  
2215    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/df</emphasis>
2216    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/edquota</emphasis>
2217    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ff</emphasis>
2218    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsdb</emphasis>  
2219    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsirand</emphasis>
2220    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fstyp</emphasis>
2221    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/labelit</emphasis>
2222    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/lockfs</emphasis>
2223    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mkfs</emphasis>  
2224    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mount</emphasis>
2225    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ncheck</emphasis>
2226    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/newfs</emphasis>
2227    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quot</emphasis>
2228    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quota</emphasis>
2229    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaoff</emphasis>
2230    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaon</emphasis>
2231    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/repquota</emphasis>
2232    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/tunefs</emphasis>
2233    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsdump</emphasis>
2234    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsrestore</emphasis>
2235    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/volcopy</emphasis>
2236 </programlisting></para>
2237           </listitem>
2238
2239           <listitem>
2240             <para>Append the following line to the end of the file <emphasis role="bold">/etc/dfs/fstypes</emphasis>.
2241             <programlisting>
2242    afs AFS Utilities
2243 </programlisting></para>
2244           </listitem>
2245
2246           <listitem>
2247             <para>Edit the <emphasis role="bold">/sbin/mountall</emphasis> file, making two changes. <itemizedlist>
2248                 <listitem>
2249                   <para>Add an entry for AFS to the <computeroutput>case</computeroutput> statement for option 2, so that it reads
2250                   as follows: <programlisting>
2251    case "$2" in
2252    ufs)    foptions="-o p"
2253            ;;
2254    afs)    foptions="-o p"
2255            ;;
2256    s5)     foptions="-y -t /var/tmp/tmp$$ -D"
2257            ;;
2258    *)      foptions="-y"
2259            ;;
2260 </programlisting></para>
2261                 </listitem>
2262
2263                 <listitem>
2264                   <para>Edit the file so that all AFS and UFS partitions are checked in parallel. Replace the following section of
2265                   code: <programlisting>
2266    # For  fsck purposes, we make a distinction between ufs and
2267    # other file systems
2268    #
2269    if [ "$fstype" = "ufs" ]; then
2270         ufs_fscklist="$ufs_fscklist $fsckdev"
2271         saveentry $fstype "$OPTIONS" $special $mountp
2272         continue
2273    fi  
2274 </programlisting></para>
2275
2276                   <para>with the following section of code:</para>
2277
2278                   <programlisting>
2279    # For fsck purposes, we make a distinction between ufs/afs
2280    # and other file systems.
2281    #
2282    if [ "$fstype" = "ufs" -o "$fstype" = "afs" ]; then
2283         ufs_fscklist="$ufs_fscklist $fsckdev"
2284         saveentry $fstype "$OPTIONS" $special $mountp
2285         continue
2286    fi
2287 </programlisting>
2288                 </listitem>
2289               </itemizedlist></para>
2290           </listitem>
2291         </orderedlist></para>
2292
2293       <indexterm>
2294         <primary>configuring</primary>
2295
2296         <secondary>AFS server partition on first AFS machine</secondary>
2297
2298         <tertiary>Solaris</tertiary>
2299       </indexterm>
2300
2301       <indexterm>
2302         <primary>AFS server partition</primary>
2303
2304         <secondary>configuring on first AFS machine</secondary>
2305
2306         <tertiary>Solaris</tertiary>
2307       </indexterm>
2308
2309       <indexterm>
2310         <primary>first AFS machine</primary>
2311
2312         <secondary>AFS server partition</secondary>
2313
2314         <tertiary>on Solaris</tertiary>
2315       </indexterm>
2316
2317       <indexterm>
2318         <primary>Solaris</primary>
2319
2320         <secondary>AFS server partition</secondary>
2321
2322         <tertiary>on first AFS machine</tertiary>
2323       </indexterm>
2324     </sect2>
2325
2326     <sect2 id="HDRWQ48">
2327       <title>Configuring Server Partitions on Solaris Systems</title>
2328
2329       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
2330       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
2331       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
2332       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
2333       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
2334       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
2335       <orderedlist>
2336           <listitem>
2337             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
2338             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
2339    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
2340 </programlisting></para>
2341           </listitem>
2342
2343           <listitem>
2344             <para>Add a line with the following format to the file systems registry file, <emphasis
2345             role="bold">/etc/vfstab</emphasis>, for each partition to be mounted on a directory created in the previous step. Note
2346             the value <computeroutput>afs</computeroutput> in the fourth field, which tells Solaris to use the AFS-modified
2347             <emphasis role="bold">fsck</emphasis> program on this partition. <programlisting>
2348    /dev/dsk/<replaceable>disk</replaceable>   /dev/rdsk/<replaceable>disk</replaceable>   /vicep<replaceable>xx</replaceable>   afs   <replaceable>boot_order</replaceable>  yes  
2349 </programlisting></para>
2350
2351             <para>The following is an example for the first partition being configured.</para>
2352
2353             <programlisting>
2354    /dev/dsk/c0t6d0s1 /dev/rdsk/c0t6d0s1 /vicepa afs 3 yes
2355 </programlisting>
2356           </listitem>
2357
2358           <listitem>
2359             <para>Create a file system on each partition that is to be mounted at a <emphasis
2360             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
2361             consult the Solaris documentation for more information. <programlisting>
2362    # <emphasis role="bold">newfs -v /dev/rdsk/</emphasis><replaceable>disk</replaceable>
2363 </programlisting></para>
2364           </listitem>
2365
2366           <listitem>
2367             <para>Issue the <emphasis role="bold">mountall</emphasis> command to mount all partitions at once.</para>
2368           </listitem>
2369
2370           <listitem>
2371             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
2372             linkend="HDRWQ49">Enabling AFS Login and Editing the File Systems Clean-up Script on Solaris Systems</link>. Otherwise,
2373             proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2374           </listitem>
2375         </orderedlist></para>
2376     </sect2>
2377
2378     <sect2 id="HDRWQ49">
2379       <title>Enabling AFS Login on Solaris Systems</title>
2380       <indexterm>
2381         <primary>enabling AFS login</primary>
2382
2383         <secondary>file server machine</secondary>
2384
2385         <tertiary>Solaris</tertiary>
2386       </indexterm>
2387
2388       <indexterm>
2389         <primary>AFS login</primary>
2390
2391         <secondary>on file server machine</secondary>
2392
2393         <tertiary>Solaris</tertiary>
2394       </indexterm>
2395
2396       <indexterm>
2397         <primary>first AFS machine</primary>
2398
2399         <secondary>AFS login</secondary>
2400
2401         <tertiary>on Solaris</tertiary>
2402       </indexterm>
2403
2404       <indexterm>
2405         <primary>Solaris</primary>
2406
2407         <secondary>AFS login</secondary>
2408
2409         <tertiary>on file server machine</tertiary>
2410       </indexterm>
2411
2412       <indexterm>
2413         <primary>PAM</primary>
2414
2415         <secondary>on Solaris</secondary>
2416
2417         <tertiary>file server machine</tertiary>
2418       </indexterm>
2419
2420       <note>
2421         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
2422         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2423       </note>
2424
2425       <para>At this point you incorporate AFS into the operating system's
2426       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
2427       authentication mechanisms on the machine, including login, to provide
2428       the security infrastructure for authenticated access to and from the
2429       machine.</para>
2430
2431       <para>Explaining PAM is beyond the scope of this document.  It is
2432       assumed that you understand the syntax and meanings of settings in the
2433       PAM configuration file (for example, how the
2434       <computeroutput>other</computeroutput> entry works, the effect of
2435       marking an entry as <computeroutput>required</computeroutput>,
2436       <computeroutput>optional</computeroutput>, or
2437       <computeroutput>sufficient</computeroutput>, and so on).</para>
2438
2439       <para>You should first configure your system to obtain Kerberos v5
2440       tickets as part of the authentication process, and then run an AFS PAM
2441       module to obtain tokens from those tickets after authentication.
2442       Current versions of Solaris come with a Kerberos v5 PAM module that
2443       will work, or you can download and install <ulink
2444       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
2445       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
2446       See the instructions of whatever PAM module you use for how to
2447       configure it.</para>
2448
2449       <para>Some Kerberos v5 PAM modules do come with native AFS support
2450       (usually requiring the Heimdal Kerberos implementation rather than the
2451       MIT Kerberos implementation).  If you are using one of those PAM
2452       modules, you can configure it to obtain AFS tokens.  It's more common,
2453       however, to separate the AFS token acquisition into a separate PAM
2454       module.</para>
2455
2456       <para>The recommended AFS PAM module is <ulink
2457       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
2458       Allbery's pam-afs-session module</ulink>.  It should work with any of
2459       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
2460       often only need to add configuration to the session group in
2461       <filename>pam.conf</filename>:</para>
2462
2463       <example>
2464         <title>Solaris PAM session example</title>
2465         <literallayout>login session required pam_afs_session.so</literallayout>
2466       </example>
2467
2468       <para>This example enables PAM authentication only for console login.
2469       You may want to add a similar line for the ssh service and for any
2470       other login service that you use, including possibly the
2471       <literal>other</literal> service (which serves as a catch-all).  You
2472       may also want to add options to the AFS PAM session module
2473       (particularly <literal>retain_after_close</literal>, which is
2474       necessary for some versions of Solaris.</para>
2475
2476       <para>For additional configuration examples and the configuration
2477       options of the AFS PAM module, see its documentation.  For more
2478       details on the available options for the PAM configuration, see the
2479       <filename>pam.conf</filename> manual page.</para>
2480
2481       <para>Sites which still require <emphasis
2482       role="bold">kaserver</emphasis> or external Kerberos v4 authentication
2483       should consult <link linkend="KAS016">Enabling kaserver based AFS
2484       Login on Solaris Systems"</link> for details of how to enable AFS
2485       login on Solaris.</para>
2486
2487       <para>Proceed to <link linkend="HDRWQ49a">Editing the File Systems 
2488       Clean-up Script on Solaris Systems</link></para>
2489     </sect2>
2490     <sect2 id="HDRWQ49a">
2491       <title>Editing the File Systems Clean-up Script on Solaris Systems</title>
2492       <indexterm>
2493         <primary>Solaris</primary>
2494
2495         <secondary>file systems clean-up script</secondary>
2496
2497         <tertiary>on file server machine</tertiary>
2498       </indexterm>
2499
2500       <indexterm>
2501         <primary>file systems clean-up script (Solaris)</primary>
2502
2503         <secondary>file server machine</secondary>
2504       </indexterm>
2505
2506       <indexterm>
2507         <primary>scripts</primary>
2508
2509         <secondary>file systems clean-up (Solaris)</secondary>
2510
2511         <tertiary>file server machine</tertiary>
2512       </indexterm>
2513
2514       
2515         <orderedlist>
2516           <listitem>
2517             <para>Some Solaris distributions include a script that locates and removes unneeded files from various file systems. Its
2518             conventional location is <emphasis role="bold">/usr/lib/fs/nfs/nfsfind</emphasis>. The script generally uses an argument
2519             to the <emphasis role="bold">find</emphasis> command to define which file systems to search. In this step you modify the
2520             command to exclude the <emphasis role="bold">/afs</emphasis> directory. Otherwise, the command traverses the AFS
2521             filespace of every cell that is accessible from the machine, which can take many hours. The following alterations are
2522             possibilities, but you must verify that they are appropriate for your cell.</para>
2523
2524             <para>The first possible alteration is to add the <emphasis role="bold">-local</emphasis> flag to the existing command,
2525             so that it looks like the following:</para>
2526
2527             <programlisting>
2528    find $dir -local -name .nfs\* -mtime +7 -mount -exec rm -f {} \;   
2529 </programlisting>
2530
2531             <para>Another alternative is to exclude any directories whose names begin with the lowercase letter <emphasis
2532             role="bold">a</emphasis> or a non-alphabetic character.</para>
2533
2534             <programlisting>
2535    find /[A-Zb-z]*  <replaceable>remainder of existing command</replaceable>   
2536 </programlisting>
2537
2538             <para>Do not use the following command, which still searches under the <emphasis role="bold">/afs</emphasis> directory,
2539             looking for a subdirectory of type <emphasis role="bold">4.2</emphasis>.</para>
2540
2541             <programlisting>
2542    find / -fstype 4.2     /* <replaceable>do not use</replaceable> */
2543 </programlisting>
2544           </listitem>
2545
2546           <listitem>
2547             <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link> (or if referring to these instructions while
2548             installing an additional file server machine, return to <link linkend="HDRWQ108">Starting Server
2549             Programs</link>).</para>
2550           </listitem>
2551         </orderedlist>
2552
2553       <indexterm>
2554         <primary>Basic OverSeer Server</primary>
2555
2556         <see>BOS Server</see>
2557       </indexterm>
2558
2559       <indexterm>
2560         <primary>BOS Server</primary>
2561
2562         <secondary>starting</secondary>
2563
2564         <tertiary>first AFS machine</tertiary>
2565       </indexterm>
2566
2567       <indexterm>
2568         <primary>starting</primary>
2569
2570         <secondary>BOS Server</secondary>
2571
2572         <tertiary>first AFS machine</tertiary>
2573       </indexterm>
2574
2575       <indexterm>
2576         <primary>first AFS machine</primary>
2577
2578         <secondary>BOS Server</secondary>
2579       </indexterm>
2580
2581       <indexterm>
2582         <primary>authorization checking (disabling)</primary>
2583
2584         <secondary>first AFS machine</secondary>
2585       </indexterm>
2586
2587       <indexterm>
2588         <primary>disabling authorization checking</primary>
2589
2590         <secondary>first AFS machine</secondary>
2591       </indexterm>
2592
2593       <indexterm>
2594         <primary>first AFS machine</primary>
2595
2596         <secondary>authorization checking (disabling)</secondary>
2597       </indexterm>
2598     </sect2>
2599   </sect1>
2600   <sect1 id="HDRWQ50">
2601     <title>Starting the BOS Server</title>
2602
2603     <para>You are now ready to start the AFS server processes on this machine. 
2604     If you are not working from a packaged distribution, begin by copying the 
2605     AFS server binaries from the distribution to the conventional local disk
2606     location, the <emphasis role="bold">/usr/afs/bin</emphasis> directory. The 
2607     following instructions also create files in other subdirectories of the 
2608     <emphasis role="bold">/usr/afs</emphasis> directory.</para>
2609
2610     <para>Then issue the <emphasis role="bold">bosserver</emphasis> command to initialize the Basic OverSeer (BOS) Server, which
2611     monitors and controls other AFS server processes on its server machine. Include the <emphasis role="bold">-noauth</emphasis>
2612     flag to disable authorization checking. Because you have not yet configured your cell's AFS authentication and authorization
2613     mechanisms, the BOS Server cannot perform authorization checking as it does during normal operation. In no-authorization mode,
2614     it does not verify the identity or privilege of the issuer of a <emphasis role="bold">bos</emphasis> command, and so performs
2615     any operation for anyone.</para>
2616
2617     <para>Disabling authorization checking gravely compromises cell security. You must complete all subsequent steps in one
2618     uninterrupted pass and must not leave the machine unattended until you restart the BOS Server with authorization checking
2619     enabled, in <link linkend="HDRWQ72">Verifying the AFS Initialization Script</link>.</para>
2620
2621     <para>As it initializes for the first time, the BOS Server creates the following directories and files, setting the owner to the
2622     local superuser <emphasis role="bold">root</emphasis> and the mode bits to limit the ability to write (and in some cases, read)
2623     them. For a description of the contents and function of these directories and files, see the chapter in the <emphasis>OpenAFS
2624     Administration Guide</emphasis> about administering server machines. For further discussion of the mode bit settings, see <link
2625     linkend="HDRWQ96">Protecting Sensitive AFS Directories</link>. <indexterm>
2626         <primary>Binary Distribution</primary>
2627
2628         <secondary>copying server files from</secondary>
2629
2630         <tertiary>first AFS machine</tertiary>
2631       </indexterm> <indexterm>
2632         <primary>first AFS machine</primary>
2633
2634         <secondary>subdirectories of /usr/afs</secondary>
2635       </indexterm> <indexterm>
2636         <primary>creating</primary>
2637
2638         <secondary>/usr/afs/bin directory</secondary>
2639
2640         <tertiary>first AFS machine</tertiary>
2641       </indexterm> <indexterm>
2642         <primary>creating</primary>
2643
2644         <secondary>/usr/afs/etc directory</secondary>
2645
2646         <tertiary>first AFS machine</tertiary>
2647       </indexterm> <indexterm>
2648         <primary>copying</primary>
2649
2650         <secondary>server files to local disk</secondary>
2651
2652         <tertiary>first AFS machine</tertiary>
2653       </indexterm> <indexterm>
2654         <primary>first AFS machine</primary>
2655
2656         <secondary>copying</secondary>
2657
2658         <tertiary>server files to local disk</tertiary>
2659       </indexterm> <indexterm>
2660         <primary>usr/afs/bin directory</primary>
2661
2662         <secondary>first AFS machine</secondary>
2663       </indexterm> <indexterm>
2664         <primary>usr/afs/etc directory</primary>
2665
2666         <secondary>first AFS machine</secondary>
2667       </indexterm> <indexterm>
2668         <primary>usr/afs/db directory</primary>
2669       </indexterm> <indexterm>
2670         <primary>usr/afs/local directory</primary>
2671       </indexterm> <indexterm>
2672         <primary>usr/afs/logs directory</primary>
2673       </indexterm> <itemizedlist>
2674         <listitem>
2675           <para><emphasis role="bold">/usr/afs/db</emphasis></para>
2676         </listitem>
2677
2678         <listitem>
2679           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis></para>
2680         </listitem>
2681
2682         <listitem>
2683           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis></para>
2684         </listitem>
2685
2686         <listitem>
2687           <para><emphasis role="bold">/usr/afs/local</emphasis></para>
2688         </listitem>
2689
2690         <listitem>
2691           <para><emphasis role="bold">/usr/afs/logs</emphasis></para>
2692         </listitem>
2693       </itemizedlist></para>
2694
2695     <para>The BOS Server also creates symbolic links called <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2696     role="bold">/usr/vice/etc/CellServDB</emphasis> to the corresponding files in the <emphasis role="bold">/usr/afs/etc</emphasis>
2697     directory. The AFS command interpreters consult the <emphasis role="bold">CellServDB</emphasis> and <emphasis
2698     role="bold">ThisCell</emphasis> files in the <emphasis role="bold">/usr/vice/etc</emphasis> directory because they generally run
2699     on client machines. On machines that are AFS servers only (as this machine currently is), the files reside only in the <emphasis
2700     role="bold">/usr/afs/etc</emphasis> directory; the links enable the command interpreters to retrieve the information they need.
2701     Later instructions for installing the client functionality replace the links with actual files. <orderedlist>
2702         <listitem>
2703           <para>If you are not working from a packaged distribution, you may need to copy files from the distribution media to the local <emphasis role="bold">/usr/afs</emphasis> directory. 
2704 <programlisting>
2705    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.server/usr/afs</emphasis>
2706    # <emphasis role="bold">cp -rp  *  /usr/afs</emphasis>
2707 </programlisting> <indexterm>
2708               <primary>commands</primary>
2709
2710               <secondary>bosserver</secondary>
2711             </indexterm> <indexterm>
2712               <primary>bosserver command</primary>
2713             </indexterm></para>
2714         </listitem>
2715
2716         <listitem>
2717           <para>Issue the <emphasis role="bold">bosserver</emphasis> command. Include the <emphasis role="bold">-noauth</emphasis>
2718           flag to disable authorization checking. <programlisting>
2719    # <emphasis role="bold">/usr/afs/bin/bosserver -noauth &amp;</emphasis>
2720 </programlisting></para>
2721         </listitem>
2722
2723         <listitem>
2724           <para>Verify that the BOS Server created <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2725           role="bold">/usr/vice/etc/CellServDB</emphasis> as symbolic links to the corresponding files in the <emphasis
2726           role="bold">/usr/afs/etc</emphasis> directory. <programlisting>
2727    # <emphasis role="bold">ls -l  /usr/vice/etc</emphasis>
2728 </programlisting></para>
2729
2730           <para>If either or both of <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2731           role="bold">/usr/vice/etc/CellServDB</emphasis> do not exist, or are not links, issue the following commands.</para>
2732
2733           <programlisting>
2734    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2735    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell</emphasis>
2736    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB</emphasis> 
2737 </programlisting>
2738         </listitem>
2739       </orderedlist></para>
2740
2741     <indexterm>
2742       <primary>cell name</primary>
2743
2744       <secondary>defining during installation of first machine</secondary>
2745     </indexterm>
2746
2747     <indexterm>
2748       <primary>defining</primary>
2749
2750       <secondary>cell name during installation of first machine</secondary>
2751     </indexterm>
2752
2753     <indexterm>
2754       <primary>cell name</primary>
2755
2756       <secondary>setting in server ThisCell file</secondary>
2757
2758       <tertiary>first AFS machine</tertiary>
2759     </indexterm>
2760
2761     <indexterm>
2762       <primary>setting</primary>
2763
2764       <secondary>cell name in server ThisCell file</secondary>
2765
2766       <tertiary>first AFS machine</tertiary>
2767     </indexterm>
2768
2769     <indexterm>
2770       <primary>first AFS machine</primary>
2771
2772       <secondary>ThisCell file (server)</secondary>
2773     </indexterm>
2774
2775     <indexterm>
2776       <primary>usr/afs/etc/ThisCell</primary>
2777
2778       <see>ThisCell file (server)</see>
2779     </indexterm>
2780
2781     <indexterm>
2782       <primary>ThisCell file (server)</primary>
2783
2784       <secondary>first AFS machine</secondary>
2785     </indexterm>
2786
2787     <indexterm>
2788       <primary>files</primary>
2789
2790       <secondary>ThisCell (server)</secondary>
2791     </indexterm>
2792
2793     <indexterm>
2794       <primary>database server machine</primary>
2795
2796       <secondary>entry in server CellServDB file</secondary>
2797
2798       <tertiary>on first AFS machine</tertiary>
2799     </indexterm>
2800
2801     <indexterm>
2802       <primary>first AFS machine</primary>
2803
2804       <secondary>cell membership, defining</secondary>
2805
2806       <tertiary>for server processes</tertiary>
2807     </indexterm>
2808
2809     <indexterm>
2810       <primary>usr/afs/etc/CellServDB file</primary>
2811
2812       <see>CellServDB file (server)</see>
2813     </indexterm>
2814
2815     <indexterm>
2816       <primary>CellServDB file (server)</primary>
2817
2818       <secondary>creating</secondary>
2819
2820       <tertiary>on first AFS machine</tertiary>
2821     </indexterm>
2822
2823     <indexterm>
2824       <primary>creating</primary>
2825
2826       <secondary>CellServDB file (server)</secondary>
2827
2828       <tertiary>first AFS machine</tertiary>
2829     </indexterm>
2830
2831     <indexterm>
2832       <primary>files</primary>
2833
2834       <secondary>CellServDB (server)</secondary>
2835     </indexterm>
2836
2837     <indexterm>
2838       <primary>first AFS machine</primary>
2839
2840       <secondary>CellServDB file (server)</secondary>
2841     </indexterm>
2842
2843     <indexterm>
2844       <primary>first AFS machine</primary>
2845
2846       <secondary>defining</secondary>
2847
2848       <tertiary>as database server</tertiary>
2849     </indexterm>
2850
2851     <indexterm>
2852       <primary>defining</primary>
2853
2854       <secondary>first AFS machine as database server</secondary>
2855     </indexterm>
2856   </sect1>
2857
2858   <sect1 id="HDRWQ51">
2859     <title>Defining Cell Name and Membership for Server Processes</title>
2860
2861     <para>Now assign your cell's name. The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration
2862     and administration issues discusses the important considerations, explains why changing the name is difficult, and outlines the
2863     restrictions on name format. Two of the most important restrictions are that the name cannot include uppercase letters or more
2864     than 64 characters.</para>
2865
2866     <para>Use the <emphasis role="bold">bos setcellname</emphasis> command to assign the cell name. It creates two files:
2867     <itemizedlist>
2868         <listitem>
2869           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis>, which defines this machine's cell membership</para>
2870         </listitem>
2871
2872         <listitem>
2873           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis>, which lists the cell's database server machines; the
2874           machine named on the command line is placed on the list automatically</para>
2875         </listitem>
2876       </itemizedlist> <note>
2877         <para>In the following and every instruction in this guide, for the <replaceable>machine name</replaceable> argument
2878         substitute the fully-qualified hostname (such as <emphasis role="bold">fs1.example.com</emphasis>) of the machine you are
2879         installing. For the <replaceable>cell name</replaceable> argument substitute your cell's complete name (such as <emphasis
2880         role="bold">example.com</emphasis>).</para>
2881       </note></para>
2882
2883     <indexterm>
2884       <primary>commands</primary>
2885
2886       <secondary>bos setcellname</secondary>
2887     </indexterm>
2888
2889     <indexterm>
2890       <primary>bos commands</primary>
2891
2892       <secondary>setcellname</secondary>
2893     </indexterm>
2894
2895     <orderedlist>
2896       <listitem>
2897         <para>If necessary, add the directory containing the <emphasis role="bold">bos</emphasis> command to your path.
2898       <programlisting>
2899    # <emphasis role="bold">export PATH=$PATH:/usr/afs/bin</emphasis>
2900       </programlisting>
2901         </para>
2902       </listitem>
2903
2904       <listitem>
2905         <para>Issue the <emphasis role="bold">bos setcellname</emphasis> command to set the cell name. <programlisting>
2906    # <emphasis role="bold">bos setcellname</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>cell name</replaceable>&gt; <emphasis
2907               role="bold">-noauth</emphasis>
2908 </programlisting></para>
2909
2910         <para>Because you are not authenticated and authorization checking is disabled, the <emphasis role="bold">bos</emphasis>
2911         command interpreter possibly produces error messages about being unable to obtain tickets and running unauthenticated. You
2912         can safely ignore the messages. <indexterm>
2913             <primary>commands</primary>
2914
2915             <secondary>bos listhosts</secondary>
2916           </indexterm> <indexterm>
2917             <primary>bos commands</primary>
2918
2919             <secondary>listhosts</secondary>
2920           </indexterm> <indexterm>
2921             <primary>CellServDB file (server)</primary>
2922
2923             <secondary>displaying entries</secondary>
2924           </indexterm> <indexterm>
2925             <primary>displaying</primary>
2926
2927             <secondary>CellServDB file (server) entries</secondary>
2928           </indexterm></para>
2929       </listitem>
2930
2931       <listitem>
2932         <para>Issue the <emphasis role="bold">bos listhosts</emphasis> command to verify that the machine you are installing is now
2933         registered as the cell's first database server machine. <programlisting>
2934    # <emphasis role="bold">bos listhosts</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
2935    Cell name is <replaceable>cell_name</replaceable>
2936        Host 1 is <replaceable>machine_name</replaceable>
2937 </programlisting></para>
2938       </listitem>
2939     </orderedlist>
2940
2941     <indexterm>
2942       <primary>database server machine</primary>
2943
2944       <secondary>installing</secondary>
2945
2946       <tertiary>first</tertiary>
2947     </indexterm>
2948
2949     <indexterm>
2950       <primary>instructions</primary>
2951
2952       <secondary>database server machine, installing first</secondary>
2953     </indexterm>
2954
2955     <indexterm>
2956       <primary>installing</primary>
2957
2958       <secondary>database server machine</secondary>
2959
2960       <tertiary>first</tertiary>
2961     </indexterm>
2962
2963     <indexterm>
2964       <primary>Backup Server</primary>
2965
2966       <secondary>starting</secondary>
2967
2968       <tertiary>first AFS machine</tertiary>
2969     </indexterm>
2970
2971     <indexterm>
2972       <primary>buserver process</primary>
2973
2974       <see>Backup Server</see>
2975     </indexterm>
2976
2977     <indexterm>
2978       <primary>starting</primary>
2979
2980       <secondary>Backup Server</secondary>
2981
2982       <tertiary>first AFS machine</tertiary>
2983     </indexterm>
2984
2985     <indexterm>
2986       <primary>first AFS machine</primary>
2987
2988       <secondary>Backup Server</secondary>
2989     </indexterm>
2990
2991     <indexterm>
2992       <primary>Protection Server</primary>
2993
2994       <secondary>starting</secondary>
2995
2996       <tertiary>first AFS machine</tertiary>
2997     </indexterm>
2998
2999     <indexterm>
3000       <primary>ptserver process</primary>
3001
3002       <see>Protection Server</see>
3003     </indexterm>
3004
3005     <indexterm>
3006       <primary>starting</primary>
3007
3008       <secondary>Protection Server</secondary>
3009
3010       <tertiary>first AFS machine</tertiary>
3011     </indexterm>
3012
3013     <indexterm>
3014       <primary>first AFS machine</primary>
3015
3016       <secondary>Protection Server</secondary>
3017     </indexterm>
3018
3019     <indexterm>
3020       <primary>VL Server (vlserver process)</primary>
3021
3022       <secondary>starting</secondary>
3023
3024       <tertiary>first AFS machine</tertiary>
3025     </indexterm>
3026
3027     <indexterm>
3028       <primary>Volume Location Server</primary>
3029
3030       <see>VL Server</see>
3031     </indexterm>
3032
3033     <indexterm>
3034       <primary>starting</primary>
3035
3036       <secondary>VL Server</secondary>
3037
3038       <tertiary>first AFS machine</tertiary>
3039     </indexterm>
3040
3041     <indexterm>
3042       <primary>first AFS machine</primary>
3043
3044       <secondary>VL Server</secondary>
3045     </indexterm>
3046
3047     <indexterm>
3048       <primary>usr/afs/local/BosConfig</primary>
3049
3050       <see>BosConfig file</see>
3051     </indexterm>
3052
3053     <indexterm>
3054       <primary>BosConfig file</primary>
3055
3056       <secondary>adding entries</secondary>
3057
3058       <tertiary>first AFS machine</tertiary>
3059     </indexterm>
3060
3061     <indexterm>
3062       <primary>adding</primary>
3063
3064       <secondary>entries to BosConfig file</secondary>
3065
3066       <tertiary>first AFS machine</tertiary>
3067     </indexterm>
3068
3069     <indexterm>
3070       <primary>files</primary>
3071
3072       <secondary>BosConfig</secondary>
3073     </indexterm>
3074
3075     <indexterm>
3076       <primary>initializing</primary>
3077
3078       <secondary>server process</secondary>
3079
3080       <see>starting</see>
3081     </indexterm>
3082
3083     <indexterm>
3084       <primary>server process</primary>
3085
3086       <secondary>see also entry for each server's name</secondary>
3087     </indexterm>
3088   </sect1>
3089
3090   <sect1 id="HDRWQ52">
3091     <title>Starting the Database Server Processes</title>
3092
3093     <para>Next use the <emphasis role="bold">bos create</emphasis> command to create entries for the three database server processes
3094     in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file and start them running. The three processes run on database
3095     server machines only: <itemizedlist>
3096
3097         <listitem>
3098           <para>The Backup Server (the <emphasis role="bold">buserver</emphasis> process) maintains the Backup Database</para>
3099         </listitem>
3100
3101         <listitem>
3102           <para>The Protection Server (the <emphasis role="bold">ptserver</emphasis> process) maintains the Protection
3103           Database</para>
3104         </listitem>
3105
3106         <listitem>
3107           <para>The Volume Location (VL) Server (the <emphasis role="bold">vlserver</emphasis> process) maintains the Volume
3108           Location Database (VLDB)</para>
3109         </listitem>
3110       </itemizedlist></para>
3111
3112     <indexterm>
3113       <primary>Kerberos</primary>
3114     </indexterm>
3115
3116     <note>
3117       <para>AFS ships with an additional database server named 'kaserver', which
3118       was historically used to provide authentication services to AFS cells.
3119       kaserver was based on <emphasis>Kerberos v4</emphasis>, as such, it is
3120       not recommended for new cells. This guide assumes you have already
3121       configured a Kerberos v5 realm for your site, and details the procedures 
3122       required to use AFS with this realm. If you do wish to use
3123       <emphasis role="bold">kaserver</emphasis>, please see the modifications
3124       to these instructions detailed in 
3125       <link linkend="KAS006">Starting the kaserver Database Server Process</link>
3126       </para>
3127     </note>
3128
3129     <para>The remaining instructions in this chapter include the <emphasis role="bold">-cell</emphasis> argument on all applicable
3130     commands. Provide the cell name you assigned in <link linkend="HDRWQ51">Defining Cell Name and Membership for Server
3131     Processes</link>. If a command appears on multiple lines, it is only for legibility. <indexterm>
3132         <primary>commands</primary>
3133
3134         <secondary>bos create</secondary>
3135       </indexterm> <indexterm>
3136         <primary>bos commands</primary>
3137
3138         <secondary>create</secondary>
3139       </indexterm> <orderedlist>
3140         <listitem>
3141           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Backup Server. <programlisting>
3142    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">buserver simple /usr/afs/bin/buserver</emphasis>  \
3143  <emphasis role="bold">                 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
3144 </programlisting></para>
3145         </listitem>
3146
3147         <listitem>
3148           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Protection Server. <programlisting>
3149    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">ptserver simple /usr/afs/bin/ptserver</emphasis>  \
3150  <emphasis role="bold">                 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
3151 </programlisting></para>
3152         </listitem>
3153
3154         <listitem>
3155           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the VL Server. <programlisting>
3156    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">vlserver simple /usr/afs/bin/vlserver</emphasis>  \
3157  <emphasis role="bold">                 -cell</emphasis> &lt;<replaceable>cell name</replaceable>&gt;  <emphasis role="bold">-noauth</emphasis>
3158 </programlisting></para>
3159         </listitem>
3160       </orderedlist></para>
3161
3162     <indexterm>
3163       <primary>admin account</primary>
3164
3165       <secondary>creating</secondary>
3166     </indexterm>
3167
3168     <indexterm>
3169       <primary>afs entry in Kerberos Database</primary>
3170     </indexterm>
3171
3172     <indexterm>
3173       <primary>Kerberos Database</primary>
3174     </indexterm>
3175
3176     <indexterm>
3177       <primary>creating</primary>
3178
3179       <secondary>afs entry in Kerberos Database</secondary>
3180     </indexterm>
3181
3182     <indexterm>
3183       <primary>creating</primary>
3184
3185       <secondary>admin account in Kerberos Database</secondary>
3186     </indexterm>
3187
3188     <indexterm>
3189       <primary>security</primary>
3190
3191       <secondary>initializing cell-wide</secondary>
3192     </indexterm>
3193
3194     <indexterm>
3195       <primary>cell</primary>
3196
3197       <secondary>initializing security mechanisms</secondary>
3198     </indexterm>
3199
3200     <indexterm>
3201       <primary>initializing</primary>
3202
3203       <secondary>cell security mechanisms</secondary>
3204     </indexterm>
3205
3206     <indexterm>
3207       <primary>usr/afs/etc/KeyFile</primary>
3208
3209       <see>KeyFile file</see>
3210     </indexterm>
3211
3212     <indexterm>
3213       <primary>KeyFile file</primary>
3214
3215       <secondary>first AFS machine</secondary>
3216     </indexterm>
3217
3218     <indexterm>
3219       <primary>files</primary>
3220
3221       <secondary>KeyFile</secondary>
3222     </indexterm>
3223
3224     <indexterm>
3225       <primary>key</primary>
3226
3227       <see>server encryption key</see>
3228     </indexterm>
3229
3230     <indexterm>
3231       <primary>encryption key</primary>
3232
3233       <see>server encryption key</see>
3234     </indexterm>
3235   </sect1>
3236
3237   <sect1 id="HDRWQ53">
3238     <title>Initializing Cell Security </title>
3239
3240     <para>If you are working with an existing cell which uses
3241     <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for authentication,
3242     please see 
3243     <link linkend="HDRWQ53">Initializing Cell Security with kaserver</link>
3244     for installation instructions which replace this section.</para>
3245     
3246     <para>Now initialize the cell's security mechanisms. Begin by creating the following two entires in your site's Kerberos database: <itemizedlist>
3247         <listitem>
3248           <para>A generic administrative account, called <emphasis role="bold">admin</emphasis> by convention. If you choose to
3249           assign a different name, substitute it throughout the remainder of this document.</para>
3250
3251           <para>After you complete the installation of the first machine, you can continue to have all administrators use the
3252           <emphasis role="bold">admin</emphasis> account, or you can create a separate administrative account for each of them. The
3253           latter scheme implies somewhat more overhead, but provides a more informative audit trail for administrative
3254           operations.</para>
3255         </listitem>
3256
3257         <listitem>
3258           <para>The entry for AFS server processes, called either 
3259           <emphasis role="bold">afs</emphasis> or 
3260           <emphasis role="bold">afs/<replaceable>cell</replaceable></emphasis>. 
3261           No user logs in under this identity, but it is used to encrypt the
3262           server tickets that granted to AFS clients for presentation to 
3263           server processes during mutual authentication. (The
3264           chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and administration describes the
3265           role of server encryption keys in mutual authentication.)</para>
3266
3267           <para>In Step <link linkend="LIWQ58">7</link>, you also place the initial AFS server encryption key into the <emphasis
3268           role="bold">/usr/afs/etc/KeyFile</emphasis> file. The AFS server processes refer to this file to learn the server
3269           encryption key when they need to decrypt server tickets.</para>
3270         </listitem>
3271       </itemizedlist></para>
3272
3273     <para>You also issue several commands that enable the new <emphasis role="bold">admin</emphasis> user to issue privileged
3274     commands in all of the AFS suites.</para>
3275
3276     <para>The following instructions do not configure all of the security mechanisms related to the AFS Backup System. See the
3277     chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about configuring the Backup System.</para>
3278
3279     <para>The examples below assume you are using MIT Kerberos. Please refer 
3280     to the documentation for your KDC's administrative interface if you are 
3281     using a different vendor</para>
3282
3283     <orderedlist>
3284         <listitem>
3285           <para>Enter <emphasis role="bold">kadmin</emphasis> interactive mode.
3286 <programlisting>
3287    # <emphasis role="bold">kadmin</emphasis>
3288 Authenticating as principal <replaceable>you</replaceable>/admin@<replaceable>YOUR REALM</replaceable> with password
3289 Password for <replaceable>you/admin@REALM</replaceable>: <replaceable>your_password</replaceable>
3290 </programlisting> <indexterm>
3291               <primary>server encryption key</primary>
3292
3293               <secondary>in Kerberos Database</secondary>
3294             </indexterm> <indexterm>
3295               <primary>creating</primary>
3296
3297               <secondary>server encryption key</secondary>
3298
3299               <tertiary>Kerberos Database</tertiary>
3300             </indexterm></para>
3301         </listitem>
3302
3303         <listitem>
3304           <para><anchor id="LIWQ54" />Issue the 
3305           <emphasis role="bold">add_principal</emphasis> command to create 
3306           Kerberos Database entries called 
3307           <emphasis role="bold">admin</emphasis> and 
3308           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>.</para>
3309
3310           <para>You should make the <replaceable>admin_passwd</replaceable> as
3311           long and complex as possible, but keep in mind that administrators 
3312           need to enter it often. It must be at least six characters long.</para>
3313           <para>Note that when creating the 
3314           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis> 
3315           entry, the encryption types should be restricted to des-cbc-crc:v4. 
3316           For more details regarding encryption types, see the documentation 
3317           for your Kerberos installation.
3318
3319 <programlisting>
3320    kadmin: <emphasis role="bold">add_principal -randkey -e des-cbc-crc:v4 afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3321    Principal "afs/<replaceable>cell name</replaceable>@<replaceable>REALM</replaceable>" created.
3322    kadmin:  <emphasis role="bold">add_principal admin</emphasis>
3323    Enter password for principal "admin@<replaceable>REALM</replaceable>": <emphasis role="bold"><replaceable>admin_password</replaceable></emphasis>
3324    Principal "admin@<replaceable>REALM</replaceable>" created.