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>Optionally, 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 system types using the <emphasis role="bold">inode</emphasis> storage format, 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
3326           long and complex as possible, but keep in mind that administrators
3327           need to enter it often. It must be at least six characters long.</para>
3328           <para>Note that when creating the
3329           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3330           entry, the encryption types should be restricted to des-cbc-crc:v4.
3331           For more details regarding encryption types, see the documentation
3332           for your Kerberos installation.
3333
3334 <programlisting>
3335    kadmin: <emphasis role="bold">add_principal -randkey -e des-cbc-crc:v4 afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3336    Principal "afs/<replaceable>cell name</replaceable>@<replaceable>REALM</replaceable>" created.
3337    kadmin:  <emphasis role="bold">add_principal admin</emphasis>
3338    Enter password for principal "admin@<replaceable>REALM</replaceable>": <emphasis role="bold"><replaceable>admin_password</replaceable></emphasis>
3339    Principal "admin@<replaceable>REALM</replaceable>" created.
3340 </programlisting>
3341           </para>
3342
3343           <indexterm>
3344             <primary>commands</primary>
3345
3346             <secondary>kas examine</secondary>
3347           </indexterm>
3348
3349           <indexterm>
3350             <primary>kas commands</primary>
3351
3352             <secondary>examine</secondary>
3353           </indexterm>
3354
3355           <indexterm>
3356             <primary>displaying</primary>
3357
3358             <secondary>server encryption key</secondary>
3359
3360             <tertiary>Authentication Database</tertiary>
3361           </indexterm>
3362         </listitem>
3363
3364         <listitem>
3365           <para><anchor id="LIWQ55" />Issue the <emphasis role="bold">kadmin
3366           get_principal</emphasis> command to display the <emphasis
3367           role="bold">afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt; entry.
3368 <programlisting>
3369   kadmin: <emphasis role="bold">get_principal afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3370   Principal: afs/<replaceable>cell</replaceable>
3371   [ ... ]
3372   Key: vno 2, DES cbc mode with CRC-32, no salt
3373   [ ... ]
3374 </programlisting>
3375 </para>
3376         </listitem>
3377         <listitem>
3378           <para>Extract the newly created key for <emphasis role="bold">afs/<replaceable>cell</replaceable></emphasis> to a keytab on the local machine. We will use <emphasis role="bold">/etc/afs.keytab</emphasis> as the location for this keytab.</para>
3379
3380           <para>The keytab contains the key material that ensures the security of your AFS cell. You should ensure that it is kept in a secure location at all times.</para>
3381
3382 <programlisting>
3383   kadmin: <emphasis role="bold">ktadd -k /etc/afs.keytab -e des-cbc-crc:v4 afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3384 Entry for principal afs/&lt;<replaceable>cell name</replaceable>&gt; with kvno 3, encryption type DES cbc mode with CRC-32 added to keytab WRFILE:/etc/afs.keytab
3385 </programlisting>
3386           <para>Make a note of the key version number (kvno) given in the
3387           response, as you will need it to load the key into bos in a later
3388           step</para>
3389
3390           <note><para>Note that each time you run
3391           <emphasis role="bold">ktadd</emphasis> a new key is generated
3392           for the item being extracted. This means that you cannot run ktadd
3393           multiple times and end up with the same key material each time.
3394           </para></note>
3395
3396         </listitem>
3397         <listitem>
3398           <para>Issue the <emphasis role="bold">kadmin quit</emphasis> command to leave <emphasis role="bold">kadmin</emphasis>
3399           interactive mode. <programlisting>
3400    kadmin: <emphasis role="bold">quit</emphasis>
3401 </programlisting> <indexterm>
3402               <primary>commands</primary>
3403
3404               <secondary>bos adduser</secondary>
3405             </indexterm> <indexterm>
3406               <primary>bos commands</primary>
3407
3408               <secondary>adduser</secondary>
3409             </indexterm> <indexterm>
3410               <primary>usr/afs/etc/UserList</primary>
3411
3412               <see>UserList file</see>
3413             </indexterm> <indexterm>
3414               <primary>UserList file</primary>
3415
3416               <secondary>first AFS machine</secondary>
3417             </indexterm> <indexterm>
3418               <primary>files</primary>
3419
3420               <secondary>UserList</secondary>
3421             </indexterm> <indexterm>
3422               <primary>creating</primary>
3423
3424               <secondary>UserList file entry</secondary>
3425             </indexterm> <indexterm>
3426               <primary>admin account</primary>
3427
3428               <secondary>adding</secondary>
3429
3430               <tertiary>to UserList file</tertiary>
3431             </indexterm></para>
3432         </listitem>
3433
3434         <listitem>
3435           <para><anchor id="LIWQ57" />Issue the <emphasis role="bold">bos adduser</emphasis> command to add the <emphasis
3436           role="bold">admin</emphasis> user to the <emphasis role="bold">/usr/afs/etc/UserList</emphasis> file. This enables the
3437           <emphasis role="bold">admin</emphasis> user to issue privileged <emphasis role="bold">bos</emphasis> and <emphasis
3438           role="bold">vos</emphasis> commands. <programlisting>
3439    # <emphasis role="bold">./bos adduser</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">admin -noauth</emphasis>
3440 </programlisting>
3441             <indexterm>
3442               <primary>commands</primary>
3443               <secondary>asetkey</secondary>
3444             </indexterm>
3445             <indexterm>
3446               <primary>creating</primary>
3447               <secondary>server encryption key</secondary>
3448               <tertiary>KeyFile file</tertiary>
3449             </indexterm>
3450             <indexterm>
3451               <primary>server encryption key</primary>
3452               <secondary>in KeyFile file</secondary>
3453             </indexterm></para>
3454         </listitem>
3455
3456         <listitem>
3457           <para><anchor id="LIWQ58" />Issue the
3458           <emphasis role="bold">asetkey</emphasis> command to set the AFS
3459           server encryption key in the
3460           <emphasis role="bold">/usr/afs/etc/KeyFile</emphasis> file. This key
3461           is created from the <emphasis role="bold">/etc/afs.keytab</emphasis>
3462           file created earlier.</para>
3463
3464           <para>asetkey requires the key version number (or kvno) of the
3465           <emphasis role="bold">afs/</emphasis><replaceable>cell</replaceable>
3466           key. You should have noted this down when creating the key earlier.
3467           The key version number can also be found by running the
3468           <emphasis role="bold">kvno</emphasis> command</para>
3469 <programlisting>
3470    # <emphasis role="bold">kvno afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3471 </programlisting>
3472
3473           <para>Once the kvno is known, the key can then be extracted using
3474           asetkey</para>
3475 <programlisting>
3476    # <emphasis role="bold">asetkey add</emphasis> &lt;<replaceable>kvno</replaceable>&gt;  <emphasis role="bold">/etc/afs.keytab afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3477 </programlisting>
3478
3479           <indexterm>
3480             <primary>commands</primary>
3481             <secondary>bos listkeys</secondary>
3482           </indexterm>
3483
3484           <indexterm>
3485             <primary>bos commands</primary>
3486             <secondary>listkeys</secondary>
3487           </indexterm>
3488
3489           <indexterm>
3490             <primary>displaying</primary>
3491             <secondary>server encryption key</secondary>
3492             <tertiary>KeyFile file</tertiary>
3493           </indexterm>
3494         </listitem>
3495
3496         <listitem>
3497           <para><anchor id="LIWQ59" />Issue the
3498           <emphasis role="bold">bos listkeys</emphasis> command to verify that
3499           the key version number for the new key in the
3500           <emphasis role="bold">KeyFile</emphasis> file is the same as the key
3501           version number in the Authentication Database's
3502           <emphasis role="bold">afs/<replaceable>cell name</replaceable></emphasis>
3503           entry, which you displayed in Step <link linkend="LIWQ55">3</link>.
3504 <programlisting>
3505    # <emphasis role="bold">./bos listkeys</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
3506    key 0 has cksum <replaceable>checksum</replaceable>
3507 </programlisting></para>
3508
3509           <para>You can safely ignore any error messages indicating that <emphasis role="bold">bos</emphasis> failed to get tickets
3510           or that authentication failed.</para>
3511         </listitem>
3512       </orderedlist>
3513     </sect1>
3514     <sect1 id="HDRWQ53a">
3515       <title>Initializing the Protection Database</title>
3516
3517       <para>Now continue to configure your cell's security systems by
3518       populating the Protection Database with the newly created
3519       <emphasis role="bold">admin</emphasis> user, and permitting it
3520       to issue priviledged commands on the AFS filesystem.</para>
3521
3522         <orderedlist>
3523           <listitem>
3524           <indexterm>
3525             <primary>commands</primary>
3526             <secondary>pts createuser</secondary>
3527           </indexterm>
3528
3529           <indexterm>
3530             <primary>pts commands</primary>
3531             <secondary>createuser</secondary>
3532           </indexterm>
3533
3534           <indexterm>
3535             <primary>Protection Database</primary>
3536           </indexterm>
3537           <para>Issue the <emphasis role="bold">pts createuser</emphasis> command to create a Protection Database entry for the
3538           <emphasis role="bold">admin</emphasis> user.</para>
3539
3540           <para>By default, the Protection Server assigns AFS UID 1 (one) to the <emphasis role="bold">admin</emphasis> user,
3541           because it is the first user entry you are creating. If the local password file (<emphasis
3542           role="bold">/etc/passwd</emphasis> or equivalent) already has an entry for <emphasis role="bold">admin</emphasis> that
3543           assigns it a UNIX UID other than 1, it is best to use the <emphasis role="bold">-id</emphasis> argument to the <emphasis
3544           role="bold">pts createuser</emphasis> command to make the new AFS UID match the existing UNIX UID. Otherwise, it is best
3545           to accept the default.</para>
3546
3547           <programlisting>
3548    # <emphasis role="bold">pts createuser -name admin</emphasis> [<emphasis
3549               role="bold">-id</emphasis> &lt;<replaceable>AFS UID</replaceable>&gt;]  <emphasis role="bold">-noauth</emphasis>
3550    User admin has id <replaceable>AFS UID</replaceable>
3551 </programlisting>
3552
3553           <indexterm>
3554             <primary>commands</primary>
3555             <secondary>pts adduser</secondary>
3556           </indexterm>
3557
3558           <indexterm>
3559             <primary>pts commands</primary>
3560             <secondary>adduser</secondary>
3561           </indexterm>
3562
3563           <indexterm>
3564             <primary>system:administrators group</primary>
3565           </indexterm>
3566
3567           <indexterm>
3568             <primary>admin account</primary>
3569             <secondary>adding</secondary>
3570             <tertiary>to system:administrators group</tertiary>
3571           </indexterm>
3572         </listitem>
3573
3574         <listitem>
3575           <para>Issue the <emphasis role="bold">pts adduser</emphasis> command to make the <emphasis role="bold">admin</emphasis>
3576           user a member of the <emphasis role="bold">system:administrators</emphasis> group, and the <emphasis role="bold">pts
3577           membership</emphasis> command to verify the new membership. Membership in the group enables the <emphasis
3578           role="bold">admin</emphasis> user to issue privileged <emphasis role="bold">pts</emphasis> commands and some privileged
3579           <emphasis role="bold">fs</emphasis> commands. <programlisting>
3580    # <emphasis role="bold">./pts adduser admin system:administrators</emphasis> <emphasis role="bold">-noauth</emphasis>
3581    # <emphasis role="bold">./pts membership admin</emphasis> <emphasis role="bold">-noauth</emphasis>
3582    Groups admin (id: 1) is a member of:
3583      system:administrators
3584 </programlisting> <indexterm>
3585               <primary>commands</primary>
3586               <secondary>bos restart</secondary>
3587               <tertiary>on first AFS machine</tertiary>
3588             </indexterm> <indexterm>
3589               <primary>bos commands</primary>
3590               <secondary>restart</secondary>
3591               <tertiary>on first AFS machine</tertiary>
3592             </indexterm> <indexterm>
3593               <primary>restarting server process</primary>
3594               <secondary>on first AFS machine</secondary>
3595             </indexterm> <indexterm>
3596               <primary>server process</primary>
3597               <secondary>restarting</secondary>
3598               <tertiary>on first AFS machine</tertiary>
3599             </indexterm></para>
3600         </listitem>
3601
3602         <listitem>
3603           <para>Issue the <emphasis role="bold">bos restart</emphasis> command with the <emphasis role="bold">-all</emphasis> flag
3604           to restart the database server processes, so that they start using the new server encryption key. <programlisting>
3605    # <emphasis role="bold">./bos restart</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-all</emphasis>
3606    <emphasis role="bold">-noauth</emphasis>
3607 </programlisting></para>
3608         </listitem>
3609       </orderedlist>
3610
3611     <indexterm>
3612       <primary>File Server</primary>
3613
3614       <secondary>first AFS machine</secondary>
3615     </indexterm>
3616
3617     <indexterm>
3618       <primary>fileserver process</primary>
3619
3620       <see>File Server</see>
3621     </indexterm>
3622
3623     <indexterm>
3624       <primary>starting</primary>
3625
3626       <secondary>File Server</secondary>
3627
3628       <tertiary>first AFS machine</tertiary>
3629     </indexterm>
3630
3631     <indexterm>
3632       <primary>first AFS machine</primary>
3633
3634       <secondary>File Server, fs process</secondary>
3635     </indexterm>
3636
3637     <indexterm>
3638       <primary>Volume Server</primary>
3639
3640       <secondary>first AFS machine</secondary>
3641     </indexterm>
3642
3643     <indexterm>
3644       <primary>volserver process</primary>
3645
3646       <see>Volume Server</see>
3647     </indexterm>
3648
3649     <indexterm>
3650       <primary>starting</primary>
3651
3652       <secondary>Volume Server</secondary>
3653
3654       <tertiary>first AFS machine</tertiary>
3655     </indexterm>
3656
3657     <indexterm>
3658       <primary>first AFS machine</primary>
3659
3660       <secondary>Volume Server</secondary>
3661     </indexterm>
3662
3663     <indexterm>
3664       <primary>Salvager (salvager process)</primary>
3665
3666       <secondary>first AFS machine</secondary>
3667     </indexterm>
3668
3669     <indexterm>
3670       <primary>fs process</primary>
3671
3672       <secondary>first AFS machine</secondary>
3673     </indexterm>
3674
3675     <indexterm>
3676       <primary>starting</primary>
3677
3678       <secondary>fs process</secondary>
3679
3680       <tertiary>first AFS machine</tertiary>
3681     </indexterm>
3682
3683     <indexterm>
3684       <primary>first AFS machine</primary>
3685
3686       <secondary>Salvager</secondary>
3687     </indexterm>
3688   </sect1>
3689
3690   <sect1 id="HDRWQ60">
3691     <title>Starting the File Server processes</title>
3692
3693     <para>Start either the <emphasis role="bold">fs</emphasis> process or, if you want to run the Demand-Attach File Server, the
3694     <emphasis role="bold">dafs</emphasis> process. The <emphasis role="bold">fs</emphasis> process consists of the File Server,
3695     Volume Server, and Salvager (<emphasis role="bold">fileserver</emphasis>, <emphasis role="bold">volserver</emphasis> and
3696     <emphasis role="bold">salvager</emphasis> processes). The <emphasis role="bold">dafs</emphasis> process consists of the
3697     Demand-Attach File Server, Volume Server, Salvage Server, and Salvager (<emphasis role="bold">dafileserver</emphasis>,
3698     <emphasis role="bold"> davolserver</emphasis>, <emphasis role="bold">salvageserver</emphasis>, and <emphasis
3699     role="bold">dasalvager</emphasis> processes). For information about the Demand-Attach File Server and to see whether or not
3700     you should run it, see <link linkend="DAFS">Appendix C, The Demand-Attach File Server</link>.
3701      <orderedlist>
3702         <listitem>
3703           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">fs</emphasis>
3704           process or the <emphasis role="bold">dafs</emphasis> process. The commands appear here on multiple lines only for legibility.
3705
3706             <itemizedlist>
3707               <listitem>
3708                 <para>If you are not planning on running the Demand-Attach File Server, create the <emphasis role="bold">fs</emphasis>
3709                 process:
3710                   <programlisting>
3711    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs fs /usr/afs/bin/fileserver</emphasis>   \
3712                    <emphasis role="bold">/usr/afs/bin/volserver /usr/afs/bin/salvager</emphasis>  \
3713                    <emphasis role="bold">-noauth</emphasis>
3714 </programlisting></para>
3715              </listitem>
3716              <listitem>
3717                <para>If you are planning on running the Demand-Attach File Server, create the <emphasis
3718                role="bold">dafs</emphasis> process:
3719                   <programlisting>
3720    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">dafs dafs /usr/afs/bin/dafileserver</emphasis>   \
3721                    <emphasis role="bold">/usr/afs/bin/davolserver /usr/afs/bin/salvageserver</emphasis> \
3722                    <emphasis role="bold">/usr/afs/bin/salvager</emphasis> <emphasis role="bold">-noauth</emphasis>
3723 </programlisting></para>
3724              </listitem>
3725             </itemizedlist>
3726           </para>
3727
3728           <para>Sometimes a message about Volume Location Database (VLDB) initialization appears, along with one or more instances
3729           of an error message similar to the following:</para>
3730
3731           <programlisting>
3732    FSYNC_clientInit temporary failure (will retry)
3733 </programlisting>
3734
3735           <para>This message appears when the <emphasis role="bold">volserver</emphasis> process tries to start before the <emphasis
3736           role="bold">fileserver</emphasis> process has completed its initialization. Wait a few minutes after the last such message
3737           before continuing, to guarantee that both processes have started successfully. <indexterm>
3738               <primary>commands</primary>
3739
3740               <secondary>bos status</secondary>
3741             </indexterm> <indexterm>
3742               <primary>bos commands</primary>
3743
3744               <secondary>status</secondary>
3745             </indexterm></para>
3746
3747           <para>You can verify that the <emphasis role="bold">fs</emphasis> or <emphasis role="bold">dafs</emphasis> process has started
3748           successfully by issuing the <emphasis role="bold">bos status</emphasis> command. Its output mentions two <computeroutput>proc
3749           starts</computeroutput>.</para>
3750
3751           <itemizedlist>
3752             <listitem>
3753               <para>If you are not running the Demand-Attach File Server:
3754
3755           <programlisting>
3756    # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs -long -noauth</emphasis>
3757 </programlisting></para></listitem>
3758
3759             <listitem>
3760               <para>If you are running the Demand-Attach File Server:
3761           <programlisting>
3762    # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">dafs -long -noauth</emphasis>
3763 </programlisting></para></listitem>
3764           </itemizedlist>
3765
3766         </listitem>
3767
3768         <listitem>
3769           <para>Your next action depends on whether you have ever run AFS file server machines in the cell: <itemizedlist>
3770               <indexterm>
3771                 <primary>commands</primary>
3772
3773                 <secondary>vos create</secondary>
3774
3775                 <tertiary>root.afs volume</tertiary>
3776               </indexterm>
3777
3778               <indexterm>
3779                 <primary>vos commands</primary>
3780
3781                 <secondary>create</secondary>
3782
3783                 <tertiary>root.afs volume</tertiary>
3784               </indexterm>
3785
3786               <indexterm>
3787                 <primary>root.afs volume</primary>
3788
3789                 <secondary>creating</secondary>
3790               </indexterm>
3791
3792               <indexterm>
3793                 <primary>volume</primary>
3794
3795                 <secondary>creating</secondary>
3796
3797                 <tertiary>root.afs</tertiary>
3798               </indexterm>
3799
3800               <indexterm>
3801                 <primary>creating</primary>
3802
3803                 <secondary>root.afs volume</secondary>
3804               </indexterm>
3805
3806               <listitem>
3807                 <para>If you are installing the first AFS server machine ever in the cell (that is, you are not upgrading the AFS
3808                 software from a previous version), create the first AFS volume, <emphasis role="bold">root.afs</emphasis>.</para>
3809
3810                 <para>For the <replaceable>partition name</replaceable> argument, substitute the name of one of the machine's AFS
3811                 server partitions (such as <emphasis role="bold">/vicepa</emphasis>).</para>
3812
3813                 <programlisting>
3814    # <emphasis role="bold">./vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
3815                     role="bold">root.afs</emphasis>   \
3816                    <emphasis role="bold">-noauth</emphasis>
3817 </programlisting>
3818
3819                 <para>The Volume Server produces a message confirming that it created the volume on the specified partition. You can
3820                 ignore error messages indicating that tokens are missing, or that authentication failed. <indexterm>
3821                     <primary>commands</primary>
3822
3823                     <secondary>vos syncvldb</secondary>
3824                   </indexterm> <indexterm>
3825                     <primary>vos commands</primary>
3826
3827                     <secondary>syncvldb</secondary>
3828                   </indexterm> <indexterm>
3829                     <primary>commands</primary>
3830
3831                     <secondary>vos syncserv</secondary>
3832                   </indexterm> <indexterm>
3833                     <primary>vos commands</primary>
3834
3835                     <secondary>syncserv</secondary>
3836                   </indexterm></para>
3837               </listitem>
3838
3839               <listitem>
3840                 <para>If there are existing AFS file server machines and volumes in the cell, issue the <emphasis role="bold">vos
3841                 syncvldb</emphasis> and <emphasis role="bold">vos syncserv</emphasis> commands to synchronize the VLDB with the
3842                 actual state of volumes on the local machine. To follow the progress of the synchronization operation, which can
3843                 take several minutes, use the <emphasis role="bold">-verbose</emphasis> flag. <programlisting>
3844    # <emphasis role="bold">./vos syncvldb</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
3845                       role="bold">-verbose  -noauth</emphasis>
3846    # <emphasis role="bold">./vos syncserv</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
3847                       role="bold">-verbose  -noauth</emphasis>
3848 </programlisting></para>
3849
3850                 <para>You can ignore error messages indicating that tokens are missing, or that authentication failed.</para>
3851               </listitem>
3852             </itemizedlist></para>
3853         </listitem>
3854       </orderedlist></para>
3855
3856     <indexterm>
3857       <primary>Update Server</primary>
3858
3859       <secondary>starting server portion</secondary>
3860
3861       <tertiary>first AFS machine</tertiary>
3862     </indexterm>
3863
3864     <indexterm>
3865       <primary>upserver process</primary>
3866
3867       <see>Update Server</see>
3868     </indexterm>
3869
3870     <indexterm>
3871       <primary>starting</primary>
3872
3873       <secondary>Update Server server portion</secondary>
3874
3875       <tertiary>first AFS machine</tertiary>
3876     </indexterm>
3877
3878     <indexterm>
3879       <primary>first AFS machine</primary>
3880
3881       <secondary>Update Server server portion</secondary>
3882     </indexterm>
3883
3884     <indexterm>
3885       <primary>first AFS machine</primary>
3886
3887       <secondary>defining</secondary>
3888
3889       <tertiary>as binary distribution machine</tertiary>
3890     </indexterm>
3891
3892     <indexterm>
3893       <primary>first AFS machine</primary>
3894
3895       <secondary>defining</secondary>
3896
3897       <tertiary>as system control machine</tertiary>
3898     </indexterm>
3899
3900     <indexterm>
3901       <primary>system control machine</primary>
3902     </indexterm>
3903
3904     <indexterm>
3905       <primary>binary distribution machine</primary>
3906     </indexterm>
3907   </sect1>
3908
3909   <sect1 id="HDRWQ61">
3910     <title>Starting the Server Portion of the Update Server</title>
3911
3912     <para>Start the server portion of the Update Server (the <emphasis role="bold">upserver</emphasis> process), to distribute the
3913     contents of directories on this machine to other server machines in the cell. It becomes active when you configure the client
3914     portion of the Update Server on additional server machines.</para>
3915
3916     <para>Distributing the contents of its <emphasis role="bold">/usr/afs/etc</emphasis> directory makes this machine the cell's
3917     <emphasis>system control machine</emphasis>. The other server machines in the cell run the <emphasis
3918     role="bold">upclientetc</emphasis> process (an instance of the client portion of the Update Server) to retrieve the
3919     configuration files. Use the <emphasis role="bold">-crypt</emphasis> argument to the <emphasis role="bold">upserver</emphasis>
3920     initialization command to specify that the Update Server distributes the contents of the <emphasis
3921     role="bold">/usr/afs/etc</emphasis> directory only in encrypted form, as shown in the following instruction. Several of the
3922     files in the directory, particularly the <emphasis role="bold">KeyFile</emphasis> file, are crucial to cell security and so must
3923     never cross the network unencrypted.</para>
3924
3925     <para>(You can choose not to configure a system control machine, in which case you must update the configuration files in each
3926     server machine's <emphasis role="bold">/usr/afs/etc</emphasis> directory individually. The <emphasis role="bold">bos</emphasis>
3927     commands used for this purpose also encrypt data before sending it across the network.)</para>
3928
3929     <para>Distributing the contents of its <emphasis role="bold">/usr/afs/bin</emphasis> directory to other server machines of its
3930     system type makes this machine a <emphasis>binary distribution machine</emphasis>. The other server machines of its system type
3931     run the <emphasis role="bold">upclientbin</emphasis> process (an instance of the client portion of the Update Server) to
3932     retrieve the binaries. If your platform has a package management system,
3933     such as 'rpm' or 'apt', running the Update Server to distribute binaries
3934     may interfere with this system.</para>
3935
3936     <para>The binaries in the <emphasis role="bold">/usr/afs/bin</emphasis> directory are not sensitive, so it is not necessary to
3937     encrypt them before transfer across the network. Include the <emphasis role="bold">-clear</emphasis> argument to the <emphasis
3938     role="bold">upserver</emphasis> initialization command to specify that the Update Server distributes the contents of the
3939     <emphasis role="bold">/usr/afs/bin</emphasis> directory in unencrypted form unless an <emphasis
3940     role="bold">upclientbin</emphasis> process requests encrypted transfer.</para>
3941
3942     <para>Note that the server and client portions of the Update Server always mutually authenticate with one another, regardless of
3943     whether you use the <emphasis role="bold">-clear</emphasis> or <emphasis role="bold">-crypt</emphasis> arguments. This protects
3944     their communications from eavesdropping to some degree.</para>
3945
3946     <para>For more information on the <emphasis role="bold">upclient</emphasis> and <emphasis role="bold">upserver</emphasis>
3947     processes, see their reference pages in the <emphasis>OpenAFS Administration Reference</emphasis>. The commands appear on
3948     multiple lines here only for legibility. <orderedlist>
3949         <listitem>
3950           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">upserver</emphasis>
3951           process. <programlisting>
3952    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name&gt;</replaceable> <emphasis role="bold">upserver simple</emphasis>  \
3953              <emphasis role="bold">"/usr/afs/bin/upserver  -crypt /usr/afs/etc</emphasis>    \
3954              <emphasis role="bold">-clear /usr/afs/bin"</emphasis> <emphasis role="bold">-noauth</emphasis>
3955 </programlisting></para>
3956         </listitem>
3957       </orderedlist></para>
3958   </sect1>
3959
3960   <sect1 id="HDRWQ62">
3961     <title>Starting the Controller for NTPD</title>
3962
3963     <para>Keeping the clocks on all server and client machines in your cell synchronized is crucial to several functions, and in
3964     particular to the correct operation of AFS's distributed database technology, Ubik. The chapter in the <emphasis>OpenAFS
3965     Administration Guide</emphasis> about administering server machines explains how time skew can disturb Ubik's performance and
3966     cause service outages in your cell.</para>
3967
3968     <para>Historically, AFS used to distribute its own version of the Network
3969 Time Protocol Daemon. Whilst this is still provided for existing sites, we
3970 recommend that you configure and install your time service independently of
3971 AFS. A reliable timeservice will also be required by your Kerberos realm,
3972 and so may already be available at your site.</para>
3973
3974     <indexterm>
3975       <primary>overview</primary>
3976
3977       <secondary>installing client functionality on first machine</secondary>
3978     </indexterm>
3979
3980     <indexterm>
3981       <primary>first AFS machine</primary>
3982
3983       <secondary>client functionality</secondary>
3984
3985       <tertiary>installing</tertiary>
3986     </indexterm>
3987
3988     <indexterm>
3989       <primary>installing</primary>
3990
3991       <secondary>client functionality</secondary>
3992
3993       <tertiary>first AFS machine</tertiary>
3994     </indexterm>
3995   </sect1>
3996
3997   <sect1 id="HDRWQ63">
3998     <title>Overview: Installing Client Functionality</title>
3999
4000     <para>The machine you are installing is now an AFS file server machine,
4001     database server machine, system control machine, and binary distribution
4002     machine. Now make it a client machine by completing the following tasks:
4003     <orderedlist>
4004         <listitem>
4005           <para>Define the machine's cell membership for client processes</para>
4006         </listitem>
4007
4008         <listitem>
4009           <para>Create the client version of the <emphasis role="bold">CellServDB</emphasis> file</para>
4010         </listitem>
4011
4012         <listitem>
4013           <para>Define cache location and size</para>
4014         </listitem>
4015
4016         <listitem>
4017           <para>Create the <emphasis role="bold">/afs</emphasis> directory and start the Cache Manager</para>
4018         </listitem>
4019       </orderedlist></para>
4020
4021     <indexterm>
4022       <primary>Distribution</primary>
4023
4024       <secondary>copying client files from</secondary>
4025
4026       <tertiary>first AFS machine</tertiary>
4027     </indexterm>
4028
4029     <indexterm>
4030       <primary>first AFS machine</primary>
4031
4032       <secondary>copying</secondary>
4033
4034       <tertiary>client files to local disk</tertiary>
4035     </indexterm>
4036
4037     <indexterm>
4038       <primary>copying</primary>
4039
4040       <secondary>client files to local disk</secondary>
4041
4042       <tertiary>first AFS machine</tertiary>
4043     </indexterm>
4044   </sect1>
4045
4046   <sect1 id="HDRWQ64">
4047     <title>Copying Client Files to the Local Disk</title>
4048
4049     <para>You need only undertake the steps in this section, if you are using
4050     a tar file distribution, or one built from scratch. Packaged distributions,
4051     such as RPMs or DEBs will already have installed the necessary files in
4052     the correct locations.</para>
4053
4054     <para>Before installing and configuring the AFS client, copy the necessary files from the tarball to the local <emphasis
4055     role="bold">/usr/vice/etc</emphasis> directory. <orderedlist>
4056         <listitem>
4057           <para>If you have not already done so, unpack the distribution
4058           tarball for this machine's system type into a suitable location on
4059           the filesystem, such as <emphasis role="bold">/tmp/afsdist</emphasis>.
4060           If you use a different location, substitue that in the examples that
4061           follow.</para>
4062         </listitem>
4063
4064         <listitem>
4065           <para>Copy files to the local <emphasis role="bold">/usr/vice/etc</emphasis> directory.</para>
4066
4067           <para>This step places a copy of the AFS initialization script (and related files, if applicable) into the <emphasis
4068           role="bold">/usr/vice/etc</emphasis> directory. In the preceding instructions for incorporating AFS into the kernel, you
4069           copied the script directly to the operating system's conventional location for initialization files. When you incorporate
4070           AFS into the machine's startup sequence in a later step, you can choose to link the two files.</para>
4071
4072           <para>On some system types that use a dynamic kernel loader program, you previously copied AFS library files into a
4073           subdirectory of the <emphasis role="bold">/usr/vice/etc</emphasis> directory. On other system types, you copied the
4074           appropriate AFS library file directly to the directory where the operating system accesses it. The following commands do
4075           not copy or recopy the AFS library files into the <emphasis role="bold">/usr/vice/etc</emphasis> directory, because on
4076           some system types the library files consume a large amount of space. If you want to copy them, add the <emphasis
4077           role="bold">-r</emphasis> flag to the first <emphasis role="bold">cp</emphasis> command and skip the second <emphasis
4078           role="bold">cp</emphasis> command.</para>
4079
4080           <programlisting>
4081    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.client/usr/vice/etc</emphasis>
4082    # <emphasis role="bold">cp -p  *  /usr/vice/etc</emphasis>
4083    # <emphasis role="bold">cp -rp  C  /usr/vice/etc</emphasis>
4084 </programlisting>
4085         </listitem>
4086       </orderedlist></para>
4087
4088     <indexterm>
4089       <primary>cell name</primary>
4090
4091       <secondary>setting in client ThisCell file</secondary>
4092
4093       <tertiary>first AFS machine</tertiary>
4094     </indexterm>
4095
4096     <indexterm>
4097       <primary>setting</primary>
4098
4099       <secondary>cell name in client ThisCell file</secondary>
4100
4101       <tertiary>first AFS machine</tertiary>
4102     </indexterm>
4103
4104     <indexterm>
4105       <primary>first AFS machine</primary>
4106
4107       <secondary>ThisCell file (client)</secondary>
4108     </indexterm>
4109
4110     <indexterm>
4111       <primary>first AFS machine</primary>
4112
4113       <secondary>cell membership, defining</secondary>
4114
4115       <tertiary>for client processes</tertiary>
4116     </indexterm>
4117
4118     <indexterm>
4119       <primary>usr/vice/etc/ThisCell</primary>
4120
4121       <see>ThisCell file (client)</see>
4122     </indexterm>
4123
4124     <indexterm>
4125       <primary>ThisCell file (client)</primary>
4126
4127       <secondary>first AFS machine</secondary>
4128     </indexterm>
4129
4130     <indexterm>
4131       <primary>files</primary>
4132
4133       <secondary>ThisCell (client)</secondary>
4134     </indexterm>
4135   </sect1>
4136
4137   <sect1 id="HDRWQ65">
4138     <title>Defining Cell Membership for Client Processes</title>
4139
4140     <para>Every AFS client machine has a copy of the <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> file on its local disk
4141     to define the machine's cell membership for the AFS client programs that run on it. The <emphasis
4142     role="bold">ThisCell</emphasis> file you created in the <emphasis role="bold">/usr/afs/etc</emphasis> directory (in <link
4143     linkend="HDRWQ51">Defining Cell Name and Membership for Server Processes</link>) is used only by server processes.</para>
4144
4145     <para>Among other functions, the <emphasis role="bold">ThisCell</emphasis> file on a client machine determines the following:
4146     <itemizedlist>
4147         <listitem>
4148           <para>The cell in which users gain tokens when they log onto the
4149           machine, assuming it is using an AFS-modified login utility</para>
4150         </listitem>
4151
4152         <listitem>
4153           <para>The cell in which users gain tokens by default when they issue
4154           the <emphasis role="bold">aklog</emphasis> command</para>
4155         </listitem>
4156
4157         <listitem>
4158           <para>The cell membership of the AFS server processes that the AFS
4159           command interpreters on this machine contact by default</para>
4160         </listitem>
4161       </itemizedlist>
4162     <orderedlist>
4163         <listitem>
4164           <para>Change to the <emphasis role="bold">/usr/vice/etc</emphasis> directory and remove the symbolic link created in <link
4165           linkend="HDRWQ50">Starting the BOS Server</link>. <programlisting>
4166    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
4167    # <emphasis role="bold">rm ThisCell</emphasis>
4168 </programlisting></para>
4169         </listitem>
4170
4171         <listitem>
4172           <para>Create the <emphasis role="bold">ThisCell</emphasis> file as a copy of the <emphasis
4173           role="bold">/usr/afs/etc/ThisCell</emphasis> file. Defining the same local cell for both server and client processes leads
4174           to the most consistent AFS performance. <programlisting>
4175    # <emphasis role="bold">cp  /usr/afs/etc/ThisCell  ThisCell</emphasis>
4176 </programlisting></para>
4177         </listitem>
4178       </orderedlist></para>
4179
4180     <indexterm>
4181       <primary>database server machine</primary>
4182
4183       <secondary>entry in client CellServDB file</secondary>
4184
4185       <tertiary>on first AFS machine</tertiary>
4186     </indexterm>
4187
4188     <indexterm>
4189       <primary>usr/vice/etc/CellServDB</primary>
4190
4191       <see>CellServDB file (client)</see>
4192     </indexterm>
4193
4194     <indexterm>
4195       <primary>CellServDB file (client)</primary>
4196
4197       <secondary>creating</secondary>
4198
4199       <tertiary>on first AFS machine</tertiary>
4200     </indexterm>
4201
4202     <indexterm>
4203       <primary>creating</primary>
4204
4205       <secondary>CellServDB file (client)</secondary>
4206
4207       <tertiary>first AFS machine</tertiary>
4208     </indexterm>
4209
4210     <indexterm>
4211       <primary>CellServDB file (client)</primary>
4212
4213       <secondary>required format</secondary>
4214     </indexterm>
4215
4216     <indexterm>
4217       <primary>requirements</primary>
4218
4219       <secondary>CellServDB file format (client version)</secondary>
4220     </indexterm>
4221
4222     <indexterm>
4223       <primary>files</primary>
4224
4225       <secondary>CellServDB (client)</secondary>
4226     </indexterm>
4227
4228     <indexterm>
4229       <primary>first AFS machine</primary>
4230
4231       <secondary>CellServDB file (client)</secondary>
4232     </indexterm>
4233   </sect1>
4234
4235   <sect1 id="HDRWQ66">
4236     <title>Creating the Client CellServDB File</title>
4237
4238     <para>The <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on a client machine's local disk lists the database
4239     server machines for each cell that the local Cache Manager can contact. If there is no entry in the file for a cell, or if the
4240     list of database server machines is wrong, then users working on this machine cannot access the cell. The chapter in the
4241     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines explains how to maintain the file after
4242     creating it.</para>
4243
4244     <para>As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it copies the contents of the
4245     <emphasis role="bold">CellServDB</emphasis> file into kernel memory. The Cache Manager always consults the list in kernel memory
4246     rather than the <emphasis role="bold">CellServDB</emphasis> file itself. Between reboots of the machine, you can use the
4247     <emphasis role="bold">fs newcell</emphasis> command to update the list in kernel memory directly; see the chapter in the
4248     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines.</para>
4249
4250     <para>The AFS distribution includes the file
4251     <emphasis role="bold">CellServDB.dist</emphasis>. It includes an entry for
4252     all AFS cells that agreed to share their database server machine
4253     information at the time the distribution was
4254     created. The definitive copy of this file is maintained at
4255     grand.central.org, and updates may be obtained from
4256     /afs/grand.central.org/service/CellServDB or
4257     <ulink url="http://grand.central.org/dl/cellservdb/CellServDB">
4258     http://grand.central.org/dl/cellservdb/CellServDB</ulink></para>
4259
4260     <para>The <emphasis role="bold">CellServDB.dist</emphasis> file can be a
4261     good basis for the client <emphasis role="bold">CellServDB</emphasis> file,
4262     because all of the entries in it use the correct format. You can add or
4263     remove cell entries as you see fit. Depending on your cache manager
4264     configuration, additional steps (as detailed in
4265     <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>) may be
4266     required to enable the Cache Manager to actually reach the cells.</para>
4267
4268     <para>In this section, you add an entry for the local cell to the local <emphasis role="bold">CellServDB</emphasis> file. The
4269     current working directory is still <emphasis role="bold">/usr/vice/etc</emphasis>. <orderedlist>
4270         <listitem>
4271           <para>Remove the symbolic link created in <link linkend="HDRWQ50">Starting the BOS Server</link> and rename the <emphasis
4272           role="bold">CellServDB.sample</emphasis> file to <emphasis role="bold">CellServDB</emphasis>. <programlisting>
4273    # <emphasis role="bold">rm CellServDB</emphasis>
4274    # <emphasis role="bold">mv CellServDB.sample CellServDB</emphasis>
4275 </programlisting></para>
4276         </listitem>
4277
4278         <listitem>
4279           <para>Add an entry for the local cell to the <emphasis role="bold">CellServDB</emphasis> file. One easy method is to use
4280           the <emphasis role="bold">cat</emphasis> command to append the contents of the server <emphasis
4281           role="bold">/usr/afs/etc/CellServDB</emphasis> file to the client version. <programlisting>
4282     # <emphasis role="bold">cat  /usr/afs/etc/CellServDB &gt;&gt;  CellServDB</emphasis>
4283 </programlisting></para>
4284
4285           <para>Then open the file in a text editor to verify that there are no blank lines, and that all entries have the required
4286           format, which is described just following. The ordering of cells is not significant, but it can be convenient to have the
4287           client machine's home cell at the top; move it there now if you wish. <itemizedlist>
4288               <listitem>
4289                 <para>The first line of a cell's entry has the following format: <programlisting>
4290    &gt;<replaceable>cell_name</replaceable>      #<replaceable>organization</replaceable>
4291 </programlisting></para>
4292
4293                 <para>where <replaceable>cell_name</replaceable> is the cell's complete Internet domain name (for example, <emphasis
4294                 role="bold">example.com</emphasis>) and <replaceable>organization</replaceable> is an optional field that follows any
4295                 number of spaces and the number sign (<computeroutput>#</computeroutput>). By convention it names the organization
4296                 to which the cell corresponds (for example, the Example Corporation).</para>
4297               </listitem>
4298
4299               <listitem>
4300                 <para>After the first line comes a separate line for each database server machine. Each line has the following
4301                 format: <programlisting>
4302    <replaceable>IP_address</replaceable>   #<replaceable>machine_name</replaceable>
4303 </programlisting></para>
4304
4305                 <para>where <replaceable>IP_address</replaceable> is the machine's IP address in dotted decimal format (for example,
4306                 192.12.105.3). Following any number of spaces and the number sign (<computeroutput>#</computeroutput>) is
4307                 <replaceable>machine_name</replaceable>, the machine's fully-qualified hostname (for example, <emphasis
4308                 role="bold">db1.example.com</emphasis>). In this case, the number sign does not indicate a comment;
4309                 <replaceable>machine_name</replaceable> is a required field.</para>
4310               </listitem>
4311             </itemizedlist></para>
4312         </listitem>
4313
4314         <listitem>
4315           <para>If the file includes cells that you do not wish users of this machine to access, remove their entries.</para>
4316         </listitem>
4317       </orderedlist></para>
4318
4319     <para>The following example shows entries for two cells, each of which has three database server machines:</para>
4320
4321     <programlisting>
4322    &gt;example.com       #Example Corporation (home cell)
4323    192.12.105.3      #db1.example.com
4324    192.12.105.4      #db2.example.com
4325    192.12.105.55     #db3.example.com
4326    &gt;stateu.edu    #State University cell
4327    138.255.68.93     #serverA.stateu.edu
4328    138.255.68.72     #serverB.stateu.edu
4329    138.255.33.154    #serverC.stateu.edu
4330 </programlisting>
4331
4332     <indexterm>
4333       <primary>cache</primary>
4334
4335       <secondary>configuring</secondary>
4336
4337       <tertiary>first AFS machine</tertiary>
4338     </indexterm>
4339
4340     <indexterm>
4341       <primary>configuring</primary>
4342
4343       <secondary>cache</secondary>
4344
4345       <tertiary>first AFS machine</tertiary>
4346     </indexterm>
4347
4348     <indexterm>
4349       <primary>setting</primary>
4350
4351       <secondary>cache size and location</secondary>
4352
4353       <tertiary>first AFS machine</tertiary>
4354     </indexterm>
4355
4356     <indexterm>
4357       <primary>first AFS machine</primary>
4358
4359       <secondary>cache size and location</secondary>
4360     </indexterm>
4361   </sect1>
4362
4363   <sect1 id="HDRWQ67">
4364     <title>Configuring the Cache</title>
4365
4366     <para>The Cache Manager uses a cache on the local disk or in machine memory to store local copies of files fetched from file
4367     server machines. As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it sets basic cache
4368     configuration parameters according to definitions in the local <emphasis role="bold">/usr/vice/etc/cacheinfo</emphasis> file.
4369     The file has three fields: <orderedlist>
4370         <listitem>
4371           <para>The first field names the local directory on which to mount the AFS filespace. The conventional location is the
4372           <emphasis role="bold">/afs</emphasis> directory.</para>
4373         </listitem>
4374
4375         <listitem>
4376           <para>The second field defines the local disk directory to use for the disk cache. The conventional location is the
4377           <emphasis role="bold">/usr/vice/cache</emphasis> directory, but you can specify an alternate directory if another
4378           partition has more space available. There must always be a value in this field, but the Cache Manager ignores it if the
4379           machine uses a memory cache.</para>
4380         </listitem>
4381
4382         <listitem>
4383           <para>The third field specifies the number of kilobyte (1024 byte) blocks to allocate for the cache.</para>
4384         </listitem>
4385       </orderedlist></para>
4386
4387     <para>The values you define must meet the following requirements. <itemizedlist>
4388         <listitem>
4389           <para>On a machine using a disk cache, the Cache Manager expects always to be able to use the amount of space specified in
4390           the third field. Failure to meet this requirement can cause serious problems, some of which can be repaired only by
4391           rebooting. You must prevent non-AFS processes from filling up the cache partition. The simplest way is to devote a
4392           partition to the cache exclusively.</para>
4393         </listitem>
4394
4395         <listitem>
4396           <para>The amount of space available in memory or on the partition housing the disk cache directory imposes an absolute
4397           limit on cache size.</para>
4398         </listitem>
4399
4400         <listitem>
4401           <para>The maximum supported cache size can vary in each AFS release; see the <emphasis>OpenAFS Release Notes</emphasis>
4402           for the current version.</para>
4403         </listitem>
4404
4405         <listitem>
4406           <para>For a disk cache, you cannot specify a value in the third field that exceeds 95% of the space available on the
4407           partition mounted at the directory named in the second field. If you violate this restriction, the <emphasis
4408           role="bold">afsd</emphasis> program exits without starting the Cache Manager and prints an appropriate message on the
4409           standard output stream. A value of 90% is more appropriate on most machines. Some operating systems (such as AIX) do not
4410           automatically reserve some space to prevent the partition from filling completely; for them, a smaller value (say, 80% to
4411           85% of the space available) is more appropriate.</para>
4412         </listitem>
4413
4414         <listitem>
4415           <para>For a memory cache, you must leave enough memory for other processes and applications to run. If you try to allocate
4416           more memory than is actually available, the <emphasis role="bold">afsd</emphasis> program exits without initializing the
4417           Cache Manager and produces the following message on the standard output stream. <programlisting>
4418    afsd: memCache allocation failure at <replaceable>number</replaceable> KB
4419 </programlisting></para>
4420
4421           <para>The <replaceable>number</replaceable> value is how many kilobytes were allocated just before the failure, and so
4422           indicates the approximate amount of memory available.</para>
4423         </listitem>
4424       </itemizedlist></para>
4425
4426     <para>Within these hard limits, the factors that determine appropriate cache size include the number of users working on the
4427     machine, the size of the files with which they work, and (for a memory cache) the number of processes that run on the machine.
4428     The higher the demand from these factors, the larger the cache needs to be to maintain good performance.</para>
4429
4430     <para>Disk caches smaller than 10 MB do not generally perform well. Machines serving multiple users usually perform better with
4431     a cache of at least 60 to 70 MB. The point at which enlarging the cache further does not really improve performance depends on
4432     the factors mentioned previously and is difficult to predict.</para>
4433
4434     <para>Memory caches smaller than 1 MB are nonfunctional, and the performance of caches smaller than 5 MB is usually
4435     unsatisfactory. Suitable upper limits are similar to those for disk caches but are probably determined more by the demands on
4436     memory from other sources on the machine (number of users and processes). Machines running only a few processes possibly can use
4437     a smaller memory cache.</para>
4438
4439     <sect2 id="HDRWQ68">
4440       <title>Configuring a Disk Cache</title>
4441
4442       <note>
4443         <para>Not all file system types that an operating system supports are necessarily supported for use as the cache partition.
4444         For possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
4445       </note>
4446
4447       <para>To configure the disk cache, perform the following procedures: <orderedlist>
4448           <listitem>
4449             <para>Create the local directory to use for caching. The following instruction shows the conventional location,
4450             <emphasis role="bold">/usr/vice/cache</emphasis>. If you are devoting a partition exclusively to caching, as
4451             recommended, you must also configure it, make a file system on it, and mount it at the directory created in this step.
4452             <programlisting>
4453    # <emphasis role="bold">mkdir /usr/vice/cache</emphasis>
4454 </programlisting></para>
4455           </listitem>
4456
4457           <listitem>
4458             <para>Create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration parameters discussed
4459             previously. The following instruction shows the standard mount location, <emphasis role="bold">/afs</emphasis>, and the
4460             standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis>. <programlisting>
4461    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
4462 </programlisting></para>
4463
4464             <para>The following example defines the disk cache size as 50,000 KB:</para>
4465
4466             <programlisting>
4467    # <emphasis role="bold">echo "/afs:/usr/vice/cache:50000" &gt; /usr/vice/etc/cacheinfo</emphasis>
4468 </programlisting>
4469           </listitem>
4470         </orderedlist></para>
4471     </sect2>
4472
4473     <sect2 id="HDRWQ69">
4474       <title>Configuring a Memory Cache</title>
4475
4476       <para>To configure a memory cache, create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration
4477       parameters discussed previously. The following instruction shows the standard mount location, <emphasis
4478       role="bold">/afs</emphasis>, and the standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis> (though the
4479       exact value of the latter is irrelevant for a memory cache).</para>
4480
4481       <programlisting>
4482    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
4483 </programlisting>
4484
4485       <para>The following example allocates 25,000 KB of memory for the cache.</para>
4486
4487       <programlisting>
4488    # <emphasis role="bold">echo "/afs:/usr/vice/cache:25000" &gt; /usr/vice/etc/cacheinfo</emphasis>
4489 </programlisting>
4490
4491       <indexterm>
4492         <primary>Cache Manager</primary>
4493
4494         <secondary>first AFS machine</secondary>
4495       </indexterm>
4496
4497       <indexterm>
4498         <primary>configuring</primary>
4499
4500         <secondary>Cache Manager</secondary>
4501
4502         <tertiary>first AFS machine</tertiary>
4503       </indexterm>
4504
4505       <indexterm>
4506         <primary>first AFS machine</primary>
4507
4508         <secondary>Cache Manager</secondary>
4509       </indexterm>
4510
4511       <indexterm>
4512         <primary>afs (/afs) directory</primary>
4513
4514         <secondary>creating</secondary>
4515
4516         <tertiary>first AFS machine</tertiary>
4517       </indexterm>
4518
4519       <indexterm>
4520         <primary>AFS initialization script</primary>
4521
4522         <secondary>setting afsd parameters</secondary>
4523
4524         <tertiary>first AFS machine</tertiary>
4525       </indexterm>
4526
4527       <indexterm>
4528         <primary>first AFS machine</primary>
4529
4530         <secondary>afsd command parameters</secondary>
4531       </indexterm>
4532     </sect2>
4533   </sect1>
4534
4535   <sect1 id="HDRWQ70">
4536     <title>Configuring the Cache Manager</title>
4537
4538     <para>By convention, the Cache Manager mounts the AFS filespace on the local <emphasis role="bold">/afs</emphasis> directory. In
4539     this section you create that directory.</para>
4540
4541     <para>The <emphasis role="bold">afsd</emphasis> program sets several cache configuration parameters as it initializes the Cache
4542     Manager, and starts daemons that improve performance. You can use the <emphasis role="bold">afsd</emphasis> command's arguments
4543     to override the parameters' default values and to change the number of some of the daemons. Depending on the machine's cache
4544     size, its amount of RAM, and how many people work on it, you can sometimes improve Cache Manager performance by overriding the
4545     default values. For a discussion of all of the <emphasis role="bold">afsd</emphasis> command's arguments, see its reference page
4546     in the <emphasis>OpenAFS Administration Reference</emphasis>.</para>
4547
4548     <para>On platforms using the standard 'afs' initialisation script (this does not apply to Fedora or RHEL based distributions), the <emphasis role="bold">afsd</emphasis> command line in the AFS initialization script on each system type includes an
4549     <computeroutput>OPTIONS</computeroutput> variable. You can use it to set nondefault values for the command's arguments, in one
4550     of the following ways: <itemizedlist>
4551         <listitem>
4552           <para>You can create an <emphasis role="bold">afsd</emphasis> <emphasis>options file</emphasis> that sets values for
4553           arguments to the <emphasis role="bold">afsd</emphasis> command. If the file exists, its contents are automatically
4554           substituted for the <computeroutput>OPTIONS</computeroutput> variable in the AFS initialization script. The AFS
4555           distribution for some system types includes an options file; on other system types, you must create it.</para>
4556
4557           <para>You use two variables in the AFS initialization script to specify the path to the options file:
4558           <computeroutput>CONFIG</computeroutput> and <computeroutput>AFSDOPT</computeroutput>. On system types that define a
4559           conventional directory for configuration files, the <computeroutput>CONFIG</computeroutput> variable indicates it by
4560           default; otherwise, the variable indicates an appropriate location.</para>
4561
4562           <para>List the desired <emphasis role="bold">afsd</emphasis> options on a single line in the options file, separating each
4563           option with one or more spaces. The following example sets the <emphasis role="bold">-stat</emphasis> argument to 2500,
4564           the <emphasis role="bold">-daemons</emphasis> argument to 4, and the <emphasis role="bold">-volumes</emphasis> argument to
4565           100.</para>
4566
4567           <programlisting>
4568    -stat 2500 -daemons 4 -volumes 100
4569 </programlisting>
4570         </listitem>
4571
4572         <listitem>
4573           <para>On a machine that uses a disk cache, you can set the <computeroutput>OPTIONS</computeroutput> variable in the AFS
4574           initialization script to one of <computeroutput>$SMALL</computeroutput>, <computeroutput>$MEDIUM</computeroutput>, or
4575           <computeroutput>$LARGE</computeroutput>. The AFS initialization script uses one of these settings if the <emphasis
4576           role="bold">afsd</emphasis> options file named by the <computeroutput>AFSDOPT</computeroutput> variable does not exist. In
4577           the script as distributed, the <computeroutput>OPTIONS</computeroutput> variable is set to the value
4578           <computeroutput>$MEDIUM</computeroutput>.</para>
4579
4580           <note>
4581             <para>Do not set the <computeroutput>OPTIONS</computeroutput> variable to <computeroutput>$SMALL</computeroutput>,
4582             <computeroutput>$MEDIUM</computeroutput>, or <computeroutput>$LARGE</computeroutput> on a machine that uses a memory
4583             cache. The arguments it sets are appropriate only on a machine that uses a disk cache.</para>
4584           </note>
4585
4586           <para>The script (or on some system types the <emphasis role="bold">afsd</emphasis> options file named by the
4587           <computeroutput>AFSDOPT</computeroutput> variable) defines a value for each of <computeroutput>SMALL</computeroutput>,
4588           <computeroutput>MEDIUM</computeroutput>, and <computeroutput>LARGE</computeroutput> that sets <emphasis
4589           role="bold">afsd</emphasis> command arguments appropriately for client machines of different sizes: <itemizedlist>
4590               <listitem>
4591                 <para><computeroutput>SMALL</computeroutput> is suitable for a small machine that serves one or two users and has
4592                 approximately 8 MB of RAM and a 20-MB cache</para>
4593               </listitem>
4594
4595               <listitem>
4596                 <para><computeroutput>MEDIUM</computeroutput> is suitable for a medium-sized machine that serves two to six users
4597                 and has 16 MB of RAM and a 40-MB cache</para>
4598               </listitem>
4599
4600               <listitem>
4601                 <para><computeroutput>LARGE</computeroutput> is suitable for a large machine that serves five to ten users and has
4602                 32 MB of RAM and a 100-MB cache</para>
4603               </listitem>
4604             </itemizedlist></para>
4605         </listitem>
4606
4607         <listitem>
4608           <para>You can choose not to create an <emphasis role="bold">afsd</emphasis> options file and to set the
4609           <computeroutput>OPTIONS</computeroutput> variable in the initialization script to a null value rather than to the default
4610           <computeroutput>$MEDIUM</computeroutput> value. You can then either set arguments directly on the <emphasis
4611           role="bold">afsd</emphasis> command line in the script, or set no arguments (and so accept default values for all Cache
4612           Manager parameters).</para>
4613         </listitem>
4614       </itemizedlist>
4615
4616       <note>
4617       <para>If you are running on a Fedora or RHEL based system, the
4618       openafs-client initialization script behaves differently from that
4619       described above. It sources /etc/sysconfig/openafs, in which the
4620       AFSD_ARGS variable may be set to contain any, or all, of the afsd options
4621       detailed. Note that this script does not support setting an OPTIONS
4622       variable, or the SMALL, MEDIUM and LARGE methods of defining cache size
4623       </para>
4624       </note>
4625
4626  <orderedlist>
4627         <listitem>
4628           <para>Create the local directory on which to mount the AFS filespace, by convention <emphasis role="bold">/afs</emphasis>.
4629           If the directory already exists, verify that it is empty. <programlisting>
4630    # <emphasis role="bold">mkdir /afs</emphasis>
4631 </programlisting></para>
4632         </listitem>
4633
4634         <listitem>
4635           <para>On AIX systems, add the following line to the <emphasis role="bold">/etc/vfs</emphasis> file. It enables AIX to
4636           unmount AFS correctly during shutdown. <programlisting>
4637    afs     4     none     none
4638 </programlisting></para>
4639         </listitem>
4640
4641         <listitem>
4642           <para>On non-package based Linux systems, copy the <emphasis role="bold">afsd</emphasis> options file from the <emphasis
4643           role="bold">/usr/vice/etc</emphasis> directory to the <emphasis role="bold">/etc/sysconfig</emphasis> directory, removing
4644           the <emphasis role="bold">.conf</emphasis> extension as you do so. <programlisting>
4645    # <emphasis role="bold">cp /usr/vice/etc/afs.conf /etc/sysconfig/afs</emphasis>
4646 </programlisting></para>
4647         </listitem>
4648
4649         <listitem>
4650           <para>Edit the machine's AFS initialization script or <emphasis role="bold">afsd</emphasis> options file to set
4651           appropriate values for <emphasis role="bold">afsd</emphasis> command parameters. The script resides in the indicated
4652           location on each system type: <itemizedlist>
4653               <listitem>
4654                 <para>On AIX systems, <emphasis role="bold">/etc/rc.afs</emphasis></para>
4655               </listitem>
4656
4657               <listitem>
4658                 <para>On HP-UX systems, <emphasis role="bold">/sbin/init.d/afs</emphasis></para>
4659               </listitem>
4660
4661               <listitem>
4662                 <para>On IRIX systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
4663               </listitem>
4664
4665                   <listitem>
4666                 <para>On Fedora and RHEL systems, <emphasis role="bold">/etc/sysconfg/openafs</emphasis></para>
4667               </listitem>
4668
4669               <listitem>
4670                 <para>On non-package based Linux systems, <emphasis role="bold">/etc/sysconfig/afs</emphasis> (the <emphasis
4671                 role="bold">afsd</emphasis> options file)</para>
4672               </listitem>
4673
4674               <listitem>
4675                 <para>On Solaris systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
4676               </listitem>
4677             </itemizedlist></para>
4678
4679           <para>Use one of the methods described in the introduction to this section to add the following flags to the <emphasis
4680           role="bold">afsd</emphasis> command line. If you intend for the machine to remain an AFS client, also set any
4681           performance-related arguments you wish. <itemizedlist>
4682               <listitem>
4683                 <para>Add the <emphasis role="bold">-memcache</emphasis> flag if the machine is to use a memory cache.</para>
4684               </listitem>
4685
4686               <listitem>
4687                 <para>Add the <emphasis role="bold">-verbose</emphasis> flag to display a trace of the Cache Manager's
4688                 initialization on the standard output stream.</para>
4689               </listitem>
4690             </itemizedlist></para>
4691         </listitem>
4692       </orderedlist>
4693       <note><para>In order to successfully complete the instructions in the
4694       remainder of this guide, it is important that the machine does not have
4695       a synthetic root (as discussed in <link linkend="HDRWQ91">Enabling Access
4696       to Foreign Cells</link>). As some distributions ship with this enabled, it
4697       may be necessary to remove any occurences of the
4698       <emphasis role="bold">-dynroot</emphasis> and
4699       <emphasis role="bold">-afsdb</emphasis> options from both the AFS
4700       initialisation script and options file. If this functionality is
4701       required it may be renabled as detailed in
4702       <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>.
4703       </para></note>
4704       </para>
4705
4706     <indexterm>
4707       <primary>overview</primary>
4708
4709       <secondary>completing installation of first machine</secondary>
4710     </indexterm>
4711
4712     <indexterm>
4713       <primary>first AFS machine</primary>
4714
4715       <secondary>completion of installation</secondary>
4716     </indexterm>
4717   </sect1>
4718
4719   <sect1 id="HDRWQ71">
4720     <title>Overview: Completing the Installation of the First AFS Machine</title>
4721
4722     <para>The machine is now configured as an AFS file server and client machine. In this final phase of the installation, you
4723     initialize the Cache Manager and then create the upper levels of your AFS filespace, among other procedures. The procedures are:
4724     <orderedlist>
4725         <listitem>
4726           <para>Verify that the initialization script works correctly, and incorporate it into the operating system's startup and
4727           shutdown sequence</para>
4728         </listitem>
4729
4730         <listitem>
4731           <para>Create and mount top-level volumes</para>
4732         </listitem>
4733
4734         <listitem>
4735           <para>Create and mount volumes to store system binaries in AFS</para>
4736         </listitem>
4737
4738         <listitem>
4739           <para>Enable access to foreign cells</para>
4740         </listitem>
4741
4742         <listitem>
4743           <para>Institute additional security measures</para>
4744         </listitem>
4745
4746         <listitem>
4747           <para>Remove client functionality if desired</para>
4748         </listitem>
4749       </orderedlist></para>
4750
4751     <indexterm>
4752       <primary>AFS initialization script</primary>
4753
4754       <secondary>verifying on first AFS machine</secondary>
4755     </indexterm>
4756
4757     <indexterm>
4758       <primary>AFS initialization script</primary>
4759
4760       <secondary>running</secondary>
4761
4762       <tertiary>first AFS machine</tertiary>
4763     </indexterm>
4764
4765     <indexterm>
4766       <primary>first AFS machine</primary>
4767
4768       <secondary>AFS initialization script</secondary>
4769
4770       <tertiary>running/verifying</tertiary>
4771     </indexterm>
4772
4773     <indexterm>
4774       <primary>running AFS init. script</primary>
4775
4776       <secondary>first AFS machine</secondary>
4777     </indexterm>
4778
4779     <indexterm>
4780       <primary>invoking AFS init. script</primary>
4781
4782       <see>running</see>
4783     </indexterm>
4784   </sect1>
4785
4786   <sect1 id="HDRWQ72">
4787     <title>Verifying the AFS Initialization Script</title>
4788
4789     <para>At this point you run the AFS initialization script to verify that it correctly invokes all of the necessary programs and
4790     AFS processes, and that they start correctly. The following are the relevant commands: <itemizedlist>
4791         <listitem>
4792           <para>The command that dynamically loads AFS modifications into the kernel, on some system types (not applicable if the
4793           kernel has AFS modifications built in)</para>
4794         </listitem>
4795
4796         <listitem>
4797           <para>The <emphasis role="bold">bosserver</emphasis> command, which starts the BOS Server; it in turn starts the server
4798           processes for which you created entries in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file</para>
4799         </listitem>
4800
4801         <listitem>
4802           <para>The <emphasis role="bold">afsd</emphasis> command, which initializes the Cache Manager</para>
4803         </listitem>
4804       </itemizedlist></para>
4805
4806     <para>On system types that use a dynamic loader program, you must reboot the machine before running the initialization script,
4807     so that it can freshly load AFS modifications into the kernel.</para>
4808
4809     <para>If there are problems during the initialization, attempt to resolve them. The OpenAFS mailing lists can provide assistance if necessary.
4810
4811      <orderedlist>
4812         <indexterm>
4813           <primary>commands</primary>
4814
4815           <secondary>bos shutdown</secondary>
4816         </indexterm>
4817
4818         <indexterm>
4819           <primary>bos commands</primary>
4820
4821           <secondary>shutdown</secondary>
4822         </indexterm>
4823
4824         <listitem>
4825           <para>Issue the <emphasis role="bold">bos shutdown</emphasis> command to shut down the AFS server processes other than the
4826           BOS Server. Include the <emphasis role="bold">-wait</emphasis> flag to delay return of the command shell prompt until all
4827           processes shut down completely. <programlisting>
4828    # <emphasis role="bold">/usr/afs/bin/bos shutdown</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
4829                 role="bold">-wait</emphasis>
4830 </programlisting></para>
4831         </listitem>
4832
4833         <listitem>
4834           <para>Issue the <emphasis role="bold">ps</emphasis> command to learn the <emphasis role="bold">bosserver</emphasis>
4835           process's process ID number (PID), and then the <emphasis role="bold">kill</emphasis> command to stop it. <programlisting>
4836    # <emphasis role="bold">ps</emphasis> <replaceable>appropriate_ps_options</replaceable> <emphasis role="bold">| grep bosserver</emphasis>
4837    # <emphasis role="bold">kill</emphasis> <replaceable>bosserver_PID</replaceable>
4838 </programlisting></para>
4839         </listitem>
4840
4841         <listitem>
4842           <para>Issue the appropriate commands to run the AFS initialization script for this system type.</para>
4843
4844           <indexterm>
4845             <primary>AIX</primary>
4846
4847             <secondary>AFS initialization script</secondary>
4848
4849             <tertiary>on first AFS machine</tertiary>
4850           </indexterm>
4851
4852           <para><emphasis role="bold">On AIX systems:</emphasis> <orderedlist>
4853               <listitem>
4854                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4855                 <programlisting>
4856    # <emphasis role="bold">cd /</emphasis>
4857    # <emphasis role="bold">shutdown -r now</emphasis>
4858    login: <emphasis role="bold">root</emphasis>
4859    Password: <replaceable>root_password</replaceable>
4860 </programlisting></para>
4861               </listitem>
4862
4863               <listitem>
4864                 <para>Run the AFS initialization script. <programlisting>
4865    # <emphasis role="bold">/etc/rc.afs</emphasis>
4866 </programlisting></para>
4867               </listitem>
4868             </orderedlist></para>
4869
4870           <indexterm>
4871             <primary>HP-UX</primary>
4872
4873             <secondary>AFS initialization script</secondary>
4874
4875             <tertiary>on first AFS machine</tertiary>
4876           </indexterm>
4877
4878           <para><emphasis role="bold">On HP-UX systems:</emphasis> <orderedlist>
4879               <listitem>
4880                 <para>Run the AFS initialization script. <programlisting>
4881    # <emphasis role="bold">/sbin/init.d/afs  start</emphasis>
4882 </programlisting></para>
4883               </listitem>
4884             </orderedlist></para>
4885
4886           <indexterm>
4887             <primary>IRIX</primary>
4888
4889             <secondary>AFS initialization script</secondary>
4890
4891             <tertiary>on first AFS machine</tertiary>
4892           </indexterm>
4893
4894           <indexterm>
4895             <primary>afsclient variable (IRIX)</primary>
4896
4897             <secondary>first AFS machine</secondary>
4898           </indexterm>
4899
4900           <indexterm>
4901             <primary>variables</primary>
4902
4903             <secondary>afsclient (IRIX)</secondary>
4904
4905             <tertiary>first AFS machine</tertiary>
4906           </indexterm>
4907
4908           <indexterm>
4909             <primary>IRIX</primary>
4910
4911             <secondary>afsclient variable</secondary>
4912
4913             <tertiary>first AFS machine</tertiary>
4914           </indexterm>
4915
4916           <indexterm>
4917             <primary>afsserver variable (IRIX)</primary>
4918
4919             <secondary>first AFS machine</secondary>
4920           </indexterm>
4921
4922           <indexterm>
4923             <primary>variables</primary>
4924
4925             <secondary>afsserver (IRIX)</secondary>
4926
4927             <tertiary>first AFS machine</tertiary>
4928           </indexterm>
4929
4930           <indexterm>
4931             <primary>IRIX</primary>
4932
4933             <secondary>afsserver variable</secondary>
4934
4935             <tertiary>first AFS machine</tertiary>
4936           </indexterm>
4937
4938           <para><emphasis role="bold">On IRIX systems:</emphasis> <orderedlist>
4939               <listitem>
4940                 <para>If you have configured the machine to use the <emphasis role="bold">ml</emphasis> dynamic loader program,
4941                 reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
4942    # <emphasis role="bold">cd /</emphasis>
4943    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
4944    login: <emphasis role="bold">root</emphasis>
4945    Password: <replaceable>root_password</replaceable>
4946 </programlisting></para>
4947               </listitem>
4948
4949               <listitem>
4950                 <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
4951                 role="bold">afsserver</emphasis> and <emphasis role="bold">afsclient</emphasis> configuration variables.
4952                 <programlisting>
4953    # <emphasis role="bold">/etc/chkconfig -f afsserver on</emphasis>
4954    # <emphasis role="bold">/etc/chkconfig -f afsclient on</emphasis>
4955 </programlisting></para>
4956               </listitem>
4957
4958               <listitem>
4959                 <para>Run the AFS initialization script. <programlisting>
4960    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
4961 </programlisting></para>
4962               </listitem>
4963             </orderedlist></para>
4964
4965           <indexterm>
4966             <primary>Linux</primary>
4967
4968             <secondary>AFS initialization script</secondary>
4969
4970             <tertiary>on first AFS machine</tertiary>
4971           </indexterm>
4972
4973           <para><emphasis role="bold">On Linux systems:</emphasis> <orderedlist>
4974               <listitem>
4975                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4976                 <programlisting>
4977    # <emphasis role="bold">cd /</emphasis>
4978    # <emphasis role="bold">shutdown -r now</emphasis>
4979    login: <emphasis role="bold">root</emphasis>
4980    Password: <replaceable>root_password</replaceable>
4981 </programlisting></para>
4982               </listitem>
4983
4984               <listitem>
4985                 <para>Run the AFS initialization scripts.
4986 <programlisting>
4987    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
4988    # <emphasis role="bold">/etc/rc.d/init.d/openafs-server  start</emphasis>
4989 </programlisting></para>
4990               </listitem>
4991             </orderedlist></para>
4992
4993           <indexterm>
4994             <primary>Solaris</primary>
4995
4996             <secondary>AFS initialization script</secondary>
4997
4998             <tertiary>on first AFS machine</tertiary>
4999           </indexterm>
5000
5001           <para><emphasis role="bold">On Solaris systems:</emphasis> <orderedlist>
5002               <listitem>
5003                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
5004                 <programlisting>
5005    # <emphasis role="bold">cd /</emphasis>
5006    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
5007    login: <emphasis role="bold">root</emphasis>
5008    Password: <replaceable>root_password</replaceable>
5009 </programlisting></para>
5010               </listitem>
5011
5012               <listitem>
5013                 <para>Run the AFS initialization script. <programlisting>
5014    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
5015 </programlisting></para>
5016               </listitem>
5017             </orderedlist></para>
5018         </listitem>
5019
5020         <listitem>
5021           <para>Wait for the message that confirms that Cache Manager initialization is complete.</para>
5022
5023           <para>On machines that use a disk cache, it can take a while to initialize the Cache Manager for the first time, because
5024           the <emphasis role="bold">afsd</emphasis> program must create all of the <emphasis
5025           role="bold">V</emphasis><replaceable>n</replaceable> files in the cache directory. Subsequent Cache Manager
5026           initializations do not take nearly as long, because the <emphasis role="bold">V</emphasis><replaceable>n</replaceable>
5027           files already exist.</para>
5028         </listitem>
5029         <listitem>
5030
5031           <indexterm>
5032             <primary>commands</primary>
5033             <secondary>aklog</secondary>
5034           </indexterm>
5035
5036           <indexterm>
5037             <primary>aklog command</primary>
5038           </indexterm>
5039
5040           <para>If you are working with an existing cell which uses
5041           <emphasis role="bold">kaserver</emphasis> for authentication,
5042           please recall the note in
5043           <link linkend="KAS003">Using this Appendix</link> detailing the
5044           substitution of <emphasis role="bold">kinit</emphasis> and
5045           <emphasis role="bold">aklog</emphasis> with
5046           <emphasis role="bold">klog</emphasis>.</para>
5047
5048           <para>As a basic test of correct AFS functioning, issue the
5049           <emphasis role="bold">kinit</emphasis> and
5050           <emphasis role="bold">aklog</emphasis> commands to authenticate
5051           as the <emphasis role="bold">admin</emphasis> user.
5052           Provide the password (<replaceable>admin_passwd</replaceable>) you
5053           defined in <link linkend="HDRWQ53">Initializing Cell Security</link>.</para>
5054
5055           <programlisting>
5056    # <emphasis role="bold">kinit admin</emphasis>
5057    Password:  <replaceable>admin_passwd</replaceable>
5058    # <emphasis role="bold">aklog</emphasis>
5059 </programlisting>
5060
5061           <indexterm>
5062             <primary>commands</primary>
5063
5064             <secondary>tokens</secondary>
5065           </indexterm>
5066
5067           <indexterm>
5068             <primary>tokens command</primary>
5069           </indexterm>
5070         </listitem>
5071
5072         <listitem>
5073           <para>Issue the <emphasis role="bold">tokens</emphasis> command to
5074           verify that the <emphasis role="bold">aklog</emphasis>
5075           command worked correctly. If it did, the output looks similar to the following example for the <emphasis
5076           role="bold">example.com</emphasis> cell, where <emphasis role="bold">admin</emphasis>'s AFS UID is 1. If the output does not
5077           seem correct, resolve the problem. Changes to the AFS initialization script are possibly necessary. The OpenAFS mailing lists can provide assistance as necessary. <programlisting>
5078    # <emphasis role="bold">tokens</emphasis>
5079    Tokens held by the Cache Manager:
5080    User's (AFS ID 1) tokens for afs@example.com [Expires May 22 11:52]
5081        --End of list--
5082 </programlisting></para>
5083         </listitem>
5084
5085         <listitem>
5086           <para>Issue the <emphasis role="bold">bos status</emphasis> command to verify that the output for each process reads
5087           <computeroutput>Currently running normally</computeroutput>. <programlisting>
5088    # <emphasis role="bold">/usr/afs/bin/bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt;
5089 </programlisting> <indexterm>
5090               <primary>fs commands</primary>
5091
5092               <secondary>checkvolumes</secondary>
5093             </indexterm> <indexterm>
5094               <primary>commands</primary>
5095
5096               <secondary>fs checkvolumes</secondary>
5097             </indexterm></para>
5098         </listitem>
5099
5100         <listitem>
5101           <para>Change directory to the local file system root (<emphasis role="bold">/</emphasis>) and issue the <emphasis
5102           role="bold">fs checkvolumes</emphasis> command. <programlisting>
5103    # <emphasis role="bold">cd /</emphasis>
5104    # <emphasis role="bold">/usr/afs/bin/fs checkvolumes</emphasis>
5105 </programlisting></para>
5106         </listitem>
5107       </orderedlist></para>
5108
5109     <indexterm>
5110       <primary>AFS initialization script</primary>
5111
5112       <secondary>adding to machine startup sequence</secondary>
5113
5114       <tertiary>first AFS machine</tertiary>
5115     </indexterm>
5116
5117     <indexterm>
5118       <primary>installing</primary>
5119
5120       <secondary>AFS initialization script</secondary>
5121
5122       <tertiary>first AFS machine</tertiary>
5123     </indexterm>
5124
5125     <indexterm>
5126       <primary>first AFS machine</primary>
5127
5128       <secondary>AFS initialization script</secondary>
5129
5130       <tertiary>activating</tertiary>
5131     </indexterm>
5132
5133     <indexterm>
5134       <primary>activating AFS init. script</primary>
5135
5136       <see>installing</see>
5137     </indexterm>
5138   </sect1>
5139
5140   <sect1 id="HDRWQ73">
5141     <title>Activating the AFS Initialization Script</title>
5142
5143     <para>Now that you have confirmed that the AFS initialization script works correctly, take the action necessary to have it run
5144     automatically at each reboot. Proceed to the instructions for your system type: <itemizedlist>
5145         <listitem>
5146           <para><link linkend="HDRWQ74">Activating the Script on AIX Systems</link></para>
5147         </listitem>
5148
5149         <listitem>
5150           <para><link linkend="HDRWQ76">Activating the Script on HP-UX Systems</link></para>
5151         </listitem>
5152
5153         <listitem>
5154           <para><link linkend="HDRWQ77">Activating the Script on IRIX Systems</link></para>
5155         </listitem>
5156
5157         <listitem>
5158           <para><link linkend="HDRWQ78">Activating the Script on Linux Systems</link></para>
5159         </listitem>
5160
5161         <listitem>
5162           <para><link linkend="HDRWQ79">Activating the Script on Solaris Systems</link></para>
5163         </listitem>
5164       </itemizedlist></para>
5165
5166     <indexterm>
5167       <primary>AIX</primary>
5168
5169       <secondary>AFS initialization script</secondary>
5170
5171       <tertiary>on first AFS machine</tertiary>
5172     </indexterm>
5173
5174     <sect2 id="HDRWQ74">
5175       <title>Activating the Script on AIX Systems</title>
5176
5177       <orderedlist>
5178         <listitem>
5179           <para>Edit the AIX initialization file, <emphasis role="bold">/etc/inittab</emphasis>, adding the following line to invoke
5180           the AFS initialization script. Place it just after the line that starts NFS daemons. <programlisting>
5181    rcafs:2:wait:/etc/rc.afs &gt; /dev/console 2&gt;&amp;1 # Start AFS services
5182 </programlisting></para>
5183         </listitem>
5184
5185         <listitem>
5186           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5187           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc</emphasis> directories. If you want to avoid
5188           potential confusion by guaranteeing that they are always the same, create a link between them. You can always retrieve the
5189           original script from the AFS CD-ROM if necessary. <programlisting>
5190    # <emphasis role="bold">cd  /usr/vice/etc</emphasis>
5191    # <emphasis role="bold">rm  rc.afs</emphasis>
5192    # <emphasis role="bold">ln -s  /etc/rc.afs</emphasis>
5193 </programlisting></para>
5194         </listitem>
5195
5196         <listitem>
5197           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5198         </listitem>
5199       </orderedlist>
5200
5201       <indexterm>
5202         <primary>HP-UX</primary>
5203
5204         <secondary>AFS initialization script</secondary>
5205
5206         <tertiary>on first AFS machine</tertiary>
5207       </indexterm>
5208     </sect2>
5209
5210     <sect2 id="HDRWQ76">
5211       <title>Activating the Script on HP-UX Systems</title>
5212
5213       <orderedlist>
5214         <listitem>
5215           <para>Change to the <emphasis role="bold">/sbin/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5216           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the HP-UX startup and
5217           shutdown sequence. <programlisting>
5218    # <emphasis role="bold">cd /sbin/init.d</emphasis>
5219    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/S460afs</emphasis>
5220    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/K800afs</emphasis>
5221 </programlisting></para>
5222         </listitem>
5223
5224         <listitem>
5225           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5226           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/sbin/init.d</emphasis> directories. If you want
5227           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5228           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5229    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5230    # <emphasis role="bold">rm afs.rc</emphasis>
5231    # <emphasis role="bold">ln -s  /sbin/init.d/afs  afs.rc</emphasis>
5232 </programlisting></para>
5233         </listitem>
5234
5235         <listitem>
5236           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5237         </listitem>
5238       </orderedlist>
5239
5240       <indexterm>
5241         <primary>IRIX</primary>
5242
5243         <secondary>AFS initialization script</secondary>
5244
5245         <tertiary>on first AFS machine</tertiary>
5246       </indexterm>
5247     </sect2>
5248
5249     <sect2 id="HDRWQ77">
5250       <title>Activating the Script on IRIX Systems</title>
5251
5252       <orderedlist>
5253         <listitem>
5254           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5255           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the IRIX startup and
5256           shutdown sequence. <programlisting>
5257    # <emphasis role="bold">cd /etc/init.d</emphasis>
5258    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc2.d/S35afs</emphasis>
5259    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K35afs</emphasis>
5260 </programlisting></para>
5261         </listitem>
5262
5263         <listitem>
5264           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5265           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
5266           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5267           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5268    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5269    # <emphasis role="bold">rm afs.rc</emphasis>
5270    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
5271 </programlisting></para>
5272         </listitem>
5273
5274         <listitem>
5275           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5276         </listitem>
5277       </orderedlist>
5278
5279       <indexterm>
5280         <primary>Linux</primary>
5281
5282         <secondary>AFS initialization script</secondary>
5283
5284         <tertiary>on first AFS machine</tertiary>
5285       </indexterm>
5286     </sect2>
5287
5288     <sect2 id="HDRWQ78">
5289       <title>Activating the Script on Linux Systems</title>
5290
5291       <orderedlist>
5292         <listitem>
5293           <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis role="bold">openafs-client</emphasis> and <emphasis role="bold">openafs-server</emphasis>
5294           configuration variables. Based on the instruction in the AFS initialization file that begins with the string
5295           <computeroutput>#chkconfig</computeroutput>, the command automatically creates the symbolic links that incorporate the
5296           script into the Linux startup and shutdown sequence. <programlisting>
5297    # <emphasis role="bold">/sbin/chkconfig  --add openafs-client</emphasis>
5298    # <emphasis role="bold">/sbin/chkconfig  --add openafs-server</emphasis>
5299 </programlisting></para>
5300         </listitem>
5301
5302         <listitem>
5303           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5304           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/rc.d/init.d</emphasis> directories, and
5305           copies of the <emphasis role="bold">afsd</emphasis> options file in both the <emphasis
5306           role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/sysconfig</emphasis> directories. If you want to avoid
5307           potential confusion by guaranteeing that the two copies of each file are always the same, create a link between them. You
5308           can always retrieve the original script or options file from the AFS CD-ROM if necessary. <programlisting>
5309    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5310    # <emphasis role="bold">rm afs.rc afs.conf</emphasis>
5311    # <emphasis role="bold">ln -s  /etc/rc.d/init.d/afs  afs.rc</emphasis>
5312    # <emphasis role="bold">ln -s  /etc/sysconfig/afs  afs.conf</emphasis>
5313 </programlisting></para>
5314         </listitem>
5315
5316         <listitem>
5317           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5318         </listitem>
5319       </orderedlist>
5320
5321       <indexterm>
5322         <primary>Solaris</primary>
5323
5324         <secondary>AFS initialization script</secondary>
5325
5326         <tertiary>on first AFS machine</tertiary>
5327       </indexterm>
5328     </sect2>
5329
5330     <sect2 id="HDRWQ79">
5331       <title>Activating the Script on Solaris Systems</title>
5332
5333       <orderedlist>
5334         <listitem>
5335           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5336           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the Solaris startup and
5337           shutdown sequence. <programlisting>
5338    # <emphasis role="bold">cd /etc/init.d</emphasis>
5339    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc3.d/S99afs</emphasis>
5340    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K66afs</emphasis>
5341 </programlisting></para>
5342         </listitem>
5343
5344         <listitem>
5345           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5346           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
5347           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5348           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5349    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5350    # <emphasis role="bold">rm afs.rc</emphasis>
5351    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
5352 </programlisting></para>
5353         </listitem>
5354       </orderedlist>
5355
5356       <indexterm>
5357         <primary>AFS filespace</primary>
5358
5359         <secondary>configuring top levels</secondary>
5360       </indexterm>
5361
5362       <indexterm>
5363         <primary>configuring</primary>
5364
5365         <secondary>AFS filespace (top levels)</secondary>
5366       </indexterm>
5367     </sect2>
5368   </sect1>
5369
5370   <sect1 id="HDRWQ80">
5371     <title>Configuring the Top Levels of the AFS Filespace</title>
5372
5373     <para>If you have not previously run AFS in your cell, you now configure the top levels of your cell's AFS filespace. If you
5374     have run a previous version of AFS, the filespace is already configured. Proceed to <link linkend="HDRWQ83">Storing AFS Binaries
5375     in AFS</link>. <indexterm>
5376         <primary>root.cell volume</primary>
5377
5378         <secondary>creating and replicating</secondary>
5379       </indexterm> <indexterm>
5380         <primary>volume</primary>
5381
5382         <secondary>creating</secondary>
5383
5384         <tertiary>root.cell</tertiary>
5385       </indexterm> <indexterm>
5386         <primary>creating</primary>
5387
5388         <secondary>root.cell volume</secondary>
5389       </indexterm></para>
5390
5391     <para>You created the <emphasis role="bold">root.afs</emphasis> volume in <link linkend="HDRWQ60">Starting the File Server,
5392     Volume Server, and Salvager</link>, and the Cache Manager mounted it automatically on the local <emphasis
5393     role="bold">/afs</emphasis> directory when you ran the AFS initialization script in <link linkend="HDRWQ72">Verifying the AFS
5394     Initialization Script</link>. You now set the access control list (ACL) on the <emphasis role="bold">/afs</emphasis> directory;
5395     creating, mounting, and setting the ACL are the three steps required when creating any volume.</para>
5396
5397     <para>After setting the ACL on the <emphasis role="bold">root.afs</emphasis> volume, you create your cell's <emphasis
5398     role="bold">root.cell</emphasis> volume, mount it as a subdirectory of the <emphasis role="bold">/afs</emphasis> directory, and
5399     set the ACL. Create both a read/write and a regular mount point for the <emphasis role="bold">root.cell</emphasis> volume. The
5400     read/write mount point enables you to access the read/write version of replicated volumes when necessary. Creating both mount
5401     points essentially creates separate read-only and read-write copies of your filespace, and enables the Cache Manager to traverse
5402     the filespace on a read-only path or read/write path as appropriate. For further discussion of these concepts, see the chapter
5403     in the <emphasis>OpenAFS Administration Guide</emphasis> about administering volumes. <indexterm>
5404         <primary>root.afs volume</primary>
5405
5406         <secondary>replicating</secondary>
5407       </indexterm> <indexterm>
5408         <primary>volume</primary>
5409
5410         <secondary>replicating root.afs and root.cell</secondary>
5411       </indexterm> <indexterm>
5412         <primary>replicating volumes</primary>
5413       </indexterm></para>
5414
5415     <para>Then replicate both the <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes.
5416     This is required if you want to replicate any other volumes in your cell, because all volumes mounted above a replicated volume
5417     must themselves be replicated in order for the Cache Manager to access the replica.</para>
5418
5419     <para>When the <emphasis role="bold">root.afs</emphasis> volume is replicated, the Cache Manager is programmed to access its
5420     read-only version (<emphasis role="bold">root.afs.readonly</emphasis>) whenever possible. To make changes to the contents of the
5421     <emphasis role="bold">root.afs</emphasis> volume (when, for example, you mount another cell's <emphasis
5422     role="bold">root.cell</emphasis> volume at the second level in your filespace), you must mount the <emphasis
5423     role="bold">root.afs</emphasis> volume temporarily, make the changes, release the volume and remove the temporary mount point.
5424     For instructions, see <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>. <indexterm>
5425         <primary>fs commands</primary>
5426
5427         <secondary>setacl</secondary>
5428       </indexterm> <indexterm>
5429         <primary>commands</primary>
5430
5431         <secondary>fs setacl</secondary>
5432       </indexterm> <indexterm>
5433         <primary>access control list (ACL), setting</primary>
5434       </indexterm> <indexterm>
5435         <primary>setting</primary>
5436
5437         <secondary>ACL</secondary>
5438       </indexterm> <orderedlist>
5439         <listitem>
5440           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to edit the ACL on the <emphasis
5441           role="bold">/afs</emphasis> directory. Add an entry that grants the <emphasis role="bold">l</emphasis> (<emphasis
5442           role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>) permissions
5443           to the <emphasis role="bold">system:anyuser</emphasis> group, to enable all AFS users who can reach your cell to traverse
5444           through the directory. If you prefer to enable access only to locally authenticated users, substitute the <emphasis
5445           role="bold">system:authuser</emphasis> group.</para>
5446
5447           <para>Note that there is already an ACL entry that grants all seven access rights to the <emphasis
5448           role="bold">system:administrators</emphasis> group. It is a default entry that AFS places on every new volume's root
5449           directory.</para>
5450
5451           <para>The top-level AFS directory, typically /afs, is a special case:
5452             when the client is configured to run in dynroot mode (e.g.
5453             <emphasis role="bold">afsd -dynroot</emphasis>, attempts to set
5454             the ACL on this directory will return <emphasis role="bold">
5455               Connection timed out</emphasis>. This is because the dynamically-
5456             generated root directory is not a part of the global AFS space,
5457             and cannot have an access control list set on it.</para>
5458
5459           <programlisting>
5460    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs system:anyuser rl</emphasis>
5461 </programlisting>
5462
5463           <indexterm>
5464             <primary>commands</primary>
5465
5466             <secondary>vos create</secondary>
5467
5468             <tertiary>root.cell volume</tertiary>
5469           </indexterm>
5470
5471           <indexterm>
5472             <primary>vos commands</primary>
5473
5474             <secondary>create</secondary>
5475
5476             <tertiary>root.cell volume</tertiary>
5477           </indexterm>
5478
5479           <indexterm>
5480             <primary>fs commands</primary>
5481
5482             <secondary>mkmount</secondary>
5483           </indexterm>
5484
5485           <indexterm>
5486             <primary>commands</primary>
5487
5488             <secondary>fs mkmount</secondary>
5489           </indexterm>
5490
5491           <indexterm>
5492             <primary>mount point</primary>
5493           </indexterm>
5494
5495           <indexterm>
5496             <primary>creating</primary>
5497
5498             <secondary>mount point</secondary>
5499           </indexterm>
5500
5501           <indexterm>
5502             <primary>volume</primary>
5503
5504             <secondary>mounting</secondary>
5505           </indexterm>
5506         </listitem>
5507
5508         <listitem>
5509           <para><anchor id="LIWQ81" />Issue the <emphasis role="bold">vos create</emphasis> command to create the <emphasis
5510           role="bold">root.cell</emphasis> volume. Then issue the <emphasis role="bold">fs mkmount</emphasis> command to mount it as
5511           a subdirectory of the <emphasis role="bold">/afs</emphasis> directory, where it serves as the root of your cell's local
5512           AFS filespace. Finally, issue the <emphasis role="bold">fs setacl</emphasis> command to create an ACL entry for the
5513           <emphasis role="bold">system:anyuser</emphasis> group (or <emphasis role="bold">system:authuser</emphasis> group).</para>
5514
5515           <para>For the <replaceable>partition name</replaceable> argument, substitute the name of one of the machine's AFS server
5516           partitions (such as <emphasis role="bold">/vicepa</emphasis>). For the <replaceable>cellname</replaceable> argument,
5517           substitute your cell's fully-qualified Internet domain name (such as <emphasis role="bold">abc.com</emphasis>).</para>
5518
5519           <programlisting>
5520    # <emphasis role="bold">/usr/afs/bin/vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5521               role="bold">root.cell</emphasis>
5522    # <emphasis role="bold">/usr/afs/bin/fs mkmount /afs/</emphasis><replaceable>cellname</replaceable>  <emphasis role="bold">root.cell</emphasis>
5523    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs/</emphasis><replaceable>cellname</replaceable>  <emphasis role="bold">system:anyuser rl</emphasis>
5524 </programlisting>
5525
5526           <indexterm>
5527             <primary>creating</primary>
5528
5529             <secondary>symbolic link</secondary>
5530
5531             <tertiary>for abbreviated cell name</tertiary>
5532           </indexterm>
5533
5534           <indexterm>
5535             <primary>symbolic link</primary>
5536
5537             <secondary>for abbreviated cell name</secondary>
5538           </indexterm>
5539
5540           <indexterm>
5541             <primary>cell name</primary>
5542
5543             <secondary>symbolic link for abbreviated</secondary>
5544           </indexterm>
5545         </listitem>
5546
5547         <listitem>
5548           <para><emphasis role="bold">(Optional)</emphasis> Create a symbolic link to a shortened cell name, to reduce the length of
5549           pathnames for users in the local cell. For example, in the <emphasis role="bold">abc.com</emphasis> cell, <emphasis
5550           role="bold">/afs/abc</emphasis> is a link to <emphasis role="bold">/afs/abc.com</emphasis>. <programlisting>
5551    # <emphasis role="bold">cd /afs</emphasis>
5552    # <emphasis role="bold">ln -s</emphasis>  <replaceable>full_cellname</replaceable>  <replaceable>short_cellname</replaceable>
5553 </programlisting> <indexterm>
5554               <primary>read/write mount point for root.afs volume</primary>
5555             </indexterm> <indexterm>
5556               <primary>root.afs volume</primary>
5557
5558               <secondary>read/write mount point</secondary>
5559             </indexterm> <indexterm>
5560               <primary>creating</primary>
5561
5562               <secondary>read/write mount point</secondary>
5563             </indexterm></para>
5564         </listitem>
5565
5566         <listitem>
5567           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to create a read/write mount point for the <emphasis
5568           role="bold">root.cell</emphasis> volume (you created a regular mount point in Step <link
5569           linkend="LIWQ81">2</link>).</para>
5570
5571           <para>By convention, the name of a read/write mount point begins with a period, both to distinguish it from the regular
5572           mount point and to make it visible only when the <emphasis role="bold">-a</emphasis> flag is used on the <emphasis
5573           role="bold">ls</emphasis> command.</para>
5574
5575           <para>Change directory to <emphasis role="bold">/usr/afs/bin</emphasis> to make it easier to access the command
5576           binaries.</para>
5577
5578           <programlisting>
5579    # <emphasis role="bold">cd /usr/afs/bin</emphasis>
5580    # <emphasis role="bold">./fs mkmount   /afs/.</emphasis><replaceable>cellname</replaceable>   <emphasis role="bold">root.cell -rw</emphasis>
5581 </programlisting>
5582
5583           <indexterm>
5584             <primary>commands</primary>
5585
5586             <secondary>vos addsite</secondary>
5587           </indexterm>
5588
5589           <indexterm>
5590             <primary>vos commands</primary>
5591
5592             <secondary>addsite</secondary>
5593           </indexterm>
5594
5595           <indexterm>
5596             <primary>volume</primary>
5597
5598             <secondary>defining replication site</secondary>
5599           </indexterm>
5600
5601           <indexterm>
5602             <primary>defining</primary>
5603
5604             <secondary>replication site for volume</secondary>
5605           </indexterm>
5606         </listitem>
5607
5608         <listitem>
5609           <para><anchor id="LIWQ82" />Issue the <emphasis role="bold">vos addsite</emphasis> command to define a replication site
5610           for both the <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes. In each
5611           case, substitute for the <replaceable>partition name</replaceable> argument the partition where the volume's read/write
5612           version resides. When you install additional file server machines, it is a good idea to create replication sites on them
5613           as well. <programlisting>
5614    # <emphasis role="bold">./vos addsite</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5615                 role="bold">root.afs</emphasis>
5616    # <emphasis role="bold">./vos addsite</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5617                 role="bold">root.cell</emphasis>
5618 </programlisting> <indexterm>
5619               <primary>fs commands</primary>
5620
5621               <secondary>examine</secondary>
5622             </indexterm> <indexterm>
5623               <primary>commands</primary>
5624
5625               <secondary>fs examine</secondary>
5626             </indexterm></para>
5627         </listitem>
5628
5629         <listitem>
5630           <para>Issue the <emphasis role="bold">fs examine</emphasis> command to verify that the Cache Manager can access both the
5631           <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes, before you attempt to
5632           replicate them. The output lists each volume's name, volumeID number, quota, size, and the size of the partition that
5633           houses them. If you get an error message instead, do not continue before taking corrective action. <programlisting>
5634    # <emphasis role="bold">./fs examine /afs</emphasis>
5635    # <emphasis role="bold">./fs examine /afs/</emphasis><replaceable>cellname</replaceable>
5636 </programlisting> <indexterm>
5637               <primary>commands</primary>
5638
5639               <secondary>vos release</secondary>
5640             </indexterm> <indexterm>
5641               <primary>vos commands</primary>
5642
5643               <secondary>release</secondary>
5644             </indexterm> <indexterm>
5645               <primary>volume</primary>
5646
5647               <secondary>releasing replicated</secondary>
5648             </indexterm> <indexterm>
5649               <primary>releasing replicated volume</primary>
5650             </indexterm></para>
5651         </listitem>
5652
5653         <listitem>
5654           <para>Issue the <emphasis role="bold">vos release</emphasis> command to release a replica of the <emphasis
5655           role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes to the sites you defined in Step
5656           <link linkend="LIWQ82">5</link>. <programlisting>
5657    # <emphasis role="bold">./vos release root.afs</emphasis>
5658    # <emphasis role="bold">./vos release root.cell</emphasis>
5659 </programlisting> <indexterm>
5660               <primary>fs commands</primary>
5661
5662               <secondary>checkvolumes</secondary>
5663             </indexterm> <indexterm>
5664               <primary>commands</primary>
5665
5666               <secondary>fs checkvolumes</secondary>
5667             </indexterm></para>
5668         </listitem>
5669
5670         <listitem>
5671           <para>Issue the <emphasis role="bold">fs checkvolumes</emphasis> to force the Cache Manager to notice that you have
5672           released read-only versions of the volumes, then issue the <emphasis role="bold">fs examine</emphasis> command again. This
5673           time its output mentions the read-only version of the volumes (<emphasis role="bold">root.afs.readonly</emphasis> and
5674           <emphasis role="bold">root.cell.readonly</emphasis>) instead of the read/write versions, because of the Cache Manager's
5675           bias to access the read-only version of the <emphasis role="bold">root.afs</emphasis> volume if it exists.
5676           <programlisting>
5677    # <emphasis role="bold">./fs checkvolumes</emphasis>
5678    # <emphasis role="bold">./fs examine /afs</emphasis>
5679    # <emphasis role="bold">./fs examine /afs/</emphasis><replaceable>cellname</replaceable>
5680 </programlisting></para>
5681         </listitem>
5682       </orderedlist></para>
5683
5684     <indexterm>
5685       <primary>storing</primary>
5686
5687       <secondary>AFS binaries in volumes</secondary>
5688     </indexterm>
5689
5690     <indexterm>
5691       <primary>creating</primary>
5692
5693       <secondary>volume</secondary>
5694
5695       <tertiary>for AFS binaries</tertiary>
5696     </indexterm>
5697
5698     <indexterm>
5699       <primary>volume</primary>
5700
5701       <secondary>for AFS binaries</secondary>
5702     </indexterm>
5703
5704     <indexterm>
5705       <primary>binaries</primary>
5706
5707       <secondary>storing AFS in volume</secondary>
5708     </indexterm>
5709
5710     <indexterm>
5711       <primary>usr/afsws directory</primary>
5712     </indexterm>
5713
5714     <indexterm>
5715       <primary>directories</primary>
5716
5717       <secondary>/usr/afsws</secondary>
5718     </indexterm>
5719   </sect1>
5720
5721   <sect1 id="HDRWQ83">
5722     <title>Storing AFS Binaries in AFS</title>
5723
5724     <note><para>Sites with existing binary distribution mechanisms, including
5725     those which use packaging systems such as RPM, may wish to skip this step,
5726     and use tools native to their operating system to manage AFS configuration
5727     information.</para></note>
5728
5729     <para>In the conventional configuration, you make AFS client binaries and configuration files available in the subdirectories of
5730     the <emphasis role="bold">/usr/afsws</emphasis> directory on client machines (<emphasis role="bold">afsws</emphasis> is an
5731     acronym for <emphasis role="bold">AFS w</emphasis><emphasis>ork</emphasis><emphasis
5732     role="bold">s</emphasis><emphasis>tation</emphasis>). You can conserve local disk space by creating <emphasis
5733     role="bold">/usr/afsws</emphasis> as a link to an AFS volume that houses the AFS client binaries and configuration files for
5734     this system type.</para>
5735
5736     <para>In this section you create the necessary volumes. The conventional location to which to link <emphasis
5737     role="bold">/usr/afsws</emphasis> is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5738     role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis>, where
5739     <replaceable>sysname</replaceable> is the appropriate system type name as specified in the <emphasis>OpenAFS Release
5740     Notes</emphasis>. The instructions in <link linkend="HDRWQ133">Installing Additional Client Machines</link> assume that you have
5741     followed the instructions in this section.</para>
5742
5743     <para>If you have previously run AFS in the cell, the volumes possibly already exist. If so, you need to perform Step <link
5744     linkend="LIWQ86">8</link> only.</para>
5745
5746     <para>The current working directory is still <emphasis role="bold">/usr/afs/bin</emphasis>, which houses the <emphasis
5747     role="bold">fs</emphasis> and <emphasis role="bold">vos</emphasis> command suite binaries. In the following commands, it is
5748     possible you still need to specify the pathname to the commands, depending on how your PATH environment variable is set.
5749     <orderedlist>
5750         <indexterm>
5751           <primary>commands</primary>
5752
5753           <secondary>vos create</secondary>
5754
5755           <tertiary>volume for AFS binaries</tertiary>
5756         </indexterm>
5757
5758         <indexterm>
5759           <primary>vos commands</primary>
5760
5761           <secondary>create</secondary>
5762
5763           <tertiary>volume for AFS binaries</tertiary>
5764         </indexterm>
5765
5766         <listitem>
5767           <para><anchor id="LIWQ84" />Issue the <emphasis role="bold">vos create</emphasis> command to create volumes for storing
5768           the AFS client binaries for this system type. The following example instruction creates volumes called
5769           <replaceable>sysname</replaceable>, <replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis>, and
5770           <replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis>. Refer to the <emphasis>OpenAFS Release
5771           Notes</emphasis> to learn the proper value of <replaceable>sysname</replaceable> for this system type. <programlisting>
5772    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable>
5773    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
5774                 role="bold">.usr</emphasis>
5775    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
5776                 role="bold">.usr.afsws</emphasis>
5777 </programlisting></para>
5778         </listitem>
5779
5780         <listitem>
5781           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the newly created volumes. Because the
5782           <emphasis role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> part
5783           of the pathname with a period to specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos
5784           release</emphasis> command to release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the
5785           <emphasis role="bold">fs checkvolumes</emphasis> command to force the local Cache Manager to access them. <programlisting>
5786    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable> <emphasis
5787                 role="bold">-vol</emphasis> <replaceable>sysname</replaceable>
5788    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5789                 role="bold">/usr</emphasis>  <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
5790                 role="bold">.usr</emphasis>
5791    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5792                 role="bold">/usr/afsws</emphasis> <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
5793                 role="bold">.usr.afsws</emphasis>
5794    # <emphasis role="bold">vos release root.cell</emphasis>
5795    # <emphasis role="bold">fs checkvolumes</emphasis>
5796 </programlisting></para>
5797         </listitem>
5798
5799         <listitem>
5800           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">l</emphasis>
5801           (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>)
5802           permissions to the <emphasis role="bold">system:anyuser</emphasis> group on each new directory's ACL. <programlisting>
5803    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable>
5804    # <emphasis role="bold">fs setacl  -dir  .  usr  usr/afsws  -acl  system:anyuser rl</emphasis>
5805 </programlisting> <indexterm>
5806               <primary>commands</primary>
5807
5808               <secondary>fs setquota</secondary>
5809             </indexterm> <indexterm>
5810               <primary>fs commands</primary>
5811
5812               <secondary>setquota</secondary>
5813             </indexterm> <indexterm>
5814               <primary>quota for volume</primary>
5815             </indexterm> <indexterm>
5816               <primary>volume</primary>
5817
5818               <secondary>setting quota</secondary>
5819             </indexterm> <indexterm>
5820               <primary>setting</primary>
5821
5822               <secondary>volume quota</secondary>
5823             </indexterm></para>
5824         </listitem>
5825
5826         <listitem>
5827           <para><anchor id="LIWQ85" />Issue the <emphasis role="bold">fs setquota</emphasis> command to set an unlimited quota on
5828           the volume mounted at the <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5829           role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory. This
5830           enables you to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's
5831           quota.</para>
5832
5833           <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operation. At that
5834           point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
5835           Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
5836
5837           <programlisting>
5838    # <emphasis role="bold">fs setquota /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5839               role="bold">/usr/afsws  0</emphasis>
5840 </programlisting>
5841         </listitem>
5842
5843         <listitem>
5844           <para>Unpack the distribution tarball into the <emphasis role="bold">/tmp/afsdist</emphasis> directory,
5845           if it is not already. <indexterm>
5846               <primary>copying</primary>
5847
5848               <secondary>AFS binaries into volume</secondary>
5849             </indexterm> <indexterm>
5850               <primary>CD-ROM</primary>
5851
5852               <secondary>copying AFS binaries into volume</secondary>
5853             </indexterm> <indexterm>
5854               <primary>first AFS machine</primary>
5855
5856               <secondary>copying</secondary>
5857
5858               <tertiary>AFS binaries into volume</tertiary>
5859             </indexterm></para>
5860         </listitem>
5861
5862         <listitem>
5863           <para>Copy the contents of the indicated directories from the
5864           distribution into the <emphasis
5865           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5866           role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory.
5867           <programlisting>
5868    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5869                 role="bold">/usr/afsws</emphasis>
5870    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/bin  .</emphasis>
5871    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/etc  .</emphasis>
5872    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/include  .</emphasis>
5873    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/lib  .</emphasis>
5874 </programlisting>
5875 <indexterm>
5876               <primary>creating</primary>
5877
5878               <secondary>symbolic link</secondary>
5879
5880               <tertiary>to AFS binaries</tertiary>
5881             </indexterm> <indexterm>
5882               <primary>symbolic link</primary>
5883
5884               <secondary>to AFS binaries from local disk</secondary>
5885             </indexterm></para>
5886         </listitem>
5887
5888         <listitem>
5889           <para><anchor id="LIWQ86" />Create <emphasis role="bold">/usr/afsws</emphasis> on the local disk as a symbolic link to the
5890           directory <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5891           role="bold">/@sys/usr/afsws</emphasis>. You can specify the actual system name instead of <emphasis
5892           role="bold">@sys</emphasis> if you wish, but the advantage of using <emphasis role="bold">@sys</emphasis> is that it
5893           remains valid if you upgrade this machine to a different system type. <programlisting>
5894    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws  /usr/afsws</emphasis>
5895 </programlisting> <indexterm>
5896               <primary>PATH environment variable for users</primary>
5897             </indexterm> <indexterm>
5898               <primary>variables</primary>
5899
5900               <secondary>PATH, setting for users</secondary>
5901             </indexterm></para>
5902         </listitem>
5903
5904         <listitem>
5905           <para><emphasis role="bold">(Optional)</emphasis> To enable users to issue commands from the AFS suites (such as <emphasis
5906           role="bold">fs</emphasis>) without having to specify a pathname to their binaries, include the <emphasis
5907           role="bold">/usr/afsws/bin</emphasis> and <emphasis role="bold">/usr/afsws/etc</emphasis> directories in the PATH
5908           environment variable you define in each user's shell initialization file (such as <emphasis
5909           role="bold">.cshrc</emphasis>).</para>
5910         </listitem>
5911       </orderedlist></para>
5912
5913     <indexterm>
5914       <primary>storing</primary>
5915
5916       <secondary>AFS documentation in volumes</secondary>
5917     </indexterm>
5918
5919     <indexterm>
5920       <primary>creating</primary>
5921
5922       <secondary>volume</secondary>
5923
5924       <tertiary>for AFS documentation</tertiary>
5925     </indexterm>
5926
5927     <indexterm>
5928       <primary>volume</primary>
5929
5930       <secondary>for AFS documentation</secondary>
5931     </indexterm>
5932
5933     <indexterm>
5934       <primary>documentation, creating volume for AFS</primary>
5935     </indexterm>
5936
5937     <indexterm>
5938       <primary>usr/afsdoc directory</primary>
5939     </indexterm>
5940
5941     <indexterm>
5942       <primary>directories</primary>
5943
5944       <secondary>/usr/afsdoc</secondary>
5945     </indexterm>
5946   </sect1>
5947
5948   <sect1 id="HDRWQ87">
5949     <title>Storing AFS Documents in AFS</title>
5950
5951     <para>The AFS distribution includes the following documents: <itemizedlist>
5952         <listitem>
5953           <para><emphasis>OpenAFS Release Notes</emphasis></para>
5954         </listitem>
5955
5956         <listitem>
5957           <para><emphasis>OpenAFS Quick Beginnings</emphasis></para>
5958         </listitem>
5959
5960         <listitem>
5961           <para><emphasis>OpenAFS User Guide</emphasis></para>
5962         </listitem>
5963
5964         <listitem>
5965           <para><emphasis>OpenAFS Administration Reference</emphasis></para>
5966         </listitem>
5967
5968         <listitem>
5969           <para><emphasis>OpenAFS Administration Guide</emphasis></para>
5970         </listitem>
5971       </itemizedlist></para>
5972
5973     <note><para>OpenAFS Documentation is not currently provided with all
5974     distributions, but may be downloaded separately from the OpenAFS
5975     website</para></note>
5976
5977     <para>The OpenAFS Documentation Distribution has a directory for each
5978     document format provided. The different formats are suitable for online
5979     viewing, printing, or both.</para>
5980
5981     <para>This section explains how to create and mount a volume to house the documents, making them available to your users. The
5982     recommended mount point for the volume is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5983     role="bold">/afsdoc</emphasis>. If you wish, you can create a link to the mount point on each client machine's local disk,
5984     called <emphasis role="bold">/usr/afsdoc</emphasis>. Alternatively, you can create a link to the mount point in each user's home
5985     directory. You can also choose to permit users to access only certain documents (most probably, the <emphasis>OpenAFS User
5986     Guide</emphasis>) by creating different mount points or setting different ACLs on different document directories.</para>
5987
5988     <para>The current working directory is still <emphasis role="bold">/usr/afs/bin</emphasis>, which houses the <emphasis
5989     role="bold">fs</emphasis> and <emphasis role="bold">vos</emphasis> command suite binaries you use to create and mount volumes.
5990     In the following commands, it is possible you still need to specify the pathname to the commands, depending on how your PATH
5991     environment variable is set. <orderedlist>
5992         <indexterm>
5993           <primary>commands</primary>
5994
5995           <secondary>vos create</secondary>
5996
5997           <tertiary>volume for AFS documentation</tertiary>
5998         </indexterm>
5999
6000         <indexterm>
6001           <primary>vos commands</primary>
6002
6003           <secondary>create</secondary>
6004
6005           <tertiary>volume for AFS documentation</tertiary>
6006         </indexterm>
6007
6008         <listitem>
6009           <para>Issue the <emphasis role="bold">vos create</emphasis> command to create a volume for storing the AFS documentation.
6010           Include the <emphasis role="bold">-maxquota</emphasis> argument to set an unlimited quota on the volume. This enables you
6011           to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's quota.</para>
6012
6013           <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operations. At that
6014           point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
6015           Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
6016
6017           <programlisting>
6018    # <emphasis role="bold">vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt;  <emphasis
6019               role="bold">afsdoc  -maxquota  0</emphasis>
6020 </programlisting>
6021         </listitem>
6022
6023         <listitem>
6024           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the new volume. Because the <emphasis
6025           role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> with a period to
6026           specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos release</emphasis> command to
6027           release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the <emphasis role="bold">fs
6028           checkvolumes</emphasis> command to force the local Cache Manager to access them. <programlisting>
6029    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis> <emphasis
6030                 role="bold">-vol</emphasis> <emphasis role="bold">afsdoc</emphasis>
6031    # <emphasis role="bold">vos release root.cell</emphasis>
6032    # <emphasis role="bold">fs checkvolumes</emphasis>
6033 </programlisting></para>
6034         </listitem>
6035
6036         <listitem>
6037           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">rl</emphasis>
6038           permissions to the <emphasis role="bold">system:anyuser</emphasis> group on the new directory's ACL. <programlisting>
6039    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis>
6040    # <emphasis role="bold">fs setacl  .  system:anyuser rl</emphasis>
6041 </programlisting></para>
6042         </listitem>
6043
6044         <listitem>
6045           <para>Unpack the OpenAFS documentation distribution into the
6046           <emphasis role="bold">/tmp/afsdocs</emphasis> directory. You may use
6047           a different directory, in which case the location you use should be
6048           subsituted in the following examples. For instructions on unpacking
6049           the distribution, consult the documentation for your operating
6050           system's <emphasis role="bold">tar</emphasis> command.
6051           <indexterm>
6052               <primary>copying</primary>
6053
6054               <secondary>AFS documentation from distribution</secondary>
6055             </indexterm> <indexterm>
6056               <primary>OpenAFS Distribution</primary>
6057
6058               <secondary>copying AFS documentation from</secondary>
6059             </indexterm> <indexterm>
6060               <primary>first AFS machine</primary>
6061
6062               <secondary>copying</secondary>
6063
6064               <tertiary>AFS documentation from OpenAFS distribution</tertiary>
6065             </indexterm> <indexterm>
6066               <primary>index.htm file</primary>
6067             </indexterm> <indexterm>
6068               <primary>files</primary>
6069
6070               <secondary>index.htm</secondary>
6071             </indexterm></para>
6072         </listitem>
6073
6074         <listitem>
6075           <para>Copy the AFS documents in one or more formats from the unpacked distribution into subdirectories of the <emphasis
6076           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis> directory. Repeat
6077           the commands for each format. <programlisting>
6078    # <emphasis role="bold">mkdir</emphasis> <replaceable>format_name</replaceable>
6079    # <emphasis role="bold">cd</emphasis> <replaceable>format_name</replaceable>
6080    # <emphasis role="bold">cp -rp /tmp/afsdocs/</emphasis><replaceable>format</replaceable>  <emphasis role="bold">.</emphasis>
6081 </programlisting></para>
6082
6083           <para>If you choose to store the HTML version of the documents in AFS, note that in addition to a subdirectory for each
6084           document there are several files with a <emphasis role="bold">.gif</emphasis> extension, which enable readers to move
6085           easily between sections of a document. The file called <emphasis role="bold">index.htm</emphasis> is an introductory HTML
6086           page that contains a hyperlink to each of the documents. For online viewing to work properly, these files must remain in
6087           the top-level HTML directory (the one named, for example, <emphasis
6088           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/html</emphasis>).</para>
6089         </listitem>
6090
6091         <listitem>
6092           <para><emphasis role="bold">(Optional)</emphasis> If you believe it is helpful to your users to access the AFS documents
6093           in a certain format via a local disk directory, create <emphasis role="bold">/usr/afsdoc</emphasis> on the local disk as a
6094           symbolic link to the documentation directory in AFS (<emphasis
6095           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6096           role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable>). <programlisting>
6097    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> <emphasis
6098                 role="bold">/usr/afsdoc</emphasis>
6099 </programlisting></para>
6100
6101           <para>An alternative is to create a link in each user's home directory to the <emphasis
6102           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6103           role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> directory.</para>
6104         </listitem>
6105       </orderedlist></para>
6106
6107     <indexterm>
6108       <primary>storing</primary>
6109
6110       <secondary>system binaries in volumes</secondary>
6111     </indexterm>
6112
6113     <indexterm>
6114       <primary>creating</primary>
6115
6116       <secondary>volume</secondary>
6117
6118       <tertiary>for system binaries</tertiary>
6119     </indexterm>
6120
6121     <indexterm>
6122       <primary>volume</primary>
6123
6124       <secondary>for system binaries</secondary>
6125     </indexterm>
6126
6127     <indexterm>
6128       <primary>binaries</primary>
6129
6130       <secondary>storing system in volumes</secondary>
6131     </indexterm>
6132   </sect1>
6133
6134   <sect1 id="HDRWQ88">
6135     <title>Storing System Binaries in AFS</title>
6136
6137     <para>You can also choose to store other system binaries in AFS volumes, such as the standard UNIX programs conventionally
6138     located in local disk directories such as <emphasis role="bold">/etc</emphasis>, <emphasis role="bold">/bin</emphasis>, and
6139     <emphasis role="bold">/lib</emphasis>. Storing such binaries in an AFS volume not only frees local disk space, but makes it
6140     easier to update binaries on all client machines.</para>
6141
6142     <para>The following is a suggested scheme for storing system binaries in AFS. It does not include instructions, but you can use
6143     the instructions in <link linkend="HDRWQ83">Storing AFS Binaries in AFS</link> (which are for AFS-specific binaries) as a
6144     template.</para>
6145
6146     <para>Some files must remain on the local disk for use when AFS is inaccessible (during bootup and file server or network
6147     outages). The required binaries include the following: <itemizedlist>
6148         <listitem>
6149           <para>A text editor, network commands, and so on</para>
6150         </listitem>
6151
6152         <listitem>
6153           <para>Files used during the boot sequence before the <emphasis role="bold">afsd</emphasis> program runs, such as
6154           initialization and configuration files, and binaries for commands that mount file systems</para>
6155         </listitem>
6156
6157         <listitem>
6158           <para>Files used by dynamic kernel loader programs</para>
6159         </listitem>
6160       </itemizedlist></para>
6161
6162     <para>In most cases, it is more secure to enable only locally authenticated users to access system binaries, by granting the
6163     <emphasis role="bold">l</emphasis> (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis
6164     role="bold">read</emphasis>) permissions to the <emphasis role="bold">system:authuser</emphasis> group on the ACLs of
6165     directories that contain the binaries. If users need to access a binary while unauthenticated, however, the ACL on its directory
6166     must grant those permissions to the <emphasis role="bold">system:anyuser</emphasis> group.</para>
6167
6168     <para>The following chart summarizes the suggested volume and mount point names for storing system binaries. It uses a separate
6169     volume for each directory. You already created a volume called <replaceable>sysname</replaceable> for this machine's system type
6170     when you followed the instructions in <link linkend="HDRWQ83">Storing AFS Binaries in AFS</link>.</para>
6171
6172     <para>You can name volumes in any way you wish, and mount them at other locations than those suggested here. However, this
6173     scheme has several advantages: <itemizedlist>
6174         <listitem>
6175           <para>Volume names clearly identify volume contents</para>
6176         </listitem>
6177
6178         <listitem>
6179           <para>Using the <replaceable>sysname</replaceable> prefix on every volume makes it is easy to back up all of the volumes
6180           together, because the AFS Backup System enables you to define sets of volumes based on a string included in all of their
6181           names</para>
6182         </listitem>
6183
6184         <listitem>
6185           <para>It makes it easy to track related volumes, keeping them together on the same file server machine if desired</para>
6186         </listitem>
6187
6188         <listitem>
6189           <para>There is a clear relationship between volume name and mount point name</para>
6190         </listitem>
6191       </itemizedlist></para>
6192
6193     <informaltable frame="none">
6194       <tgroup cols="2">
6195         <colspec colwidth="50*" />
6196
6197         <colspec colwidth="50*" />
6198
6199         <thead>
6200           <row>
6201             <entry><emphasis role="bold">Volume Name</emphasis></entry>
6202
6203             <entry><emphasis role="bold">Mount Point</emphasis></entry>
6204           </row>
6205         </thead>
6206
6207         <tbody>
6208           <row>
6209             <entry><replaceable>sysname</replaceable></entry>
6210
6211             <entry><emphasis
6212             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable></entry>
6213           </row>
6214
6215           <row>
6216             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">bin</emphasis></entry>
6217
6218             <entry><emphasis
6219             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6220             role="bold">/bin</emphasis></entry>
6221           </row>
6222
6223           <row>
6224             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">etc</emphasis></entry>
6225
6226             <entry><emphasis
6227             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6228             role="bold">/etc</emphasis></entry>
6229           </row>
6230
6231           <row>
6232             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis></entry>
6233
6234             <entry><emphasis
6235             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6236             role="bold">/usr</emphasis></entry>
6237           </row>
6238
6239           <row>
6240             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis></entry>
6241
6242             <entry><emphasis
6243             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6244             role="bold">/usr/afsws</emphasis></entry>
6245           </row>
6246
6247           <row>
6248             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.bin</emphasis></entry>
6249
6250             <entry><emphasis
6251             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6252             role="bold">/usr/bin</emphasis></entry>
6253           </row>
6254
6255           <row>
6256             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.etc</emphasis></entry>
6257
6258             <entry><emphasis
6259             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6260             role="bold">/usr/etc</emphasis></entry>
6261           </row>
6262
6263           <row>
6264             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.inc</emphasis></entry>
6265
6266             <entry><emphasis
6267             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6268             role="bold">/usr/include</emphasis></entry>
6269           </row>
6270
6271           <row>
6272             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.lib</emphasis></entry>
6273
6274             <entry><emphasis
6275             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6276             role="bold">/usr/lib</emphasis></entry>
6277           </row>
6278
6279           <row>
6280             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.loc</emphasis></entry>
6281
6282             <entry><emphasis
6283             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6284             role="bold">/usr/local</emphasis></entry>
6285           </row>
6286
6287           <row>
6288             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.man</emphasis></entry>
6289
6290             <entry><emphasis
6291             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6292             role="bold">/usr/man</emphasis></entry>
6293           </row>
6294
6295           <row>
6296             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.sys</emphasis></entry>
6297
6298             <entry><emphasis
6299             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6300             role="bold">/usr/sys</emphasis></entry>
6301           </row>
6302         </tbody>
6303       </tgroup>
6304     </informaltable>
6305
6306     <indexterm>
6307       <primary>foreign cell, enabling access</primary>
6308     </indexterm>
6309
6310     <indexterm>
6311       <primary>cell</primary>
6312
6313       <secondary>enabling access to foreign</secondary>
6314     </indexterm>
6315
6316     <indexterm>
6317       <primary>access</primary>
6318
6319       <secondary>to local and foreign cells</secondary>
6320     </indexterm>
6321
6322     <indexterm>
6323       <primary>AFS filespace</primary>
6324
6325       <secondary>enabling access to foreign cells</secondary>
6326     </indexterm>
6327
6328     <indexterm>
6329       <primary>root.cell volume</primary>
6330
6331       <secondary>mounting for foreign cells in local filespace</secondary>
6332     </indexterm>
6333
6334     <indexterm>
6335       <primary>database server machine</primary>
6336
6337       <secondary>entry in client CellServDB file</secondary>
6338
6339       <tertiary>for foreign cell</tertiary>
6340     </indexterm>
6341
6342     <indexterm>
6343       <primary>CellServDB file (client)</primary>
6344
6345       <secondary>adding entry</secondary>
6346
6347       <tertiary>for foreign cell</tertiary>
6348     </indexterm>
6349   </sect1>
6350
6351   <sect1 id="HDRWQ91">
6352     <title>Enabling Access to Foreign Cells</title>
6353
6354     <para>With current OpenAFS releases, there exist a number of mechanisms for
6355     providing access to foreign cells. You may add mount points in your AFS
6356     filespace for each foreign cell you wish users to access, or you can
6357     enable a 'synthetic' AFS root, which contains mountpoints for either all
6358     AFS cells defined in the client machine's local
6359     <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis>, or for all cells
6360     providing location information in the DNS.
6361     </para>
6362
6363     <sect2>
6364     <title>Enabling a Synthetic AFS root</title>
6365
6366     <para>When a synthetic root is enabled, the client cache machine creates its
6367     own root.afs volume, rather than using the one provided with your cell. This
6368     allows clients to access all cells in the
6369     <emphasis role="bold">CellServDB</emphasis> file and, optionally, all cells
6370     registered in the DNS, without requiring system administrator action to
6371     enable this access. Using a synthetic root has the additional advantage that
6372     it allows a client to start its AFS service without a network available, as
6373     it is no longer necessary to contact a fileserver to obtain the root volume.
6374     </para>
6375
6376     <para>OpenAFS supports two complimentary mechanisms for creating the
6377     synthetic root. Starting the cache manager with the
6378     <emphasis role="bold">-dynroot</emphasis> option adds all cells listed
6379     in <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> to the client's
6380     AFS root. Adding the <emphasis role="bold">-afsdb</emphasis> option in
6381     addition to this enables DNS lookups for any cells that are not found in
6382     the client's CellServDB file. Both of these options are added to the AFS
6383     initialisation script, or options file, as detailed in
6384     <link linkend="HDRWQ70">Configuring the Cache Manager</link>.</para>
6385     </sect2>
6386     <sect2>
6387       <title>Adding foreign cells to a conventional root volume</title>
6388
6389     <para>In this section you create a mount point in your AFS filespace for the <emphasis role="bold">root.cell</emphasis> volume
6390     of each foreign cell that you want to enable your users to access. For users working on a client machine to access the cell,
6391     there must in addition be an entry for it in the client machine's local <emphasis
6392     role="bold">/usr/vice/etc/CellServDB</emphasis> file. (The instructions in <link linkend="HDRWQ66">Creating the Client
6393     CellServDB File</link> suggest that you use the <emphasis role="bold">CellServDB.sample</emphasis> file included in the AFS
6394     distribution as the basis for your cell's client <emphasis role="bold">CellServDB</emphasis> file. The sample file lists all of
6395     the cells that had agreed to participate in the AFS global namespace at the time your AFS CD-ROM was created. As mentioned in
6396     that section, the AFS Product Support group also maintains a copy of the file, updating it as necessary.)</para>
6397
6398     <para>The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell administration and configuration issues
6399     discusses the implications of participating in the global AFS namespace. The chapter about administering client machines
6400     explains how to maintain knowledge of foreign cells on client machines, and includes suggestions for maintaining a central
6401     version of the file in AFS. <orderedlist>
6402         <listitem>
6403           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount each foreign cell's <emphasis
6404           role="bold">root.cell</emphasis> volume on a directory called <emphasis
6405           role="bold">/afs/</emphasis><replaceable>foreign_cell</replaceable>. Because the <emphasis role="bold">root.afs</emphasis>
6406           volume is replicated, you must create a temporary mount point for its read/write version in a directory to which you have
6407           write access (such as your cell's <emphasis role="bold">/afs/.</emphasis><replaceable>cellname</replaceable> directory).
6408           Create the mount points, issue the <emphasis role="bold">vos release</emphasis> command to release new replicas to the
6409           read-only sites for the <emphasis role="bold">root.afs</emphasis> volume, and issue the <emphasis role="bold">fs
6410           checkvolumes</emphasis> command to force the local Cache Manager to access the new replica.</para>
6411
6412           <note>
6413             <para>You need to issue the <emphasis role="bold">fs mkmount</emphasis> command only once for each foreign cell's
6414             <emphasis role="bold">root.cell</emphasis> volume. You do not need to repeat the command on each client machine.</para>
6415           </note>
6416
6417           <para>Substitute your cell's name for <replaceable>cellname</replaceable>.</para>
6418
6419           <programlisting>
6420    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable>
6421    # <emphasis role="bold">/usr/afs/bin/fs  mkmount  temp  root.afs</emphasis>
6422 </programlisting>
6423
6424           <para>Repeat the <emphasis role="bold">fs mkmount</emphasis> command for each foreign cell you wish to mount at this
6425           time.</para>
6426
6427           <programlisting>
6428    # <emphasis role="bold">/usr/afs/bin/fs mkmount temp/</emphasis><replaceable>foreign_cell</replaceable> <emphasis role="bold">root.cell -c</emphasis> <replaceable>foreign_cell</replaceable>
6429 </programlisting>
6430
6431           <para>Issue the following commands only once.</para>
6432
6433           <programlisting>
6434    # <emphasis role="bold">/usr/afs/bin/fs rmmount temp</emphasis>
6435    # <emphasis role="bold">/usr/afs/bin/vos release root.afs</emphasis>
6436    # <emphasis role="bold">/usr/afs/bin/fs checkvolumes</emphasis>
6437 </programlisting>
6438
6439           <indexterm>
6440             <primary>fs commands</primary>
6441
6442             <secondary>newcell</secondary>
6443           </indexterm>
6444
6445           <indexterm>
6446             <primary>commands</primary>
6447
6448             <secondary>fs newcell</secondary>
6449           </indexterm>
6450         </listitem>
6451
6452         <listitem>
6453           <para><anchor id="LIWQ92" />If this machine is going to remain an AFS client after you complete the installation, verify
6454           that the local <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file includes an entry for each foreign
6455           cell.</para>
6456
6457           <para>For each cell that does not already have an entry, complete the following instructions: <orderedlist>
6458               <listitem>
6459                 <para>Create an entry in the <emphasis role="bold">CellServDB</emphasis> file. Be sure to comply with the formatting
6460                 instructions in <link linkend="HDRWQ66">Creating the Client CellServDB File</link>.</para>
6461               </listitem>
6462
6463               <listitem>
6464                 <para>Issue the <emphasis role="bold">fs newcell</emphasis> command to add an entry for the cell directly to the
6465                 list that the Cache Manager maintains in kernel memory. Provide each database server machine's fully qualified
6466                 hostname. <programlisting>
6467    # <emphasis role="bold">/usr/afs/bin/fs newcell</emphasis> &lt;<replaceable>foreign_cell</replaceable>&gt; &lt;<replaceable>dbserver1&gt;</replaceable>    \
6468             [&lt;<replaceable>dbserver2&gt;</replaceable>] [&lt;<replaceable>dbserver3&gt;</replaceable>]
6469 </programlisting></para>
6470               </listitem>
6471
6472               <listitem>
6473                 <para>If you plan to maintain a central version of the <emphasis role="bold">CellServDB</emphasis> file (the
6474                 conventional location is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6475                 role="bold">/common/etc/CellServDB</emphasis>), create it now as a copy of the local <emphasis
6476                 role="bold">/usr/vice/etc/CellServDB</emphasis> file. Verify that it includes an entry for each foreign cell you
6477                 want your users to be able to access. <programlisting>
6478    # <emphasis role="bold">mkdir common</emphasis>
6479    # <emphasis role="bold">mkdir common/etc</emphasis>
6480    # <emphasis role="bold">cp  /usr/vice/etc/CellServDB  common/etc</emphasis>
6481    # <emphasis role="bold">/usr/afs/bin/vos release root.cell</emphasis>
6482 </programlisting></para>
6483               </listitem>
6484             </orderedlist></para>
6485         </listitem>
6486
6487         <listitem>
6488           <para>Issue the <emphasis role="bold">ls</emphasis> command to verify that the new cell's mount point is visible in your
6489           filespace. The output lists the directories at the top level of the new cell's AFS filespace. <programlisting>
6490    # <emphasis role="bold">ls /afs/</emphasis><replaceable>foreign_cell</replaceable>
6491 </programlisting></para>
6492         </listitem>
6493
6494         <listitem>
6495           <para>If you wish to participate in the global AFS namespace, and only
6496           intend running one database server, please
6497           register your cell with grand.central.org at this time.
6498           To do so, email the <emphasis role="bold">CellServDB</emphasis> fragment
6499           describing your cell, together with a contact name and email address
6500           for any queries, to cellservdb@grand.central.org. If you intend
6501           on deploying multiple database servers, please wait until you have
6502           installed all of them before registering your cell.</para>
6503         </listitem>
6504         <listitem>
6505           <para>If you wish to allow your cell to be located through DNS lookups,
6506           at this time you should also add the necessary configuration to your
6507           DNS.</para>
6508
6509           <para>AFS database servers may be located by creating AFSDB records
6510           in the DNS for the domain name corresponding to the name of your cell.
6511           It's outside the scope of this guide to give an indepth description of
6512           managing, or configuring, your site's DNS. You should consult the
6513           documentation for your DNS server for further details on AFSDB
6514           records.</para>
6515         </listitem>
6516       </orderedlist></para>
6517     </sect2>
6518   </sect1>
6519
6520   <sect1 id="HDRWQ93">
6521     <title>Improving Cell Security</title>
6522
6523     <indexterm>
6524       <primary>cell</primary>
6525
6526       <secondary>improving security</secondary>
6527     </indexterm>
6528
6529     <indexterm>
6530       <primary>security</primary>
6531
6532       <secondary>improving</secondary>
6533     </indexterm>
6534
6535     <indexterm>
6536       <primary>root superuser</primary>
6537
6538       <secondary>controlling access</secondary>
6539     </indexterm>
6540
6541     <indexterm>
6542       <primary>access</primary>
6543
6544       <secondary>to root and admin accounts</secondary>
6545     </indexterm>
6546
6547     <indexterm>
6548       <primary>admin account</primary>
6549
6550       <secondary>controlling access to</secondary>
6551     </indexterm>
6552
6553     <indexterm>
6554       <primary>AFS filespace</primary>
6555
6556       <secondary>controlling access by root superuser</secondary>
6557     </indexterm>
6558
6559     <para>This section discusses ways to improve the security of AFS data
6560     in your cell. Also see the chapter in the <emphasis>OpenAFS
6561     Administration Guide</emphasis> about configuration and administration
6562     issues.</para>
6563
6564     <sect2 id="HDRWQ94">
6565       <title>Controlling root Access</title>
6566
6567       <para>As on any machine, it is important to prevent unauthorized users from logging onto an AFS server or client machine as
6568       the local superuser <emphasis role="bold">root</emphasis>. Take care to keep the <emphasis role="bold">root</emphasis>
6569       password secret.</para>
6570
6571       <para>The local <emphasis role="bold">root</emphasis> superuser does not have special access to AFS data through the Cache
6572       Manager (as members of the <emphasis role="bold">system:administrators</emphasis> group do), but it does have the following
6573       privileges: <itemizedlist>
6574           <listitem>
6575             <para>On client machines, the ability to issue commands from the <emphasis role="bold">fs</emphasis> suite that affect
6576             AFS performance</para>
6577           </listitem>
6578
6579           <listitem>
6580             <para>On server machines, the ability to disable authorization checking, or to install rogue process binaries</para>
6581           </listitem>
6582         </itemizedlist></para>
6583     </sect2>
6584
6585     <sect2 id="HDRWQ95">
6586       <title>Controlling System Administrator Access</title>
6587
6588       <para>Following are suggestions for managing AFS administrative privilege: <itemizedlist>
6589           <listitem>
6590             <para>Create an administrative account for each administrator named
6591             something like
6592             <replaceable>username</replaceable><emphasis role="bold">.admin</emphasis>.
6593             Administrators authenticate under these identities only when
6594             performing administrative tasks, and destroy the administrative
6595             tokens immediately after finishing the task (either by issuing the
6596             <emphasis role="bold">unlog</emphasis> command, or the
6597             <emphasis role="bold">kinit</emphasis> and
6598             <emphasis role="bold">aklog</emphasis> commands to adopt their
6599             regular identity).</para>
6600           </listitem>
6601
6602           <listitem>
6603             <para>Set a short ticket lifetime for administrator accounts (for example, 20 minutes) by using the
6604             facilities of your KDC. For instance, with a MIT Kerberos KDC, this
6605             can be performed using the
6606             <emphasis role="bold">--max-ticket-life</emphasis> argument to
6607             the <emphasis role="bold">kadmin modify_principal</emphasis>
6608             command. Do not however, use a short lifetime for users
6609             who issue long-running <emphasis role="bold">backup</emphasis> commands.</para>
6610           </listitem>
6611
6612           <listitem>
6613             <para>Limit the number of system administrators in your cell, especially those who belong to the <emphasis
6614             role="bold">system:administrators</emphasis> group. By default they have all ACL rights on all directories in the local
6615             AFS filespace, and therefore must be trusted not to examine private files.</para>
6616           </listitem>
6617
6618           <listitem>
6619             <para>Limit the use of system administrator accounts on machines in public areas. It is especially important not to
6620             leave such machines unattended without first destroying the administrative tokens.</para>
6621           </listitem>
6622
6623           <listitem>
6624             <para>Limit the use by administrators of standard UNIX commands that make connections to remote machines (such as the
6625             <emphasis role="bold">telnet</emphasis> utility). Many of these programs send passwords across the network without
6626             encrypting them.</para>
6627           </listitem>
6628         </itemizedlist></para>
6629
6630       <indexterm>
6631         <primary>BOS Server</primary>
6632
6633         <secondary>checking mode bits on AFS directories</secondary>
6634       </indexterm>
6635
6636       <indexterm>
6637         <primary>mode bits on local AFS directories</primary>
6638       </indexterm>
6639
6640       <indexterm>
6641         <primary>UNIX mode bits on local AFS directories</primary>
6642       </indexterm>
6643     </sect2>
6644
6645     <sect2 id="HDRWQ96">
6646       <title>Protecting Sensitive AFS Directories</title>
6647
6648       <para>Some subdirectories of the <emphasis role="bold">/usr/afs</emphasis> directory contain files crucial to cell security.
6649       Unauthorized users must not read or write to these files because of the potential for misuse of the information they
6650       contain.</para>
6651
6652       <para>As the BOS Server initializes for the first time on a server machine, it creates several files and directories (as
6653       mentioned in <link linkend="HDRWQ50">Starting the BOS Server</link>). It sets their owner to the local superuser <emphasis
6654       role="bold">root</emphasis> and sets their mode bits to enable writing by the owner only; in some cases, it also restricts
6655       reading.</para>
6656
6657       <para>At each subsequent restart, the BOS Server checks that the owner and mode bits on these files are still set
6658       appropriately. If they are not, it write the following message to the <emphasis role="bold">/usr/afs/logs/BosLog</emphasis>
6659       file:</para>
6660
6661       <programlisting>
6662    Bosserver reports inappropriate access on server directories
6663 </programlisting>
6664
6665       <para>The BOS Server does not reset the mode bits, which enables you to set alternate values if you wish.</para>
6666
6667       <para>The following charts lists the expected mode bit settings. A question mark indicates that the BOS Server does not check
6668       that mode bit.</para>
6669
6670       <informaltable frame="none">
6671         <tgroup cols="2">
6672           <colspec colwidth="30*" />
6673
6674           <colspec colwidth="70*" />
6675
6676           <tbody>
6677             <row>
6678               <entry><emphasis role="bold">/usr/afs</emphasis></entry>
6679
6680               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6681             </row>
6682
6683             <row>
6684               <entry><emphasis role="bold">/usr/afs/backup</emphasis></entry>
6685
6686               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6687             </row>
6688
6689             <row>
6690               <entry><emphasis role="bold">/usr/afs/bin</emphasis></entry>
6691
6692               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6693             </row>
6694
6695             <row>
6696               <entry><emphasis role="bold">/usr/afs/db</emphasis></entry>
6697
6698               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6699             </row>
6700
6701             <row>
6702               <entry><emphasis role="bold">/usr/afs/etc</emphasis></entry>
6703
6704               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6705             </row>
6706
6707             <row>
6708               <entry><emphasis role="bold">/usr/afs/etc/KeyFile</emphasis></entry>
6709
6710               <entry><computeroutput>-rw</computeroutput>????<computeroutput>---</computeroutput></entry>
6711             </row>
6712
6713             <row>
6714               <entry><emphasis role="bold">/usr/afs/etc/UserList</emphasis></entry>
6715
6716               <entry><computeroutput>-rw</computeroutput>?????<computeroutput>--</computeroutput></entry>
6717             </row>
6718
6719             <row>
6720               <entry><emphasis role="bold">/usr/afs/local</emphasis></entry>
6721
6722               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6723             </row>
6724
6725             <row>
6726               <entry><emphasis role="bold">/usr/afs/logs</emphasis></entry>
6727
6728               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6729             </row>
6730           </tbody>
6731         </tgroup>
6732       </informaltable>
6733
6734       <indexterm>
6735         <primary>first AFS machine</primary>
6736
6737         <secondary>client functionality</secondary>
6738
6739         <tertiary>removing</tertiary>
6740       </indexterm>
6741
6742       <indexterm>
6743         <primary>removing</primary>
6744
6745         <secondary>client functionality from first AFS machine</secondary>
6746       </indexterm>
6747     </sect2>
6748   </sect1>
6749
6750   <sect1 id="HDRWQ98">
6751     <title>Removing Client Functionality</title>
6752
6753     <para>Follow the instructions in this section only if you do not wish this machine to remain an AFS client. Removing client
6754     functionality means that you cannot use this machine to access AFS files. <orderedlist>
6755         <listitem>
6756           <para>Remove the files from the <emphasis role="bold">/usr/vice/etc</emphasis> directory. The command does not remove the
6757           directory for files used by the dynamic kernel loader program, if it exists on this system type. Those files are still
6758           needed on a server-only machine. <programlisting>
6759    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
6760    # <emphasis role="bold">rm  *</emphasis>
6761    # <emphasis role="bold">rm -rf  C</emphasis>
6762 </programlisting></para>
6763         </listitem>
6764
6765         <listitem>
6766           <para>Create symbolic links to the <emphasis role="bold">ThisCell</emphasis> and <emphasis
6767           role="bold">CellServDB</emphasis> files in the <emphasis role="bold">/usr/afs/etc</emphasis> directory. This makes it
6768           possible to issue commands from the AFS command suites (such as <emphasis role="bold">bos</emphasis> and <emphasis
6769           role="bold">fs</emphasis>) on this machine. <programlisting>
6770    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell ThisCell</emphasis>
6771    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB CellServDB</emphasis>
6772 </programlisting></para>
6773         </listitem>
6774
6775         <listitem>
6776           <para>On IRIX systems, issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
6777           role="bold">afsclient</emphasis> configuration variable. <programlisting>
6778    # <emphasis role="bold">/etc/chkconfig -f afsclient off</emphasis>
6779 </programlisting></para>
6780         </listitem>
6781
6782         <listitem>
6783           <para>Reboot the machine. Most system types use the <emphasis role="bold">shutdown</emphasis> command, but the appropriate
6784           options vary. <programlisting>
6785    # <emphasis role="bold">cd /</emphasis>
6786    # <emphasis role="bold">shutdown</emphasis> <replaceable>appropriate_options</replaceable>
6787 </programlisting></para>
6788         </listitem>
6789       </orderedlist></para>
6790   </sect1>
6791 </chapter>