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 to dynamically
1682     load the 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 provides RPMS for all current Fedora and RedHat Enterprise Linux (RHEL) releases on the OpenAFS web site and the OpenAFS yum repository.
1729         <orderedlist>
1730           <listitem>
1731             <para>Browse to
1732             http://dl.openafs.org/dl/openafs/<replaceable>VERSION</replaceable>,
1733             where VERSION is the latest stable release of
1734             OpenAFS. Download the
1735             openafs-repository-<replaceable>VERSION</replaceable>.noarch.rpm
1736             file for Fedora systems or the
1737             openafs-repository-rhel-<replaceable>VERSION</replaceable>.noarch.rpm
1738             file for RedHat-based systems.
1739             </para>
1740           </listitem>
1741           <listitem>
1742             <para>Install the downloaded RPM file using the following command:
1743               <programlisting>
1744                 # rpm -U openafs-repository*.rpm
1745               </programlisting>
1746             </para>
1747           </listitem>
1748           <listitem>
1749             <para>Install the RPM set for your operating system using the yum command as follows:
1750               <programlisting>
1751                 # yum -y install openafs-client openafs-server openafs-krb5 kmod-openafs
1752               </programlisting>
1753
1754             </para>
1755             <para>Alternatively, you may use dynamically-compiled kernel
1756               modules if you have the kernel headers, a compiler, and the
1757               dkms package from
1758               <ulink url="http://fedoraproject.org/wiki/EPEL"><citetitle>EPEL</citetitle></ulink> installed.
1759
1760             </para>
1761             <para>To use dynamically-compiled kernel modules instead of statically compiled modules, use the following command instead of the kmod-openafs as shown above:
1762               <programlisting>
1763                 # yum install openafs-client openafs-server openafs-krb5 dkms-openafs
1764               </programlisting>
1765             </para>
1766           </listitem>
1767 <!-- If you do this with current RHEL and Fedora releases you end up with
1768      a dynroot'd client running - this breaks setting up the root.afs volume
1769      as described later in this guide
1770           <listitem>
1771             <para>Run the AFS initialization script to load AFS extensions into
1772             the kernel. You can ignore any error messages about the inability
1773             to start the BOS Server or the Cache Manager or AFS client.</para>
1774 <programlisting>
1775    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
1776 </programlisting>
1777           </listitem>
1778 -->
1779         </orderedlist>
1780       </para>
1781       </sect3>
1782       <sect3>
1783          <title>Systems packaged as tar files</title>
1784          <para>If you are running a system where the OpenAFS Binary Distribution
1785          is provided as a tar file, or where you have built the system from
1786          source yourself, you need to install the relevant components by hand
1787          </para>
1788          <orderedlist>
1789
1790           <listitem>
1791             <para>Unpack the distribution tarball. The examples below assume
1792             that you have unpacked the files into the
1793             <emphasis role="bold">/tmp/afsdist</emphasis>directory. If you
1794             pick a different location, substitute this in all of the following
1795             examples. Once you have unpacked the distribution,
1796             change directory as indicated.
1797 <programlisting>
1798   # <emphasis role="bold">cd /tmp/afsdist/linux/root.client/usr/vice/etc</emphasis>
1799 </programlisting></para>
1800           </listitem>
1801
1802           <listitem>
1803             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/modload</emphasis> directory.
1804             The filenames for the libraries have the format <emphasis
1805             role="bold">libafs-</emphasis><replaceable>version</replaceable><emphasis role="bold">.o</emphasis>, where
1806             <replaceable>version</replaceable> indicates the kernel build level. The string <emphasis role="bold">.mp</emphasis> in
1807             the <replaceable>version</replaceable> indicates that the file is appropriate for machines running a multiprocessor
1808             kernel. <programlisting>
1809    # <emphasis role="bold">cp -rp  modload  /usr/vice/etc</emphasis>
1810 </programlisting></para>
1811           </listitem>
1812
1813           <listitem>
1814             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1815             role="bold">/etc/rc.d/init.d</emphasis> on Linux machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1816             extension as you copy the script. <programlisting>
1817    # <emphasis role="bold">cp -p   afs.rc  /etc/rc.d/init.d/afs</emphasis>
1818 </programlisting></para>
1819           </listitem>
1820
1821 <!-- I don't think we need to do this for Linux, and it complicates things if
1822      dynroot is enabled ...
1823           <listitem>
1824             <para>Run the AFS initialization script to load AFS extensions into the kernel. You can ignore any error messages about
1825             the inability to start the BOS Server or the Cache Manager or AFS client.</para>
1826 <programlisting>
1827    # <emphasis role="bold">/etc/rc.d/init.d/afs start</emphasis>
1828 </programlisting>
1829           </listitem>
1830 -->
1831         </orderedlist>
1832
1833       <indexterm>
1834         <primary>configuring</primary>
1835
1836         <secondary>AFS server partition on first AFS machine</secondary>
1837
1838         <tertiary>Linux</tertiary>
1839       </indexterm>
1840
1841       <indexterm>
1842         <primary>AFS server partition</primary>
1843
1844         <secondary>configuring on first AFS machine</secondary>
1845
1846         <tertiary>Linux</tertiary>
1847       </indexterm>
1848
1849       <indexterm>
1850         <primary>first AFS machine</primary>
1851
1852         <secondary>AFS server partition</secondary>
1853
1854         <tertiary>on Linux</tertiary>
1855       </indexterm>
1856
1857       <indexterm>
1858         <primary>Linux</primary>
1859
1860         <secondary>AFS server partition</secondary>
1861
1862         <tertiary>on first AFS machine</tertiary>
1863       </indexterm>
1864     </sect3>
1865     </sect2>
1866
1867     <sect2 id="HDRWQ43">
1868       <title>Configuring Server Partitions on Linux Systems</title>
1869
1870       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1871       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1872       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1873       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1874       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1875       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
1876       <orderedlist>
1877           <listitem>
1878             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1879             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1880    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1881 </programlisting></para>
1882           </listitem>
1883
1884           <listitem>
1885             <para>Add a line with the following format to the file systems registry file, <emphasis
1886             role="bold">/etc/fstab</emphasis>, for each directory just created. The entry maps the directory name to the disk
1887             partition to be mounted on it. <programlisting>
1888    /dev/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  ext2  defaults  0  2
1889 </programlisting></para>
1890
1891             <para>The following is an example for the first partition being configured.</para>
1892
1893             <programlisting>
1894    /dev/sda8 /vicepa ext2 defaults 0 2
1895 </programlisting>
1896           </listitem>
1897
1898           <listitem>
1899             <para>Create a file system on each partition that is to be mounted at a <emphasis
1900             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
1901             consult the Linux documentation for more information. <programlisting>
1902    # <emphasis role="bold">mkfs -v /dev/</emphasis><replaceable>disk</replaceable>
1903 </programlisting></para>
1904           </listitem>
1905
1906           <listitem>
1907             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1908             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1909           </listitem>
1910
1911           <listitem>
1912             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1913             linkend="HDRWQ44">Enabling AFS Login on Linux Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1914             BOS Server</link>.</para>
1915           </listitem>
1916         </orderedlist></para>
1917
1918       <indexterm>
1919         <primary>enabling AFS login</primary>
1920
1921         <secondary>file server machine</secondary>
1922
1923         <tertiary>Linux</tertiary>
1924       </indexterm>
1925
1926       <indexterm>
1927         <primary>AFS login</primary>
1928
1929         <secondary>on file server machine</secondary>
1930
1931         <tertiary>Linux</tertiary>
1932       </indexterm>
1933
1934       <indexterm>
1935         <primary>first AFS machine</primary>
1936
1937         <secondary>AFS login</secondary>
1938
1939         <tertiary>on Linux</tertiary>
1940       </indexterm>
1941
1942       <indexterm>
1943         <primary>Linux</primary>
1944
1945         <secondary>AFS login</secondary>
1946
1947         <tertiary>on file server machine</tertiary>
1948       </indexterm>
1949
1950       <indexterm>
1951         <primary>PAM</primary>
1952
1953         <secondary>on Linux</secondary>
1954
1955         <tertiary>file server machine</tertiary>
1956       </indexterm>
1957     </sect2>
1958
1959     <sect2 id="HDRWQ44">
1960       <title>Enabling AFS Login on Linux Systems</title>
1961
1962       <note>
1963         <para>If you plan to remove client functionality from this machine
1964         after completing the installation, skip this section and proceed
1965         to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1966       </note>
1967
1968       <para>At this point you incorporate AFS into the operating system's
1969       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
1970       authentication mechanisms on the machine, including login, to provide
1971       the security infrastructure for authenticated access to and from the
1972       machine.</para>
1973
1974       <para>You should first configure your system to obtain Kerberos v5
1975       tickets as part of the authentication process, and then run an AFS PAM
1976       module to obtain tokens from those tickets after authentication.  Many
1977       Linux distributions come with a Kerberos v5 PAM module (usually called
1978       pam-krb5 or pam_krb5), or you can download and install <ulink
1979       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
1980       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
1981       See the instructions of whatever PAM module you use for how to
1982       configure it.</para>
1983
1984       <para>Some Kerberos v5 PAM modules do come with native AFS support
1985       (usually requiring the Heimdal Kerberos implementation rather than the
1986       MIT Kerberos implementation).  If you are using one of those PAM
1987       modules, you can configure it to obtain AFS tokens.  It's more common,
1988       however, to separate the AFS token acquisition into a separate PAM
1989       module.</para>
1990
1991       <para>The recommended AFS PAM module is <ulink
1992       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
1993       Allbery's pam-afs-session module</ulink>.  It should work with any of
1994       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
1995       often only need to add configuration to the session group:</para>
1996
1997       <example>
1998         <title>Linux PAM session example</title>
1999         <literallayout>session  required  pam_afs_session.so</literallayout>
2000       </example>
2001
2002       <para>If you also want to obtain AFS tokens for <command>scp</command>
2003       and similar commands that don't open a session, you will also need to
2004       add the AFS PAM module to the auth group so that the PAM
2005       <function>setcred</function> call will obtain tokens.  The
2006       <literal>pam_afs_session</literal> module will always return success
2007       for authentication so that it can be added to the auth group only for
2008       <function>setcred</function>, so make sure that it's not marked as
2009       <literal>sufficient</literal>.</para>
2010
2011       <example>
2012         <title>Linux PAM auth example</title>
2013 <literallayout>auth  [success=ok default=1]  pam_krb5.so
2014 auth  [default=done]          pam_afs_session.so
2015 auth  required                pam_unix.so try_first_pass</literallayout>
2016       </example>
2017
2018       <para>This example will work if you want to try Kerberos v5 first and
2019       then fall back to regular Unix authentication.
2020       <literal>success=ok</literal> for the Kerberos PAM module followed by
2021       <literal>default=done</literal> for the AFS PAM module will cause a
2022       successful Kerberos login to run the AFS PAM module and then skip the
2023       Unix authentication module.  <literal>default=1</literal> on the
2024       Kerberos PAM module causes failure of that module to skip the next
2025       module (the AFS PAM module) and fall back to the Unix module.  If you
2026       want to try Unix authentication first and rearrange the order, be sure
2027       to use <literal>default=die</literal> instead.</para>
2028
2029       <para>The PAM configuration is stored in different places in different
2030       Linux distributions.  On Red Hat, look in
2031       <filename>/etc/pam.d/system-auth</filename>.  On Debian and
2032       derivatives, look in <filename>/etc/pam.d/common-session</filename>
2033       and <filename>/etc/pam.d/common-auth</filename>.</para>
2034
2035       <para>For additional configuration examples and the configuration
2036       options of the AFS PAM module, see its documentation.  For more
2037       details on the available options for the PAM configuration, see the
2038       Linux PAM documentation.</para>
2039
2040       <para>Sites which still require <command>kaserver</command> or
2041       external Kerberos v4 authentication should consult <link
2042       linkend="KAS015">Enabling kaserver based AFS Login on Linux
2043       Systems</link> for details of how to enable AFS login on Linux.</para>
2044
2045       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
2046       Server</link> (or if referring to these instructions while installing
2047       an additional file server machine, return to <link
2048       linkend="HDRWQ108">Starting Server Programs</link>).</para>
2049     </sect2>
2050   </sect1>
2051
2052   <sect1 id="HDRWQ45">
2053     <title>Getting Started on Solaris Systems</title>
2054
2055     <para>Begin by running the AFS initialization script to call the <emphasis role="bold">modload</emphasis> program distributed by
2056     Sun Microsystems, which dynamically loads AFS modifications into the kernel. Then create partitions for storing AFS volumes, and
2057     install and configure the AFS-modified <emphasis role="bold">fsck</emphasis> program to run on AFS server partitions. If the
2058     machine is to remain an AFS client machine, incorporate AFS into the machine's Pluggable Authentication Module (PAM) scheme.
2059     <indexterm>
2060         <primary>incorporating AFS kernel extensions</primary>
2061
2062         <secondary>first AFS machine</secondary>
2063
2064         <tertiary>Solaris</tertiary>
2065       </indexterm> <indexterm>
2066         <primary>AFS kernel extensions</primary>
2067
2068         <secondary>on first AFS machine</secondary>
2069
2070         <tertiary>Solaris</tertiary>
2071       </indexterm> <indexterm>
2072         <primary>first AFS machine</primary>
2073
2074         <secondary>AFS kernel extensions</secondary>
2075
2076         <tertiary>on Solaris</tertiary>
2077       </indexterm> <indexterm>
2078         <primary>Solaris</primary>
2079
2080         <secondary>AFS kernel extensions</secondary>
2081
2082         <tertiary>on first AFS machine</tertiary>
2083       </indexterm></para>
2084
2085     <sect2 id="HDRWQ46">
2086       <title>Loading AFS into the Solaris Kernel</title>
2087
2088       <para>The <emphasis role="bold">modload</emphasis> program is the dynamic kernel loader provided by Sun Microsystems for
2089       Solaris systems. Solaris does not support incorporation of AFS modifications during a kernel build.</para>
2090
2091       <para>For AFS to function correctly, the <emphasis role="bold">modload</emphasis> program must run each time the machine
2092       reboots, so the AFS initialization script (included on the AFS CD-ROM) invokes it automatically. In this section you copy the
2093       appropriate AFS library file to the location where the <emphasis role="bold">modload</emphasis> program accesses it and then
2094       run the script.</para>
2095
2096       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
2097       incorporate AFS into the Solaris startup and shutdown sequence. <orderedlist>
2098           <listitem>
2099             <para>Unpack the OpenAFS Solaris distribution tarball. The examples
2100             below assume that you have unpacked the files into the
2101             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
2102             pick a diferent location, substitute this in all of the following
2103             exmaples. Once you have unpacked the distribution, change directory
2104             as indicated.
2105 <programlisting>
2106    # <emphasis role="bold">cd  /tmp/afsdist/sun4x_56/root.client/usr/vice/etc</emphasis>
2107 </programlisting></para>
2108           </listitem>
2109
2110           <listitem>
2111             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
2112             role="bold">/etc/init.d</emphasis> on Solaris machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
2113             extension as you copy the script. <programlisting>
2114    # <emphasis role="bold">cp -p  afs.rc  /etc/init.d/afs</emphasis>
2115 </programlisting></para>
2116           </listitem>
2117
2118           <listitem>
2119             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
2120             role="bold">/kernel/fs/afs</emphasis>.</para>
2121
2122             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, its kernel supports NFS server
2123             functionality, and the <emphasis role="bold">nfsd</emphasis> process is running:</para>
2124
2125             <programlisting>
2126    # <emphasis role="bold">cp -p modload/libafs.o /kernel/fs/afs</emphasis>
2127 </programlisting>
2128
2129             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, and its kernel does not support NFS
2130             server functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2131
2132             <programlisting>
2133    # <emphasis role="bold">cp -p modload/libafs.nonfs.o /kernel/fs/afs</emphasis>
2134 </programlisting>
2135
2136             <para>If the machine is running the 64-bit version of Solaris 7, its kernel supports NFS server functionality, and the
2137             <emphasis role="bold">nfsd</emphasis> process is running:</para>
2138
2139             <programlisting>
2140    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/sparcv9/afs</emphasis>
2141 </programlisting>
2142
2143             <para>If the machine is running the 64-bit version of Solaris 7, and its kernel does not support NFS server
2144             functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2145
2146             <programlisting>
2147    # <emphasis role="bold">cp -p modload/libafs64.nonfs.o /kernel/fs/sparcv9/afs</emphasis>
2148 </programlisting>
2149           </listitem>
2150
2151           <listitem>
2152             <para>Run the AFS initialization script to load AFS modifications into the kernel. You can ignore any error messages
2153             about the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
2154    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2155 </programlisting></para>
2156
2157             <para>When an entry called <computeroutput>afs</computeroutput> does not already exist in the local <emphasis
2158             role="bold">/etc/name_to_sysnum</emphasis> file, the script automatically creates it and reboots the machine to start
2159             using the new version of the file. If this happens, log in again as the superuser <emphasis role="bold">root</emphasis>
2160             after the reboot and run the initialization script again. This time the required entry exists in the <emphasis
2161             role="bold">/etc/name_to_sysnum</emphasis> file, and the <emphasis role="bold">modload</emphasis> program runs.</para>
2162
2163             <programlisting>
2164    login: <emphasis role="bold">root</emphasis>
2165    Password: <replaceable>root_password</replaceable>
2166    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2167 </programlisting>
2168           </listitem>
2169         </orderedlist></para>
2170
2171       <indexterm>
2172         <primary>replacing fsck program</primary>
2173
2174         <secondary>first AFS machine</secondary>
2175
2176         <tertiary>Solaris</tertiary>
2177       </indexterm>
2178
2179       <indexterm>
2180         <primary>fsck program</primary>
2181
2182         <secondary>on first AFS machine</secondary>
2183
2184         <tertiary>Solaris</tertiary>
2185       </indexterm>
2186
2187       <indexterm>
2188         <primary>first AFS machine</primary>
2189
2190         <secondary>fsck program</secondary>
2191
2192         <tertiary>on Solaris</tertiary>
2193       </indexterm>
2194
2195       <indexterm>
2196         <primary>Solaris</primary>
2197
2198         <secondary>fsck program</secondary>
2199
2200         <tertiary>on first AFS machine</tertiary>
2201       </indexterm>
2202     </sect2>
2203
2204     <sect2 id="HDRWQ47">
2205       <title>Configuring the AFS-modified fsck Program on Solaris Systems</title>
2206
2207       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
2208       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
2209       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
2210       it removes all of the data. To repeat:</para>
2211
2212       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS volumes.</emphasis>
2213       <orderedlist>
2214           <listitem>
2215             <para>Create the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory to house the AFS-modified <emphasis
2216             role="bold">fsck</emphasis> program and related files. <programlisting>
2217    # <emphasis role="bold">mkdir /usr/lib/fs/afs</emphasis>
2218    # <emphasis role="bold">cd /usr/lib/fs/afs</emphasis>
2219 </programlisting></para>
2220           </listitem>
2221
2222           <listitem>
2223             <para>Copy the <emphasis role="bold">vfsck</emphasis> binary to the newly created directory, changing the name as you do
2224             so. <programlisting>
2225    # <emphasis role="bold">cp  /tmp/afsdist/sun4x_56/root.server/etc/vfsck  fsck</emphasis>
2226 </programlisting></para>
2227           </listitem>
2228
2229           <listitem>
2230             <para>Working in the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory, create the following links to Solaris
2231             libraries: <programlisting>
2232    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/clri</emphasis>
2233    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/df</emphasis>
2234    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/edquota</emphasis>
2235    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ff</emphasis>
2236    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsdb</emphasis>
2237    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsirand</emphasis>
2238    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fstyp</emphasis>
2239    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/labelit</emphasis>
2240    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/lockfs</emphasis>
2241    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mkfs</emphasis>
2242    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mount</emphasis>
2243    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ncheck</emphasis>
2244    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/newfs</emphasis>
2245    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quot</emphasis>
2246    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quota</emphasis>
2247    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaoff</emphasis>
2248    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaon</emphasis>
2249    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/repquota</emphasis>
2250    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/tunefs</emphasis>
2251    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsdump</emphasis>
2252    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsrestore</emphasis>
2253    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/volcopy</emphasis>
2254 </programlisting></para>
2255           </listitem>
2256
2257           <listitem>
2258             <para>Append the following line to the end of the file <emphasis role="bold">/etc/dfs/fstypes</emphasis>.
2259             <programlisting>
2260    afs AFS Utilities
2261 </programlisting></para>
2262           </listitem>
2263
2264           <listitem>
2265             <para>Edit the <emphasis role="bold">/sbin/mountall</emphasis> file, making two changes. <itemizedlist>
2266                 <listitem>
2267                   <para>Add an entry for AFS to the <computeroutput>case</computeroutput> statement for option 2, so that it reads
2268                   as follows: <programlisting>
2269    case "$2" in
2270    ufs)    foptions="-o p"
2271            ;;
2272    afs)    foptions="-o p"
2273            ;;
2274    s5)     foptions="-y -t /var/tmp/tmp$$ -D"
2275            ;;
2276    *)      foptions="-y"
2277            ;;
2278 </programlisting></para>
2279                 </listitem>
2280
2281                 <listitem>
2282                   <para>Edit the file so that all AFS and UFS partitions are checked in parallel. Replace the following section of
2283                   code: <programlisting>
2284    # For  fsck purposes, we make a distinction between ufs and
2285    # other file systems
2286    #
2287    if [ "$fstype" = "ufs" ]; then
2288         ufs_fscklist="$ufs_fscklist $fsckdev"
2289         saveentry $fstype "$OPTIONS" $special $mountp
2290         continue
2291    fi
2292 </programlisting></para>
2293
2294                   <para>with the following section of code:</para>
2295
2296                   <programlisting>
2297    # For fsck purposes, we make a distinction between ufs/afs
2298    # and other file systems.
2299    #
2300    if [ "$fstype" = "ufs" -o "$fstype" = "afs" ]; then
2301         ufs_fscklist="$ufs_fscklist $fsckdev"
2302         saveentry $fstype "$OPTIONS" $special $mountp
2303         continue
2304    fi
2305 </programlisting>
2306                 </listitem>
2307               </itemizedlist></para>
2308           </listitem>
2309         </orderedlist></para>
2310
2311       <indexterm>
2312         <primary>configuring</primary>
2313
2314         <secondary>AFS server partition on first AFS machine</secondary>
2315
2316         <tertiary>Solaris</tertiary>
2317       </indexterm>
2318
2319       <indexterm>
2320         <primary>AFS server partition</primary>
2321
2322         <secondary>configuring on first AFS machine</secondary>
2323
2324         <tertiary>Solaris</tertiary>
2325       </indexterm>
2326
2327       <indexterm>
2328         <primary>first AFS machine</primary>
2329
2330         <secondary>AFS server partition</secondary>
2331
2332         <tertiary>on Solaris</tertiary>
2333       </indexterm>
2334
2335       <indexterm>
2336         <primary>Solaris</primary>
2337
2338         <secondary>AFS server partition</secondary>
2339
2340         <tertiary>on first AFS machine</tertiary>
2341       </indexterm>
2342     </sect2>
2343
2344     <sect2 id="HDRWQ48">
2345       <title>Configuring Server Partitions on Solaris Systems</title>
2346
2347       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
2348       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
2349       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
2350       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
2351       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
2352       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
2353       <orderedlist>
2354           <listitem>
2355             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
2356             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
2357    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
2358 </programlisting></para>
2359           </listitem>
2360
2361           <listitem>
2362             <para>Add a line with the following format to the file systems registry file, <emphasis
2363             role="bold">/etc/vfstab</emphasis>, for each partition to be mounted on a directory created in the previous step. Note
2364             the value <computeroutput>afs</computeroutput> in the fourth field, which tells Solaris to use the AFS-modified
2365             <emphasis role="bold">fsck</emphasis> program on this partition. <programlisting>
2366    /dev/dsk/<replaceable>disk</replaceable>   /dev/rdsk/<replaceable>disk</replaceable>   /vicep<replaceable>xx</replaceable>   afs   <replaceable>boot_order</replaceable>  yes
2367 </programlisting></para>
2368
2369             <para>The following is an example for the first partition being configured.</para>
2370
2371             <programlisting>
2372    /dev/dsk/c0t6d0s1 /dev/rdsk/c0t6d0s1 /vicepa afs 3 yes
2373 </programlisting>
2374           </listitem>
2375
2376           <listitem>
2377             <para>Create a file system on each partition that is to be mounted at a <emphasis
2378             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
2379             consult the Solaris documentation for more information. <programlisting>
2380    # <emphasis role="bold">newfs -v /dev/rdsk/</emphasis><replaceable>disk</replaceable>
2381 </programlisting></para>
2382           </listitem>
2383
2384           <listitem>
2385             <para>Issue the <emphasis role="bold">mountall</emphasis> command to mount all partitions at once.</para>
2386           </listitem>
2387
2388           <listitem>
2389             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
2390             linkend="HDRWQ49">Enabling AFS Login and Editing the File Systems Clean-up Script on Solaris Systems</link>. Otherwise,
2391             proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2392           </listitem>
2393         </orderedlist></para>
2394     </sect2>
2395
2396     <sect2 id="HDRWQ49">
2397       <title>Enabling AFS Login on Solaris Systems</title>
2398       <indexterm>
2399         <primary>enabling AFS login</primary>
2400
2401         <secondary>file server machine</secondary>
2402
2403         <tertiary>Solaris</tertiary>
2404       </indexterm>
2405
2406       <indexterm>
2407         <primary>AFS login</primary>
2408
2409         <secondary>on file server machine</secondary>
2410
2411         <tertiary>Solaris</tertiary>
2412       </indexterm>
2413
2414       <indexterm>
2415         <primary>first AFS machine</primary>
2416
2417         <secondary>AFS login</secondary>
2418
2419         <tertiary>on Solaris</tertiary>
2420       </indexterm>
2421
2422       <indexterm>
2423         <primary>Solaris</primary>
2424
2425         <secondary>AFS login</secondary>
2426
2427         <tertiary>on file server machine</tertiary>
2428       </indexterm>
2429
2430       <indexterm>
2431         <primary>PAM</primary>
2432
2433         <secondary>on Solaris</secondary>
2434
2435         <tertiary>file server machine</tertiary>
2436       </indexterm>
2437
2438       <note>
2439         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
2440         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2441       </note>
2442
2443       <para>At this point you incorporate AFS into the operating system's
2444       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
2445       authentication mechanisms on the machine, including login, to provide
2446       the security infrastructure for authenticated access to and from the
2447       machine.</para>
2448
2449       <para>Explaining PAM is beyond the scope of this document.  It is
2450       assumed that you understand the syntax and meanings of settings in the
2451       PAM configuration file (for example, how the
2452       <computeroutput>other</computeroutput> entry works, the effect of
2453       marking an entry as <computeroutput>required</computeroutput>,
2454       <computeroutput>optional</computeroutput>, or
2455       <computeroutput>sufficient</computeroutput>, and so on).</para>
2456
2457       <para>You should first configure your system to obtain Kerberos v5
2458       tickets as part of the authentication process, and then run an AFS PAM
2459       module to obtain tokens from those tickets after authentication.
2460       Current versions of Solaris come with a Kerberos v5 PAM module that
2461       will work, or you can download and install <ulink
2462       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
2463       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
2464       See the instructions of whatever PAM module you use for how to
2465       configure it.</para>
2466
2467       <para>Some Kerberos v5 PAM modules do come with native AFS support
2468       (usually requiring the Heimdal Kerberos implementation rather than the
2469       MIT Kerberos implementation).  If you are using one of those PAM
2470       modules, you can configure it to obtain AFS tokens.  It's more common,
2471       however, to separate the AFS token acquisition into a separate PAM
2472       module.</para>
2473
2474       <para>The recommended AFS PAM module is <ulink
2475       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
2476       Allbery's pam-afs-session module</ulink>.  It should work with any of
2477       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
2478       often only need to add configuration to the session group in
2479       <filename>pam.conf</filename>:</para>
2480
2481       <example>
2482         <title>Solaris PAM session example</title>
2483         <literallayout>login session required pam_afs_session.so</literallayout>
2484       </example>
2485
2486       <para>This example enables PAM authentication only for console login.
2487       You may want to add a similar line for the ssh service and for any
2488       other login service that you use, including possibly the
2489       <literal>other</literal> service (which serves as a catch-all).  You
2490       may also want to add options to the AFS PAM session module
2491       (particularly <literal>retain_after_close</literal>, which is
2492       necessary for some versions of Solaris.</para>
2493
2494       <para>For additional configuration examples and the configuration
2495       options of the AFS PAM module, see its documentation.  For more
2496       details on the available options for the PAM configuration, see the
2497       <filename>pam.conf</filename> manual page.</para>
2498
2499       <para>Sites which still require <emphasis
2500       role="bold">kaserver</emphasis> or external Kerberos v4 authentication
2501       should consult <link linkend="KAS016">Enabling kaserver based AFS
2502       Login on Solaris Systems"</link> for details of how to enable AFS
2503       login on Solaris.</para>
2504
2505       <para>Proceed to <link linkend="HDRWQ49a">Editing the File Systems
2506       Clean-up Script on Solaris Systems</link></para>
2507     </sect2>
2508     <sect2 id="HDRWQ49a">
2509       <title>Editing the File Systems Clean-up Script on Solaris Systems</title>
2510       <indexterm>
2511         <primary>Solaris</primary>
2512
2513         <secondary>file systems clean-up script</secondary>
2514
2515         <tertiary>on file server machine</tertiary>
2516       </indexterm>
2517
2518       <indexterm>
2519         <primary>file systems clean-up script (Solaris)</primary>
2520
2521         <secondary>file server machine</secondary>
2522       </indexterm>
2523
2524       <indexterm>
2525         <primary>scripts</primary>
2526
2527         <secondary>file systems clean-up (Solaris)</secondary>
2528
2529         <tertiary>file server machine</tertiary>
2530       </indexterm>
2531
2532
2533         <orderedlist>
2534           <listitem>
2535             <para>Some Solaris distributions include a script that locates and removes unneeded files from various file systems. Its
2536             conventional location is <emphasis role="bold">/usr/lib/fs/nfs/nfsfind</emphasis>. The script generally uses an argument
2537             to the <emphasis role="bold">find</emphasis> command to define which file systems to search. In this step you modify the
2538             command to exclude the <emphasis role="bold">/afs</emphasis> directory. Otherwise, the command traverses the AFS
2539             filespace of every cell that is accessible from the machine, which can take many hours. The following alterations are
2540             possibilities, but you must verify that they are appropriate for your cell.</para>
2541
2542             <para>The first possible alteration is to add the <emphasis role="bold">-local</emphasis> flag to the existing command,
2543             so that it looks like the following:</para>
2544
2545             <programlisting>
2546    find $dir -local -name .nfs\* -mtime +7 -mount -exec rm -f {} \;
2547 </programlisting>
2548
2549             <para>Another alternative is to exclude any directories whose names begin with the lowercase letter <emphasis
2550             role="bold">a</emphasis> or a non-alphabetic character.</para>
2551
2552             <programlisting>
2553    find /[A-Zb-z]*  <replaceable>remainder of existing command</replaceable>
2554 </programlisting>
2555
2556             <para>Do not use the following command, which still searches under the <emphasis role="bold">/afs</emphasis> directory,
2557             looking for a subdirectory of type <emphasis role="bold">4.2</emphasis>.</para>
2558
2559             <programlisting>
2560    find / -fstype 4.2     /* <replaceable>do not use</replaceable> */
2561 </programlisting>
2562           </listitem>
2563
2564           <listitem>
2565             <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link> (or if referring to these instructions while
2566             installing an additional file server machine, return to <link linkend="HDRWQ108">Starting Server
2567             Programs</link>).</para>
2568           </listitem>
2569         </orderedlist>
2570
2571       <indexterm>
2572         <primary>Basic OverSeer Server</primary>
2573
2574         <see>BOS Server</see>
2575       </indexterm>
2576
2577       <indexterm>
2578         <primary>BOS Server</primary>
2579
2580         <secondary>starting</secondary>
2581
2582         <tertiary>first AFS machine</tertiary>
2583       </indexterm>
2584
2585       <indexterm>
2586         <primary>starting</primary>
2587
2588         <secondary>BOS Server</secondary>
2589
2590         <tertiary>first AFS machine</tertiary>
2591       </indexterm>
2592
2593       <indexterm>
2594         <primary>first AFS machine</primary>
2595
2596         <secondary>BOS Server</secondary>
2597       </indexterm>
2598
2599       <indexterm>
2600         <primary>authorization checking (disabling)</primary>
2601
2602         <secondary>first AFS machine</secondary>
2603       </indexterm>
2604
2605       <indexterm>
2606         <primary>disabling authorization checking</primary>
2607
2608         <secondary>first AFS machine</secondary>
2609       </indexterm>
2610
2611       <indexterm>
2612         <primary>first AFS machine</primary>
2613
2614         <secondary>authorization checking (disabling)</secondary>
2615       </indexterm>
2616     </sect2>
2617   </sect1>
2618   <sect1 id="HDRWQ50">
2619     <title>Starting the BOS Server</title>
2620
2621     <para>You are now ready to start the AFS server processes on this machine.
2622     If you are not working from a packaged distribution, begin by copying the
2623     AFS server binaries from the distribution to the conventional local disk
2624     location, the <emphasis role="bold">/usr/afs/bin</emphasis> directory. The
2625     following instructions also create files in other subdirectories of the
2626     <emphasis role="bold">/usr/afs</emphasis> directory.</para>
2627
2628     <para>Then issue the <emphasis role="bold">bosserver</emphasis> command to initialize the Basic OverSeer (BOS) Server, which
2629     monitors and controls other AFS server processes on its server machine. Include the <emphasis role="bold">-noauth</emphasis>
2630     flag to disable authorization checking. Because you have not yet configured your cell's AFS authentication and authorization
2631     mechanisms, the BOS Server cannot perform authorization checking as it does during normal operation. In no-authorization mode,
2632     it does not verify the identity or privilege of the issuer of a <emphasis role="bold">bos</emphasis> command, and so performs
2633     any operation for anyone.</para>
2634
2635     <para>Disabling authorization checking gravely compromises cell security. You must complete all subsequent steps in one
2636     uninterrupted pass and must not leave the machine unattended until you restart the BOS Server with authorization checking
2637     enabled, in <link linkend="HDRWQ72">Verifying the AFS Initialization Script</link>.</para>
2638
2639     <para>As it initializes for the first time, the BOS Server creates the following directories and files, setting the owner to the
2640     local superuser <emphasis role="bold">root</emphasis> and the mode bits to limit the ability to write (and in some cases, read)
2641     them. For a description of the contents and function of these directories and files, see the chapter in the <emphasis>OpenAFS
2642     Administration Guide</emphasis> about administering server machines. For further discussion of the mode bit settings, see <link
2643     linkend="HDRWQ96">Protecting Sensitive AFS Directories</link>. <indexterm>
2644         <primary>Binary Distribution</primary>
2645
2646         <secondary>copying server files from</secondary>
2647
2648         <tertiary>first AFS machine</tertiary>
2649       </indexterm> <indexterm>
2650         <primary>first AFS machine</primary>
2651
2652         <secondary>subdirectories of /usr/afs</secondary>
2653       </indexterm> <indexterm>
2654         <primary>creating</primary>
2655
2656         <secondary>/usr/afs/bin directory</secondary>
2657
2658         <tertiary>first AFS machine</tertiary>
2659       </indexterm> <indexterm>
2660         <primary>creating</primary>
2661
2662         <secondary>/usr/afs/etc directory</secondary>
2663
2664         <tertiary>first AFS machine</tertiary>
2665       </indexterm> <indexterm>
2666         <primary>copying</primary>
2667
2668         <secondary>server files to local disk</secondary>
2669
2670         <tertiary>first AFS machine</tertiary>
2671       </indexterm> <indexterm>
2672         <primary>first AFS machine</primary>
2673
2674         <secondary>copying</secondary>
2675
2676         <tertiary>server files to local disk</tertiary>
2677       </indexterm> <indexterm>
2678         <primary>usr/afs/bin directory</primary>
2679
2680         <secondary>first AFS machine</secondary>
2681       </indexterm> <indexterm>
2682         <primary>usr/afs/etc directory</primary>
2683
2684         <secondary>first AFS machine</secondary>
2685       </indexterm> <indexterm>
2686         <primary>usr/afs/db directory</primary>
2687       </indexterm> <indexterm>
2688         <primary>usr/afs/local directory</primary>
2689       </indexterm> <indexterm>
2690         <primary>usr/afs/logs directory</primary>
2691       </indexterm> <itemizedlist>
2692         <listitem>
2693           <para><emphasis role="bold">/usr/afs/db</emphasis></para>
2694         </listitem>
2695
2696         <listitem>
2697           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis></para>
2698         </listitem>
2699
2700         <listitem>
2701           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis></para>
2702         </listitem>
2703
2704         <listitem>
2705           <para><emphasis role="bold">/usr/afs/local</emphasis></para>
2706         </listitem>
2707
2708         <listitem>
2709           <para><emphasis role="bold">/usr/afs/logs</emphasis></para>
2710         </listitem>
2711       </itemizedlist></para>
2712
2713     <para>The BOS Server also creates symbolic links called <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2714     role="bold">/usr/vice/etc/CellServDB</emphasis> to the corresponding files in the <emphasis role="bold">/usr/afs/etc</emphasis>
2715     directory. The AFS command interpreters consult the <emphasis role="bold">CellServDB</emphasis> and <emphasis
2716     role="bold">ThisCell</emphasis> files in the <emphasis role="bold">/usr/vice/etc</emphasis> directory because they generally run
2717     on client machines. On machines that are AFS servers only (as this machine currently is), the files reside only in the <emphasis
2718     role="bold">/usr/afs/etc</emphasis> directory; the links enable the command interpreters to retrieve the information they need.
2719     Later instructions for installing the client functionality replace the links with actual files. <orderedlist>
2720         <listitem>
2721           <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.
2722 <programlisting>
2723    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.server/usr/afs</emphasis>
2724    # <emphasis role="bold">cp -rp  *  /usr/afs</emphasis>
2725 </programlisting> <indexterm>
2726               <primary>commands</primary>
2727
2728               <secondary>bosserver</secondary>
2729             </indexterm> <indexterm>
2730               <primary>bosserver command</primary>
2731             </indexterm></para>
2732         </listitem>
2733
2734         <listitem>
2735           <para>Issue the <emphasis role="bold">bosserver</emphasis> command. Include the <emphasis role="bold">-noauth</emphasis>
2736           flag to disable authorization checking. <programlisting>
2737    # <emphasis role="bold">/usr/afs/bin/bosserver -noauth &amp;</emphasis>
2738 </programlisting></para>
2739         </listitem>
2740
2741         <listitem>
2742           <para>Verify that the BOS Server created <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2743           role="bold">/usr/vice/etc/CellServDB</emphasis> as symbolic links to the corresponding files in the <emphasis
2744           role="bold">/usr/afs/etc</emphasis> directory. <programlisting>
2745    # <emphasis role="bold">ls -l  /usr/vice/etc</emphasis>
2746 </programlisting></para>
2747
2748           <para>If either or both of <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2749           role="bold">/usr/vice/etc/CellServDB</emphasis> do not exist, or are not links, issue the following commands.</para>
2750
2751           <programlisting>
2752    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2753    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell</emphasis>
2754    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB</emphasis>
2755 </programlisting>
2756         </listitem>
2757       </orderedlist></para>
2758
2759     <indexterm>
2760       <primary>cell name</primary>
2761
2762       <secondary>defining during installation of first machine</secondary>
2763     </indexterm>
2764
2765     <indexterm>
2766       <primary>defining</primary>
2767
2768       <secondary>cell name during installation of first machine</secondary>
2769     </indexterm>
2770
2771     <indexterm>
2772       <primary>cell name</primary>
2773
2774       <secondary>setting in server ThisCell file</secondary>
2775
2776       <tertiary>first AFS machine</tertiary>
2777     </indexterm>
2778
2779     <indexterm>
2780       <primary>setting</primary>
2781
2782       <secondary>cell name in server ThisCell file</secondary>
2783
2784       <tertiary>first AFS machine</tertiary>
2785     </indexterm>
2786
2787     <indexterm>
2788       <primary>first AFS machine</primary>
2789
2790       <secondary>ThisCell file (server)</secondary>
2791     </indexterm>
2792
2793     <indexterm>
2794       <primary>usr/afs/etc/ThisCell</primary>
2795
2796       <see>ThisCell file (server)</see>
2797     </indexterm>
2798
2799     <indexterm>
2800       <primary>ThisCell file (server)</primary>
2801
2802       <secondary>first AFS machine</secondary>
2803     </indexterm>
2804
2805     <indexterm>
2806       <primary>files</primary>
2807
2808       <secondary>ThisCell (server)</secondary>
2809     </indexterm>
2810
2811     <indexterm>
2812       <primary>database server machine</primary>
2813
2814       <secondary>entry in server CellServDB file</secondary>
2815
2816       <tertiary>on first AFS machine</tertiary>
2817     </indexterm>
2818
2819     <indexterm>
2820       <primary>first AFS machine</primary>
2821
2822       <secondary>cell membership, defining</secondary>
2823
2824       <tertiary>for server processes</tertiary>
2825     </indexterm>
2826
2827     <indexterm>
2828       <primary>usr/afs/etc/CellServDB file</primary>
2829
2830       <see>CellServDB file (server)</see>
2831     </indexterm>
2832
2833     <indexterm>
2834       <primary>CellServDB file (server)</primary>
2835
2836       <secondary>creating</secondary>
2837
2838       <tertiary>on first AFS machine</tertiary>
2839     </indexterm>
2840
2841     <indexterm>
2842       <primary>creating</primary>
2843
2844       <secondary>CellServDB file (server)</secondary>
2845
2846       <tertiary>first AFS machine</tertiary>
2847     </indexterm>
2848
2849     <indexterm>
2850       <primary>files</primary>
2851
2852       <secondary>CellServDB (server)</secondary>
2853     </indexterm>
2854
2855     <indexterm>
2856       <primary>first AFS machine</primary>
2857
2858       <secondary>CellServDB file (server)</secondary>
2859     </indexterm>
2860
2861     <indexterm>
2862       <primary>first AFS machine</primary>
2863
2864       <secondary>defining</secondary>
2865
2866       <tertiary>as database server</tertiary>
2867     </indexterm>
2868
2869     <indexterm>
2870       <primary>defining</primary>
2871
2872       <secondary>first AFS machine as database server</secondary>
2873     </indexterm>
2874   </sect1>
2875
2876   <sect1 id="HDRWQ51">
2877     <title>Defining Cell Name and Membership for Server Processes</title>
2878
2879     <para>Now assign your cell's name. The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration
2880     and administration issues discusses the important considerations, explains why changing the name is difficult, and outlines the
2881     restrictions on name format. Two of the most important restrictions are that the name cannot include uppercase letters or more
2882     than 64 characters.</para>
2883
2884     <para>Use the <emphasis role="bold">bos setcellname</emphasis> command to assign the cell name. It creates two files:
2885     <itemizedlist>
2886         <listitem>
2887           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis>, which defines this machine's cell membership</para>
2888         </listitem>
2889
2890         <listitem>
2891           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis>, which lists the cell's database server machines; the
2892           machine named on the command line is placed on the list automatically</para>
2893         </listitem>
2894       </itemizedlist> <note>
2895         <para>In the following and every instruction in this guide, for the <replaceable>machine name</replaceable> argument
2896         substitute the fully-qualified hostname (such as <emphasis role="bold">fs1.example.com</emphasis>) of the machine you are
2897         installing. For the <replaceable>cell name</replaceable> argument substitute your cell's complete name (such as <emphasis
2898         role="bold">example.com</emphasis>).</para>
2899       </note></para>
2900
2901     <indexterm>
2902       <primary>commands</primary>
2903
2904       <secondary>bos setcellname</secondary>
2905     </indexterm>
2906
2907     <indexterm>
2908       <primary>bos commands</primary>
2909
2910       <secondary>setcellname</secondary>
2911     </indexterm>
2912
2913     <orderedlist>
2914       <listitem>
2915         <para>If necessary, add the directory containing the <emphasis role="bold">bos</emphasis> command to your path.
2916       <programlisting>
2917    # <emphasis role="bold">export PATH=$PATH:/usr/afs/bin</emphasis>
2918       </programlisting>
2919         </para>
2920       </listitem>
2921
2922       <listitem>
2923         <para>Issue the <emphasis role="bold">bos setcellname</emphasis> command to set the cell name. <programlisting>
2924    # <emphasis role="bold">bos setcellname</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>cell name</replaceable>&gt; <emphasis
2925               role="bold">-noauth</emphasis>
2926 </programlisting></para>
2927
2928         <para>Because you are not authenticated and authorization checking is disabled, the <emphasis role="bold">bos</emphasis>
2929         command interpreter possibly produces error messages about being unable to obtain tickets and running unauthenticated. You
2930         can safely ignore the messages. <indexterm>
2931             <primary>commands</primary>
2932
2933             <secondary>bos listhosts</secondary>
2934           </indexterm> <indexterm>
2935             <primary>bos commands</primary>
2936
2937             <secondary>listhosts</secondary>
2938           </indexterm> <indexterm>
2939             <primary>CellServDB file (server)</primary>
2940
2941             <secondary>displaying entries</secondary>
2942           </indexterm> <indexterm>
2943             <primary>displaying</primary>
2944
2945             <secondary>CellServDB file (server) entries</secondary>
2946           </indexterm></para>
2947       </listitem>
2948
2949       <listitem>
2950         <para>Issue the <emphasis role="bold">bos listhosts</emphasis> command to verify that the machine you are installing is now
2951         registered as the cell's first database server machine. <programlisting>
2952    # <emphasis role="bold">bos listhosts</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
2953    Cell name is <replaceable>cell_name</replaceable>
2954        Host 1 is <replaceable>machine_name</replaceable>
2955 </programlisting></para>
2956       </listitem>
2957     </orderedlist>
2958
2959     <indexterm>
2960       <primary>database server machine</primary>
2961
2962       <secondary>installing</secondary>
2963
2964       <tertiary>first</tertiary>
2965     </indexterm>
2966
2967     <indexterm>
2968       <primary>instructions</primary>
2969
2970       <secondary>database server machine, installing first</secondary>
2971     </indexterm>
2972
2973     <indexterm>
2974       <primary>installing</primary>
2975
2976       <secondary>database server machine</secondary>
2977
2978       <tertiary>first</tertiary>
2979     </indexterm>
2980
2981     <indexterm>
2982       <primary>Backup Server</primary>
2983
2984       <secondary>starting</secondary>
2985
2986       <tertiary>first AFS machine</tertiary>
2987     </indexterm>
2988
2989     <indexterm>
2990       <primary>buserver process</primary>
2991
2992       <see>Backup Server</see>
2993     </indexterm>
2994
2995     <indexterm>
2996       <primary>starting</primary>
2997
2998       <secondary>Backup Server</secondary>
2999
3000       <tertiary>first AFS machine</tertiary>
3001     </indexterm>
3002
3003     <indexterm>
3004       <primary>first AFS machine</primary>
3005
3006       <secondary>Backup Server</secondary>
3007     </indexterm>
3008
3009     <indexterm>
3010       <primary>Protection Server</primary>
3011
3012       <secondary>starting</secondary>
3013
3014       <tertiary>first AFS machine</tertiary>
3015     </indexterm>
3016
3017     <indexterm>
3018       <primary>ptserver process</primary>
3019
3020       <see>Protection Server</see>
3021     </indexterm>
3022
3023     <indexterm>
3024       <primary>starting</primary>
3025
3026       <secondary>Protection Server</secondary>
3027
3028       <tertiary>first AFS machine</tertiary>
3029     </indexterm>
3030
3031     <indexterm>
3032       <primary>first AFS machine</primary>
3033
3034       <secondary>Protection Server</secondary>
3035     </indexterm>
3036
3037     <indexterm>
3038       <primary>VL Server (vlserver process)</primary>
3039
3040       <secondary>starting</secondary>
3041
3042       <tertiary>first AFS machine</tertiary>
3043     </indexterm>
3044
3045     <indexterm>
3046       <primary>Volume Location Server</primary>
3047
3048       <see>VL Server</see>
3049     </indexterm>
3050
3051     <indexterm>
3052       <primary>starting</primary>
3053
3054       <secondary>VL Server</secondary>
3055
3056       <tertiary>first AFS machine</tertiary>
3057     </indexterm>
3058
3059     <indexterm>
3060       <primary>first AFS machine</primary>
3061
3062       <secondary>VL Server</secondary>
3063     </indexterm>
3064
3065     <indexterm>
3066       <primary>usr/afs/local/BosConfig</primary>
3067
3068       <see>BosConfig file</see>
3069     </indexterm>
3070
3071     <indexterm>
3072       <primary>BosConfig file</primary>
3073
3074       <secondary>adding entries</secondary>
3075
3076       <tertiary>first AFS machine</tertiary>
3077     </indexterm>
3078
3079     <indexterm>
3080       <primary>adding</primary>
3081
3082       <secondary>entries to BosConfig file</secondary>
3083
3084       <tertiary>first AFS machine</tertiary>
3085     </indexterm>
3086
3087     <indexterm>
3088       <primary>files</primary>
3089
3090       <secondary>BosConfig</secondary>
3091     </indexterm>
3092
3093     <indexterm>
3094       <primary>initializing</primary>
3095
3096       <secondary>server process</secondary>
3097
3098       <see>starting</see>
3099     </indexterm>
3100
3101     <indexterm>
3102       <primary>server process</primary>
3103
3104       <secondary>see also entry for each server's name</secondary>
3105     </indexterm>
3106   </sect1>
3107
3108   <sect1 id="HDRWQ52">
3109     <title>Starting the Database Server Processes</title>
3110
3111     <para>Next use the <emphasis role="bold">bos create</emphasis> command to create entries for the three database server processes
3112     in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file and start them running. The three processes run on database
3113     server machines only: <itemizedlist>
3114
3115         <listitem>
3116           <para>The Backup Server (the <emphasis role="bold">buserver</emphasis> process) maintains the Backup Database</para>
3117         </listitem>
3118
3119         <listitem>
3120           <para>The Protection Server (the <emphasis role="bold">ptserver</emphasis> process) maintains the Protection
3121           Database</para>
3122         </listitem>
3123
3124         <listitem>
3125           <para>The Volume Location (VL) Server (the <emphasis role="bold">vlserver</emphasis> process) maintains the Volume
3126           Location Database (VLDB)</para>
3127         </listitem>
3128       </itemizedlist></para>
3129
3130     <indexterm>
3131       <primary>Kerberos</primary>
3132     </indexterm>
3133
3134     <note>
3135       <para>AFS ships with an additional database server named 'kaserver', which
3136       was historically used to provide authentication services to AFS cells.
3137       kaserver was based on <emphasis>Kerberos v4</emphasis>, as such, it is
3138       not recommended for new cells. This guide assumes you have already
3139       configured a Kerberos v5 realm for your site, and details the procedures
3140       required to use AFS with this realm. If you do wish to use
3141       <emphasis role="bold">kaserver</emphasis>, please see the modifications
3142       to these instructions detailed in
3143       <link linkend="KAS006">Starting the kaserver Database Server Process</link>
3144       </para>
3145     </note>
3146
3147     <para>The remaining instructions in this chapter include the <emphasis role="bold">-cell</emphasis> argument on all applicable
3148     commands. Provide the cell name you assigned in <link linkend="HDRWQ51">Defining Cell Name and Membership for Server
3149     Processes</link>. If a command appears on multiple lines, it is only for legibility. <indexterm>
3150         <primary>commands</primary>
3151
3152         <secondary>bos create</secondary>
3153       </indexterm> <indexterm>
3154         <primary>bos commands</primary>
3155
3156         <secondary>create</secondary>
3157       </indexterm> <orderedlist>
3158         <listitem>
3159           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Backup Server. <programlisting>
3160    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">buserver simple /usr/afs/bin/buserver</emphasis>  <emphasis role="bold">-noauth</emphasis>
3161 </programlisting></para>
3162         </listitem>
3163
3164         <listitem>
3165           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Protection Server. <programlisting>
3166    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">ptserver simple /usr/afs/bin/ptserver</emphasis> <emphasis role="bold">-noauth</emphasis>
3167 </programlisting></para>
3168         </listitem>
3169
3170         <listitem>
3171           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the VL Server. <programlisting>
3172    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">vlserver simple /usr/afs/bin/vlserver</emphasis> <emphasis role="bold">-noauth</emphasis>
3173 </programlisting></para>
3174         </listitem>
3175       </orderedlist></para>
3176
3177     <indexterm>
3178       <primary>admin account</primary>
3179
3180       <secondary>creating</secondary>
3181     </indexterm>
3182
3183     <indexterm>
3184       <primary>afs entry in Kerberos Database</primary>
3185     </indexterm>
3186
3187     <indexterm>
3188       <primary>Kerberos Database</primary>
3189     </indexterm>
3190
3191     <indexterm>
3192       <primary>creating</primary>
3193
3194       <secondary>afs entry in Kerberos Database</secondary>
3195     </indexterm>
3196
3197     <indexterm>
3198       <primary>creating</primary>
3199
3200       <secondary>admin account in Kerberos Database</secondary>
3201     </indexterm>
3202
3203     <indexterm>
3204       <primary>security</primary>
3205
3206       <secondary>initializing cell-wide</secondary>
3207     </indexterm>
3208
3209     <indexterm>
3210       <primary>cell</primary>
3211
3212       <secondary>initializing security mechanisms</secondary>
3213     </indexterm>
3214
3215     <indexterm>
3216       <primary>initializing</primary>
3217
3218       <secondary>cell security mechanisms</secondary>
3219     </indexterm>
3220
3221     <indexterm>
3222       <primary>usr/afs/etc/KeyFile</primary>
3223
3224       <see>KeyFile file</see>
3225     </indexterm>
3226
3227     <indexterm>
3228       <primary>KeyFile file</primary>
3229
3230       <secondary>first AFS machine</secondary>
3231     </indexterm>
3232
3233     <indexterm>
3234       <primary>files</primary>
3235
3236       <secondary>KeyFile</secondary>
3237     </indexterm>
3238
3239     <indexterm>
3240       <primary>key</primary>
3241
3242       <see>server encryption key</see>
3243     </indexterm>
3244
3245     <indexterm>
3246       <primary>encryption key</primary>
3247
3248       <see>server encryption key</see>
3249     </indexterm>
3250   </sect1>
3251
3252   <sect1 id="HDRWQ53">
3253     <title>Initializing Cell Security </title>
3254
3255     <para>If you are working with an existing cell which uses
3256     <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for authentication,
3257     please see
3258     <link linkend="HDRWQ53">Initializing Cell Security with kaserver</link>
3259     for installation instructions which replace this section.</para>
3260
3261     <para>Now initialize the cell's security mechanisms. Begin by creating the following two entires in your site's Kerberos database: <itemizedlist>
3262         <listitem>
3263           <para>A generic administrative account, called <emphasis role="bold">admin</emphasis> by convention. If you choose to
3264           assign a different name, substitute it throughout the remainder of this document.</para>
3265
3266           <para>After you complete the installation of the first machine, you can continue to have all administrators use the
3267           <emphasis role="bold">admin</emphasis> account, or you can create a separate administrative account for each of them. The
3268           latter scheme implies somewhat more overhead, but provides a more informative audit trail for administrative
3269           operations.</para>
3270         </listitem>
3271
3272         <listitem>
3273           <para>The entry for AFS server processes, called either
3274           <emphasis role="bold">afs</emphasis> or
3275           <emphasis role="bold">afs/<replaceable>cell</replaceable></emphasis>.
3276           No user logs in under this identity, but it is used to encrypt the
3277           server tickets that granted to AFS clients for presentation to
3278           server processes during mutual authentication. (The
3279           chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and administration describes the
3280           role of server encryption keys in mutual authentication.)</para>
3281
3282           <para>In Step <link linkend="LIWQ58">7</link>, you also place the initial AFS server encryption key into the <emphasis
3283           role="bold">/usr/afs/etc/KeyFile</emphasis> file. The AFS server processes refer to this file to learn the server
3284           encryption key when they need to decrypt server tickets.</para>
3285         </listitem>
3286       </itemizedlist></para>
3287
3288     <para>You also issue several commands that enable the new <emphasis role="bold">admin</emphasis> user to issue privileged
3289     commands in all of the AFS suites.</para>
3290
3291     <para>The following instructions do not configure all of the security mechanisms related to the AFS Backup System. See the
3292     chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about configuring the Backup System.</para>
3293
3294     <para>The examples below assume you are using MIT Kerberos. Please refer
3295     to the documentation for your KDC's administrative interface if you are
3296     using a different vendor</para>
3297
3298     <orderedlist>
3299         <listitem>
3300           <para>Enter <emphasis role="bold">kadmin</emphasis> interactive mode.
3301 <programlisting>
3302    # <emphasis role="bold">kadmin</emphasis>
3303 Authenticating as principal <replaceable>you</replaceable>/admin@<replaceable>YOUR REALM</replaceable> with password
3304 Password for <replaceable>you/admin@REALM</replaceable>: <replaceable>your_password</replaceable>
3305 </programlisting> <indexterm>
3306               <primary>server encryption key</primary>
3307
3308               <secondary>in Kerberos Database</secondary>
3309             </indexterm> <indexterm>
3310               <primary>creating</primary>
3311
3312               <secondary>server encryption key</secondary>
3313
3314               <tertiary>Kerberos Database</tertiary>
3315             </indexterm></para>
3316         </listitem>
3317
3318         <listitem>
3319           <para><anchor id="LIWQ54" />Issue the
3320           <emphasis role="bold">add_principal</emphasis> command to create
3321           Kerberos Database entries called
3322           <emphasis role="bold">admin</emphasis> and
3323           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>.</para>
3324
3325           <para>You should make the <replaceable>admin_passwd</replaceable> as