doc/xml/QuickStartUnix/auqbg005.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <chapter id="HDRWQ17">
   3   <title>Installing the First AFS Machine</title>
   4
   5   <indexterm>
   6     <primary>file server machine</primary>
   7
   8     <seealso>first AFS machine</seealso>
   9
  10     <seealso>file server machine, additional</seealso>
  11   </indexterm>
  12
  13   <indexterm>
  14     <primary>instructions</primary>
  15
  16     <secondary>first AFS machine</secondary>
  17   </indexterm>
  18
  19   <indexterm>
  20     <primary>installing</primary>
  21
  22     <secondary>first AFS machine</secondary>
  23   </indexterm>
  24
  25   <para>This chapter describes how to install the first AFS machine in your cell, configuring it as both a file server machine and a
  26   client machine. After completing all procedures in this chapter, you can remove the client functionality if you wish, as described
  27   in <link linkend="HDRWQ98">Removing Client Functionality</link>.</para>
  28
  29   <para>To install additional file server machines after completing this chapter, see <link linkend="HDRWQ99">Installing Additional
  30   Server Machines</link>.</para>
  31
  32   <para>To install additional client machines after completing this chapter, see <link linkend="HDRWQ133">Installing Additional
  33   Client Machines</link>. <indexterm>
  34       <primary>requirements</primary>
  35
  36       <secondary>first AFS machine</secondary>
  37     </indexterm></para>
  38
  39   <sect1 id="Header_29">
  40     <title>Requirements and Configuration Decisions</title>
  41
  42     <para>The instructions in this chapter assume that you meet the following requirements.
  43       <itemizedlist>
  44         <listitem>
  45           <para>You are logged onto the machine's console as the local superuser <emphasis role="bold">root</emphasis></para>
  46         </listitem>
  47
  48         <listitem>
  49           <para>A standard version of one of the operating systems supported by the current version of AFS is running on the
  50           machine</para>
  51         </listitem>
  52
  53         <listitem>
  54           <para>You have either installed the provided OpenAFS packages for
  55           your system, have access to a binary distribution tarball, or have
  56           successfully built OpenAFS from source</para>
  57         </listitem>
  58
  59         <listitem>
  60           <para>You have a Kerberos v5 realm running for your site. If you are
  61           working with an existing cell which uses
  62           <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for
  63           authentication, please see
  64           <link linkend="KAS001">kaserver and Legacy Kerberos v4 Authentication</link>
  65           for the modifications required to this installation procedure.</para>
  66         </listitem>
  67
  68         <listitem>
  69           <para>You have a NTP, or similar, time service deployed to ensure
  70           rough clock syncronistation between your clients and servers. If you
  71           wish to use AFS's built in timeservice (which is deprecated) please
  72           see Appendix B for the necessary modifications to this installation
  73           procedure.</para>
  74         </listitem>
  75       </itemizedlist></para>
  76
  77     <para>You must make the following configuration decisions while installing the first AFS machine. To speed the installation
  78     itself, it is best to make the decisions before beginning. See the chapter in the <emphasis>OpenAFS Administration
  79     Guide</emphasis> about issues in cell administration and configuration for detailed guidelines. <indexterm>
  80         <primary>cell name</primary>
  81
  82         <secondary>choosing</secondary>
  83       </indexterm> <indexterm>
  84         <primary>AFS filespace</primary>
  85
  86         <secondary>deciding how to configure</secondary>
  87       </indexterm> <indexterm>
  88         <primary>filespace</primary>
  89
  90         <see>AFS filespace</see>
  91       </indexterm> <itemizedlist>
  92         <listitem>
  93           <para>Select the first AFS machine</para>
  94         </listitem>
  95
  96         <listitem>
  97           <para>Select the cell name</para>
  98         </listitem>
  99
 100         <listitem>
 101           <para>Decide which partitions or logical volumes to configure as AFS server partitions, and choose the directory names on
 102           which to mount them</para>
 103         </listitem>
 104
 105         <listitem>
 106           <para>Decide how big to make the client cache</para>
 107         </listitem>
 108
 109         <listitem>
 110           <para>Decide how to configure the top levels of your cell's AFS filespace</para>
 111         </listitem>
 112       </itemizedlist></para>
 113
 114     <para>This chapter is divided into three large sections corresponding to the three parts of installing the first AFS machine.
 115     Perform all of the steps in the order they appear. Each functional section begins with a summary of the procedures to perform.
 116     The sections are as follows: <itemizedlist>
 117         <listitem>
 118           <para>Installing server functionality (begins in <link linkend="HDRWQ18">Overview: Installing Server
 119           Functionality</link>)</para>
 120         </listitem>
 121
 122         <listitem>
 123           <para>Installing client functionality (begins in <link linkend="HDRWQ63">Overview: Installing Client
 124           Functionality</link>)</para>
 125         </listitem>
 126
 127         <listitem>
 128           <para>Configuring your cell's filespace, establishing further security mechanisms, and enabling access to foreign cells
 129           (begins in <link linkend="HDRWQ71">Overview: Completing the Installation of the First AFS Machine</link>)</para>
 130         </listitem>
 131       </itemizedlist></para>
 132
 133     <indexterm>
 134       <primary>overview</primary>
 135
 136       <secondary>installing server functionality on first AFS machine</secondary>
 137     </indexterm>
 138
 139     <indexterm>
 140       <primary>first AFS machine</primary>
 141
 142       <secondary>server functionality</secondary>
 143     </indexterm>
 144
 145     <indexterm>
 146       <primary>installing</primary>
 147
 148       <secondary>server functionality</secondary>
 149
 150       <tertiary>first AFS machine</tertiary>
 151     </indexterm>
 152   </sect1>
 153
 154   <sect1 id="HDRWQ18">
 155     <title>Overview: Installing Server Functionality</title>
 156
 157     <para>In the first phase of installing your cell's first AFS machine, you install file server and database server functionality
 158     by performing the following procedures:
 159     <orderedlist>
 160         <listitem>
 161           <para>Choose which machine to install as the first AFS machine</para>
 162         </listitem>
 163
 164         <listitem>
 165           <para>Create AFS-related directories on the local disk</para>
 166         </listitem>
 167
 168         <listitem>
 169           <para>Incorporate AFS modifications into the machine's kernel</para>
 170         </listitem>
 171
 172         <listitem>
 173           <para>Configure partitions or logical volumes for storing AFS volumes</para>
 174         </listitem>
 175
 176         <listitem>
 177           <para>On some system types, install and configure an AFS-modified version of the <emphasis role="bold">fsck</emphasis>
 178           program</para>
 179         </listitem>
 180
 181         <listitem>
 182           <para>If the machine is to remain a client machine, incorporate AFS into its authentication system</para>
 183         </listitem>
 184
 185         <listitem>
 186           <para>Start the Basic OverSeer (BOS) Server</para>
 187         </listitem>
 188
 189         <listitem>
 190           <para>Define the cell name and the machine's cell membership</para>
 191         </listitem>
 192
 193         <listitem>
 194           <para>Start the database server processes: Backup Server, Protection Server, and Volume Location
 195           (VL) Server</para>
 196         </listitem>
 197
 198         <listitem>
 199           <para>Configure initial security mechanisms</para>
 200         </listitem>
 201
 202         <listitem>
 203           <para>Start the <emphasis role="bold">fs</emphasis> process, which incorporates three component processes: the File
 204           Server, Volume Server, and Salvager</para>
 205         </listitem>
 206
 207         <listitem>
 208           <para>Start the server portion of the Update Server</para>
 209         </listitem>
 210
 211       </orderedlist></para>
 212   </sect1>
 213
 214   <sect1 id="HDRWQ19">
 215     <title>Choosing the First AFS Machine</title>
 216
 217     <para>The first AFS machine you install must have sufficient disk space to store AFS volumes. To take best advantage of AFS's
 218     capabilities, store client-side binaries as well as user files in volumes. When you later install additional file server
 219     machines in your cell, you can distribute these volumes among the different machines as you see fit.</para>
 220
 221     <para>These instructions configure the first AFS machine as a <emphasis>database server machine</emphasis>, the <emphasis>binary
 222     distribution machine</emphasis> for its system type, and the cell's <emphasis>system control machine</emphasis>. For a
 223     description of these roles, see the <emphasis>OpenAFS Administration Guide</emphasis>.</para>
 224
 225     <para>Installation of additional machines is simplest if the first machine has the lowest IP address of any database server
 226     machine you currently plan to install. If you later install database server functionality on a machine with a lower IP address,
 227     you must first update the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on all of your cell's client machines.
 228     For more details, see <link linkend="HDRWQ114">Installing Database Server Functionality</link>.</para>
 229   </sect1>
 230
 231   <sect1 id="Header_32">
 232     <title>Creating AFS Directories</title>
 233
 234     <indexterm>
 235       <primary>usr/afs directory</primary>
 236
 237       <secondary>first AFS machine</secondary>
 238     </indexterm>
 239
 240     <indexterm>
 241       <primary>first AFS machine</primary>
 242
 243       <secondary>/usr/afs directory</secondary>
 244     </indexterm>
 245
 246     <indexterm>
 247       <primary>creating</primary>
 248
 249       <secondary>/usr/afs directory</secondary>
 250
 251       <tertiary>first AFS machine</tertiary>
 252     </indexterm>
 253
 254     <indexterm>
 255       <primary>usr/vice/etc directory</primary>
 256
 257       <secondary>first AFS machine</secondary>
 258     </indexterm>
 259
 260     <indexterm>
 261       <primary>first AFS machine</primary>
 262
 263       <secondary>/usr/vice/etc directory</secondary>
 264     </indexterm>
 265
 266     <indexterm>
 267       <primary>creating</primary>
 268
 269       <secondary>/usr/vice/etc directory</secondary>
 270
 271       <tertiary>first AFS machine</tertiary>
 272     </indexterm>
 273
 274     <indexterm>
 275       <primary>/ as start to file and directory names</primary>
 276
 277       <secondary>see alphabetized entries without initial slash</secondary>
 278     </indexterm>
 279
 280     <para>If you are installing from packages (such as Debian .deb or
 281     Fedora/SuSe .rpm files), you should now install all of the available
 282     OpenAFS packages for your system type. Typically, these will include
 283     packages for client and server functionality, and a seperate package
 284     containing a suitable kernel module for your running kernel. Consult
 285     the package lists on the OpenAFS website to determine the packages
 286     appropriate for your system.</para>
 287
 288     <para>If you are installing from a tarfile, or from a locally compiled
 289     source tree you should create the <emphasis role="bold">/usr/afs</emphasis>
 290     and <emphasis role="bold">/usr/vice/etc</emphasis> directories on the
 291     local disk, to house server and client files respectively. Subsequent
 292     instructions copy files from the distribution tarfile into them. </para>
 293 <programlisting>
 294    # <emphasis role="bold">mkdir /usr/afs</emphasis>
 295    # <emphasis role="bold">mkdir /usr/vice</emphasis>
 296    # <emphasis role="bold">mkdir /usr/vice/etc</emphasis>
 297 </programlisting>
 298   </sect1>
 299
 300   <sect1 id="HDRWQ20">
 301     <title>Performing Platform-Specific Procedures</title>
 302
 303     <para>Several of the initial procedures for installing a file server machine differ for each system type. For convenience, the
 304     following sections group them together for each system type: <itemizedlist>
 305         <indexterm>
 306           <primary>kernel extensions</primary>
 307
 308           <see>AFS kernel extensions</see>
 309         </indexterm>
 310
 311         <indexterm>
 312           <primary>loading AFS kernel extensions</primary>
 313
 314           <see>incorporating</see>
 315         </indexterm>
 316
 317         <indexterm>
 318           <primary>building</primary>
 319
 320           <secondary>AFS extensions into kernel</secondary>
 321
 322           <see>incorporating AFS kernel extensions</see>
 323         </indexterm>
 324
 325         <listitem>
 326           <para>Incorporate AFS modifications into the kernel.</para>
 327
 328           <para>The kernel on every AFS client machine and, on some systems,
 329           the AFS fileservers, must incorporate AFS extensions. On machines
 330           that use a dynamic kernel module loader, it is conventional to
 331           alter the machine's initialization script to load the AFS extensions
 332           at each reboot. <indexterm>
 333               <primary>AFS server partition</primary>
 334
 335               <secondary>mounted on /vicep directory</secondary>
 336             </indexterm> <indexterm>
 337               <primary>partition</primary>
 338
 339               <see>AFS server partition</see>
 340             </indexterm> <indexterm>
 341               <primary>logical volume</primary>
 342
 343               <see>AFS server partition</see>
 344             </indexterm> <indexterm>
 345               <primary>requirements</primary>
 346
 347               <secondary>AFS server partition name and location</secondary>
 348             </indexterm> <indexterm>
 349               <primary>naming conventions for AFS server partition</primary>
 350             </indexterm> <indexterm>
 351               <primary>vicep<emphasis>xx</emphasis> directory</primary>
 352
 353               <see>AFS server partition</see>
 354             </indexterm> <indexterm>
 355               <primary>directories</primary>
 356
 357               <secondary>/vicep<emphasis>xx</emphasis></secondary>
 358
 359               <see>AFS server partition</see>
 360             </indexterm></para>
 361         </listitem>
 362
 363         <listitem>
 364           <para>Configure server partitions or logical volumes to house AFS volumes.</para>
 365
 366           <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes
 367           (for convenience, the documentation hereafter refers to partitions only). Each server partition is mounted at a directory
 368           named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where <replaceable>xx</replaceable> is one or
 369           two lowercase letters. By convention, the first 26 partitions are mounted on the directories called <emphasis
 370           role="bold">/vicepa</emphasis> through <emphasis role="bold">/vicepz</emphasis>, the 27th one is mounted on the <emphasis
 371           role="bold">/vicepaa</emphasis> directory, and so on through <emphasis role="bold">/vicepaz</emphasis> and <emphasis
 372           role="bold">/vicepba</emphasis>, continuing up to the index corresponding to the maximum number of server partitions
 373           supported in the current version of AFS (which is specified in the <emphasis>OpenAFS Release Notes</emphasis>).</para>
 374
 375           <para>The <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server
 376           machine's root directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is
 377           not an acceptable directory location).</para>
 378
 379           <para>You can also add or remove server partitions on an existing file server machine. For instructions, see the chapter
 380           in the <emphasis>OpenAFS Administration Guide</emphasis> about maintaining server machines.</para>
 381
 382           <note>
 383             <para>Not all file system types supported by an operating system are necessarily supported as AFS server partitions. For
 384             possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
 385           </note>
 386         </listitem>
 387
 388         <listitem>
 389           <para>On some system types, install and configure a modified <emphasis role="bold">fsck</emphasis> program which
 390           recognizes the structures that the File Server uses to organize volume data on AFS server partitions. The <emphasis
 391           role="bold">fsck</emphasis> program provided with the operating system does not understand the AFS data structures, and so
 392           removes them to the <emphasis role="bold">lost+found</emphasis> directory.</para>
 393         </listitem>
 394
 395         <listitem>
 396           <para>If the machine is to remain an AFS client machine, modify the machine's authentication system so that users obtain
 397           an AFS token as they log into the local file system. Using AFS is simpler and more convenient for your users if you make
 398           the modifications on all client machines. Otherwise, users must perform a two or three step login procedure (login to the local
 399           system, then obtain Kerberos credentials, and then issue the <emphasis role="bold">aklog</emphasis> command). For further discussion of AFS
 400           authentication, see the chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and
 401           administration issues.</para>
 402         </listitem>
 403       </itemizedlist></para>
 404
 405     <para>To continue, proceed to the appropriate section: <itemizedlist>
 406         <listitem>
 407           <para><link linkend="HDRWQ21">Getting Started on AIX Systems</link></para>
 408         </listitem>
 409
 410         <listitem>
 411           <para><link linkend="HDRWQ31">Getting Started on HP-UX Systems</link></para>
 412         </listitem>
 413
 414         <listitem>
 415           <para><link linkend="HDRWQ36">Getting Started on IRIX Systems</link></para>
 416         </listitem>
 417
 418         <listitem>
 419           <para><link linkend="HDRWQ41">Getting Started on Linux Systems</link></para>
 420         </listitem>
 421
 422         <listitem>
 423           <para><link linkend="HDRWQ45">Getting Started on Solaris Systems</link></para>
 424         </listitem>
 425       </itemizedlist></para>
 426   </sect1>
 427
 428   <sect1 id="HDRWQ21">
 429     <title>Getting Started on AIX Systems</title>
 430
 431     <para>Begin by running the AFS initialization script to call the AIX kernel extension facility, which dynamically loads AFS
 432     modifications into the kernel. Then use the <emphasis role="bold">SMIT</emphasis> program to configure partitions for storing
 433     AFS volumes, and replace the AIX <emphasis role="bold">fsck</emphasis> program helper with a version that correctly handles AFS
 434     volumes. If the machine is to remain an AFS client machine, incorporate AFS into the AIX secondary authentication system.
 435     <indexterm>
 436         <primary>incorporating AFS kernel extensions</primary>
 437
 438         <secondary>first AFS machine</secondary>
 439
 440         <tertiary>AIX</tertiary>
 441       </indexterm> <indexterm>
 442         <primary>AFS kernel extensions</primary>
 443
 444         <secondary>on first AFS machine</secondary>
 445
 446         <tertiary>AIX</tertiary>
 447       </indexterm> <indexterm>
 448         <primary>first AFS machine</primary>
 449
 450         <secondary>AFS kernel extensions</secondary>
 451
 452         <tertiary>on AIX</tertiary>
 453       </indexterm> <indexterm>
 454         <primary>AIX</primary>
 455
 456         <secondary>AFS kernel extensions</secondary>
 457
 458         <tertiary>on first AFS machine</tertiary>
 459       </indexterm></para>
 460
 461     <sect2 id="HDRWQ22">
 462       <title>Loading AFS into the AIX Kernel</title>
 463
 464       <para>The AIX kernel extension facility is the dynamic kernel loader
 465       provided by IBM Corporation.  AIX does not support incorporation of
 466       AFS modifications during a kernel build.</para>
 467
 468       <para>For AFS to function correctly, the kernel extension facility must run each time the machine reboots, so the AFS
 469       initialization script (included in the AFS distribution) invokes it automatically. In this section you copy the script to the
 470       conventional location and edit it to select the appropriate options depending on whether NFS is also to run.</para>
 471
 472       <para>After editing the script, you run it to incorporate AFS into the kernel. In later sections you verify that the script
 473       correctly initializes all AFS components, then configure the AIX <emphasis role="bold">inittab</emphasis> file so that the
 474       script runs automatically at reboot. <orderedlist>
 475           <listitem>
 476             <para>Unpack the distribution tarball. The examples below assume
 477             that you have unpacked the files into the
 478             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
 479             pick a different location, substitute this in all of the following
 480             examples. Once you have unpacked the distribution,
 481             change directory as indicated.
 482 <programlisting>
 483    # <emphasis role="bold">cd /tmp/afsdist/rs_aix42/root.client/usr/vice/etc</emphasis>
 484 </programlisting></para>
 485           </listitem>
 486
 487           <listitem>
 488             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/dkload</emphasis> directory,
 489             and the AFS initialization script to the <emphasis role="bold">/etc</emphasis> directory. <programlisting>
 490    # <emphasis role="bold">cp -rp  dkload  /usr/vice/etc</emphasis>
 491    # <emphasis role="bold">cp -p  rc.afs  /etc/rc.afs</emphasis>
 492 </programlisting></para>
 493           </listitem>
 494
 495           <listitem>
 496             <para>Edit the <emphasis role="bold">/etc/rc.afs</emphasis> script, setting the <computeroutput>NFS</computeroutput>
 497             variable as indicated.</para>
 498
 499             <para>If the machine is not to function as an NFS/AFS Translator, set the <computeroutput>NFS</computeroutput> variable
 500             as follows.</para>
 501
 502             <programlisting>
 503    NFS=$NFS_NONE
 504 </programlisting>
 505
 506             <para>If the machine is to function as an NFS/AFS Translator and is running AIX 4.2.1 or higher, set the
 507             <computeroutput>NFS</computeroutput> variable as follows. Note that NFS must already be loaded into the kernel, which
 508             happens automatically on systems running AIX 4.1.1 and later, as long as the file <emphasis
 509             role="bold">/etc/exports</emphasis> exists.</para>
 510
 511             <programlisting>
 512    NFS=$NFS_IAUTH
 513 </programlisting>
 514           </listitem>
 515
 516           <listitem>
 517             <para>Invoke the <emphasis role="bold">/etc/rc.afs</emphasis> script to load AFS modifications into the kernel. You can
 518             ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS client.
 519             <programlisting>
 520    # <emphasis role="bold">/etc/rc.afs</emphasis>
 521 </programlisting></para>
 522           </listitem>
 523         </orderedlist></para>
 524
 525       <indexterm>
 526         <primary>configuring</primary>
 527
 528         <secondary>AFS server partition on first AFS machine</secondary>
 529
 530         <tertiary>AIX</tertiary>
 531       </indexterm>
 532
 533       <indexterm>
 534         <primary>AFS server partition</primary>
 535
 536         <secondary>configuring on first AFS machine</secondary>
 537
 538         <tertiary>AIX</tertiary>
 539       </indexterm>
 540
 541       <indexterm>
 542         <primary>first AFS machine</primary>
 543
 544         <secondary>AFS server partition</secondary>
 545
 546         <tertiary>on AIX</tertiary>
 547       </indexterm>
 548
 549       <indexterm>
 550         <primary>AIX</primary>
 551
 552         <secondary>AFS server partition</secondary>
 553
 554         <tertiary>on first AFS machine</tertiary>
 555       </indexterm>
 556     </sect2>
 557
 558     <sect2 id="HDRWQ23">
 559       <title>Configuring Server Partitions on AIX Systems</title>
 560
 561       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
 562       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
 563       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
 564       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
 565       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
 566       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific
 567       Procedures</link>.</para>
 568
 569       <para>To configure server partitions on an AIX system, perform the following procedures: <orderedlist>
 570           <listitem>
 571             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
 572             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
 573    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
 574 </programlisting></para>
 575           </listitem>
 576
 577           <listitem>
 578             <para>Use the <emphasis role="bold">SMIT</emphasis> program to create a journaling file system on each partition to be
 579             configured as an AFS server partition.</para>
 580           </listitem>
 581
 582           <listitem>
 583             <para>Mount each partition at one of the <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>
 584             directories. Choose one of the following three methods: <itemizedlist>
 585                 <listitem>
 586                   <para>Use the <emphasis role="bold">SMIT</emphasis> program</para>
 587                 </listitem>
 588
 589                 <listitem>
 590                   <para>Use the <emphasis role="bold">mount -a</emphasis> command to mount all partitions at once</para>
 591                 </listitem>
 592
 593                 <listitem>
 594                   <para>Use the <emphasis role="bold">mount</emphasis> command on each partition in turn</para>
 595                 </listitem>
 596               </itemizedlist></para>
 597
 598             <para>Also configure the partitions so that they are mounted automatically at each reboot. For more information, refer
 599             to the AIX documentation.</para>
 600           </listitem>
 601         </orderedlist></para>
 602
 603       <indexterm>
 604         <primary>replacing fsck program</primary>
 605
 606         <secondary>first AFS machine</secondary>
 607
 608         <tertiary>AIX</tertiary>
 609       </indexterm>
 610
 611       <indexterm>
 612         <primary>fsck program</primary>
 613
 614         <secondary>on first AFS machine</secondary>
 615
 616         <tertiary>AIX</tertiary>
 617       </indexterm>
 618
 619       <indexterm>
 620         <primary>first AFS machine</primary>
 621
 622         <secondary>fsck program</secondary>
 623
 624         <tertiary>on AIX</tertiary>
 625       </indexterm>
 626
 627       <indexterm>
 628         <primary>AIX</primary>
 629
 630         <secondary>fsck program</secondary>
 631
 632         <tertiary>on first AFS machine</tertiary>
 633       </indexterm>
 634     </sect2>
 635
 636     <sect2 id="HDRWQ24">
 637       <title>Replacing the fsck Program Helper on AIX Systems</title>
 638
 639       <note><para>The AFS modified fsck program is not required on AIX 5.1
 640       systems, and the <emphasis role="bold">v3fshelper</emphasis> program
 641       refered to below is not shipped for these systems.</para></note>
 642
 643       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
 644       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
 645       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
 646       it removes all of the data. To repeat:</para>
 647
 648       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS
 649       volumes.</emphasis></para>
 650
 651       <para>On AIX systems, you do not replace the <emphasis role="bold">fsck</emphasis> binary itself, but rather the
 652       <emphasis>program helper</emphasis> file included in the AIX distribution as <emphasis
 653       role="bold">/sbin/helpers/v3fshelper</emphasis>. <orderedlist>
 654           <listitem>
 655             <para>Move the AIX <emphasis role="bold">fsck</emphasis> program helper to a safe location and install the version from
 656             the AFS distribution in its place.
 657 <programlisting>
 658    # <emphasis role="bold">cd /sbin/helpers</emphasis>
 659    # <emphasis role="bold">mv v3fshelper v3fshelper.noafs</emphasis>
 660    # <emphasis role="bold">cp -p /tmp/afsdist/rs_aix42/root.server/etc/v3fshelper v3fshelper</emphasis>
 661 </programlisting></para>
 662           </listitem>
 663
 664           <listitem>
 665             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
 666             linkend="HDRWQ25">Enabling AFS Login on AIX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
 667             BOS Server</link>.</para>
 668           </listitem>
 669         </orderedlist></para>
 670
 671       <indexterm>
 672         <primary>enabling AFS login</primary>
 673
 674         <secondary>file server machine</secondary>
 675
 676         <tertiary>AIX</tertiary>
 677       </indexterm>
 678
 679       <indexterm>
 680         <primary>AFS login</primary>
 681
 682         <secondary>on file server machine</secondary>
 683
 684         <tertiary>AIX</tertiary>
 685       </indexterm>
 686
 687       <indexterm>
 688         <primary>first AFS machine</primary>
 689
 690         <secondary>AFS login</secondary>
 691
 692         <tertiary>on AIX</tertiary>
 693       </indexterm>
 694
 695       <indexterm>
 696         <primary>AIX</primary>
 697
 698         <secondary>AFS login</secondary>
 699
 700         <tertiary>on file server machine</tertiary>
 701       </indexterm>
 702
 703       <indexterm>
 704         <primary>secondary authentication system (AIX)</primary>
 705
 706         <secondary>server machine</secondary>
 707       </indexterm>
 708     </sect2>
 709
 710     <sect2 id="HDRWQ25">
 711       <title>Enabling AFS Login on AIX Systems</title>
 712
 713       <note>
 714         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
 715         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
 716       </note>
 717
 718       <para>In modern AFS installations, you should be using Kerberos v5
 719       for user login, and obtaining AFS tokens following this authentication
 720       step.</para>
 721
 722       <para>There are currently no instructions available on configuring AIX to
 723       automatically obtain AFS tokens at login. Following login, users can
 724       obtain tokens by running the <emphasis role="bold">aklog</emphasis>
 725       command</para>
 726
 727       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
 728       or external Kerberos v4 authentication should consult
 729       <link linkend="KAS012">Enabling kaserver based AFS login on AIX systems</link>
 730       for details of how to enable AIX login.</para>
 731
 732       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>
 733       (or if referring to these instructions while installing an additional
 734       file server machine, return to <link linkend="HDRWQ108">Starting Server
 735       Programs</link>).</para>
 736     </sect2>
 737   </sect1>
 738
 739   <sect1 id="HDRWQ31">
 740     <title>Getting Started on HP-UX Systems</title>
 741
 742     <para>Begin by building AFS modifications into a new kernel; HP-UX
 743     does not support dynamic loading. Then create partitions for storing
 744     AFS volumes, and install and configure the AFS-modified <emphasis
 745     role="bold">fsck</emphasis> program to run on AFS server
 746     partitions. If the machine is to remain an AFS client machine,
 747     incorporate AFS into the machine's Pluggable Authentication Module
 748     (PAM) scheme. <indexterm>
 749         <primary>incorporating AFS kernel extensions</primary>
 750
 751         <secondary>first AFS machine</secondary>
 752
 753         <tertiary>HP-UX</tertiary>
 754       </indexterm> <indexterm>
 755         <primary>AFS kernel extensions</primary>
 756
 757         <secondary>on first AFS machine</secondary>
 758
 759         <tertiary>HP-UX</tertiary>
 760       </indexterm> <indexterm>
 761         <primary>first AFS machine</primary>
 762
 763         <secondary>AFS kernel extensions</secondary>
 764
 765         <tertiary>on HP-UX</tertiary>
 766       </indexterm> <indexterm>
 767         <primary>HP-UX</primary>
 768
 769         <secondary>AFS-modified kernel</secondary>
 770
 771         <tertiary>on first AFS machine</tertiary>
 772       </indexterm></para>
 773
 774     <sect2 id="HDRWQ32">
 775       <title>Building AFS into the HP-UX Kernel</title>
 776
 777       <para>Use the following instructions to build AFS modifications into the kernel on an HP-UX system. <orderedlist>
 778           <listitem>
 779             <para>Move the existing kernel-related files to a safe location. <programlisting>
 780    # <emphasis role="bold">cp /stand/vmunix /stand/vmunix.noafs</emphasis>
 781    # <emphasis role="bold">cp /stand/system /stand/system.noafs</emphasis>
 782 </programlisting></para>
 783           </listitem>
 784
 785           <listitem>
 786             <para>Unpack the OpenAFS HP-UX distribution tarball. The examples
 787             below assume that you have unpacked the files into the
 788             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
 789             pick a different location, substitute this in all of the following
 790             examples. Once you have unpacked the distribution, change directory
 791             as indicated.
 792             <programlisting>
 793    # <emphasis role="bold">cd /tmp/afsdist/hp_ux110/root.client</emphasis>
 794 </programlisting></para>
 795           </listitem>
 796
 797           <listitem>
 798             <para>Copy the AFS initialization file to the local directory for initialization files (by convention, <emphasis
 799             role="bold">/sbin/init.d</emphasis> on HP-UX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
 800             extension as you copy the file. <programlisting>
 801    # <emphasis role="bold">cp usr/vice/etc/afs.rc  /sbin/init.d/afs</emphasis>
 802 </programlisting></para>
 803           </listitem>
 804
 805           <listitem>
 806             <para>Copy the file <emphasis role="bold">afs.driver</emphasis> to the local <emphasis
 807             role="bold">/usr/conf/master.d</emphasis> directory, changing its name to <emphasis role="bold">afs</emphasis> as you
 808             do. <programlisting>
 809    # <emphasis role="bold">cp  usr/vice/etc/afs.driver  /usr/conf/master.d/afs</emphasis>
 810 </programlisting></para>
 811           </listitem>
 812
 813           <listitem>
 814             <para>Copy the AFS kernel module to the local <emphasis role="bold">/usr/conf/lib</emphasis> directory.</para>
 815
 816             <para>If the machine's kernel supports NFS server functionality:</para>
 817
 818             <programlisting>
 819    # <emphasis role="bold">cp bin/libafs.a /usr/conf/lib</emphasis>
 820 </programlisting>
 821
 822             <para>If the machine's kernel does not support NFS server functionality, change the file's name as you copy it:</para>
 823
 824             <programlisting>
 825    # <emphasis role="bold">cp bin/libafs.nonfs.a /usr/conf/lib/libafs.a</emphasis>
 826 </programlisting>
 827           </listitem>
 828
 829           <listitem>
 830             <para>Incorporate the AFS driver into the kernel, either using the <emphasis role="bold">SAM</emphasis> program or a
 831             series of individual commands. <itemizedlist>
 832                 <listitem>
 833                   <para>To use the <emphasis role="bold">SAM</emphasis> program: <orderedlist>
 834                       <listitem>
 835                         <para>Invoke the <emphasis role="bold">SAM</emphasis> program, specifying the hostname of the local machine
 836                         as <replaceable>local_hostname</replaceable>. The <emphasis role="bold">SAM</emphasis> graphical user
 837                         interface pops up. <programlisting>
 838    # <emphasis role="bold">sam -display</emphasis> <replaceable>local_hostname</replaceable><emphasis role="bold">:0</emphasis>
 839 </programlisting></para>
 840                       </listitem>
 841
 842                       <listitem>
 843                         <para>Choose the <emphasis role="bold">Kernel Configuration</emphasis> icon, then the <emphasis
 844                         role="bold">Drivers</emphasis> icon. From the list of drivers, select <emphasis
 845                         role="bold">afs</emphasis>.</para>
 846                       </listitem>
 847
 848                       <listitem>
 849                         <para>Open the pull-down <emphasis role="bold">Actions</emphasis> menu and choose the <emphasis
 850                         role="bold">Add Driver to Kernel</emphasis> option.</para>
 851                       </listitem>
 852
 853                       <listitem>
 854                         <para>Open the <emphasis role="bold">Actions</emphasis> menu again and choose the <emphasis
 855                         role="bold">Create a New Kernel</emphasis> option.</para>
 856                       </listitem>
 857
 858                       <listitem>
 859                         <para>Confirm your choices by choosing <emphasis role="bold">Yes</emphasis> and <emphasis
 860                         role="bold">OK</emphasis> when prompted by subsequent pop-up windows. The <emphasis
 861                         role="bold">SAM</emphasis> program builds the kernel and reboots the system.</para>
 862                       </listitem>
 863
 864                       <listitem>
 865                         <para>Login again as the superuser <emphasis role="bold">root</emphasis>. <programlisting>
 866    login: <emphasis role="bold">root</emphasis>
 867    Password: <replaceable>root_password</replaceable>
 868 </programlisting></para>
 869                       </listitem>
 870                     </orderedlist></para>
 871                 </listitem>
 872
 873                 <listitem>
 874                   <para>To use individual commands: <orderedlist>
 875                       <listitem>
 876                         <para>Edit the file <emphasis role="bold">/stand/system</emphasis>, adding an entry for <emphasis
 877                         role="bold">afs</emphasis> to the <computeroutput>Subsystems</computeroutput> section.</para>
 878                       </listitem>
 879
 880                       <listitem>
 881                         <para>Change to the <emphasis role="bold">/stand/build</emphasis> directory and issue the <emphasis
 882                         role="bold">mk_kernel</emphasis> command to build the kernel. <programlisting>
 883    # <emphasis role="bold">cd /stand/build</emphasis>
 884    # <emphasis role="bold">mk_kernel</emphasis>
 885 </programlisting></para>
 886                       </listitem>
 887
 888                       <listitem>
 889                         <para>Move the new kernel to the standard location (<emphasis role="bold">/stand/vmunix</emphasis>), reboot
 890                         the machine to start using it, and login again as the superuser <emphasis role="bold">root</emphasis>.
 891                         <programlisting>
 892    # <emphasis role="bold">mv /stand/build/vmunix_test /stand/vmunix</emphasis>
 893    # <emphasis role="bold">cd /</emphasis>
 894    # <emphasis role="bold">shutdown -r now</emphasis>
 895    login: <emphasis role="bold">root</emphasis>
 896    Password: <replaceable>root_password</replaceable>
 897 </programlisting></para>
 898                       </listitem>
 899                     </orderedlist></para>
 900                 </listitem>
 901               </itemizedlist></para>
 902           </listitem>
 903         </orderedlist></para>
 904
 905       <indexterm>
 906         <primary>configuring</primary>
 907
 908         <secondary>AFS server partition on first AFS machine</secondary>
 909
 910         <tertiary>HP-UX</tertiary>
 911       </indexterm>
 912
 913       <indexterm>
 914         <primary>AFS server partition</primary>
 915
 916         <secondary>configuring on first AFS machine</secondary>
 917
 918         <tertiary>HP-UX</tertiary>
 919       </indexterm>
 920
 921       <indexterm>
 922         <primary>first AFS machine</primary>
 923
 924         <secondary>AFS server partition</secondary>
 925
 926         <tertiary>on HP-UX</tertiary>
 927       </indexterm>
 928
 929       <indexterm>
 930         <primary>HP-UX</primary>
 931
 932         <secondary>AFS server partition</secondary>
 933
 934         <tertiary>on first AFS machine</tertiary>
 935       </indexterm>
 936     </sect2>
 937
 938     <sect2 id="HDRWQ33">
 939       <title>Configuring Server Partitions on HP-UX Systems</title>
 940
 941       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
 942       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
 943       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
 944       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
 945       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
 946       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
 947       <orderedlist>
 948           <listitem>
 949             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
 950             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
 951    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
 952 </programlisting></para>
 953           </listitem>
 954
 955           <listitem>
 956             <para>Use the <emphasis role="bold">SAM</emphasis> program to create a file system on each partition. For instructions,
 957             consult the HP-UX documentation.</para>
 958           </listitem>
 959
 960           <listitem>
 961             <para>On some HP-UX systems that use logical volumes, the <emphasis role="bold">SAM</emphasis> program automatically
 962             mounts the partitions. If it has not, mount each partition by issuing either the <emphasis role="bold">mount
 963             -a</emphasis> command to mount all partitions at once or the <emphasis role="bold">mount</emphasis> command to mount
 964             each partition in turn.</para>
 965           </listitem>
 966         </orderedlist></para>
 967
 968       <indexterm>
 969         <primary>replacing fsck program</primary>
 970
 971         <secondary>first AFS machine</secondary>
 972
 973         <tertiary>HP-UX</tertiary>
 974       </indexterm>
 975
 976       <indexterm>
 977         <primary>fsck program</primary>
 978
 979         <secondary>on first AFS machine</secondary>
 980
 981         <tertiary>HP-UX</tertiary>
 982       </indexterm>
 983
 984       <indexterm>
 985         <primary>first AFS machine</primary>
 986
 987         <secondary>fsck program</secondary>
 988
 989         <tertiary>on HP-UX</tertiary>
 990       </indexterm>
 991
 992       <indexterm>
 993         <primary>HP-UX</primary>
 994
 995         <secondary>fsck program</secondary>
 996
 997         <tertiary>on first AFS machine</tertiary>
 998       </indexterm>
 999     </sect2>
1000
1001     <sect2 id="HDRWQ34">
1002       <title>Configuring the AFS-modified fsck Program on HP-UX Systems</title>
1003
1004       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
1005       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
1006       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
1007       it removes all of the data. To repeat:</para>
1008
1009       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS
1010       volumes.</emphasis></para>
1011
1012       <para>On HP-UX systems, there are several configuration files to install in addition to the AFS-modified <emphasis
1013       role="bold">fsck</emphasis> program (the <emphasis role="bold">vfsck</emphasis> binary). <orderedlist>
1014           <listitem>
1015             <para>Create the command configuration file <emphasis role="bold">/sbin/lib/mfsconfig.d/afs</emphasis>. Use a text
1016             editor to place the indicated two lines in it: <programlisting>
1017    format_revision 1
1018    fsck            0        m,P,p,d,f,b:c:y,n,Y,N,q,
1019 </programlisting></para>
1020           </listitem>
1021
1022           <listitem>
1023             <para>Create and change directory to an AFS-specific command directory called <emphasis
1024             role="bold">/sbin/fs/afs</emphasis>. <programlisting>
1025    # <emphasis role="bold">mkdir /sbin/fs/afs</emphasis>
1026    # <emphasis role="bold">cd  /sbin/fs/afs</emphasis>
1027 </programlisting></para>
1028           </listitem>
1029
1030           <listitem>
1031             <para>Copy the AFS-modified version of the <emphasis role="bold">fsck</emphasis> program (the <emphasis
1032             role="bold">vfsck</emphasis> binary) and related files from the distribution directory to the new AFS-specific command
1033             directory. <programlisting>
1034    # <emphasis role="bold">cp -p /tmp/afsdist/hp_ux110/root.server/etc/*  .</emphasis>
1035 </programlisting></para>
1036           </listitem>
1037
1038           <listitem>
1039             <para>Change the <emphasis role="bold">vfsck</emphasis> binary's name to <emphasis role="bold">fsck</emphasis> and set
1040             the mode bits appropriately on all of the files in the <emphasis role="bold">/sbin/fs/afs</emphasis> directory.
1041             <programlisting>
1042    # <emphasis role="bold">mv  vfsck  fsck</emphasis>
1043    # <emphasis role="bold">chmod  755  *</emphasis>
1044 </programlisting></para>
1045           </listitem>
1046
1047           <listitem>
1048             <para>Edit the <emphasis role="bold">/etc/fstab</emphasis> file, changing the file system type for each AFS server
1049             partition from <computeroutput>hfs</computeroutput> to <computeroutput>afs</computeroutput>. This ensures that the
1050             AFS-modified <emphasis role="bold">fsck</emphasis> program runs on the appropriate partitions.</para>
1051
1052             <para>The sixth line in the following example of an edited file shows an AFS server partition, <emphasis
1053             role="bold">/vicepa</emphasis>.</para>
1054
1055             <programlisting>
1056    /dev/vg00/lvol1 / hfs defaults 0 1
1057    /dev/vg00/lvol4 /opt hfs defaults 0 2
1058    /dev/vg00/lvol5 /tmp hfs defaults 0 2
1059    /dev/vg00/lvol6 /usr hfs defaults 0 2
1060    /dev/vg00/lvol8 /var hfs defaults 0 2
1061    /dev/vg00/lvol9 /vicepa afs defaults 0 2
1062    /dev/vg00/lvol7 /usr/vice/cache hfs defaults 0 2
1063 </programlisting>
1064           </listitem>
1065
1066           <listitem>
1067             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1068             linkend="HDRWQ35">Enabling AFS Login on HP-UX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1069             BOS Server</link>.</para>
1070           </listitem>
1071         </orderedlist></para>
1072
1073       <indexterm>
1074         <primary>enabling AFS login</primary>
1075
1076         <secondary>file server machine</secondary>
1077
1078         <tertiary>HP-UX</tertiary>
1079       </indexterm>
1080
1081       <indexterm>
1082         <primary>AFS login</primary>
1083
1084         <secondary>on file server machine</secondary>
1085
1086         <tertiary>HP-UX</tertiary>
1087       </indexterm>
1088
1089       <indexterm>
1090         <primary>first AFS machine</primary>
1091
1092         <secondary>AFS login</secondary>
1093
1094         <tertiary>on HP-UX</tertiary>
1095       </indexterm>
1096
1097       <indexterm>
1098         <primary>HP-UX</primary>
1099
1100         <secondary>AFS login</secondary>
1101
1102         <tertiary>on file server machine</tertiary>
1103       </indexterm>
1104
1105       <indexterm>
1106         <primary>PAM</primary>
1107
1108         <secondary>on HP-UX</secondary>
1109
1110         <tertiary>file server machine</tertiary>
1111       </indexterm>
1112
1113       <indexterm>
1114         <primary>Pluggable Authentication Module</primary>
1115
1116         <see>PAM</see>
1117       </indexterm>
1118     </sect2>
1119
1120     <sect2 id="HDRWQ35">
1121       <title>Enabling AFS Login on HP-UX Systems</title>
1122
1123       <note><para>If you plan to remove client functionality from this machine after completing the installation, skip this section and proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para></note>
1124
1125       <para>At this point you incorporate AFS into the operating system's
1126       Pluggable Authentication Module (PAM) scheme. PAM integrates all
1127       authentication mechanisms on the machine, including login, to
1128       provide the security infrastructure for authenticated access to and
1129       from the machine.</para>
1130
1131       <para>In modern AFS installations, you should be using Kerberos v5
1132       for user login, and obtaining AFS tokens subsequent to this
1133       authentication step. OpenAFS does not currently distribute a PAM
1134       module allowing AFS tokens to be automatically gained at
1135       login. Whilst there are a number of third party modules providing
1136       this functionality, it is not know if these have been tested with
1137       HP/UX.</para>
1138
1139       <para>Following login, users can obtain tokens by running the
1140       <emphasis role="bold">aklog</emphasis> command</para>
1141
1142       <para>Sites which still require <emphasis
1143       role="bold">kaserver</emphasis> or external Kerberos v4
1144       authentication should consult <link linkend="KAS013">Enabling
1145       kaserver based AFS login on HP-UX systems</link> for details of how
1146       to enable HP-UX login.</para>
1147
1148       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
1149       Server</link> (or if referring to these instructions while
1150       installing an additional file server machine, return to <link
1151       linkend="HDRWQ108">Starting Server Programs</link>).</para>
1152     </sect2>
1153   </sect1>
1154
1155   <sect1 id="HDRWQ36">
1156     <title>Getting Started on IRIX Systems</title>
1157
1158     <indexterm>
1159       <primary>incorporating AFS kernel extensions</primary>
1160
1161       <secondary>first AFS machine</secondary>
1162
1163       <tertiary>IRIX</tertiary>
1164     </indexterm>
1165
1166     <indexterm>
1167       <primary>AFS kernel extensions</primary>
1168
1169       <secondary>on first AFS machine</secondary>
1170
1171       <tertiary>IRIX</tertiary>
1172     </indexterm>
1173
1174     <indexterm>
1175       <primary>first AFS machine</primary>
1176
1177       <secondary>AFS kernel extensions</secondary>
1178
1179       <tertiary>on IRIX</tertiary>
1180     </indexterm>
1181
1182     <indexterm>
1183       <primary>replacing fsck program</primary>
1184
1185       <secondary>not necessary on IRIX</secondary>
1186     </indexterm>
1187
1188     <indexterm>
1189       <primary>fsck program</primary>
1190
1191       <secondary>on first AFS machine</secondary>
1192
1193       <tertiary>IRIX</tertiary>
1194     </indexterm>
1195
1196     <indexterm>
1197       <primary>first AFS machine</primary>
1198
1199       <secondary>fsck program</secondary>
1200
1201       <tertiary>on IRIX</tertiary>
1202     </indexterm>
1203
1204     <indexterm>
1205       <primary>IRIX</primary>
1206
1207       <secondary>fsck program replacement not necessary</secondary>
1208     </indexterm>
1209
1210     <para>To incorporate AFS into the kernel on IRIX systems, choose one of two methods: <itemizedlist>
1211         <listitem>
1212           <para>Run the AFS initialization script to invoke the <emphasis role="bold">ml</emphasis> program distributed by Silicon
1213           Graphics, Incorporated (SGI), which dynamically loads AFS modifications into the kernel</para>
1214         </listitem>
1215
1216         <listitem>
1217           <para>Build a new static kernel</para>
1218         </listitem>
1219       </itemizedlist></para>
1220
1221     <para>Then create partitions for storing AFS volumes. You do not need to replace the IRIX <emphasis role="bold">fsck</emphasis>
1222     program because SGI has already modified it to handle AFS volumes properly. If the machine is to remain an AFS client machine,
1223     verify that the IRIX login utility installed on the machine grants an AFS token.</para>
1224
1225     <para>In preparation for either dynamic loading or kernel building, perform the following procedures: <orderedlist>
1226         <listitem>
1227           <para>Unpack the OpenAFS IRIX distribution tarball. The examples
1228           below assume that you have unpacked the files into the
1229           <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
1230           pick a different location, substitue this in all of the following
1231           examples. Once you have unpacked the distribution, change directory
1232           as indicated.
1233 <programlisting>
1234    # <emphasis role="bold">cd  /tmp/afsdist/sgi_65/root.client</emphasis>
1235 </programlisting></para>
1236         </listitem>
1237
1238         <listitem>
1239           <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1240           role="bold">/etc/init.d</emphasis> on IRIX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1241           extension as you copy the script. <programlisting>
1242    # <emphasis role="bold">cp -p   usr/vice/etc/afs.rc  /etc/init.d/afs</emphasis>
1243 </programlisting></para>
1244         </listitem>
1245
1246         <listitem>
1247           <para>Issue the <emphasis role="bold">uname -m</emphasis> command to determine the machine's CPU board type. The <emphasis
1248           role="bold">IP</emphasis><replaceable>xx</replaceable> value in the output must match one of the supported CPU board types
1249           listed in the <emphasis>OpenAFS Release Notes</emphasis> for the current version of AFS. <programlisting>
1250    # <emphasis role="bold">uname -m</emphasis>
1251 </programlisting></para>
1252         </listitem>
1253
1254         <listitem>
1255           <para>Proceed to either <link linkend="HDRWQ37">Loading AFS into the IRIX Kernel</link> or <link
1256           linkend="HDRWQ38">Building AFS into the IRIX Kernel</link>.</para>
1257         </listitem>
1258       </orderedlist></para>
1259
1260     <indexterm>
1261       <primary>IRIX</primary>
1262
1263       <secondary>AFS kernel extensions</secondary>
1264
1265       <tertiary>on first AFS machine</tertiary>
1266     </indexterm>
1267
1268     <indexterm>
1269       <primary>afsml variable (IRIX)</primary>
1270
1271       <secondary>first AFS machine</secondary>
1272     </indexterm>
1273
1274     <indexterm>
1275       <primary>variables</primary>
1276
1277       <secondary>afsml (IRIX)</secondary>
1278
1279       <tertiary>first AFS machine</tertiary>
1280     </indexterm>
1281
1282     <indexterm>
1283       <primary>IRIX</primary>
1284
1285       <secondary>afsml variable</secondary>
1286
1287       <tertiary>first AFS machine</tertiary>
1288     </indexterm>
1289
1290     <indexterm>
1291       <primary>afsxnfs variable (IRIX)</primary>
1292
1293       <secondary>first AFS machine</secondary>
1294     </indexterm>
1295
1296     <indexterm>
1297       <primary>variables</primary>
1298
1299       <secondary>afsxnfs (IRIX)</secondary>
1300
1301       <tertiary>first AFS machine</tertiary>
1302     </indexterm>
1303
1304     <indexterm>
1305       <primary>IRIX</primary>
1306
1307       <secondary>afsxnfs variable</secondary>
1308
1309       <tertiary>first AFS machine</tertiary>
1310     </indexterm>
1311
1312     <sect2 id="HDRWQ37">
1313       <title>Loading AFS into the IRIX Kernel</title>
1314
1315       <para>The <emphasis role="bold">ml</emphasis> program is the dynamic kernel loader provided by SGI for IRIX systems. If you
1316       use it rather than building AFS modifications into a static kernel, then for AFS to function correctly the <emphasis
1317       role="bold">ml</emphasis> program must run each time the machine reboots. Therefore, the AFS initialization script (included
1318       on the AFS CD-ROM) invokes it automatically when the <emphasis role="bold">afsml</emphasis> configuration variable is
1319       activated. In this section you activate the variable and run the script.</para>
1320
1321       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
1322       incorporate AFS into the IRIX startup and shutdown sequence. <orderedlist>
1323           <listitem>
1324             <para>Create the local <emphasis role="bold">/usr/vice/etc/sgiload</emphasis> directory to house the AFS kernel library
1325             file. <programlisting>
1326    # <emphasis role="bold">mkdir /usr/vice/etc/sgiload</emphasis>
1327 </programlisting></para>
1328           </listitem>
1329
1330           <listitem>
1331             <para>Copy the appropriate AFS kernel library file to the <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
1332             directory. The <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable> portion of the library file name must
1333             match the value previously returned by the <emphasis role="bold">uname -m</emphasis> command. Also choose the file
1334             appropriate to whether the machine's kernel supports NFS server functionality (NFS must be supported for the machine to
1335             act as an NFS/AFS Translator). Single- and multiprocessor machines use the same library file.</para>
1336
1337             <para>(You can choose to copy all of the kernel library files into the <emphasis
1338             role="bold">/usr/vice/etc/sgiload</emphasis> directory, but they require a significant amount of space.)</para>
1339
1340             <para>If the machine's kernel supports NFS server functionality:</para>
1341
1342             <programlisting>
1343    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.o  /usr/vice/etc/sgiload</emphasis>
1344 </programlisting>
1345
1346             <para>If the machine's kernel does not support NFS server functionality:</para>
1347
1348             <programlisting>
1349    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.o</emphasis>   \
1350                    <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
1351 </programlisting>
1352           </listitem>
1353
1354           <listitem>
1355             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
1356             role="bold">afsml</emphasis> configuration variable. <programlisting>
1357    # <emphasis role="bold">/etc/chkconfig -f afsml on</emphasis>
1358 </programlisting></para>
1359
1360             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1361             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1362
1363             <programlisting>
1364    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1365 </programlisting>
1366           </listitem>
1367
1368           <listitem>
1369             <para>Run the <emphasis role="bold">/etc/init.d/afs</emphasis> script to load AFS extensions into the kernel. The script
1370             invokes the <emphasis role="bold">ml</emphasis> command, automatically determining which kernel library file to use
1371             based on this machine's CPU type and the activation state of the <emphasis role="bold">afsxnfs</emphasis>
1372             variable.</para>
1373
1374             <para>You can ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS
1375             client.</para>
1376
1377             <programlisting>
1378    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
1379 </programlisting>
1380           </listitem>
1381
1382           <listitem>
1383             <para>Proceed to <link linkend="HDRWQ39">Configuring Server Partitions on IRIX Systems</link>.</para>
1384           </listitem>
1385         </orderedlist></para>
1386
1387       <indexterm>
1388         <primary>IRIX</primary>
1389
1390         <secondary>AFS-modified kernel</secondary>
1391
1392         <tertiary>on first AFS machine</tertiary>
1393       </indexterm>
1394     </sect2>
1395
1396     <sect2 id="HDRWQ38">
1397       <title>Building AFS into the IRIX Kernel</title>
1398
1399       <para>Use the following instructions to build AFS modifications into the kernel on an IRIX system. <orderedlist>
1400           <listitem>
1401             <para>Copy the kernel initialization file <emphasis role="bold">afs.sm</emphasis> to the local <emphasis
1402             role="bold">/var/sysgen/system</emphasis> directory, and the kernel master file <emphasis role="bold">afs</emphasis> to
1403             the local <emphasis role="bold">/var/sysgen/master.d</emphasis> directory. <programlisting>
1404    # <emphasis role="bold">cp -p  bin/afs.sm  /var/sysgen/system</emphasis>
1405    # <emphasis role="bold">cp -p  bin/afs  /var/sysgen/master.d</emphasis>
1406 </programlisting></para>
1407           </listitem>
1408
1409           <listitem>
1410             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
1411             role="bold">/var/sysgen/boot/afs.a</emphasis>; the <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable>
1412             portion of the library file name must match the value previously returned by the <emphasis role="bold">uname
1413             -m</emphasis> command. Also choose the file appropriate to whether the machine's kernel supports NFS server
1414             functionality (NFS must be supported for the machine to act as an NFS/AFS Translator). Single- and multiprocessor
1415             machines use the same library file.</para>
1416
1417             <para>If the machine's kernel supports NFS server functionality:</para>
1418
1419             <programlisting>
1420    # <emphasis role="bold">cp -p   bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.a   /var/sysgen/boot/afs.a</emphasis>
1421 </programlisting>
1422
1423             <para>If the machine's kernel does not support NFS server functionality:</para>
1424
1425             <programlisting>
1426    # <emphasis role="bold">cp -p  bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.a  /var/sysgen/boot/afs.a</emphasis>
1427 </programlisting>
1428           </listitem>
1429
1430           <listitem>
1431             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
1432             role="bold">afsml</emphasis> configuration variable. <programlisting>
1433    # <emphasis role="bold">/etc/chkconfig -f afsml off</emphasis>
1434 </programlisting></para>
1435
1436             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
1437             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
1438
1439             <programlisting>
1440    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
1441 </programlisting>
1442           </listitem>
1443
1444           <listitem>
1445             <para>Copy the existing kernel file, <emphasis role="bold">/unix</emphasis>, to a safe location. Compile the new kernel,
1446             which is created in the file <emphasis role="bold">/unix.install</emphasis>. It overwrites the existing <emphasis
1447             role="bold">/unix</emphasis> file when the machine reboots in the next step. <programlisting>
1448    # <emphasis role="bold">cp /unix /unix_noafs</emphasis>
1449    # <emphasis role="bold">autoconfig</emphasis>
1450 </programlisting></para>
1451           </listitem>
1452
1453           <listitem>
1454             <para>Reboot the machine to start using the new kernel, and login again as the superuser <emphasis
1455             role="bold">root</emphasis>. <programlisting>
1456    # <emphasis role="bold">cd /</emphasis>
1457    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
1458    login: <emphasis role="bold">root</emphasis>
1459    Password: <replaceable>root_password</replaceable>
1460 </programlisting></para>
1461           </listitem>
1462         </orderedlist></para>
1463
1464       <indexterm>
1465         <primary>configuring</primary>
1466
1467         <secondary>AFS server partition on first AFS machine</secondary>
1468
1469         <tertiary>IRIX</tertiary>
1470       </indexterm>
1471
1472       <indexterm>
1473         <primary>AFS server partition</primary>
1474
1475         <secondary>configuring on first AFS machine</secondary>
1476
1477         <tertiary>IRIX</tertiary>
1478       </indexterm>
1479
1480       <indexterm>
1481         <primary>first AFS machine</primary>
1482
1483         <secondary>AFS server partition</secondary>
1484
1485         <tertiary>on IRIX</tertiary>
1486       </indexterm>
1487
1488       <indexterm>
1489         <primary>IRIX</primary>
1490
1491         <secondary>AFS server partition</secondary>
1492
1493         <tertiary>on first AFS machine</tertiary>
1494       </indexterm>
1495     </sect2>
1496
1497     <sect2 id="HDRWQ39">
1498       <title>Configuring Server Partitions on IRIX Systems</title>
1499
1500       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1501       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1502       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1503       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1504       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1505       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific
1506       Procedures</link>.</para>
1507
1508       <para>AFS supports use of both EFS and XFS partitions for housing AFS volumes. SGI encourages use of XFS partitions.
1509       <orderedlist>
1510           <listitem>
1511             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1512             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1513    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1514 </programlisting></para>
1515           </listitem>
1516
1517           <listitem>
1518             <para>Add a line with the following format to the file systems registry file, <emphasis
1519             role="bold">/etc/fstab</emphasis>, for each partition (or logical volume created with the XLV volume manager) to be
1520             mounted on one of the directories created in the previous step.</para>
1521
1522             <para>For an XFS partition or logical volume:</para>
1523
1524             <programlisting>
1525    /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  xfs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0
1526 </programlisting>
1527
1528             <para>For an EFS partition:</para>
1529
1530             <programlisting>
1531    /dev/dsk/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  efs  rw,raw=/dev/rdsk/<replaceable>disk</replaceable>  0  0
1532 </programlisting>
1533
1534             <para>The following are examples of an entry for each file system type:</para>
1535
1536             <programlisting>
1537    /dev/dsk/dks0d2s6 /vicepa  xfs rw,raw=/dev/rdsk/dks0d2s6  0 0
1538    /dev/dsk/dks0d3s1 /vicepb  efs rw,raw=/dev/rdsk/dks0d3s1  0 0
1539 </programlisting>
1540           </listitem>
1541
1542           <listitem>
1543             <para>Create a file system on each partition that is to be mounted on a <emphasis
1544             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following commands are probably appropriate,
1545             but consult the IRIX documentation for more information. In both cases, <replaceable>raw_device</replaceable> is a raw
1546             device name like <emphasis role="bold">/dev/rdsk/dks0d0s0</emphasis> for a single disk partition or <emphasis
1547             role="bold">/dev/rxlv/xlv0</emphasis> for a logical volume.</para>
1548
1549             <para>For XFS file systems, include the indicated options to configure the partition or logical volume with inodes large
1550             enough to accommodate AFS-specific information:</para>
1551
1552             <programlisting>
1553    # <emphasis role="bold">mkfs -t xfs -i size=512 -l size=4000b</emphasis> <replaceable>raw_device</replaceable>
1554 </programlisting>
1555
1556             <para>For EFS file systems:</para>
1557
1558             <programlisting>
1559    # <emphasis role="bold">mkfs -t efs</emphasis> <replaceable>raw_device</replaceable>
1560 </programlisting>
1561           </listitem>
1562
1563           <listitem>
1564             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1565             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1566           </listitem>
1567
1568           <listitem>
1569             <para><emphasis role="bold">(Optional)</emphasis> If you have configured partitions or logical volumes to use XFS, issue
1570             the following command to verify that the inodes are configured properly (are large enough to accommodate AFS-specific
1571             information). If the configuration is correct, the command returns no output. Otherwise, it specifies the command to run
1572             in order to configure each partition or logical volume properly. <programlisting>
1573    # <emphasis role="bold">/usr/afs/bin/xfs_size_check</emphasis>
1574 </programlisting></para>
1575           </listitem>
1576
1577           <listitem>
1578             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1579             linkend="HDRWQ40">Enabling AFS Login on IRIX Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1580             BOS Server</link>.</para>
1581           </listitem>
1582         </orderedlist></para>
1583
1584       <indexterm>
1585         <primary>enabling AFS login</primary>
1586
1587         <secondary>file server machine</secondary>
1588
1589         <tertiary>IRIX</tertiary>
1590       </indexterm>
1591
1592       <indexterm>
1593         <primary>AFS login</primary>
1594
1595         <secondary>on file server machine</secondary>
1596
1597         <tertiary>IRIX</tertiary>
1598       </indexterm>
1599
1600       <indexterm>
1601         <primary>first AFS machine</primary>
1602
1603         <secondary>AFS login</secondary>
1604
1605         <tertiary>on IRIX</tertiary>
1606       </indexterm>
1607
1608       <indexterm>
1609         <primary>IRIX</primary>
1610
1611         <secondary>AFS login</secondary>
1612       </indexterm>
1613     </sect2>
1614
1615     <sect2 id="HDRWQ40">
1616       <title>Enabling AFS Login on IRIX Systems</title>
1617
1618       <note>
1619         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
1620         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1621       </note>
1622
1623       <para>Whilst the standard IRIX command-line
1624       <emphasis role="bold">login</emphasis> program and the
1625       graphical <emphasis role="bold">xdm</emphasis> login program both have
1626       the ability to grant AFS tokens, this ability relies upon the deprecated
1627       kaserver authentication system.</para>
1628
1629       <para>Users who have been successfully authenticated via Kerberos 5
1630       authentication may obtain AFS tokens following login by running the
1631       <emphasis role="bold">aklog</emphasis> command.</para>
1632
1633       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
1634       or external Kerberos v4 authentication should consult
1635       <link linkend="KAS014">Enabling kaserver based AFS Login on IRIX Systems</link>
1636       for details of how to enable IRIX login.</para>
1637
1638       <para>After taking any necessary action, proceed to
1639       <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1640     </sect2>
1641   </sect1>
1642
1643   <sect1 id="HDRWQ41">
1644     <title>Getting Started on Linux Systems</title>
1645
1646     <indexterm>
1647       <primary>replacing fsck program</primary>
1648
1649       <secondary>not necessary on Linux</secondary>
1650     </indexterm>
1651
1652     <indexterm>
1653       <primary>fsck program</primary>
1654
1655       <secondary>on first AFS machine</secondary>
1656
1657       <tertiary>Linux</tertiary>
1658     </indexterm>
1659
1660     <indexterm>
1661       <primary>first AFS machine</primary>
1662
1663       <secondary>fsck program</secondary>
1664
1665       <tertiary>on Linux</tertiary>
1666     </indexterm>
1667
1668     <indexterm>
1669       <primary>Linux</primary>
1670
1671       <secondary>fsck program replacement not necessary</secondary>
1672     </indexterm>
1673
1674     <para>Since this guide was originally written, the procedure for starting
1675     OpenAFS has diverged significantly between different Linux distributions.
1676     The instructions that follow are appropriate for both the Fedora and
1677     RedHat Enterprise Linux packages distributed by OpenAFS. Additional
1678     instructions are provided for those building from source.</para>
1679
1680     <para>Begin by running the AFS client startup scripts, which call the
1681     <emphasis role="bold">modprobe</emphasis> program, which dynamically
1682     loads AFS modifications into the kernel. Then create partitions for
1683     storing AFS volumes. You do not need to replace the Linux <emphasis
1684     role="bold">fsck</emphasis> program. If the machine is to remain an
1685     AFS client machine, incorporate AFS into the machine's Pluggable
1686     Authentication Module (PAM) scheme. <indexterm>
1687         <primary>incorporating AFS kernel extensions</primary>
1688
1689         <secondary>first AFS machine</secondary>
1690
1691         <tertiary>Linux</tertiary>
1692       </indexterm> <indexterm>
1693         <primary>AFS kernel extensions</primary>
1694
1695         <secondary>on first AFS machine</secondary>
1696
1697         <tertiary>Linux</tertiary>
1698       </indexterm> <indexterm>
1699         <primary>first AFS machine</primary>
1700
1701         <secondary>AFS kernel extensions</secondary>
1702
1703         <tertiary>on Linux</tertiary>
1704       </indexterm> <indexterm>
1705         <primary>Linux</primary>
1706
1707         <secondary>AFS kernel extensions</secondary>
1708
1709         <tertiary>on first AFS machine</tertiary>
1710       </indexterm></para>
1711
1712     <sect2 id="HDRWQ42">
1713       <title>Loading AFS into the Linux Kernel</title>
1714
1715       <para>The <emphasis role="bold">modprobe</emphasis> program is the dynamic kernel loader for Linux. Linux does not support
1716       incorporation of AFS modifications during a kernel build.</para>
1717
1718       <para>For AFS to function correctly, the <emphasis role="bold">modprobe</emphasis> program must run each time the machine
1719       reboots, so your distribution's AFS initialization script invokes it automatically. The script also includes
1720       commands that select the appropriate AFS library file automatically. In this section you run the script.</para>
1721
1722       <para>In later sections you verify that the script correctly initializes all AFS components, then activate a configuration
1723       variable, which results in the script being incorporated into the Linux startup and shutdown sequence.</para>
1724
1725       <para>The procedure for starting up OpenAFS depends upon your distribution</para>
1726       <sect3>
1727         <title>Fedora and RedHat Enterprise Linux</title>
1728         <para>OpenAFS ship RPMS for all current Fedora and RHEL releases.
1729         <orderedlist>
1730           <listitem>
1731             <para>Download and install the RPM set for your operating system.
1732             RPMs are available from the OpenAFS web site. You will need the
1733             <emphasis role="bold">openafs</emphasis>
1734             <emphasis role="bold">openafs-client></emphasis>
1735             <emphasis role="bold">openafs-server</emphasis> packages, along with
1736             an <emphasis role="bold">openafs-kernel</emphasis> package matching
1737             your current, running, kernel.</para>
1738             <para>You can find the version of your current kernel by running
1739 <programlisting>
1740   # uname -r
1741 <replaceable>2.6.20-1.2933.fc6</replaceable>
1742 </programlisting></para>
1743             <para>Once downloaded, the packages may be installed with the
1744             <emphasis role="bold">rpm</emphasis> command
1745 <programlisting>
1746   # rpm -U openafs-* openafs-client-* openafs-server-* openafs-kernel-*
1747 </programlisting></para>
1748           </listitem>
1749 <!-- If you do this with current RHEL and Fedora releases you end up with
1750      a dynroot'd client running - this breaks setting up the root.afs volume
1751      as described later in this guide
1752           <listitem>
1753             <para>Run the AFS initialization script to load AFS extensions into
1754             the kernel. You can ignore any error messages about the inability
1755             to start the BOS Server or the Cache Manager or AFS client.</para>
1756 <programlisting>
1757    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
1758 </programlisting>
1759           </listitem>
1760 -->
1761         </orderedlist>
1762       </para>
1763       </sect3>
1764       <sect3>
1765          <title>Systems packaged as tar files</title>
1766          <para>If you are running a system where the OpenAFS Binary Distribution
1767          is provided as a tar file, or where you have built the system from
1768          source yourself, you need to install the relevant components by hand
1769          </para>
1770          <orderedlist>
1771
1772           <listitem>
1773             <para>Unpack the distribution tarball. The examples below assume
1774             that you have unpacked the files into the
1775             <emphasis role="bold">/tmp/afsdist</emphasis>directory. If you
1776             pick a different location, substitute this in all of the following
1777             examples. Once you have unpacked the distribution,
1778             change directory as indicated.
1779 <programlisting>
1780   # <emphasis role="bold">cd /tmp/afsdist/linux/root.client/usr/vice/etc</emphasis>
1781 </programlisting></para>
1782           </listitem>
1783
1784           <listitem>
1785             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/modload</emphasis> directory.
1786             The filenames for the libraries have the format <emphasis
1787             role="bold">libafs-</emphasis><replaceable>version</replaceable><emphasis role="bold">.o</emphasis>, where
1788             <replaceable>version</replaceable> indicates the kernel build level. The string <emphasis role="bold">.mp</emphasis> in
1789             the <replaceable>version</replaceable> indicates that the file is appropriate for machines running a multiprocessor
1790             kernel. <programlisting>
1791    # <emphasis role="bold">cp -rp  modload  /usr/vice/etc</emphasis>
1792 </programlisting></para>
1793           </listitem>
1794
1795           <listitem>
1796             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1797             role="bold">/etc/rc.d/init.d</emphasis> on Linux machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1798             extension as you copy the script. <programlisting>
1799    # <emphasis role="bold">cp -p   afs.rc  /etc/rc.d/init.d/afs</emphasis>
1800 </programlisting></para>
1801           </listitem>
1802
1803 <!-- I don't think we need to do this for Linux, and it complicates things if
1804      dynroot is enabled ...
1805           <listitem>
1806             <para>Run the AFS initialization script to load AFS extensions into the kernel. You can ignore any error messages about
1807             the inability to start the BOS Server or the Cache Manager or AFS client.</para>
1808 <programlisting>
1809    # <emphasis role="bold">/etc/rc.d/init.d/afs start</emphasis>
1810 </programlisting>
1811           </listitem>
1812 -->
1813         </orderedlist>
1814
1815       <indexterm>
1816         <primary>configuring</primary>
1817
1818         <secondary>AFS server partition on first AFS machine</secondary>
1819
1820         <tertiary>Linux</tertiary>
1821       </indexterm>
1822
1823       <indexterm>
1824         <primary>AFS server partition</primary>
1825
1826         <secondary>configuring on first AFS machine</secondary>
1827
1828         <tertiary>Linux</tertiary>
1829       </indexterm>
1830
1831       <indexterm>
1832         <primary>first AFS machine</primary>
1833
1834         <secondary>AFS server partition</secondary>
1835
1836         <tertiary>on Linux</tertiary>
1837       </indexterm>
1838
1839       <indexterm>
1840         <primary>Linux</primary>
1841
1842         <secondary>AFS server partition</secondary>
1843
1844         <tertiary>on first AFS machine</tertiary>
1845       </indexterm>
1846     </sect3>
1847     </sect2>
1848
1849     <sect2 id="HDRWQ43">
1850       <title>Configuring Server Partitions on Linux Systems</title>
1851
1852       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
1853       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
1854       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
1855       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
1856       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
1857       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
1858       <orderedlist>
1859           <listitem>
1860             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
1861             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
1862    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
1863 </programlisting></para>
1864           </listitem>
1865
1866           <listitem>
1867             <para>Add a line with the following format to the file systems registry file, <emphasis
1868             role="bold">/etc/fstab</emphasis>, for each directory just created. The entry maps the directory name to the disk
1869             partition to be mounted on it. <programlisting>
1870    /dev/<replaceable>disk</replaceable>  /vicep<replaceable>xx</replaceable>  ext2  defaults  0  2
1871 </programlisting></para>
1872
1873             <para>The following is an example for the first partition being configured.</para>
1874
1875             <programlisting>
1876    /dev/sda8 /vicepa ext2 defaults 0 2
1877 </programlisting>
1878           </listitem>
1879
1880           <listitem>
1881             <para>Create a file system on each partition that is to be mounted at a <emphasis
1882             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
1883             consult the Linux documentation for more information. <programlisting>
1884    # <emphasis role="bold">mkfs -v /dev/</emphasis><replaceable>disk</replaceable>
1885 </programlisting></para>
1886           </listitem>
1887
1888           <listitem>
1889             <para>Mount each partition by issuing either the <emphasis role="bold">mount -a</emphasis> command to mount all
1890             partitions at once or the <emphasis role="bold">mount</emphasis> command to mount each partition in turn.</para>
1891           </listitem>
1892
1893           <listitem>
1894             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
1895             linkend="HDRWQ44">Enabling AFS Login on Linux Systems</link>. Otherwise, proceed to <link linkend="HDRWQ50">Starting the
1896             BOS Server</link>.</para>
1897           </listitem>
1898         </orderedlist></para>
1899
1900       <indexterm>
1901         <primary>enabling AFS login</primary>
1902
1903         <secondary>file server machine</secondary>
1904
1905         <tertiary>Linux</tertiary>
1906       </indexterm>
1907
1908       <indexterm>
1909         <primary>AFS login</primary>
1910
1911         <secondary>on file server machine</secondary>
1912
1913         <tertiary>Linux</tertiary>
1914       </indexterm>
1915
1916       <indexterm>
1917         <primary>first AFS machine</primary>
1918
1919         <secondary>AFS login</secondary>
1920
1921         <tertiary>on Linux</tertiary>
1922       </indexterm>
1923
1924       <indexterm>
1925         <primary>Linux</primary>
1926
1927         <secondary>AFS login</secondary>
1928
1929         <tertiary>on file server machine</tertiary>
1930       </indexterm>
1931
1932       <indexterm>
1933         <primary>PAM</primary>
1934
1935         <secondary>on Linux</secondary>
1936
1937         <tertiary>file server machine</tertiary>
1938       </indexterm>
1939     </sect2>
1940
1941     <sect2 id="HDRWQ44">
1942       <title>Enabling AFS Login on Linux Systems</title>
1943
1944       <note>
1945         <para>If you plan to remove client functionality from this machine
1946         after completing the installation, skip this section and proceed
1947         to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
1948       </note>
1949
1950       <para>At this point you incorporate AFS into the operating system's
1951       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
1952       authentication mechanisms on the machine, including login, to provide
1953       the security infrastructure for authenticated access to and from the
1954       machine.</para>
1955
1956       <para>You should first configure your system to obtain Kerberos v5
1957       tickets as part of the authentication process, and then run an AFS PAM
1958       module to obtain tokens from those tickets after authentication.  Many
1959       Linux distributions come with a Kerberos v5 PAM module (usually called
1960       pam-krb5 or pam_krb5), or you can download and install <ulink
1961       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
1962       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
1963       See the instructions of whatever PAM module you use for how to
1964       configure it.</para>
1965
1966       <para>Some Kerberos v5 PAM modules do come with native AFS support
1967       (usually requiring the Heimdal Kerberos implementation rather than the
1968       MIT Kerberos implementation).  If you are using one of those PAM
1969       modules, you can configure it to obtain AFS tokens.  It's more common,
1970       however, to separate the AFS token acquisition into a separate PAM
1971       module.</para>
1972
1973       <para>The recommended AFS PAM module is <ulink
1974       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
1975       Allbery's pam-afs-session module</ulink>.  It should work with any of
1976       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
1977       often only need to add configuration to the session group:</para>
1978
1979       <example>
1980         <title>Linux PAM session example</title>
1981         <literallayout>session  required  pam_afs_session.so</literallayout>
1982       </example>
1983
1984       <para>If you also want to obtain AFS tokens for <command>scp</command>
1985       and similar commands that don't open a session, you will also need to
1986       add the AFS PAM module to the auth group so that the PAM
1987       <function>setcred</function> call will obtain tokens.  The
1988       <literal>pam_afs_session</literal> module will always return success
1989       for authentication so that it can be added to the auth group only for
1990       <function>setcred</function>, so make sure that it's not marked as
1991       <literal>sufficient</literal>.</para>
1992
1993       <example>
1994         <title>Linux PAM auth example</title>
1995 <literallayout>auth  [success=ok default=1]  pam_krb5.so
1996 auth  [default=done]          pam_afs_session.so
1997 auth  required                pam_unix.so try_first_pass</literallayout>
1998       </example>
1999
2000       <para>This example will work if you want to try Kerberos v5 first and
2001       then fall back to regular Unix authentication.
2002       <literal>success=ok</literal> for the Kerberos PAM module followed by
2003       <literal>default=done</literal> for the AFS PAM module will cause a
2004       successful Kerberos login to run the AFS PAM module and then skip the
2005       Unix authentication module.  <literal>default=1</literal> on the
2006       Kerberos PAM module causes failure of that module to skip the next
2007       module (the AFS PAM module) and fall back to the Unix module.  If you
2008       want to try Unix authentication first and rearrange the order, be sure
2009       to use <literal>default=die</literal> instead.</para>
2010
2011       <para>The PAM configuration is stored in different places in different
2012       Linux distributions.  On Red Hat, look in
2013       <filename>/etc/pam.d/system-auth</filename>.  On Debian and
2014       derivatives, look in <filename>/etc/pam.d/common-session</filename>
2015       and <filename>/etc/pam.d/common-auth</filename>.</para>
2016
2017       <para>For additional configuration examples and the configuration
2018       options of the AFS PAM module, see its documentation.  For more
2019       details on the available options for the PAM configuration, see the
2020       Linux PAM documentation.</para>
2021
2022       <para>Sites which still require <command>kaserver</command> or
2023       external Kerberos v4 authentication should consult <link
2024       linkend="KAS015">Enabling kaserver based AFS Login on Linux
2025       Systems</link> for details of how to enable AFS login on Linux.</para>
2026
2027       <para>Proceed to <link linkend="HDRWQ50">Starting the BOS
2028       Server</link> (or if referring to these instructions while installing
2029       an additional file server machine, return to <link
2030       linkend="HDRWQ108">Starting Server Programs</link>).</para>
2031     </sect2>
2032   </sect1>
2033
2034   <sect1 id="HDRWQ45">
2035     <title>Getting Started on Solaris Systems</title>
2036
2037     <para>Begin by running the AFS initialization script to call the <emphasis role="bold">modload</emphasis> program distributed by
2038     Sun Microsystems, which dynamically loads AFS modifications into the kernel. Then create partitions for storing AFS volumes, and
2039     install and configure the AFS-modified <emphasis role="bold">fsck</emphasis> program to run on AFS server partitions. If the
2040     machine is to remain an AFS client machine, incorporate AFS into the machine's Pluggable Authentication Module (PAM) scheme.
2041     <indexterm>
2042         <primary>incorporating AFS kernel extensions</primary>
2043
2044         <secondary>first AFS machine</secondary>
2045
2046         <tertiary>Solaris</tertiary>
2047       </indexterm> <indexterm>
2048         <primary>AFS kernel extensions</primary>
2049
2050         <secondary>on first AFS machine</secondary>
2051
2052         <tertiary>Solaris</tertiary>
2053       </indexterm> <indexterm>
2054         <primary>first AFS machine</primary>
2055
2056         <secondary>AFS kernel extensions</secondary>
2057
2058         <tertiary>on Solaris</tertiary>
2059       </indexterm> <indexterm>
2060         <primary>Solaris</primary>
2061
2062         <secondary>AFS kernel extensions</secondary>
2063
2064         <tertiary>on first AFS machine</tertiary>
2065       </indexterm></para>
2066
2067     <sect2 id="HDRWQ46">
2068       <title>Loading AFS into the Solaris Kernel</title>
2069
2070       <para>The <emphasis role="bold">modload</emphasis> program is the dynamic kernel loader provided by Sun Microsystems for
2071       Solaris systems. Solaris does not support incorporation of AFS modifications during a kernel build.</para>
2072
2073       <para>For AFS to function correctly, the <emphasis role="bold">modload</emphasis> program must run each time the machine
2074       reboots, so the AFS initialization script (included on the AFS CD-ROM) invokes it automatically. In this section you copy the
2075       appropriate AFS library file to the location where the <emphasis role="bold">modload</emphasis> program accesses it and then
2076       run the script.</para>
2077
2078       <para>In later sections you verify that the script correctly initializes all AFS components, then create the links that
2079       incorporate AFS into the Solaris startup and shutdown sequence. <orderedlist>
2080           <listitem>
2081             <para>Unpack the OpenAFS Solaris distribution tarball. The examples
2082             below assume that you have unpacked the files into the
2083             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
2084             pick a diferent location, substitute this in all of the following
2085             exmaples. Once you have unpacked the distribution, change directory
2086             as indicated.
2087 <programlisting>
2088    # <emphasis role="bold">cd  /tmp/afsdist/sun4x_56/root.client/usr/vice/etc</emphasis>
2089 </programlisting></para>
2090           </listitem>
2091
2092           <listitem>
2093             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
2094             role="bold">/etc/init.d</emphasis> on Solaris machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
2095             extension as you copy the script. <programlisting>
2096    # <emphasis role="bold">cp -p  afs.rc  /etc/init.d/afs</emphasis>
2097 </programlisting></para>
2098           </listitem>
2099
2100           <listitem>
2101             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
2102             role="bold">/kernel/fs/afs</emphasis>.</para>
2103
2104             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, its kernel supports NFS server
2105             functionality, and the <emphasis role="bold">nfsd</emphasis> process is running:</para>
2106
2107             <programlisting>
2108    # <emphasis role="bold">cp -p modload/libafs.o /kernel/fs/afs</emphasis>
2109 </programlisting>
2110
2111             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, and its kernel does not support NFS
2112             server functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2113
2114             <programlisting>
2115    # <emphasis role="bold">cp -p modload/libafs.nonfs.o /kernel/fs/afs</emphasis>
2116 </programlisting>
2117
2118             <para>If the machine is running the 64-bit version of Solaris 7, its kernel supports NFS server functionality, and the
2119             <emphasis role="bold">nfsd</emphasis> process is running:</para>
2120
2121             <programlisting>
2122    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/sparcv9/afs</emphasis>
2123 </programlisting>
2124
2125             <para>If the machine is running the 64-bit version of Solaris 7, and its kernel does not support NFS server
2126             functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2127
2128             <programlisting>
2129    # <emphasis role="bold">cp -p modload/libafs64.nonfs.o /kernel/fs/sparcv9/afs</emphasis>
2130 </programlisting>
2131           </listitem>
2132
2133           <listitem>
2134             <para>Run the AFS initialization script to load AFS modifications into the kernel. You can ignore any error messages
2135             about the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
2136    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2137 </programlisting></para>
2138
2139             <para>When an entry called <computeroutput>afs</computeroutput> does not already exist in the local <emphasis
2140             role="bold">/etc/name_to_sysnum</emphasis> file, the script automatically creates it and reboots the machine to start
2141             using the new version of the file. If this happens, log in again as the superuser <emphasis role="bold">root</emphasis>
2142             after the reboot and run the initialization script again. This time the required entry exists in the <emphasis
2143             role="bold">/etc/name_to_sysnum</emphasis> file, and the <emphasis role="bold">modload</emphasis> program runs.</para>
2144
2145             <programlisting>
2146    login: <emphasis role="bold">root</emphasis>
2147    Password: <replaceable>root_password</replaceable>
2148    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2149 </programlisting>
2150           </listitem>
2151         </orderedlist></para>
2152
2153       <indexterm>
2154         <primary>replacing fsck program</primary>
2155
2156         <secondary>first AFS machine</secondary>
2157
2158         <tertiary>Solaris</tertiary>
2159       </indexterm>
2160
2161       <indexterm>
2162         <primary>fsck program</primary>
2163
2164         <secondary>on first AFS machine</secondary>
2165
2166         <tertiary>Solaris</tertiary>
2167       </indexterm>
2168
2169       <indexterm>
2170         <primary>first AFS machine</primary>
2171
2172         <secondary>fsck program</secondary>
2173
2174         <tertiary>on Solaris</tertiary>
2175       </indexterm>
2176
2177       <indexterm>
2178         <primary>Solaris</primary>
2179
2180         <secondary>fsck program</secondary>
2181
2182         <tertiary>on first AFS machine</tertiary>
2183       </indexterm>
2184     </sect2>
2185
2186     <sect2 id="HDRWQ47">
2187       <title>Configuring the AFS-modified fsck Program on Solaris Systems</title>
2188
2189       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
2190       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
2191       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
2192       it removes all of the data. To repeat:</para>
2193
2194       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS volumes.</emphasis>
2195       <orderedlist>
2196           <listitem>
2197             <para>Create the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory to house the AFS-modified <emphasis
2198             role="bold">fsck</emphasis> program and related files. <programlisting>
2199    # <emphasis role="bold">mkdir /usr/lib/fs/afs</emphasis>
2200    # <emphasis role="bold">cd /usr/lib/fs/afs</emphasis>
2201 </programlisting></para>
2202           </listitem>
2203
2204           <listitem>
2205             <para>Copy the <emphasis role="bold">vfsck</emphasis> binary to the newly created directory, changing the name as you do
2206             so. <programlisting>
2207    # <emphasis role="bold">cp  /tmp/afsdist/sun4x_56/root.server/etc/vfsck  fsck</emphasis>
2208 </programlisting></para>
2209           </listitem>
2210
2211           <listitem>
2212             <para>Working in the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory, create the following links to Solaris
2213             libraries: <programlisting>
2214    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/clri</emphasis>
2215    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/df</emphasis>
2216    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/edquota</emphasis>
2217    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ff</emphasis>
2218    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsdb</emphasis>
2219    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsirand</emphasis>
2220    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fstyp</emphasis>
2221    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/labelit</emphasis>
2222    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/lockfs</emphasis>
2223    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mkfs</emphasis>
2224    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mount</emphasis>
2225    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ncheck</emphasis>
2226    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/newfs</emphasis>
2227    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quot</emphasis>
2228    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quota</emphasis>
2229    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaoff</emphasis>
2230    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaon</emphasis>
2231    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/repquota</emphasis>
2232    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/tunefs</emphasis>
2233    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsdump</emphasis>
2234    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsrestore</emphasis>
2235    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/volcopy</emphasis>
2236 </programlisting></para>
2237           </listitem>
2238
2239           <listitem>
2240             <para>Append the following line to the end of the file <emphasis role="bold">/etc/dfs/fstypes</emphasis>.
2241             <programlisting>
2242    afs AFS Utilities
2243 </programlisting></para>
2244           </listitem>
2245
2246           <listitem>
2247             <para>Edit the <emphasis role="bold">/sbin/mountall</emphasis> file, making two changes. <itemizedlist>
2248                 <listitem>
2249                   <para>Add an entry for AFS to the <computeroutput>case</computeroutput> statement for option 2, so that it reads
2250                   as follows: <programlisting>
2251    case "$2" in
2252    ufs)    foptions="-o p"
2253            ;;
2254    afs)    foptions="-o p"
2255            ;;
2256    s5)     foptions="-y -t /var/tmp/tmp$$ -D"
2257            ;;
2258    *)      foptions="-y"
2259            ;;
2260 </programlisting></para>
2261                 </listitem>
2262
2263                 <listitem>
2264                   <para>Edit the file so that all AFS and UFS partitions are checked in parallel. Replace the following section of
2265                   code: <programlisting>
2266    # For  fsck purposes, we make a distinction between ufs and
2267    # other file systems
2268    #
2269    if [ "$fstype" = "ufs" ]; then
2270         ufs_fscklist="$ufs_fscklist $fsckdev"
2271         saveentry $fstype "$OPTIONS" $special $mountp
2272         continue
2273    fi
2274 </programlisting></para>
2275
2276                   <para>with the following section of code:</para>
2277
2278                   <programlisting>
2279    # For fsck purposes, we make a distinction between ufs/afs
2280    # and other file systems.
2281    #
2282    if [ "$fstype" = "ufs" -o "$fstype" = "afs" ]; then
2283         ufs_fscklist="$ufs_fscklist $fsckdev"
2284         saveentry $fstype "$OPTIONS" $special $mountp
2285         continue
2286    fi
2287 </programlisting>
2288                 </listitem>
2289               </itemizedlist></para>
2290           </listitem>
2291         </orderedlist></para>
2292
2293       <indexterm>
2294         <primary>configuring</primary>
2295
2296         <secondary>AFS server partition on first AFS machine</secondary>
2297
2298         <tertiary>Solaris</tertiary>
2299       </indexterm>
2300
2301       <indexterm>
2302         <primary>AFS server partition</primary>
2303
2304         <secondary>configuring on first AFS machine</secondary>
2305
2306         <tertiary>Solaris</tertiary>
2307       </indexterm>
2308
2309       <indexterm>
2310         <primary>first AFS machine</primary>
2311
2312         <secondary>AFS server partition</secondary>
2313
2314         <tertiary>on Solaris</tertiary>
2315       </indexterm>
2316
2317       <indexterm>
2318         <primary>Solaris</primary>
2319
2320         <secondary>AFS server partition</secondary>
2321
2322         <tertiary>on first AFS machine</tertiary>
2323       </indexterm>
2324     </sect2>
2325
2326     <sect2 id="HDRWQ48">
2327       <title>Configuring Server Partitions on Solaris Systems</title>
2328
2329       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
2330       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
2331       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
2332       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
2333       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
2334       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
2335       <orderedlist>
2336           <listitem>
2337             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
2338             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
2339    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
2340 </programlisting></para>
2341           </listitem>
2342
2343           <listitem>
2344             <para>Add a line with the following format to the file systems registry file, <emphasis
2345             role="bold">/etc/vfstab</emphasis>, for each partition to be mounted on a directory created in the previous step. Note
2346             the value <computeroutput>afs</computeroutput> in the fourth field, which tells Solaris to use the AFS-modified
2347             <emphasis role="bold">fsck</emphasis> program on this partition. <programlisting>
2348    /dev/dsk/<replaceable>disk</replaceable>   /dev/rdsk/<replaceable>disk</replaceable>   /vicep<replaceable>xx</replaceable>   afs   <replaceable>boot_order</replaceable>  yes
2349 </programlisting></para>
2350
2351             <para>The following is an example for the first partition being configured.</para>
2352
2353             <programlisting>
2354    /dev/dsk/c0t6d0s1 /dev/rdsk/c0t6d0s1 /vicepa afs 3 yes
2355 </programlisting>
2356           </listitem>
2357
2358           <listitem>
2359             <para>Create a file system on each partition that is to be mounted at a <emphasis
2360             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
2361             consult the Solaris documentation for more information. <programlisting>
2362    # <emphasis role="bold">newfs -v /dev/rdsk/</emphasis><replaceable>disk</replaceable>
2363 </programlisting></para>
2364           </listitem>
2365
2366           <listitem>
2367             <para>Issue the <emphasis role="bold">mountall</emphasis> command to mount all partitions at once.</para>
2368           </listitem>
2369
2370           <listitem>
2371             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
2372             linkend="HDRWQ49">Enabling AFS Login and Editing the File Systems Clean-up Script on Solaris Systems</link>. Otherwise,
2373             proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2374           </listitem>
2375         </orderedlist></para>
2376     </sect2>
2377
2378     <sect2 id="HDRWQ49">
2379       <title>Enabling AFS Login on Solaris Systems</title>
2380       <indexterm>
2381         <primary>enabling AFS login</primary>
2382
2383         <secondary>file server machine</secondary>
2384
2385         <tertiary>Solaris</tertiary>
2386       </indexterm>
2387
2388       <indexterm>
2389         <primary>AFS login</primary>
2390
2391         <secondary>on file server machine</secondary>
2392
2393         <tertiary>Solaris</tertiary>
2394       </indexterm>
2395
2396       <indexterm>
2397         <primary>first AFS machine</primary>
2398
2399         <secondary>AFS login</secondary>
2400
2401         <tertiary>on Solaris</tertiary>
2402       </indexterm>
2403
2404       <indexterm>
2405         <primary>Solaris</primary>
2406
2407         <secondary>AFS login</secondary>
2408
2409         <tertiary>on file server machine</tertiary>
2410       </indexterm>
2411
2412       <indexterm>
2413         <primary>PAM</primary>
2414
2415         <secondary>on Solaris</secondary>
2416
2417         <tertiary>file server machine</tertiary>
2418       </indexterm>
2419
2420       <note>
2421         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
2422         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2423       </note>
2424
2425       <para>At this point you incorporate AFS into the operating system's
2426       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
2427       authentication mechanisms on the machine, including login, to provide
2428       the security infrastructure for authenticated access to and from the
2429       machine.</para>
2430
2431       <para>Explaining PAM is beyond the scope of this document.  It is
2432       assumed that you understand the syntax and meanings of settings in the
2433       PAM configuration file (for example, how the
2434       <computeroutput>other</computeroutput> entry works, the effect of
2435       marking an entry as <computeroutput>required</computeroutput>,
2436       <computeroutput>optional</computeroutput>, or
2437       <computeroutput>sufficient</computeroutput>, and so on).</para>
2438
2439       <para>You should first configure your system to obtain Kerberos v5
2440       tickets as part of the authentication process, and then run an AFS PAM
2441       module to obtain tokens from those tickets after authentication.
2442       Current versions of Solaris come with a Kerberos v5 PAM module that
2443       will work, or you can download and install <ulink
2444       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
2445       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
2446       See the instructions of whatever PAM module you use for how to
2447       configure it.</para>
2448
2449       <para>Some Kerberos v5 PAM modules do come with native AFS support
2450       (usually requiring the Heimdal Kerberos implementation rather than the
2451       MIT Kerberos implementation).  If you are using one of those PAM
2452       modules, you can configure it to obtain AFS tokens.  It's more common,
2453       however, to separate the AFS token acquisition into a separate PAM
2454       module.</para>
2455
2456       <para>The recommended AFS PAM module is <ulink
2457       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
2458       Allbery's pam-afs-session module</ulink>.  It should work with any of
2459       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
2460       often only need to add configuration to the session group in
2461       <filename>pam.conf</filename>:</para>
2462
2463       <example>
2464         <title>Solaris PAM session example</title>
2465         <literallayout>login session required pam_afs_session.so</literallayout>
2466       </example>
2467
2468       <para>This example enables PAM authentication only for console login.
2469       You may want to add a similar line for the ssh service and for any
2470       other login service that you use, including possibly the
2471       <literal>other</literal> service (which serves as a catch-all).  You
2472       may also want to add options to the AFS PAM session module
2473       (particularly <literal>retain_after_close</literal>, which is
2474       necessary for some versions of Solaris.</para>
2475
2476       <para>For additional configuration examples and the configuration
2477       options of the AFS PAM module, see its documentation.  For more
2478       details on the available options for the PAM configuration, see the
2479       <filename>pam.conf</filename> manual page.</para>
2480
2481       <para>Sites which still require <emphasis
2482       role="bold">kaserver</emphasis> or external Kerberos v4 authentication
2483       should consult <link linkend="KAS016">Enabling kaserver based AFS
2484       Login on Solaris Systems"</link> for details of how to enable AFS
2485       login on Solaris.</para>
2486
2487       <para>Proceed to <link linkend="HDRWQ49a">Editing the File Systems
2488       Clean-up Script on Solaris Systems</link></para>
2489     </sect2>
2490     <sect2 id="HDRWQ49a">
2491       <title>Editing the File Systems Clean-up Script on Solaris Systems</title>
2492       <indexterm>
2493         <primary>Solaris</primary>
2494
2495         <secondary>file systems clean-up script</secondary>
2496
2497         <tertiary>on file server machine</tertiary>
2498       </indexterm>
2499
2500       <indexterm>
2501         <primary>file systems clean-up script (Solaris)</primary>
2502
2503         <secondary>file server machine</secondary>
2504       </indexterm>
2505
2506       <indexterm>
2507         <primary>scripts</primary>
2508
2509         <secondary>file systems clean-up (Solaris)</secondary>
2510
2511         <tertiary>file server machine</tertiary>
2512       </indexterm>
2513
2514
2515         <orderedlist>
2516           <listitem>
2517             <para>Some Solaris distributions include a script that locates and removes unneeded files from various file systems. Its
2518             conventional location is <emphasis role="bold">/usr/lib/fs/nfs/nfsfind</emphasis>. The script generally uses an argument
2519             to the <emphasis role="bold">find</emphasis> command to define which file systems to search. In this step you modify the
2520             command to exclude the <emphasis role="bold">/afs</emphasis> directory. Otherwise, the command traverses the AFS
2521             filespace of every cell that is accessible from the machine, which can take many hours. The following alterations are
2522             possibilities, but you must verify that they are appropriate for your cell.</para>
2523
2524             <para>The first possible alteration is to add the <emphasis role="bold">-local</emphasis> flag to the existing command,
2525             so that it looks like the following:</para>
2526
2527             <programlisting>
2528    find $dir -local -name .nfs\* -mtime +7 -mount -exec rm -f {} \;
2529 </programlisting>
2530
2531             <para>Another alternative is to exclude any directories whose names begin with the lowercase letter <emphasis
2532             role="bold">a</emphasis> or a non-alphabetic character.</para>
2533
2534             <programlisting>
2535    find /[A-Zb-z]*  <replaceable>remainder of existing command</replaceable>
2536 </programlisting>
2537
2538             <para>Do not use the following command, which still searches under the <emphasis role="bold">/afs</emphasis> directory,
2539             looking for a subdirectory of type <emphasis role="bold">4.2</emphasis>.</para>
2540
2541             <programlisting>
2542    find / -fstype 4.2     /* <replaceable>do not use</replaceable> */
2543 </programlisting>
2544           </listitem>
2545
2546           <listitem>
2547             <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link> (or if referring to these instructions while
2548             installing an additional file server machine, return to <link linkend="HDRWQ108">Starting Server
2549             Programs</link>).</para>
2550           </listitem>
2551         </orderedlist>
2552
2553       <indexterm>
2554         <primary>Basic OverSeer Server</primary>
2555
2556         <see>BOS Server</see>
2557       </indexterm>
2558
2559       <indexterm>
2560         <primary>BOS Server</primary>
2561
2562         <secondary>starting</secondary>
2563
2564         <tertiary>first AFS machine</tertiary>
2565       </indexterm>
2566
2567       <indexterm>
2568         <primary>starting</primary>
2569
2570         <secondary>BOS Server</secondary>
2571
2572         <tertiary>first AFS machine</tertiary>
2573       </indexterm>
2574
2575       <indexterm>
2576         <primary>first AFS machine</primary>
2577
2578         <secondary>BOS Server</secondary>
2579       </indexterm>
2580
2581       <indexterm>
2582         <primary>authorization checking (disabling)</primary>
2583
2584         <secondary>first AFS machine</secondary>
2585       </indexterm>
2586
2587       <indexterm>
2588         <primary>disabling authorization checking</primary>
2589
2590         <secondary>first AFS machine</secondary>
2591       </indexterm>
2592
2593       <indexterm>
2594         <primary>first AFS machine</primary>
2595
2596         <secondary>authorization checking (disabling)</secondary>
2597       </indexterm>
2598     </sect2>
2599   </sect1>
2600   <sect1 id="HDRWQ50">
2601     <title>Starting the BOS Server</title>
2602
2603     <para>You are now ready to start the AFS server processes on this machine.
2604     If you are not working from a packaged distribution, begin by copying the
2605     AFS server binaries from the distribution to the conventional local disk
2606     location, the <emphasis role="bold">/usr/afs/bin</emphasis> directory. The
2607     following instructions also create files in other subdirectories of the
2608     <emphasis role="bold">/usr/afs</emphasis> directory.</para>
2609
2610     <para>Then issue the <emphasis role="bold">bosserver</emphasis> command to initialize the Basic OverSeer (BOS) Server, which
2611     monitors and controls other AFS server processes on its server machine. Include the <emphasis role="bold">-noauth</emphasis>
2612     flag to disable authorization checking. Because you have not yet configured your cell's AFS authentication and authorization
2613     mechanisms, the BOS Server cannot perform authorization checking as it does during normal operation. In no-authorization mode,
2614     it does not verify the identity or privilege of the issuer of a <emphasis role="bold">bos</emphasis> command, and so performs
2615     any operation for anyone.</para>
2616
2617     <para>Disabling authorization checking gravely compromises cell security. You must complete all subsequent steps in one
2618     uninterrupted pass and must not leave the machine unattended until you restart the BOS Server with authorization checking
2619     enabled, in <link linkend="HDRWQ72">Verifying the AFS Initialization Script</link>.</para>
2620
2621     <para>As it initializes for the first time, the BOS Server creates the following directories and files, setting the owner to the
2622     local superuser <emphasis role="bold">root</emphasis> and the mode bits to limit the ability to write (and in some cases, read)
2623     them. For a description of the contents and function of these directories and files, see the chapter in the <emphasis>OpenAFS
2624     Administration Guide</emphasis> about administering server machines. For further discussion of the mode bit settings, see <link
2625     linkend="HDRWQ96">Protecting Sensitive AFS Directories</link>. <indexterm>
2626         <primary>Binary Distribution</primary>
2627
2628         <secondary>copying server files from</secondary>
2629
2630         <tertiary>first AFS machine</tertiary>
2631       </indexterm> <indexterm>
2632         <primary>first AFS machine</primary>
2633
2634         <secondary>subdirectories of /usr/afs</secondary>
2635       </indexterm> <indexterm>
2636         <primary>creating</primary>
2637
2638         <secondary>/usr/afs/bin directory</secondary>
2639
2640         <tertiary>first AFS machine</tertiary>
2641       </indexterm> <indexterm>
2642         <primary>creating</primary>
2643
2644         <secondary>/usr/afs/etc directory</secondary>
2645
2646         <tertiary>first AFS machine</tertiary>
2647       </indexterm> <indexterm>
2648         <primary>copying</primary>
2649
2650         <secondary>server files to local disk</secondary>
2651
2652         <tertiary>first AFS machine</tertiary>
2653       </indexterm> <indexterm>
2654         <primary>first AFS machine</primary>
2655
2656         <secondary>copying</secondary>
2657
2658         <tertiary>server files to local disk</tertiary>
2659       </indexterm> <indexterm>
2660         <primary>usr/afs/bin directory</primary>
2661
2662         <secondary>first AFS machine</secondary>
2663       </indexterm> <indexterm>
2664         <primary>usr/afs/etc directory</primary>
2665
2666         <secondary>first AFS machine</secondary>
2667       </indexterm> <indexterm>
2668         <primary>usr/afs/db directory</primary>
2669       </indexterm> <indexterm>
2670         <primary>usr/afs/local directory</primary>
2671       </indexterm> <indexterm>
2672         <primary>usr/afs/logs directory</primary>
2673       </indexterm> <itemizedlist>
2674         <listitem>
2675           <para><emphasis role="bold">/usr/afs/db</emphasis></para>
2676         </listitem>
2677
2678         <listitem>
2679           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis></para>
2680         </listitem>
2681
2682         <listitem>
2683           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis></para>
2684         </listitem>
2685
2686         <listitem>
2687           <para><emphasis role="bold">/usr/afs/local</emphasis></para>
2688         </listitem>
2689
2690         <listitem>
2691           <para><emphasis role="bold">/usr/afs/logs</emphasis></para>
2692         </listitem>
2693       </itemizedlist></para>
2694
2695     <para>The BOS Server also creates symbolic links called <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2696     role="bold">/usr/vice/etc/CellServDB</emphasis> to the corresponding files in the <emphasis role="bold">/usr/afs/etc</emphasis>
2697     directory. The AFS command interpreters consult the <emphasis role="bold">CellServDB</emphasis> and <emphasis
2698     role="bold">ThisCell</emphasis> files in the <emphasis role="bold">/usr/vice/etc</emphasis> directory because they generally run
2699     on client machines. On machines that are AFS servers only (as this machine currently is), the files reside only in the <emphasis
2700     role="bold">/usr/afs/etc</emphasis> directory; the links enable the command interpreters to retrieve the information they need.
2701     Later instructions for installing the client functionality replace the links with actual files. <orderedlist>
2702         <listitem>
2703           <para>If you are not working from a packaged distribution, you may need to copy files from the distribution media to the local <emphasis role="bold">/usr/afs</emphasis> directory.
2704 <programlisting>
2705    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.server/usr/afs</emphasis>
2706    # <emphasis role="bold">cp -rp  *  /usr/afs</emphasis>
2707 </programlisting> <indexterm>
2708               <primary>commands</primary>
2709
2710               <secondary>bosserver</secondary>
2711             </indexterm> <indexterm>
2712               <primary>bosserver command</primary>
2713             </indexterm></para>
2714         </listitem>
2715
2716         <listitem>
2717           <para>Issue the <emphasis role="bold">bosserver</emphasis> command. Include the <emphasis role="bold">-noauth</emphasis>
2718           flag to disable authorization checking. <programlisting>
2719    # <emphasis role="bold">/usr/afs/bin/bosserver -noauth &amp;</emphasis>
2720 </programlisting></para>
2721         </listitem>
2722
2723         <listitem>
2724           <para>Verify that the BOS Server created <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2725           role="bold">/usr/vice/etc/CellServDB</emphasis> as symbolic links to the corresponding files in the <emphasis
2726           role="bold">/usr/afs/etc</emphasis> directory. <programlisting>
2727    # <emphasis role="bold">ls -l  /usr/vice/etc</emphasis>
2728 </programlisting></para>
2729
2730           <para>If either or both of <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2731           role="bold">/usr/vice/etc/CellServDB</emphasis> do not exist, or are not links, issue the following commands.</para>
2732
2733           <programlisting>
2734    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2735    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell</emphasis>
2736    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB</emphasis>
2737 </programlisting>
2738         </listitem>
2739       </orderedlist></para>
2740
2741     <indexterm>
2742       <primary>cell name</primary>
2743
2744       <secondary>defining during installation of first machine</secondary>
2745     </indexterm>
2746
2747     <indexterm>
2748       <primary>defining</primary>
2749
2750       <secondary>cell name during installation of first machine</secondary>
2751     </indexterm>
2752
2753     <indexterm>
2754       <primary>cell name</primary>
2755
2756       <secondary>setting in server ThisCell file</secondary>
2757
2758       <tertiary>first AFS machine</tertiary>
2759     </indexterm>
2760
2761     <indexterm>
2762       <primary>setting</primary>
2763
2764       <secondary>cell name in server ThisCell file</secondary>
2765
2766       <tertiary>first AFS machine</tertiary>
2767     </indexterm>
2768
2769     <indexterm>
2770       <primary>first AFS machine</primary>
2771
2772       <secondary>ThisCell file (server)</secondary>
2773     </indexterm>
2774
2775     <indexterm>
2776       <primary>usr/afs/etc/ThisCell</primary>
2777
2778       <see>ThisCell file (server)</see>
2779     </indexterm>
2780
2781     <indexterm>
2782       <primary>ThisCell file (server)</primary>
2783
2784       <secondary>first AFS machine</secondary>
2785     </indexterm>
2786
2787     <indexterm>
2788       <primary>files</primary>
2789
2790       <secondary>ThisCell (server)</secondary>
2791     </indexterm>
2792
2793     <indexterm>
2794       <primary>database server machine</primary>
2795
2796       <secondary>entry in server CellServDB file</secondary>
2797
2798       <tertiary>on first AFS machine</tertiary>
2799     </indexterm>
2800
2801     <indexterm>
2802       <primary>first AFS machine</primary>
2803
2804       <secondary>cell membership, defining</secondary>
2805
2806       <tertiary>for server processes</tertiary>
2807     </indexterm>
2808
2809     <indexterm>
2810       <primary>usr/afs/etc/CellServDB file</primary>
2811
2812       <see>CellServDB file (server)</see>
2813     </indexterm>
2814
2815     <indexterm>
2816       <primary>CellServDB file (server)</primary>
2817
2818       <secondary>creating</secondary>
2819
2820       <tertiary>on first AFS machine</tertiary>
2821     </indexterm>
2822
2823     <indexterm>
2824       <primary>creating</primary>
2825
2826       <secondary>CellServDB file (server)</secondary>
2827
2828       <tertiary>first AFS machine</tertiary>
2829     </indexterm>
2830
2831     <indexterm>
2832       <primary>files</primary>
2833
2834       <secondary>CellServDB (server)</secondary>
2835     </indexterm>
2836
2837     <indexterm>
2838       <primary>first AFS machine</primary>
2839
2840       <secondary>CellServDB file (server)</secondary>
2841     </indexterm>
2842
2843     <indexterm>
2844       <primary>first AFS machine</primary>
2845
2846       <secondary>defining</secondary>
2847
2848       <tertiary>as database server</tertiary>
2849     </indexterm>
2850
2851     <indexterm>
2852       <primary>defining</primary>
2853
2854       <secondary>first AFS machine as database server</secondary>
2855     </indexterm>
2856   </sect1>
2857
2858   <sect1 id="HDRWQ51">
2859     <title>Defining Cell Name and Membership for Server Processes</title>
2860
2861     <para>Now assign your cell's name. The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration
2862     and administration issues discusses the important considerations, explains why changing the name is difficult, and outlines the
2863     restrictions on name format. Two of the most important restrictions are that the name cannot include uppercase letters or more
2864     than 64 characters.</para>
2865
2866     <para>Use the <emphasis role="bold">bos setcellname</emphasis> command to assign the cell name. It creates two files:
2867     <itemizedlist>
2868         <listitem>
2869           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis>, which defines this machine's cell membership</para>
2870         </listitem>
2871
2872         <listitem>
2873           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis>, which lists the cell's database server machines; the
2874           machine named on the command line is placed on the list automatically</para>
2875         </listitem>
2876       </itemizedlist> <note>
2877         <para>In the following and every instruction in this guide, for the <replaceable>machine name</replaceable> argument
2878         substitute the fully-qualified hostname (such as <emphasis role="bold">fs1.example.com</emphasis>) of the machine you are
2879         installing. For the <replaceable>cell name</replaceable> argument substitute your cell's complete name (such as <emphasis
2880         role="bold">example.com</emphasis>).</para>
2881       </note></para>
2882
2883     <indexterm>
2884       <primary>commands</primary>
2885
2886       <secondary>bos setcellname</secondary>
2887     </indexterm>
2888
2889     <indexterm>
2890       <primary>bos commands</primary>
2891
2892       <secondary>setcellname</secondary>
2893     </indexterm>
2894
2895     <orderedlist>
2896       <listitem>
2897         <para>If necessary, add the directory containing the <emphasis role="bold">bos</emphasis> command to your path.
2898       <programlisting>
2899    # <emphasis role="bold">export PATH=$PATH:/usr/afs/bin</emphasis>
2900       </programlisting>
2901         </para>
2902       </listitem>
2903
2904       <listitem>
2905         <para>Issue the <emphasis role="bold">bos setcellname</emphasis> command to set the cell name. <programlisting>
2906    # <emphasis role="bold">bos setcellname</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>cell name</replaceable>&gt; <emphasis
2907               role="bold">-noauth</emphasis>
2908 </programlisting></para>
2909
2910         <para>Because you are not authenticated and authorization checking is disabled, the <emphasis role="bold">bos</emphasis>
2911         command interpreter possibly produces error messages about being unable to obtain tickets and running unauthenticated. You
2912         can safely ignore the messages. <indexterm>
2913             <primary>commands</primary>
2914
2915             <secondary>bos listhosts</secondary>
2916           </indexterm> <indexterm>
2917             <primary>bos commands</primary>
2918
2919             <secondary>listhosts</secondary>
2920           </indexterm> <indexterm>
2921             <primary>CellServDB file (server)</primary>
2922
2923             <secondary>displaying entries</secondary>
2924           </indexterm> <indexterm>
2925             <primary>displaying</primary>
2926
2927             <secondary>CellServDB file (server) entries</secondary>
2928           </indexterm></para>
2929       </listitem>
2930
2931       <listitem>
2932         <para>Issue the <emphasis role="bold">bos listhosts</emphasis> command to verify that the machine you are installing is now
2933         registered as the cell's first database server machine. <programlisting>
2934    # <emphasis role="bold">bos listhosts</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
2935    Cell name is <replaceable>cell_name</replaceable>
2936        Host 1 is <replaceable>machine_name</replaceable>
2937 </programlisting></para>
2938       </listitem>
2939     </orderedlist>
2940
2941     <indexterm>
2942       <primary>database server machine</primary>
2943
2944       <secondary>installing</secondary>
2945
2946       <tertiary>first</tertiary>
2947     </indexterm>
2948
2949     <indexterm>
2950       <primary>instructions</primary>
2951
2952       <secondary>database server machine, installing first</secondary>
2953     </indexterm>
2954
2955     <indexterm>
2956       <primary>installing</primary>
2957
2958       <secondary>database server machine</secondary>
2959
2960       <tertiary>first</tertiary>
2961     </indexterm>
2962
2963     <indexterm>
2964       <primary>Backup Server</primary>
2965
2966       <secondary>starting</secondary>
2967
2968       <tertiary>first AFS machine</tertiary>
2969     </indexterm>
2970
2971     <indexterm>
2972       <primary>buserver process</primary>
2973
2974       <see>Backup Server</see>
2975     </indexterm>
2976
2977     <indexterm>
2978       <primary>starting</primary>
2979
2980       <secondary>Backup Server</secondary>
2981
2982       <tertiary>first AFS machine</tertiary>
2983     </indexterm>
2984
2985     <indexterm>
2986       <primary>first AFS machine</primary>
2987
2988       <secondary>Backup Server</secondary>
2989     </indexterm>
2990
2991     <indexterm>
2992       <primary>Protection Server</primary>
2993
2994       <secondary>starting</secondary>
2995
2996       <tertiary>first AFS machine</tertiary>
2997     </indexterm>
2998
2999     <indexterm>
3000       <primary>ptserver process</primary>
3001
3002       <see>Protection Server</see>
3003     </indexterm>
3004
3005     <indexterm>
3006       <primary>starting</primary>
3007
3008       <secondary>Protection Server</secondary>
3009
3010       <tertiary>first AFS machine</tertiary>
3011     </indexterm>
3012
3013     <indexterm>
3014       <primary>first AFS machine</primary>
3015
3016       <secondary>Protection Server</secondary>
3017     </indexterm>
3018
3019     <indexterm>
3020       <primary>VL Server (vlserver process)</primary>
3021
3022       <secondary>starting</secondary>
3023
3024       <tertiary>first AFS machine</tertiary>
3025     </indexterm>
3026
3027     <indexterm>
3028       <primary>Volume Location Server</primary>
3029
3030       <see>VL Server</see>
3031     </indexterm>
3032
3033     <indexterm>
3034       <primary>starting</primary>
3035
3036       <secondary>VL Server</secondary>
3037
3038       <tertiary>first AFS machine</tertiary>
3039     </indexterm>
3040
3041     <indexterm>
3042       <primary>first AFS machine</primary>
3043
3044       <secondary>VL Server</secondary>
3045     </indexterm>
3046
3047     <indexterm>
3048       <primary>usr/afs/local/BosConfig</primary>
3049
3050       <see>BosConfig file</see>
3051     </indexterm>
3052
3053     <indexterm>
3054       <primary>BosConfig file</primary>
3055
3056       <secondary>adding entries</secondary>
3057
3058       <tertiary>first AFS machine</tertiary>
3059     </indexterm>
3060
3061     <indexterm>
3062       <primary>adding</primary>
3063
3064       <secondary>entries to BosConfig file</secondary>
3065
3066       <tertiary>first AFS machine</tertiary>
3067     </indexterm>
3068
3069     <indexterm>
3070       <primary>files</primary>
3071
3072       <secondary>BosConfig</secondary>
3073     </indexterm>
3074
3075     <indexterm>
3076       <primary>initializing</primary>
3077
3078       <secondary>server process</secondary>
3079
3080       <see>starting</see>
3081     </indexterm>
3082
3083     <indexterm>
3084       <primary>server process</primary>
3085
3086       <secondary>see also entry for each server's name</secondary>
3087     </indexterm>
3088   </sect1>
3089
3090   <sect1 id="HDRWQ52">
3091     <title>Starting the Database Server Processes</title>
3092
3093     <para>Next use the <emphasis role="bold">bos create</emphasis> command to create entries for the three database server processes
3094     in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file and start them running. The three processes run on database
3095     server machines only: <itemizedlist>
3096
3097         <listitem>
3098           <para>The Backup Server (the <emphasis role="bold">buserver</emphasis> process) maintains the Backup Database</para>
3099         </listitem>
3100
3101         <listitem>
3102           <para>The Protection Server (the <emphasis role="bold">ptserver</emphasis> process) maintains the Protection
3103           Database</para>
3104         </listitem>
3105
3106         <listitem>
3107           <para>The Volume Location (VL) Server (the <emphasis role="bold">vlserver</emphasis> process) maintains the Volume
3108           Location Database (VLDB)</para>
3109         </listitem>
3110       </itemizedlist></para>
3111
3112     <indexterm>
3113       <primary>Kerberos</primary>
3114     </indexterm>
3115
3116     <note>
3117       <para>AFS ships with an additional database server named 'kaserver', which
3118       was historically used to provide authentication services to AFS cells.
3119       kaserver was based on <emphasis>Kerberos v4</emphasis>, as such, it is
3120       not recommended for new cells. This guide assumes you have already
3121       configured a Kerberos v5 realm for your site, and details the procedures
3122       required to use AFS with this realm. If you do wish to use
3123       <emphasis role="bold">kaserver</emphasis>, please see the modifications
3124       to these instructions detailed in
3125       <link linkend="KAS006">Starting the kaserver Database Server Process</link>
3126       </para>
3127     </note>
3128
3129     <para>The remaining instructions in this chapter include the <emphasis role="bold">-cell</emphasis> argument on all applicable
3130     commands. Provide the cell name you assigned in <link linkend="HDRWQ51">Defining Cell Name and Membership for Server
3131     Processes</link>. If a command appears on multiple lines, it is only for legibility. <indexterm>
3132         <primary>commands</primary>
3133
3134         <secondary>bos create</secondary>
3135       </indexterm> <indexterm>
3136         <primary>bos commands</primary>
3137
3138         <secondary>create</secondary>
3139       </indexterm> <orderedlist>
3140         <listitem>
3141           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Backup Server. <programlisting>
3142    # <emphasis role="bold">./bos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">buserver simple /usr/afs/bin/buserver</emphasis>  <emphasis role="bold">-noauth</emphasis>
3143 </programlisting></para>
3144         </listitem>
3145
3146         <listitem>
3147           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Protection Server. <programlisting>
3148    # <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>
3149 </programlisting></para>
3150         </listitem>
3151
3152         <listitem>
3153           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the VL Server. <programlisting>
3154    # <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>
3155 </programlisting></para>
3156         </listitem>
3157       </orderedlist></para>
3158
3159     <indexterm>
3160       <primary>admin account</primary>
3161
3162       <secondary>creating</secondary>
3163     </indexterm>
3164
3165     <indexterm>
3166       <primary>afs entry in Kerberos Database</primary>
3167     </indexterm>
3168
3169     <indexterm>
3170       <primary>Kerberos Database</primary>
3171     </indexterm>
3172
3173     <indexterm>
3174       <primary>creating</primary>
3175
3176       <secondary>afs entry in Kerberos Database</secondary>
3177     </indexterm>
3178
3179     <indexterm>
3180       <primary>creating</primary>
3181
3182       <secondary>admin account in Kerberos Database</secondary>
3183     </indexterm>
3184
3185     <indexterm>
3186       <primary>security</primary>
3187
3188       <secondary>initializing cell-wide</secondary>
3189     </indexterm>
3190
3191     <indexterm>
3192       <primary>cell</primary>
3193
3194       <secondary>initializing security mechanisms</secondary>
3195     </indexterm>
3196
3197     <indexterm>
3198       <primary>initializing</primary>
3199
3200       <secondary>cell security mechanisms</secondary>
3201     </indexterm>
3202
3203     <indexterm>
3204       <primary>usr/afs/etc/KeyFile</primary>
3205
3206       <see>KeyFile file</see>
3207     </indexterm>
3208
3209     <indexterm>
3210       <primary>KeyFile file</primary>
3211
3212       <secondary>first AFS machine</secondary>
3213     </indexterm>
3214
3215     <indexterm>
3216       <primary>files</primary>
3217
3218       <secondary>KeyFile</secondary>
3219     </indexterm>
3220
3221     <indexterm>
3222       <primary>key</primary>
3223
3224       <see>server encryption key</see>
3225     </indexterm>
3226
3227     <indexterm>
3228       <primary>encryption key</primary>
3229
3230       <see>server encryption key</see>
3231     </indexterm>
3232   </sect1>
3233
3234   <sect1 id="HDRWQ53">
3235     <title>Initializing Cell Security </title>
3236
3237     <para>If you are working with an existing cell which uses
3238     <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for authentication,
3239     please see
3240     <link linkend="HDRWQ53">Initializing Cell Security with kaserver</link>
3241     for installation instructions which replace this section.</para>
3242
3243     <para>Now initialize the cell's security mechanisms. Begin by creating the following two entires in your site's Kerberos database: <itemizedlist>
3244         <listitem>
3245           <para>A generic administrative account, called <emphasis role="bold">admin</emphasis> by convention. If you choose to
3246           assign a different name, substitute it throughout the remainder of this document.</para>
3247
3248           <para>After you complete the installation of the first machine, you can continue to have all administrators use the
3249           <emphasis role="bold">admin</emphasis> account, or you can create a separate administrative account for each of them. The
3250           latter scheme implies somewhat more overhead, but provides a more informative audit trail for administrative
3251           operations.</para>
3252         </listitem>
3253
3254         <listitem>
3255           <para>The entry for AFS server processes, called either
3256           <emphasis role="bold">afs</emphasis> or
3257           <emphasis role="bold">afs/<replaceable>cell</replaceable></emphasis>.
3258           No user logs in under this identity, but it is used to encrypt the
3259           server tickets that granted to AFS clients for presentation to
3260           server processes during mutual authentication. (The
3261           chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and administration describes the
3262           role of server encryption keys in mutual authentication.)</para>
3263
3264           <para>In Step <link linkend="LIWQ58">7</link>, you also place the initial AFS server encryption key into the <emphasis
3265           role="bold">/usr/afs/etc/KeyFile</emphasis> file. The AFS server processes refer to this file to learn the server
3266           encryption key when they need to decrypt server tickets.</para>
3267         </listitem>
3268       </itemizedlist></para>
3269
3270     <para>You also issue several commands that enable the new <emphasis role="bold">admin</emphasis> user to issue privileged
3271     commands in all of the AFS suites.</para>
3272
3273     <para>The following instructions do not configure all of the security mechanisms related to the AFS Backup System. See the
3274     chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about configuring the Backup System.</para>
3275
3276     <para>The examples below assume you are using MIT Kerberos. Please refer
3277     to the documentation for your KDC's administrative interface if you are
3278     using a different vendor</para>
3279
3280     <orderedlist>
3281         <listitem>
3282           <para>Enter <emphasis role="bold">kadmin</emphasis> interactive mode.
3283 <programlisting>
3284    # <emphasis role="bold">kadmin</emphasis>
3285 Authenticating as principal <replaceable>you</replaceable>/admin@<replaceable>YOUR REALM</replaceable> with password
3286 Password for <replaceable>you/admin@REALM</replaceable>: <replaceable>your_password</replaceable>
3287 </programlisting> <indexterm>
3288               <primary>server encryption key</primary>
3289
3290               <secondary>in Kerberos Database</secondary>
3291             </indexterm> <indexterm>
3292               <primary>creating</primary>
3293
3294               <secondary>server encryption key</secondary>
3295
3296               <tertiary>Kerberos Database</tertiary>
3297             </indexterm></para>
3298         </listitem>
3299
3300         <listitem>
3301           <para><anchor id="LIWQ54" />Issue the
3302           <emphasis role="bold">add_principal</emphasis> command to create
3303           Kerberos Database entries called
3304           <emphasis role="bold">admin</emphasis> and
3305           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>.</para>
3306
3307           <para>You should make the <replaceable>admin_passwd</replaceable> as
3308           long and complex as possible, but keep in mind that administrators
3309           need to enter it often. It must be at least six characters long.</para>
3310           <para>Note that when creating the
3311           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3312           entry, the encryption types should be restricted to des-cbc-crc:v4.
3313           For more details regarding encryption types, see the documentation
3314           for your Kerberos installation.
3315
3316 <programlisting>
3317    kadmin: <emphasis role="bold">add_principal -randkey -e des-cbc-crc:v4 afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3318    Principal "afs/<replaceable>cell name</replaceable>@<replaceable>REALM</replaceable>" created.
3319    kadmin:  <emphasis role="bold">add_principal admin</emphasis>
3320    Enter password for principal "admin@<replaceable>REALM</replaceable>": <emphasis role="bold"><replaceable>admin_password</replaceable></emphasis>
3321    Principal "admin@<replaceable>REALM</replaceable>" created.
3322 </programlisting>
3323           </para>
3324
3325           <indexterm>
3326             <primary>commands</primary>
3327
3328             <secondary>kas examine</secondary>
3329           </indexterm>
3330
3331           <indexterm>
3332             <primary>kas commands</primary>
3333
3334             <secondary>examine</secondary>
3335           </indexterm>
3336
3337           <indexterm>
3338             <primary>displaying</primary>
3339
3340             <secondary>server encryption key</secondary>
3341
3342             <tertiary>Authentication Database</tertiary>
3343           </indexterm>
3344         </listitem>
3345
3346         <listitem>
3347           <para><anchor id="LIWQ55" />Issue the <emphasis role="bold">kadmin
3348           get_principal</emphasis> command to display the <emphasis
3349           role="bold">afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt; entry.
3350 <programlisting>
3351   kadmin: <emphasis role="bold">get_principal afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3352   Principal: afs/<replaceable>cell</replaceable>
3353   [ ... ]
3354   Key: vno 2, DES cbc mode with CRC-32, no salt
3355   [ ... ]
3356 </programlisting>
3357 </para>
3358         </listitem>
3359         <listitem>
3360           <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>
3361
3362           <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>
3363
3364 <programlisting>
3365   kadmin: <emphasis role="bold">ktadd -k /etc/afs.keytab -e des-cbc-crc:v4 afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3366 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
3367 </programlisting>
3368           <para>Make a note of the key version number (kvno) given in the
3369           response, as you will need it to load the key into bos in a later
3370           step</para>
3371
3372           <note><para>Note that each time you run
3373           <emphasis role="bold">ktadd</emphasis> a new key is generated
3374           for the item being extracted. This means that you cannot run ktadd
3375           multiple times and end up with the same key material each time.
3376           </para></note>
3377
3378         </listitem>
3379         <listitem>
3380           <para>Issue the <emphasis role="bold">kadmin quit</emphasis> command to leave <emphasis role="bold">kadmin</emphasis>
3381           interactive mode. <programlisting>
3382    kadmin: <emphasis role="bold">quit</emphasis>
3383 </programlisting> <indexterm>
3384               <primary>commands</primary>
3385
3386               <secondary>bos adduser</secondary>
3387             </indexterm> <indexterm>
3388               <primary>bos commands</primary>
3389
3390               <secondary>adduser</secondary>
3391             </indexterm> <indexterm>
3392               <primary>usr/afs/etc/UserList</primary>
3393
3394               <see>UserList file</see>
3395             </indexterm> <indexterm>
3396               <primary>UserList file</primary>
3397
3398               <secondary>first AFS machine</secondary>
3399             </indexterm> <indexterm>
3400               <primary>files</primary>
3401
3402               <secondary>UserList</secondary>
3403             </indexterm> <indexterm>
3404               <primary>creating</primary>
3405
3406               <secondary>UserList file entry</secondary>
3407             </indexterm> <indexterm>
3408               <primary>admin account</primary>
3409
3410               <secondary>adding</secondary>
3411
3412               <tertiary>to UserList file</tertiary>
3413             </indexterm></para>
3414         </listitem>
3415
3416         <listitem>
3417           <para><anchor id="LIWQ57" />Issue the <emphasis role="bold">bos adduser</emphasis> command to add the <emphasis
3418           role="bold">admin</emphasis> user to the <emphasis role="bold">/usr/afs/etc/UserList</emphasis> file. This enables the
3419           <emphasis role="bold">admin</emphasis> user to issue privileged <emphasis role="bold">bos</emphasis> and <emphasis
3420           role="bold">vos</emphasis> commands. <programlisting>
3421    # <emphasis role="bold">./bos adduser</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
3422 </programlisting>
3423             <indexterm>
3424               <primary>commands</primary>
3425               <secondary>asetkey</secondary>
3426             </indexterm>
3427             <indexterm>
3428               <primary>creating</primary>
3429               <secondary>server encryption key</secondary>
3430               <tertiary>KeyFile file</tertiary>
3431             </indexterm>
3432             <indexterm>
3433               <primary>server encryption key</primary>
3434               <secondary>in KeyFile file</secondary>
3435             </indexterm></para>
3436         </listitem>
3437
3438         <listitem>
3439           <para><anchor id="LIWQ58" />Issue the
3440           <emphasis role="bold">asetkey</emphasis> command to set the AFS
3441           server encryption key in the
3442           <emphasis role="bold">/usr/afs/etc/KeyFile</emphasis> file. This key
3443           is created from the <emphasis role="bold">/etc/afs.keytab</emphasis>
3444           file created earlier.</para>
3445
3446           <para>asetkey requires the key version number (or kvno) of the
3447           <emphasis role="bold">afs/</emphasis><replaceable>cell</replaceable>
3448           key. You should have noted this down when creating the key earlier.
3449           The key version number can also be found by running the
3450           <emphasis role="bold">kvno</emphasis> command</para>
3451 <programlisting>
3452    # <emphasis role="bold">kvno afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3453 </programlisting>
3454
3455           <para>Once the kvno is known, the key can then be extracted using
3456           asetkey</para>
3457 <programlisting>
3458    # <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;
3459 </programlisting>
3460
3461           <indexterm>
3462             <primary>commands</primary>
3463             <secondary>bos listkeys</secondary>
3464           </indexterm>
3465
3466           <indexterm>
3467             <primary>bos commands</primary>
3468             <secondary>listkeys</secondary>
3469           </indexterm>
3470
3471           <indexterm>
3472             <primary>displaying</primary>
3473             <secondary>server encryption key</secondary>
3474             <tertiary>KeyFile file</tertiary>
3475           </indexterm>
3476         </listitem>
3477
3478         <listitem>
3479           <para><anchor id="LIWQ59" />Issue the
3480           <emphasis role="bold">bos listkeys</emphasis> command to verify that
3481           the key version number for the new key in the
3482           <emphasis role="bold">KeyFile</emphasis> file is the same as the key
3483           version number in the Authentication Database's
3484           <emphasis role="bold">afs/<replaceable>cell name</replaceable></emphasis>
3485           entry, which you displayed in Step <link linkend="LIWQ55">3</link>.
3486 <programlisting>
3487    # <emphasis role="bold">./bos listkeys</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
3488    key 0 has cksum <replaceable>checksum</replaceable>
3489 </programlisting></para>
3490
3491           <para>You can safely ignore any error messages indicating that <emphasis role="bold">bos</emphasis> failed to get tickets
3492           or that authentication failed.</para>
3493         </listitem>
3494       </orderedlist>
3495     </sect1>
3496     <sect1 id="HDRWQ53a">
3497       <title>Initializing the Protection Database</title>
3498
3499       <para>Now continue to configure your cell's security systems by
3500       populating the Protection Database with the newly created
3501       <emphasis role="bold">admin</emphasis> user, and permitting it
3502       to issue priviledged commands on the AFS filesystem.</para>
3503
3504         <orderedlist>
3505           <listitem>
3506           <indexterm>
3507             <primary>commands</primary>
3508             <secondary>pts createuser</secondary>
3509           </indexterm>
3510
3511           <indexterm>
3512             <primary>pts commands</primary>
3513             <secondary>createuser</secondary>
3514           </indexterm>
3515
3516           <indexterm>
3517             <primary>Protection Database</primary>
3518           </indexterm>
3519           <para>Issue the <emphasis role="bold">pts createuser</emphasis> command to create a Protection Database entry for the
3520           <emphasis role="bold">admin</emphasis> user.</para>
3521
3522           <para>By default, the Protection Server assigns AFS UID 1 (one) to the <emphasis role="bold">admin</emphasis> user,
3523           because it is the first user entry you are creating. If the local password file (<emphasis
3524           role="bold">/etc/passwd</emphasis> or equivalent) already has an entry for <emphasis role="bold">admin</emphasis> that
3525           assigns it a UNIX UID other than 1, it is best to use the <emphasis role="bold">-id</emphasis> argument to the <emphasis
3526           role="bold">pts createuser</emphasis> command to make the new AFS UID match the existing UNIX UID. Otherwise, it is best
3527           to accept the default.</para>
3528
3529           <programlisting>
3530    # <emphasis role="bold">pts createuser -name admin</emphasis> [<emphasis
3531               role="bold">-id</emphasis> &lt;<replaceable>AFS UID</replaceable>&gt;]  <emphasis role="bold">-noauth</emphasis>
3532    User admin has id <replaceable>AFS UID</replaceable>
3533 </programlisting>
3534
3535           <indexterm>
3536             <primary>commands</primary>
3537             <secondary>pts adduser</secondary>
3538           </indexterm>
3539
3540           <indexterm>
3541             <primary>pts commands</primary>
3542             <secondary>adduser</secondary>
3543           </indexterm>
3544
3545           <indexterm>
3546             <primary>system:administrators group</primary>
3547           </indexterm>
3548
3549           <indexterm>
3550             <primary>admin account</primary>
3551             <secondary>adding</secondary>
3552             <tertiary>to system:administrators group</tertiary>
3553           </indexterm>
3554         </listitem>
3555
3556         <listitem>
3557           <para>Issue the <emphasis role="bold">pts adduser</emphasis> command to make the <emphasis role="bold">admin</emphasis>
3558           user a member of the <emphasis role="bold">system:administrators</emphasis> group, and the <emphasis role="bold">pts
3559           membership</emphasis> command to verify the new membership. Membership in the group enables the <emphasis
3560           role="bold">admin</emphasis> user to issue privileged <emphasis role="bold">pts</emphasis> commands and some privileged
3561           <emphasis role="bold">fs</emphasis> commands. <programlisting>
3562    # <emphasis role="bold">./pts adduser admin system:administrators</emphasis> <emphasis role="bold">-noauth</emphasis>
3563    # <emphasis role="bold">./pts membership admin</emphasis> <emphasis role="bold">-noauth</emphasis>
3564    Groups admin (id: 1) is a member of:
3565      system:administrators
3566 </programlisting> <indexterm>
3567               <primary>commands</primary>
3568               <secondary>bos restart</secondary>
3569               <tertiary>on first AFS machine</tertiary>
3570             </indexterm> <indexterm>
3571               <primary>bos commands</primary>
3572               <secondary>restart</secondary>
3573               <tertiary>on first AFS machine</tertiary>
3574             </indexterm> <indexterm>
3575               <primary>restarting server process</primary>
3576               <secondary>on first AFS machine</secondary>
3577             </indexterm> <indexterm>
3578               <primary>server process</primary>
3579               <secondary>restarting</secondary>
3580               <tertiary>on first AFS machine</tertiary>
3581             </indexterm></para>
3582         </listitem>
3583
3584         <listitem>
3585           <para>Issue the <emphasis role="bold">bos restart</emphasis> command with the <emphasis role="bold">-all</emphasis> flag
3586           to restart the database server processes, so that they start using the new server encryption key. <programlisting>
3587    # <emphasis role="bold">./bos restart</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-all</emphasis>
3588    <emphasis role="bold">-noauth</emphasis>
3589 </programlisting></para>
3590         </listitem>
3591       </orderedlist>
3592
3593     <indexterm>
3594       <primary>File Server</primary>
3595
3596       <secondary>first AFS machine</secondary>
3597     </indexterm>
3598
3599     <indexterm>
3600       <primary>fileserver process</primary>
3601
3602       <see>File Server</see>
3603     </indexterm>
3604
3605     <indexterm>
3606       <primary>starting</primary>
3607
3608       <secondary>File Server</secondary>
3609
3610       <tertiary>first AFS machine</tertiary>
3611     </indexterm>
3612
3613     <indexterm>
3614       <primary>first AFS machine</primary>
3615
3616       <secondary>File Server, fs process</secondary>
3617     </indexterm>
3618
3619     <indexterm>
3620       <primary>Volume Server</primary>
3621
3622       <secondary>first AFS machine</secondary>
3623     </indexterm>
3624
3625     <indexterm>
3626       <primary>volserver process</primary>
3627
3628       <see>Volume Server</see>
3629     </indexterm>
3630
3631     <indexterm>
3632       <primary>starting</primary>
3633
3634       <secondary>Volume Server</secondary>
3635
3636       <tertiary>first AFS machine</tertiary>
3637     </indexterm>
3638
3639     <indexterm>
3640       <primary>first AFS machine</primary>
3641
3642       <secondary>Volume Server</secondary>
3643     </indexterm>
3644
3645     <indexterm>
3646       <primary>Salvager (salvager process)</primary>
3647
3648       <secondary>first AFS machine</secondary>
3649     </indexterm>
3650
3651     <indexterm>
3652       <primary>fs process</primary>
3653
3654       <secondary>first AFS machine</secondary>
3655     </indexterm>
3656
3657     <indexterm>
3658       <primary>starting</primary>
3659
3660       <secondary>fs process</secondary>
3661
3662       <tertiary>first AFS machine</tertiary>
3663     </indexterm>
3664
3665     <indexterm>
3666       <primary>first AFS machine</primary>
3667
3668       <secondary>Salvager</secondary>
3669     </indexterm>
3670   </sect1>
3671
3672   <sect1 id="HDRWQ60">
3673     <title>Starting the File Server processes</title>
3674
3675     <para>Start either the <emphasis role="bold">fs</emphasis> process or, if you want to run the Demand-Attach File Server, the
3676     <emphasis role="bold">dafs</emphasis> process. The <emphasis role="bold">fs</emphasis> process consists of the File Server,
3677     Volume Server, and Salvager (<emphasis role="bold">fileserver</emphasis>, <emphasis role="bold">volserver</emphasis> and
3678     <emphasis role="bold">salvager</emphasis> processes). The <emphasis role="bold">dafs</emphasis> process consists of the
3679     Demand-Attach File Server, Volume Server, Salvage Server, and Salvager (<emphasis role="bold">dafileserver</emphasis>,
3680     <emphasis role="bold"> davolserver</emphasis>, <emphasis role="bold">salvageserver</emphasis>, and <emphasis
3681     role="bold">dasalvager</emphasis> processes). For information about the Demand-Attach File Server and to see whether or not
3682     you should run it, see <link linkend="DAFS">Appendix C, The Demand-Attach File Server</link>.
3683      <orderedlist>
3684         <listitem>
3685           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">fs</emphasis>
3686           process or the <emphasis role="bold">dafs</emphasis> process. The commands appear here on multiple lines only for legibility.
3687
3688             <itemizedlist>
3689               <listitem>
3690                 <para>If you are not planning on running the Demand-Attach File Server, create the <emphasis role="bold">fs</emphasis>
3691                 process:
3692                   <programlisting>
3693    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs fs /usr/afs/bin/fileserver</emphasis>   \
3694                    <emphasis role="bold">/usr/afs/bin/volserver /usr/afs/bin/salvager</emphasis>  \
3695                    <emphasis role="bold">-noauth</emphasis>
3696 </programlisting></para>
3697              </listitem>
3698              <listitem>
3699                <para>If you are planning on running the Demand-Attach File Server, create the <emphasis
3700                role="bold">dafs</emphasis> process:
3701                   <programlisting>
3702    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs fs /usr/afs/bin/dafileserver</emphasis>   \
3703                    <emphasis role="bold">/usr/afs/bin/davolserver /usr/afs/bin/salvageserver</emphasis> \
3704                    <emphasis role="bold">/usr/afs/bin/salvager</emphasis> <emphasis role="bold">-noauth</emphasis>
3705 </programlisting></para>
3706              </listitem>
3707             </itemizedlist>
3708           </para>
3709
3710           <para>Sometimes a message about Volume Location Database (VLDB) initialization appears, along with one or more instances
3711           of an error message similar to the following:</para>
3712
3713           <programlisting>
3714    FSYNC_clientInit temporary failure (will retry)
3715 </programlisting>
3716
3717           <para>This message appears when the <emphasis role="bold">volserver</emphasis> process tries to start before the <emphasis
3718           role="bold">fileserver</emphasis> process has completed its initialization. Wait a few minutes after the last such message
3719           before continuing, to guarantee that both processes have started successfully. <indexterm>
3720               <primary>commands</primary>
3721
3722               <secondary>bos status</secondary>
3723             </indexterm> <indexterm>
3724               <primary>bos commands</primary>
3725
3726               <secondary>status</secondary>
3727             </indexterm></para>
3728
3729           <para>You can verify that the <emphasis role="bold">fs</emphasis> or <emphasis role="bold">dafs</emphasis> process has started
3730           successfully by issuing the <emphasis role="bold">bos status</emphasis> command. Its output mentions two <computeroutput>proc
3731           starts</computeroutput>.</para>
3732
3733           <itemizedlist>
3734             <listitem>
3735               <para>If you are not running the Demand-Attach File Server:
3736
3737           <programlisting>
3738    # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs -long -noauth</emphasis>
3739 </programlisting></para></listitem>
3740
3741             <listitem>
3742               <para>If you are running the Demand-Attach File Server:
3743           <programlisting>
3744    # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">dafs -long -noauth</emphasis>
3745 </programlisting></para></listitem>
3746           </itemizedlist>
3747
3748         </listitem>
3749
3750         <listitem>
3751           <para>Your next action depends on whether you have ever run AFS file server machines in the cell: <itemizedlist>
3752               <indexterm>
3753                 <primary>commands</primary>
3754
3755                 <secondary>vos create</secondary>
3756
3757                 <tertiary>root.afs volume</tertiary>
3758               </indexterm>
3759
3760               <indexterm>
3761                 <primary>vos commands</primary>
3762
3763                 <secondary>create</secondary>
3764
3765                 <tertiary>root.afs volume</tertiary>
3766               </indexterm>
3767
3768               <indexterm>
3769                 <primary>root.afs volume</primary>
3770
3771                 <secondary>creating</secondary>
3772               </indexterm>
3773
3774               <indexterm>
3775                 <primary>volume</primary>
3776
3777                 <secondary>creating</secondary>
3778
3779                 <tertiary>root.afs</tertiary>
3780               </indexterm>
3781
3782               <indexterm>
3783                 <primary>creating</primary>
3784
3785                 <secondary>root.afs volume</secondary>
3786               </indexterm>
3787
3788               <listitem>
3789                 <para>If you are installing the first AFS server machine ever in the cell (that is, you are not upgrading the AFS
3790                 software from a previous version), create the first AFS volume, <emphasis role="bold">root.afs</emphasis>.</para>
3791
3792                 <para>For the <replaceable>partition name</replaceable> argument, substitute the name of one of the machine's AFS
3793                 server partitions (such as <emphasis role="bold">/vicepa</emphasis>).</para>
3794
3795                 <programlisting>
3796    # <emphasis role="bold">./vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
3797                     role="bold">root.afs</emphasis>   \
3798                    <emphasis role="bold">-noauth</emphasis>
3799 </programlisting>
3800
3801                 <para>The Volume Server produces a message confirming that it created the volume on the specified partition. You can
3802                 ignore error messages indicating that tokens are missing, or that authentication failed. <indexterm>
3803                     <primary>commands</primary>
3804
3805                     <secondary>vos syncvldb</secondary>
3806                   </indexterm> <indexterm>
3807                     <primary>vos commands</primary>
3808
3809                     <secondary>syncvldb</secondary>
3810                   </indexterm> <indexterm>
3811                     <primary>commands</primary>
3812
3813                     <secondary>vos syncserv</secondary>
3814                   </indexterm> <indexterm>
3815                     <primary>vos commands</primary>
3816
3817                     <secondary>syncserv</secondary>
3818                   </indexterm></para>
3819               </listitem>
3820
3821               <listitem>
3822                 <para>If there are existing AFS file server machines and volumes in the cell, issue the <emphasis role="bold">vos
3823                 syncvldb</emphasis> and <emphasis role="bold">vos syncserv</emphasis> commands to synchronize the VLDB with the
3824                 actual state of volumes on the local machine. To follow the progress of the synchronization operation, which can
3825                 take several minutes, use the <emphasis role="bold">-verbose</emphasis> flag. <programlisting>
3826    # <emphasis role="bold">./vos syncvldb</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
3827                       role="bold">-verbose  -noauth</emphasis>
3828    # <emphasis role="bold">./vos syncserv</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
3829                       role="bold">-verbose  -noauth</emphasis>
3830 </programlisting></para>
3831
3832                 <para>You can ignore error messages indicating that tokens are missing, or that authentication failed.</para>
3833               </listitem>
3834             </itemizedlist></para>
3835         </listitem>
3836       </orderedlist></para>
3837
3838     <indexterm>
3839       <primary>Update Server</primary>
3840
3841       <secondary>starting server portion</secondary>
3842
3843       <tertiary>first AFS machine</tertiary>
3844     </indexterm>
3845
3846     <indexterm>
3847       <primary>upserver process</primary>
3848
3849       <see>Update Server</see>
3850     </indexterm>
3851
3852     <indexterm>
3853       <primary>starting</primary>
3854
3855       <secondary>Update Server server portion</secondary>
3856
3857       <tertiary>first AFS machine</tertiary>
3858     </indexterm>
3859
3860     <indexterm>
3861       <primary>first AFS machine</primary>
3862
3863       <secondary>Update Server server portion</secondary>
3864     </indexterm>
3865
3866     <indexterm>
3867       <primary>first AFS machine</primary>
3868
3869       <secondary>defining</secondary>
3870
3871       <tertiary>as binary distribution machine</tertiary>
3872     </indexterm>
3873
3874     <indexterm>
3875       <primary>first AFS machine</primary>
3876
3877       <secondary>defining</secondary>
3878
3879       <tertiary>as system control machine</tertiary>
3880     </indexterm>
3881
3882     <indexterm>
3883       <primary>system control machine</primary>
3884     </indexterm>
3885
3886     <indexterm>
3887       <primary>binary distribution machine</primary>
3888     </indexterm>
3889   </sect1>
3890
3891   <sect1 id="HDRWQ61">
3892     <title>Starting the Server Portion of the Update Server</title>
3893
3894     <para>Start the server portion of the Update Server (the <emphasis role="bold">upserver</emphasis> process), to distribute the
3895     contents of directories on this machine to other server machines in the cell. It becomes active when you configure the client
3896     portion of the Update Server on additional server machines.</para>
3897
3898     <para>Distributing the contents of its <emphasis role="bold">/usr/afs/etc</emphasis> directory makes this machine the cell's
3899     <emphasis>system control machine</emphasis>. The other server machines in the cell run the <emphasis
3900     role="bold">upclientetc</emphasis> process (an instance of the client portion of the Update Server) to retrieve the
3901     configuration files. Use the <emphasis role="bold">-crypt</emphasis> argument to the <emphasis role="bold">upserver</emphasis>
3902     initialization command to specify that the Update Server distributes the contents of the <emphasis
3903     role="bold">/usr/afs/etc</emphasis> directory only in encrypted form, as shown in the following instruction. Several of the
3904     files in the directory, particularly the <emphasis role="bold">KeyFile</emphasis> file, are crucial to cell security and so must
3905     never cross the network unencrypted.</para>
3906
3907     <para>(You can choose not to configure a system control machine, in which case you must update the configuration files in each
3908     server machine's <emphasis role="bold">/usr/afs/etc</emphasis> directory individually. The <emphasis role="bold">bos</emphasis>
3909     commands used for this purpose also encrypt data before sending it across the network.)</para>
3910
3911     <para>Distributing the contents of its <emphasis role="bold">/usr/afs/bin</emphasis> directory to other server machines of its
3912     system type makes this machine a <emphasis>binary distribution machine</emphasis>. The other server machines of its system type
3913     run the <emphasis role="bold">upclientbin</emphasis> process (an instance of the client portion of the Update Server) to
3914     retrieve the binaries. If your platform has a package management system,
3915     such as 'rpm' or 'apt', running the Update Server to distribute binaries
3916     may interfere with this system.</para>
3917
3918     <para>The binaries in the <emphasis role="bold">/usr/afs/bin</emphasis> directory are not sensitive, so it is not necessary to
3919     encrypt them before transfer across the network. Include the <emphasis role="bold">-clear</emphasis> argument to the <emphasis
3920     role="bold">upserver</emphasis> initialization command to specify that the Update Server distributes the contents of the
3921     <emphasis role="bold">/usr/afs/bin</emphasis> directory in unencrypted form unless an <emphasis
3922     role="bold">upclientbin</emphasis> process requests encrypted transfer.</para>
3923
3924     <para>Note that the server and client portions of the Update Server always mutually authenticate with one another, regardless of
3925     whether you use the <emphasis role="bold">-clear</emphasis> or <emphasis role="bold">-crypt</emphasis> arguments. This protects
3926     their communications from eavesdropping to some degree.</para>
3927
3928     <para>For more information on the <emphasis role="bold">upclient</emphasis> and <emphasis role="bold">upserver</emphasis>
3929     processes, see their reference pages in the <emphasis>OpenAFS Administration Reference</emphasis>. The commands appear on
3930     multiple lines here only for legibility. <orderedlist>
3931         <listitem>
3932           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">upserver</emphasis>
3933           process. <programlisting>
3934    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name&gt;</replaceable> <emphasis role="bold">upserver simple</emphasis>  \
3935              <emphasis role="bold">"/usr/afs/bin/upserver  -crypt /usr/afs/etc</emphasis>    \
3936              <emphasis role="bold">-clear /usr/afs/bin"</emphasis> <emphasis role="bold">-noauth</emphasis>
3937 </programlisting></para>
3938         </listitem>
3939       </orderedlist></para>
3940   </sect1>
3941
3942   <sect1 id="HDRWQ62">
3943     <title>Starting the Controller for NTPD</title>
3944
3945     <para>Keeping the clocks on all server and client machines in your cell synchronized is crucial to several functions, and in
3946     particular to the correct operation of AFS's distributed database technology, Ubik. The chapter in the <emphasis>OpenAFS
3947     Administration Guide</emphasis> about administering server machines explains how time skew can disturb Ubik's performance and
3948     cause service outages in your cell.</para>
3949
3950     <para>Historically, AFS used to distribute its own version of the Network
3951 Time Protocol Daemon. Whilst this is still provided for existing sites, we
3952 recommend that you configure and install your time service independently of
3953 AFS. A reliable timeservice will also be required by your Kerberos realm,
3954 and so may already be available at your site.</para>
3955
3956     <indexterm>
3957       <primary>overview</primary>
3958
3959       <secondary>installing client functionality on first machine</secondary>
3960     </indexterm>
3961
3962     <indexterm>
3963       <primary>first AFS machine</primary>
3964
3965       <secondary>client functionality</secondary>
3966
3967       <tertiary>installing</tertiary>
3968     </indexterm>
3969
3970     <indexterm>
3971       <primary>installing</primary>
3972
3973       <secondary>client functionality</secondary>
3974
3975       <tertiary>first AFS machine</tertiary>
3976     </indexterm>
3977   </sect1>
3978
3979   <sect1 id="HDRWQ63">
3980     <title>Overview: Installing Client Functionality</title>
3981
3982     <para>The machine you are installing is now an AFS file server machine,
3983     database server machine, system control machine, and binary distribution
3984     machine. Now make it a client machine by completing the following tasks:
3985     <orderedlist>
3986         <listitem>
3987           <para>Define the machine's cell membership for client processes</para>
3988         </listitem>
3989
3990         <listitem>
3991           <para>Create the client version of the <emphasis role="bold">CellServDB</emphasis> file</para>
3992         </listitem>
3993
3994         <listitem>
3995           <para>Define cache location and size</para>
3996         </listitem>
3997
3998         <listitem>
3999           <para>Create the <emphasis role="bold">/afs</emphasis> directory and start the Cache Manager</para>
4000         </listitem>
4001       </orderedlist></para>
4002
4003     <indexterm>
4004       <primary>Distribution</primary>
4005
4006       <secondary>copying client files from</secondary>
4007
4008       <tertiary>first AFS machine</tertiary>
4009     </indexterm>
4010
4011     <indexterm>
4012       <primary>first AFS machine</primary>
4013
4014       <secondary>copying</secondary>
4015
4016       <tertiary>client files to local disk</tertiary>
4017     </indexterm>
4018
4019     <indexterm>
4020       <primary>copying</primary>
4021
4022       <secondary>client files to local disk</secondary>
4023
4024       <tertiary>first AFS machine</tertiary>
4025     </indexterm>
4026   </sect1>
4027
4028   <sect1 id="HDRWQ64">
4029     <title>Copying Client Files to the Local Disk</title>
4030
4031     <para>You need only undertake the steps in this section, if you are using
4032     a tar file distribution, or one built from scratch. Packaged distributions,
4033     such as RPMs or DEBs will already have installed the necessary files in
4034     the correct locations.</para>
4035
4036     <para>Before installing and configuring the AFS client, copy the necessary files from the tarball to the local <emphasis
4037     role="bold">/usr/vice/etc</emphasis> directory. <orderedlist>
4038         <listitem>
4039           <para>If you have not already done so, unpack the distribution
4040           tarball for this machine's system type into a suitable location on
4041           the filesystem, such as <emphasis role="bold">/tmp/afsdist</emphasis>.
4042           If you use a different location, substitue that in the examples that
4043           follow.</para>
4044         </listitem>
4045
4046         <listitem>
4047           <para>Copy files to the local <emphasis role="bold">/usr/vice/etc</emphasis> directory.</para>
4048
4049           <para>This step places a copy of the AFS initialization script (and related files, if applicable) into the <emphasis
4050           role="bold">/usr/vice/etc</emphasis> directory. In the preceding instructions for incorporating AFS into the kernel, you
4051           copied the script directly to the operating system's conventional location for initialization files. When you incorporate
4052           AFS into the machine's startup sequence in a later step, you can choose to link the two files.</para>
4053
4054           <para>On some system types that use a dynamic kernel loader program, you previously copied AFS library files into a
4055           subdirectory of the <emphasis role="bold">/usr/vice/etc</emphasis> directory. On other system types, you copied the
4056           appropriate AFS library file directly to the directory where the operating system accesses it. The following commands do
4057           not copy or recopy the AFS library files into the <emphasis role="bold">/usr/vice/etc</emphasis> directory, because on
4058           some system types the library files consume a large amount of space. If you want to copy them, add the <emphasis
4059           role="bold">-r</emphasis> flag to the first <emphasis role="bold">cp</emphasis> command and skip the second <emphasis
4060           role="bold">cp</emphasis> command.</para>
4061
4062           <programlisting>
4063    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.client/usr/vice/etc</emphasis>
4064    # <emphasis role="bold">cp -p  *  /usr/vice/etc</emphasis>
4065    # <emphasis role="bold">cp -rp  C  /usr/vice/etc</emphasis>
4066 </programlisting>
4067         </listitem>
4068       </orderedlist></para>
4069
4070     <indexterm>
4071       <primary>cell name</primary>
4072
4073       <secondary>setting in client ThisCell file</secondary>
4074
4075       <tertiary>first AFS machine</tertiary>
4076     </indexterm>
4077
4078     <indexterm>
4079       <primary>setting</primary>
4080
4081       <secondary>cell name in client ThisCell file</secondary>
4082
4083       <tertiary>first AFS machine</tertiary>
4084     </indexterm>
4085
4086     <indexterm>
4087       <primary>first AFS machine</primary>
4088
4089       <secondary>ThisCell file (client)</secondary>
4090     </indexterm>
4091
4092     <indexterm>
4093       <primary>first AFS machine</primary>
4094
4095       <secondary>cell membership, defining</secondary>
4096
4097       <tertiary>for client processes</tertiary>
4098     </indexterm>
4099
4100     <indexterm>
4101       <primary>usr/vice/etc/ThisCell</primary>
4102
4103       <see>ThisCell file (client)</see>
4104     </indexterm>
4105
4106     <indexterm>
4107       <primary>ThisCell file (client)</primary>
4108
4109       <secondary>first AFS machine</secondary>
4110     </indexterm>
4111
4112     <indexterm>
4113       <primary>files</primary>
4114
4115       <secondary>ThisCell (client)</secondary>
4116     </indexterm>
4117   </sect1>
4118
4119   <sect1 id="HDRWQ65">
4120     <title>Defining Cell Membership for Client Processes</title>
4121
4122     <para>Every AFS client machine has a copy of the <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> file on its local disk
4123     to define the machine's cell membership for the AFS client programs that run on it. The <emphasis
4124     role="bold">ThisCell</emphasis> file you created in the <emphasis role="bold">/usr/afs/etc</emphasis> directory (in <link
4125     linkend="HDRWQ51">Defining Cell Name and Membership for Server Processes</link>) is used only by server processes.</para>
4126
4127     <para>Among other functions, the <emphasis role="bold">ThisCell</emphasis> file on a client machine determines the following:
4128     <itemizedlist>
4129         <listitem>
4130           <para>The cell in which users gain tokens when they log onto the
4131           machine, assuming it is using an AFS-modified login utility</para>
4132         </listitem>
4133
4134         <listitem>
4135           <para>The cell in which users gain tokens by default when they issue
4136           the <emphasis role="bold">aklog</emphasis> command</para>
4137         </listitem>
4138
4139         <listitem>
4140           <para>The cell membership of the AFS server processes that the AFS
4141           command interpreters on this machine contact by default</para>
4142         </listitem>
4143       </itemizedlist>
4144     <orderedlist>
4145         <listitem>
4146           <para>Change to the <emphasis role="bold">/usr/vice/etc</emphasis> directory and remove the symbolic link created in <link
4147           linkend="HDRWQ50">Starting the BOS Server</link>. <programlisting>
4148    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
4149    # <emphasis role="bold">rm ThisCell</emphasis>
4150 </programlisting></para>
4151         </listitem>
4152
4153         <listitem>
4154           <para>Create the <emphasis role="bold">ThisCell</emphasis> file as a copy of the <emphasis
4155           role="bold">/usr/afs/etc/ThisCell</emphasis> file. Defining the same local cell for both server and client processes leads
4156           to the most consistent AFS performance. <programlisting>
4157    # <emphasis role="bold">cp  /usr/afs/etc/ThisCell  ThisCell</emphasis>
4158 </programlisting></para>
4159         </listitem>
4160       </orderedlist></para>
4161
4162     <indexterm>
4163       <primary>database server machine</primary>
4164
4165       <secondary>entry in client CellServDB file</secondary>
4166
4167       <tertiary>on first AFS machine</tertiary>
4168     </indexterm>
4169
4170     <indexterm>
4171       <primary>usr/vice/etc/CellServDB</primary>
4172
4173       <see>CellServDB file (client)</see>
4174     </indexterm>
4175
4176     <indexterm>
4177       <primary>CellServDB file (client)</primary>
4178
4179       <secondary>creating</secondary>
4180
4181       <tertiary>on first AFS machine</tertiary>
4182     </indexterm>
4183
4184     <indexterm>
4185       <primary>creating</primary>
4186
4187       <secondary>CellServDB file (client)</secondary>
4188
4189       <tertiary>first AFS machine</tertiary>
4190     </indexterm>
4191
4192     <indexterm>
4193       <primary>CellServDB file (client)</primary>
4194
4195       <secondary>required format</secondary>
4196     </indexterm>
4197
4198     <indexterm>
4199       <primary>requirements</primary>
4200
4201       <secondary>CellServDB file format (client version)</secondary>
4202     </indexterm>
4203
4204     <indexterm>
4205       <primary>files</primary>
4206
4207       <secondary>CellServDB (client)</secondary>
4208     </indexterm>
4209
4210     <indexterm>
4211       <primary>first AFS machine</primary>
4212
4213       <secondary>CellServDB file (client)</secondary>
4214     </indexterm>
4215   </sect1>
4216
4217   <sect1 id="HDRWQ66">
4218     <title>Creating the Client CellServDB File</title>
4219
4220     <para>The <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on a client machine's local disk lists the database
4221     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
4222     list of database server machines is wrong, then users working on this machine cannot access the cell. The chapter in the
4223     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines explains how to maintain the file after
4224     creating it.</para>
4225
4226     <para>As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it copies the contents of the
4227     <emphasis role="bold">CellServDB</emphasis> file into kernel memory. The Cache Manager always consults the list in kernel memory
4228     rather than the <emphasis role="bold">CellServDB</emphasis> file itself. Between reboots of the machine, you can use the
4229     <emphasis role="bold">fs newcell</emphasis> command to update the list in kernel memory directly; see the chapter in the
4230     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines.</para>
4231
4232     <para>The AFS distribution includes the file
4233     <emphasis role="bold">CellServDB.dist</emphasis>. It includes an entry for
4234     all AFS cells that agreed to share their database server machine
4235     information at the time the distribution was
4236     created. The definitive copy of this file is maintained at
4237     grand.central.org, and updates may be obtained from
4238     /afs/grand.central.org/service/CellServDB or
4239     <ulink url="http://grand.central.org/dl/cellservdb/CellServDB">
4240     http://grand.central.org/dl/cellservdb/CellServDB</ulink></para>
4241
4242     <para>The <emphasis role="bold">CellServDB.dist</emphasis> file can be a
4243     good basis for the client <emphasis role="bold">CellServDB</emphasis> file,
4244     because all of the entries in it use the correct format. You can add or
4245     remove cell entries as you see fit. Depending on your cache manager
4246     configuration, additional steps (as detailed in
4247     <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>) may be
4248     required to enable the Cache Manager to actually reach the cells.</para>
4249
4250     <para>In this section, you add an entry for the local cell to the local <emphasis role="bold">CellServDB</emphasis> file. The
4251     current working directory is still <emphasis role="bold">/usr/vice/etc</emphasis>. <orderedlist>
4252         <listitem>
4253           <para>Remove the symbolic link created in <link linkend="HDRWQ50">Starting the BOS Server</link> and rename the <emphasis
4254           role="bold">CellServDB.sample</emphasis> file to <emphasis role="bold">CellServDB</emphasis>. <programlisting>
4255    # <emphasis role="bold">rm CellServDB</emphasis>
4256    # <emphasis role="bold">mv CellServDB.sample CellServDB</emphasis>
4257 </programlisting></para>
4258         </listitem>
4259
4260         <listitem>
4261           <para>Add an entry for the local cell to the <emphasis role="bold">CellServDB</emphasis> file. One easy method is to use
4262           the <emphasis role="bold">cat</emphasis> command to append the contents of the server <emphasis
4263           role="bold">/usr/afs/etc/CellServDB</emphasis> file to the client version. <programlisting>
4264     # <emphasis role="bold">cat  /usr/afs/etc/CellServDB &gt;&gt;  CellServDB</emphasis>
4265 </programlisting></para>
4266
4267           <para>Then open the file in a text editor to verify that there are no blank lines, and that all entries have the required
4268           format, which is described just following. The ordering of cells is not significant, but it can be convenient to have the
4269           client machine's home cell at the top; move it there now if you wish. <itemizedlist>
4270               <listitem>
4271                 <para>The first line of a cell's entry has the following format: <programlisting>
4272    &gt;<replaceable>cell_name</replaceable>      #<replaceable>organization</replaceable>
4273 </programlisting></para>
4274
4275                 <para>where <replaceable>cell_name</replaceable> is the cell's complete Internet domain name (for example, <emphasis
4276                 role="bold">example.com</emphasis>) and <replaceable>organization</replaceable> is an optional field that follows any
4277                 number of spaces and the number sign (<computeroutput>#</computeroutput>). By convention it names the organization
4278                 to which the cell corresponds (for example, the Example Corporation).</para>
4279               </listitem>
4280
4281               <listitem>
4282                 <para>After the first line comes a separate line for each database server machine. Each line has the following
4283                 format: <programlisting>
4284    <replaceable>IP_address</replaceable>   #<replaceable>machine_name</replaceable>
4285 </programlisting></para>
4286
4287                 <para>where <replaceable>IP_address</replaceable> is the machine's IP address in dotted decimal format (for example,
4288                 192.12.105.3). Following any number of spaces and the number sign (<computeroutput>#</computeroutput>) is
4289                 <replaceable>machine_name</replaceable>, the machine's fully-qualified hostname (for example, <emphasis
4290                 role="bold">db1.example.com</emphasis>). In this case, the number sign does not indicate a comment;
4291                 <replaceable>machine_name</replaceable> is a required field.</para>
4292               </listitem>
4293             </itemizedlist></para>
4294         </listitem>
4295
4296         <listitem>
4297           <para>If the file includes cells that you do not wish users of this machine to access, remove their entries.</para>
4298         </listitem>
4299       </orderedlist></para>
4300
4301     <para>The following example shows entries for two cells, each of which has three database server machines:</para>
4302
4303     <programlisting>
4304    &gt;example.com       #Example Corporation (home cell)
4305    192.12.105.3      #db1.example.com
4306    192.12.105.4      #db2.example.com
4307    192.12.105.55     #db3.example.com
4308    &gt;stateu.edu    #State University cell
4309    138.255.68.93     #serverA.stateu.edu
4310    138.255.68.72     #serverB.stateu.edu
4311    138.255.33.154    #serverC.stateu.edu
4312 </programlisting>
4313
4314     <indexterm>
4315       <primary>cache</primary>
4316
4317       <secondary>configuring</secondary>
4318
4319       <tertiary>first AFS machine</tertiary>
4320     </indexterm>
4321
4322     <indexterm>
4323       <primary>configuring</primary>
4324
4325       <secondary>cache</secondary>
4326
4327       <tertiary>first AFS machine</tertiary>
4328     </indexterm>
4329
4330     <indexterm>
4331       <primary>setting</primary>
4332
4333       <secondary>cache size and location</secondary>
4334
4335       <tertiary>first AFS machine</tertiary>
4336     </indexterm>
4337
4338     <indexterm>
4339       <primary>first AFS machine</primary>
4340
4341       <secondary>cache size and location</secondary>
4342     </indexterm>
4343   </sect1>
4344
4345   <sect1 id="HDRWQ67">
4346     <title>Configuring the Cache</title>
4347
4348     <para>The Cache Manager uses a cache on the local disk or in machine memory to store local copies of files fetched from file
4349     server machines. As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it sets basic cache
4350     configuration parameters according to definitions in the local <emphasis role="bold">/usr/vice/etc/cacheinfo</emphasis> file.
4351     The file has three fields: <orderedlist>
4352         <listitem>
4353           <para>The first field names the local directory on which to mount the AFS filespace. The conventional location is the
4354           <emphasis role="bold">/afs</emphasis> directory.</para>
4355         </listitem>
4356
4357         <listitem>
4358           <para>The second field defines the local disk directory to use for the disk cache. The conventional location is the
4359           <emphasis role="bold">/usr/vice/cache</emphasis> directory, but you can specify an alternate directory if another
4360           partition has more space available. There must always be a value in this field, but the Cache Manager ignores it if the
4361           machine uses a memory cache.</para>
4362         </listitem>
4363
4364         <listitem>
4365           <para>The third field specifies the number of kilobyte (1024 byte) blocks to allocate for the cache.</para>
4366         </listitem>
4367       </orderedlist></para>
4368
4369     <para>The values you define must meet the following requirements. <itemizedlist>
4370         <listitem>
4371           <para>On a machine using a disk cache, the Cache Manager expects always to be able to use the amount of space specified in
4372           the third field. Failure to meet this requirement can cause serious problems, some of which can be repaired only by
4373           rebooting. You must prevent non-AFS processes from filling up the cache partition. The simplest way is to devote a
4374           partition to the cache exclusively.</para>
4375         </listitem>
4376
4377         <listitem>
4378           <para>The amount of space available in memory or on the partition housing the disk cache directory imposes an absolute
4379           limit on cache size.</para>
4380         </listitem>
4381
4382         <listitem>
4383           <para>The maximum supported cache size can vary in each AFS release; see the <emphasis>OpenAFS Release Notes</emphasis>
4384           for the current version.</para>
4385         </listitem>
4386
4387         <listitem>
4388           <para>For a disk cache, you cannot specify a value in the third field that exceeds 95% of the space available on the
4389           partition mounted at the directory named in the second field. If you violate this restriction, the <emphasis
4390           role="bold">afsd</emphasis> program exits without starting the Cache Manager and prints an appropriate message on the
4391           standard output stream. A value of 90% is more appropriate on most machines. Some operating systems (such as AIX) do not
4392           automatically reserve some space to prevent the partition from filling completely; for them, a smaller value (say, 80% to
4393           85% of the space available) is more appropriate.</para>
4394         </listitem>
4395
4396         <listitem>
4397           <para>For a memory cache, you must leave enough memory for other processes and applications to run. If you try to allocate
4398           more memory than is actually available, the <emphasis role="bold">afsd</emphasis> program exits without initializing the
4399           Cache Manager and produces the following message on the standard output stream. <programlisting>
4400    afsd: memCache allocation failure at <replaceable>number</replaceable> KB
4401 </programlisting></para>
4402
4403           <para>The <replaceable>number</replaceable> value is how many kilobytes were allocated just before the failure, and so
4404           indicates the approximate amount of memory available.</para>
4405         </listitem>
4406       </itemizedlist></para>
4407
4408     <para>Within these hard limits, the factors that determine appropriate cache size include the number of users working on the
4409     machine, the size of the files with which they work, and (for a memory cache) the number of processes that run on the machine.
4410     The higher the demand from these factors, the larger the cache needs to be to maintain good performance.</para>
4411
4412     <para>Disk caches smaller than 10 MB do not generally perform well. Machines serving multiple users usually perform better with
4413     a cache of at least 60 to 70 MB. The point at which enlarging the cache further does not really improve performance depends on
4414     the factors mentioned previously and is difficult to predict.</para>
4415
4416     <para>Memory caches smaller than 1 MB are nonfunctional, and the performance of caches smaller than 5 MB is usually
4417     unsatisfactory. Suitable upper limits are similar to those for disk caches but are probably determined more by the demands on
4418     memory from other sources on the machine (number of users and processes). Machines running only a few processes possibly can use
4419     a smaller memory cache.</para>
4420
4421     <sect2 id="HDRWQ68">
4422       <title>Configuring a Disk Cache</title>
4423
4424       <note>
4425         <para>Not all file system types that an operating system supports are necessarily supported for use as the cache partition.
4426         For possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
4427       </note>
4428
4429       <para>To configure the disk cache, perform the following procedures: <orderedlist>
4430           <listitem>
4431             <para>Create the local directory to use for caching. The following instruction shows the conventional location,
4432             <emphasis role="bold">/usr/vice/cache</emphasis>. If you are devoting a partition exclusively to caching, as
4433             recommended, you must also configure it, make a file system on it, and mount it at the directory created in this step.
4434             <programlisting>
4435    # <emphasis role="bold">mkdir /usr/vice/cache</emphasis>
4436 </programlisting></para>
4437           </listitem>
4438
4439           <listitem>
4440             <para>Create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration parameters discussed
4441             previously. The following instruction shows the standard mount location, <emphasis role="bold">/afs</emphasis>, and the
4442             standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis>. <programlisting>
4443    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
4444 </programlisting></para>
4445
4446             <para>The following example defines the disk cache size as 50,000 KB:</para>
4447
4448             <programlisting>
4449    # <emphasis role="bold">echo "/afs:/usr/vice/cache:50000" &gt; /usr/vice/etc/cacheinfo</emphasis>
4450 </programlisting>
4451           </listitem>
4452         </orderedlist></para>
4453     </sect2>
4454
4455     <sect2 id="HDRWQ69">
4456       <title>Configuring a Memory Cache</title>
4457
4458       <para>To configure a memory cache, create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration
4459       parameters discussed previously. The following instruction shows the standard mount location, <emphasis
4460       role="bold">/afs</emphasis>, and the standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis> (though the
4461       exact value of the latter is irrelevant for a memory cache).</para>
4462
4463       <programlisting>
4464    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
4465 </programlisting>
4466
4467       <para>The following example allocates 25,000 KB of memory for the cache.</para>
4468
4469       <programlisting>
4470    # <emphasis role="bold">echo "/afs:/usr/vice/cache:25000" &gt; /usr/vice/etc/cacheinfo</emphasis>
4471 </programlisting>
4472
4473       <indexterm>
4474         <primary>Cache Manager</primary>
4475
4476         <secondary>first AFS machine</secondary>
4477       </indexterm>
4478
4479       <indexterm>
4480         <primary>configuring</primary>
4481
4482         <secondary>Cache Manager</secondary>
4483
4484         <tertiary>first AFS machine</tertiary>
4485       </indexterm>
4486
4487       <indexterm>
4488         <primary>first AFS machine</primary>
4489
4490         <secondary>Cache Manager</secondary>
4491       </indexterm>
4492
4493       <indexterm>
4494         <primary>afs (/afs) directory</primary>
4495
4496         <secondary>creating</secondary>
4497
4498         <tertiary>first AFS machine</tertiary>
4499       </indexterm>
4500
4501       <indexterm>
4502         <primary>AFS initialization script</primary>
4503
4504         <secondary>setting afsd parameters</secondary>
4505
4506         <tertiary>first AFS machine</tertiary>
4507       </indexterm>
4508
4509       <indexterm>
4510         <primary>first AFS machine</primary>
4511
4512         <secondary>afsd command parameters</secondary>
4513       </indexterm>
4514     </sect2>
4515   </sect1>
4516
4517   <sect1 id="HDRWQ70">
4518     <title>Configuring the Cache Manager</title>
4519
4520     <para>By convention, the Cache Manager mounts the AFS filespace on the local <emphasis role="bold">/afs</emphasis> directory. In
4521     this section you create that directory.</para>
4522
4523     <para>The <emphasis role="bold">afsd</emphasis> program sets several cache configuration parameters as it initializes the Cache
4524     Manager, and starts daemons that improve performance. You can use the <emphasis role="bold">afsd</emphasis> command's arguments
4525     to override the parameters' default values and to change the number of some of the daemons. Depending on the machine's cache
4526     size, its amount of RAM, and how many people work on it, you can sometimes improve Cache Manager performance by overriding the
4527     default values. For a discussion of all of the <emphasis role="bold">afsd</emphasis> command's arguments, see its reference page
4528     in the <emphasis>OpenAFS Administration Reference</emphasis>.</para>
4529
4530     <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
4531     <computeroutput>OPTIONS</computeroutput> variable. You can use it to set nondefault values for the command's arguments, in one
4532     of the following ways: <itemizedlist>
4533         <listitem>
4534           <para>You can create an <emphasis role="bold">afsd</emphasis> <emphasis>options file</emphasis> that sets values for
4535           arguments to the <emphasis role="bold">afsd</emphasis> command. If the file exists, its contents are automatically
4536           substituted for the <computeroutput>OPTIONS</computeroutput> variable in the AFS initialization script. The AFS
4537           distribution for some system types includes an options file; on other system types, you must create it.</para>
4538
4539           <para>You use two variables in the AFS initialization script to specify the path to the options file:
4540           <computeroutput>CONFIG</computeroutput> and <computeroutput>AFSDOPT</computeroutput>. On system types that define a
4541           conventional directory for configuration files, the <computeroutput>CONFIG</computeroutput> variable indicates it by
4542           default; otherwise, the variable indicates an appropriate location.</para>
4543
4544           <para>List the desired <emphasis role="bold">afsd</emphasis> options on a single line in the options file, separating each
4545           option with one or more spaces. The following example sets the <emphasis role="bold">-stat</emphasis> argument to 2500,
4546           the <emphasis role="bold">-daemons</emphasis> argument to 4, and the <emphasis role="bold">-volumes</emphasis> argument to
4547           100.</para>
4548
4549           <programlisting>
4550    -stat 2500 -daemons 4 -volumes 100
4551 </programlisting>
4552         </listitem>
4553
4554         <listitem>
4555           <para>On a machine that uses a disk cache, you can set the <computeroutput>OPTIONS</computeroutput> variable in the AFS
4556           initialization script to one of <computeroutput>$SMALL</computeroutput>, <computeroutput>$MEDIUM</computeroutput>, or
4557           <computeroutput>$LARGE</computeroutput>. The AFS initialization script uses one of these settings if the <emphasis
4558           role="bold">afsd</emphasis> options file named by the <computeroutput>AFSDOPT</computeroutput> variable does not exist. In
4559           the script as distributed, the <computeroutput>OPTIONS</computeroutput> variable is set to the value
4560           <computeroutput>$MEDIUM</computeroutput>.</para>
4561
4562           <note>
4563             <para>Do not set the <computeroutput>OPTIONS</computeroutput> variable to <computeroutput>$SMALL</computeroutput>,
4564             <computeroutput>$MEDIUM</computeroutput>, or <computeroutput>$LARGE</computeroutput> on a machine that uses a memory
4565             cache. The arguments it sets are appropriate only on a machine that uses a disk cache.</para>
4566           </note>
4567
4568           <para>The script (or on some system types the <emphasis role="bold">afsd</emphasis> options file named by the
4569           <computeroutput>AFSDOPT</computeroutput> variable) defines a value for each of <computeroutput>SMALL</computeroutput>,
4570           <computeroutput>MEDIUM</computeroutput>, and <computeroutput>LARGE</computeroutput> that sets <emphasis
4571           role="bold">afsd</emphasis> command arguments appropriately for client machines of different sizes: <itemizedlist>
4572               <listitem>
4573                 <para><computeroutput>SMALL</computeroutput> is suitable for a small machine that serves one or two users and has
4574                 approximately 8 MB of RAM and a 20-MB cache</para>
4575               </listitem>
4576
4577               <listitem>
4578                 <para><computeroutput>MEDIUM</computeroutput> is suitable for a medium-sized machine that serves two to six users
4579                 and has 16 MB of RAM and a 40-MB cache</para>
4580               </listitem>
4581
4582               <listitem>
4583                 <para><computeroutput>LARGE</computeroutput> is suitable for a large machine that serves five to ten users and has
4584                 32 MB of RAM and a 100-MB cache</para>
4585               </listitem>
4586             </itemizedlist></para>
4587         </listitem>
4588
4589         <listitem>
4590           <para>You can choose not to create an <emphasis role="bold">afsd</emphasis> options file and to set the
4591           <computeroutput>OPTIONS</computeroutput> variable in the initialization script to a null value rather than to the default
4592           <computeroutput>$MEDIUM</computeroutput> value. You can then either set arguments directly on the <emphasis
4593           role="bold">afsd</emphasis> command line in the script, or set no arguments (and so accept default values for all Cache
4594           Manager parameters).</para>
4595         </listitem>
4596       </itemizedlist>
4597
4598       <note>
4599       <para>If you are running on a Fedora or RHEL based system, the
4600       openafs-client initialization script behaves differently from that
4601       described above. It sources /etc/sysconfig/openafs, in which the
4602       AFSD_ARGS variable may be set to contain any, or all, of the afsd options
4603       detailed. Note that this script does not support setting an OPTIONS
4604       variable, or the SMALL, MEDIUM and LARGE methods of defining cache size
4605       </para>
4606       </note>
4607
4608  <orderedlist>
4609         <listitem>
4610           <para>Create the local directory on which to mount the AFS filespace, by convention <emphasis role="bold">/afs</emphasis>.
4611           If the directory already exists, verify that it is empty. <programlisting>
4612    # <emphasis role="bold">mkdir /afs</emphasis>
4613 </programlisting></para>
4614         </listitem>
4615
4616         <listitem>
4617           <para>On AIX systems, add the following line to the <emphasis role="bold">/etc/vfs</emphasis> file. It enables AIX to
4618           unmount AFS correctly during shutdown. <programlisting>
4619    afs     4     none     none
4620 </programlisting></para>
4621         </listitem>
4622
4623         <listitem>
4624           <para>On non-package based Linux systems, copy the <emphasis role="bold">afsd</emphasis> options file from the <emphasis
4625           role="bold">/usr/vice/etc</emphasis> directory to the <emphasis role="bold">/etc/sysconfig</emphasis> directory, removing
4626           the <emphasis role="bold">.conf</emphasis> extension as you do so. <programlisting>
4627    # <emphasis role="bold">cp /usr/vice/etc/afs.conf /etc/sysconfig/afs</emphasis>
4628 </programlisting></para>
4629         </listitem>
4630
4631         <listitem>
4632           <para>Edit the machine's AFS initialization script or <emphasis role="bold">afsd</emphasis> options file to set
4633           appropriate values for <emphasis role="bold">afsd</emphasis> command parameters. The script resides in the indicated
4634           location on each system type: <itemizedlist>
4635               <listitem>
4636                 <para>On AIX systems, <emphasis role="bold">/etc/rc.afs</emphasis></para>
4637               </listitem>
4638
4639               <listitem>
4640                 <para>On HP-UX systems, <emphasis role="bold">/sbin/init.d/afs</emphasis></para>
4641               </listitem>
4642
4643               <listitem>
4644                 <para>On IRIX systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
4645               </listitem>
4646
4647                   <listitem>
4648                 <para>On Fedora and RHEL systems, <emphasis role="bold">/etc/sysconfg/openafs</emphasis></para>
4649               </listitem>
4650
4651               <listitem>
4652                 <para>On non-package based Linux systems, <emphasis role="bold">/etc/sysconfig/afs</emphasis> (the <emphasis
4653                 role="bold">afsd</emphasis> options file)</para>
4654               </listitem>
4655
4656               <listitem>
4657                 <para>On Solaris systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
4658               </listitem>
4659             </itemizedlist></para>
4660
4661           <para>Use one of the methods described in the introduction to this section to add the following flags to the <emphasis
4662           role="bold">afsd</emphasis> command line. If you intend for the machine to remain an AFS client, also set any
4663           performance-related arguments you wish. <itemizedlist>
4664               <listitem>
4665                 <para>Add the <emphasis role="bold">-memcache</emphasis> flag if the machine is to use a memory cache.</para>
4666               </listitem>
4667
4668               <listitem>
4669                 <para>Add the <emphasis role="bold">-verbose</emphasis> flag to display a trace of the Cache Manager's
4670                 initialization on the standard output stream.</para>
4671               </listitem>
4672             </itemizedlist></para>
4673         </listitem>
4674       </orderedlist>
4675       <note><para>In order to successfully complete the instructions in the
4676       remainder of this guide, it is important that the machine does not have
4677       a synthetic root (as discussed in <link linkend="HDRWQ91">Enabling Access
4678       to Foreign Cells</link>). As some distributions ship with this enabled, it
4679       may be necessary to remove any occurences of the
4680       <emphasis role="bold">-dynroot</emphasis> and
4681       <emphasis role="bold">-afsdb</emphasis> options from both the AFS
4682       initialisation script and options file. If this functionality is
4683       required it may be renabled as detailed in
4684       <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>.
4685       </para></note>
4686       </para>
4687
4688     <indexterm>
4689       <primary>overview</primary>
4690
4691       <secondary>completing installation of first machine</secondary>
4692     </indexterm>
4693
4694     <indexterm>
4695       <primary>first AFS machine</primary>
4696
4697       <secondary>completion of installation</secondary>
4698     </indexterm>
4699   </sect1>
4700
4701   <sect1 id="HDRWQ71">
4702     <title>Overview: Completing the Installation of the First AFS Machine</title>
4703
4704     <para>The machine is now configured as an AFS file server and client machine. In this final phase of the installation, you
4705     initialize the Cache Manager and then create the upper levels of your AFS filespace, among other procedures. The procedures are:
4706     <orderedlist>
4707         <listitem>
4708           <para>Verify that the initialization script works correctly, and incorporate it into the operating system's startup and
4709           shutdown sequence</para>
4710         </listitem>
4711
4712         <listitem>
4713           <para>Create and mount top-level volumes</para>
4714         </listitem>
4715
4716         <listitem>
4717           <para>Create and mount volumes to store system binaries in AFS</para>
4718         </listitem>
4719
4720         <listitem>
4721           <para>Enable access to foreign cells</para>
4722         </listitem>
4723
4724         <listitem>
4725           <para>Institute additional security measures</para>
4726         </listitem>
4727
4728         <listitem>
4729           <para>Remove client functionality if desired</para>
4730         </listitem>
4731       </orderedlist></para>
4732
4733     <indexterm>
4734       <primary>AFS initialization script</primary>
4735
4736       <secondary>verifying on first AFS machine</secondary>
4737     </indexterm>
4738
4739     <indexterm>
4740       <primary>AFS initialization script</primary>
4741
4742       <secondary>running</secondary>
4743
4744       <tertiary>first AFS machine</tertiary>
4745     </indexterm>
4746
4747     <indexterm>
4748       <primary>first AFS machine</primary>
4749
4750       <secondary>AFS initialization script</secondary>
4751
4752       <tertiary>running/verifying</tertiary>
4753     </indexterm>
4754
4755     <indexterm>
4756       <primary>running AFS init. script</primary>
4757
4758       <secondary>first AFS machine</secondary>
4759     </indexterm>
4760
4761     <indexterm>
4762       <primary>invoking AFS init. script</primary>
4763
4764       <see>running</see>
4765     </indexterm>
4766   </sect1>
4767
4768   <sect1 id="HDRWQ72">
4769     <title>Verifying the AFS Initialization Script</title>
4770
4771     <para>At this point you run the AFS initialization script to verify that it correctly invokes all of the necessary programs and
4772     AFS processes, and that they start correctly. The following are the relevant commands: <itemizedlist>
4773         <listitem>
4774           <para>The command that dynamically loads AFS modifications into the kernel, on some system types (not applicable if the
4775           kernel has AFS modifications built in)</para>
4776         </listitem>
4777
4778         <listitem>
4779           <para>The <emphasis role="bold">bosserver</emphasis> command, which starts the BOS Server; it in turn starts the server
4780           processes for which you created entries in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file</para>
4781         </listitem>
4782
4783         <listitem>
4784           <para>The <emphasis role="bold">afsd</emphasis> command, which initializes the Cache Manager</para>
4785         </listitem>
4786       </itemizedlist></para>
4787
4788     <para>On system types that use a dynamic loader program, you must reboot the machine before running the initialization script,
4789     so that it can freshly load AFS modifications into the kernel.</para>
4790
4791     <para>If there are problems during the initialization, attempt to resolve them. The OpenAFS mailing lists can provide assistance if necessary.
4792
4793      <orderedlist>
4794         <indexterm>
4795           <primary>commands</primary>
4796
4797           <secondary>bos shutdown</secondary>
4798         </indexterm>
4799
4800         <indexterm>
4801           <primary>bos commands</primary>
4802
4803           <secondary>shutdown</secondary>
4804         </indexterm>
4805
4806         <listitem>
4807           <para>Issue the <emphasis role="bold">bos shutdown</emphasis> command to shut down the AFS server processes other than the
4808           BOS Server. Include the <emphasis role="bold">-wait</emphasis> flag to delay return of the command shell prompt until all
4809           processes shut down completely. <programlisting>
4810    # <emphasis role="bold">/usr/afs/bin/bos shutdown</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
4811                 role="bold">-wait</emphasis>
4812 </programlisting></para>
4813         </listitem>
4814
4815         <listitem>
4816           <para>Issue the <emphasis role="bold">ps</emphasis> command to learn the <emphasis role="bold">bosserver</emphasis>
4817           process's process ID number (PID), and then the <emphasis role="bold">kill</emphasis> command to stop it. <programlisting>
4818    # <emphasis role="bold">ps</emphasis> <replaceable>appropriate_ps_options</replaceable> <emphasis role="bold">| grep bosserver</emphasis>
4819    # <emphasis role="bold">kill</emphasis> <replaceable>bosserver_PID</replaceable>
4820 </programlisting></para>
4821         </listitem>
4822
4823         <listitem>
4824           <para>Issue the appropriate commands to run the AFS initialization script for this system type.</para>
4825
4826           <indexterm>
4827             <primary>AIX</primary>
4828
4829             <secondary>AFS initialization script</secondary>
4830
4831             <tertiary>on first AFS machine</tertiary>
4832           </indexterm>
4833
4834           <para><emphasis role="bold">On AIX systems:</emphasis> <orderedlist>
4835               <listitem>
4836                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4837                 <programlisting>
4838    # <emphasis role="bold">cd /</emphasis>
4839    # <emphasis role="bold">shutdown -r now</emphasis>
4840    login: <emphasis role="bold">root</emphasis>
4841    Password: <replaceable>root_password</replaceable>
4842 </programlisting></para>
4843               </listitem>
4844
4845               <listitem>
4846                 <para>Run the AFS initialization script. <programlisting>
4847    # <emphasis role="bold">/etc/rc.afs</emphasis>
4848 </programlisting></para>
4849               </listitem>
4850             </orderedlist></para>
4851
4852           <indexterm>
4853             <primary>HP-UX</primary>
4854
4855             <secondary>AFS initialization script</secondary>
4856
4857             <tertiary>on first AFS machine</tertiary>
4858           </indexterm>
4859
4860           <para><emphasis role="bold">On HP-UX systems:</emphasis> <orderedlist>
4861               <listitem>
4862                 <para>Run the AFS initialization script. <programlisting>
4863    # <emphasis role="bold">/sbin/init.d/afs  start</emphasis>
4864 </programlisting></para>
4865               </listitem>
4866             </orderedlist></para>
4867
4868           <indexterm>
4869             <primary>IRIX</primary>
4870
4871             <secondary>AFS initialization script</secondary>
4872
4873             <tertiary>on first AFS machine</tertiary>
4874           </indexterm>
4875
4876           <indexterm>
4877             <primary>afsclient variable (IRIX)</primary>
4878
4879             <secondary>first AFS machine</secondary>
4880           </indexterm>
4881
4882           <indexterm>
4883             <primary>variables</primary>
4884
4885             <secondary>afsclient (IRIX)</secondary>
4886
4887             <tertiary>first AFS machine</tertiary>
4888           </indexterm>
4889
4890           <indexterm>
4891             <primary>IRIX</primary>
4892
4893             <secondary>afsclient variable</secondary>
4894
4895             <tertiary>first AFS machine</tertiary>
4896           </indexterm>
4897
4898           <indexterm>
4899             <primary>afsserver variable (IRIX)</primary>
4900
4901             <secondary>first AFS machine</secondary>
4902           </indexterm>
4903
4904           <indexterm>
4905             <primary>variables</primary>
4906
4907             <secondary>afsserver (IRIX)</secondary>
4908
4909             <tertiary>first AFS machine</tertiary>
4910           </indexterm>
4911
4912           <indexterm>
4913             <primary>IRIX</primary>
4914
4915             <secondary>afsserver variable</secondary>
4916
4917             <tertiary>first AFS machine</tertiary>
4918           </indexterm>
4919
4920           <para><emphasis role="bold">On IRIX systems:</emphasis> <orderedlist>
4921               <listitem>
4922                 <para>If you have configured the machine to use the <emphasis role="bold">ml</emphasis> dynamic loader program,
4923                 reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
4924    # <emphasis role="bold">cd /</emphasis>
4925    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
4926    login: <emphasis role="bold">root</emphasis>
4927    Password: <replaceable>root_password</replaceable>
4928 </programlisting></para>
4929               </listitem>
4930
4931               <listitem>
4932                 <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
4933                 role="bold">afsserver</emphasis> and <emphasis role="bold">afsclient</emphasis> configuration variables.
4934                 <programlisting>
4935    # <emphasis role="bold">/etc/chkconfig -f afsserver on</emphasis>
4936    # <emphasis role="bold">/etc/chkconfig -f afsclient on</emphasis>
4937 </programlisting></para>
4938               </listitem>
4939
4940               <listitem>
4941                 <para>Run the AFS initialization script. <programlisting>
4942    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
4943 </programlisting></para>
4944               </listitem>
4945             </orderedlist></para>
4946
4947           <indexterm>
4948             <primary>Linux</primary>
4949
4950             <secondary>AFS initialization script</secondary>
4951
4952             <tertiary>on first AFS machine</tertiary>
4953           </indexterm>
4954
4955           <para><emphasis role="bold">On Linux systems:</emphasis> <orderedlist>
4956               <listitem>
4957                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4958                 <programlisting>
4959    # <emphasis role="bold">cd /</emphasis>
4960    # <emphasis role="bold">shutdown -r now</emphasis>
4961    login: <emphasis role="bold">root</emphasis>
4962    Password: <replaceable>root_password</replaceable>
4963 </programlisting></para>
4964               </listitem>
4965
4966               <listitem>
4967                 <para>Run the AFS initialization scripts.
4968 <programlisting>
4969    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
4970    # <emphasis role="bold">/etc/rc.d/init.d/openafs-server  start</emphasis>
4971 </programlisting></para>
4972               </listitem>
4973             </orderedlist></para>
4974
4975           <indexterm>
4976             <primary>Solaris</primary>
4977
4978             <secondary>AFS initialization script</secondary>
4979
4980             <tertiary>on first AFS machine</tertiary>
4981           </indexterm>
4982
4983           <para><emphasis role="bold">On Solaris systems:</emphasis> <orderedlist>
4984               <listitem>
4985                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4986                 <programlisting>
4987    # <emphasis role="bold">cd /</emphasis>
4988    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
4989    login: <emphasis role="bold">root</emphasis>
4990    Password: <replaceable>root_password</replaceable>
4991 </programlisting></para>
4992               </listitem>
4993
4994               <listitem>
4995                 <para>Run the AFS initialization script. <programlisting>
4996    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
4997 </programlisting></para>
4998               </listitem>
4999             </orderedlist></para>
5000         </listitem>
5001
5002         <listitem>
5003           <para>Wait for the message that confirms that Cache Manager initialization is complete.</para>
5004
5005           <para>On machines that use a disk cache, it can take a while to initialize the Cache Manager for the first time, because
5006           the <emphasis role="bold">afsd</emphasis> program must create all of the <emphasis
5007           role="bold">V</emphasis><replaceable>n</replaceable> files in the cache directory. Subsequent Cache Manager
5008           initializations do not take nearly as long, because the <emphasis role="bold">V</emphasis><replaceable>n</replaceable>
5009           files already exist.</para>
5010         </listitem>
5011         <listitem>
5012
5013           <indexterm>
5014             <primary>commands</primary>
5015             <secondary>aklog</secondary>
5016           </indexterm>
5017
5018           <indexterm>
5019             <primary>aklog command</primary>
5020           </indexterm>
5021
5022           <para>If you are working with an existing cell which uses
5023           <emphasis role="bold">kaserver</emphasis> for authentication,
5024           please recall the note in
5025           <link linkend="KAS003">Using this Appendix</link> detailing the
5026           substitution of <emphasis role="bold">kinit</emphasis> and
5027           <emphasis role="bold">aklog</emphasis> with
5028           <emphasis role="bold">klog</emphasis>.</para>
5029
5030           <para>As a basic test of correct AFS functioning, issue the
5031           <emphasis role="bold">kinit</emphasis> and
5032           <emphasis role="bold">aklog</emphasis> commands to authenticate
5033           as the <emphasis role="bold">admin</emphasis> user.
5034           Provide the password (<replaceable>admin_passwd</replaceable>) you
5035           defined in <link linkend="HDRWQ53">Initializing Cell Security</link>.</para>
5036
5037           <programlisting>
5038    # <emphasis role="bold">kinit admin</emphasis>
5039    Password:  <replaceable>admin_passwd</replaceable>
5040    # <emphasis role="bold">aklog</emphasis>
5041 </programlisting>
5042
5043           <indexterm>
5044             <primary>commands</primary>
5045
5046             <secondary>tokens</secondary>
5047           </indexterm>
5048
5049           <indexterm>
5050             <primary>tokens command</primary>
5051           </indexterm>
5052         </listitem>
5053
5054         <listitem>
5055           <para>Issue the <emphasis role="bold">tokens</emphasis> command to
5056           verify that the <emphasis role="bold">aklog</emphasis>
5057           command worked correctly. If it did, the output looks similar to the following example for the <emphasis
5058           role="bold">example.com</emphasis> cell, where <emphasis role="bold">admin</emphasis>'s AFS UID is 1. If the output does not
5059           seem correct, resolve the problem. Changes to the AFS initialization script are possibly necessary. The OpenAFS mailing lists can provide assistance as necessary. <programlisting>
5060    # <emphasis role="bold">tokens</emphasis>
5061    Tokens held by the Cache Manager:
5062    User's (AFS ID 1) tokens for afs@example.com [Expires May 22 11:52]
5063        --End of list--
5064 </programlisting></para>
5065         </listitem>
5066
5067         <listitem>
5068           <para>Issue the <emphasis role="bold">bos status</emphasis> command to verify that the output for each process reads
5069           <computeroutput>Currently running normally</computeroutput>. <programlisting>
5070    # <emphasis role="bold">/usr/afs/bin/bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt;
5071 </programlisting> <indexterm>
5072               <primary>fs commands</primary>
5073
5074               <secondary>checkvolumes</secondary>
5075             </indexterm> <indexterm>
5076               <primary>commands</primary>
5077
5078               <secondary>fs checkvolumes</secondary>
5079             </indexterm></para>
5080         </listitem>
5081
5082         <listitem>
5083           <para>Change directory to the local file system root (<emphasis role="bold">/</emphasis>) and issue the <emphasis
5084           role="bold">fs checkvolumes</emphasis> command. <programlisting>
5085    # <emphasis role="bold">cd /</emphasis>
5086    # <emphasis role="bold">/usr/afs/bin/fs checkvolumes</emphasis>
5087 </programlisting></para>
5088         </listitem>
5089       </orderedlist></para>
5090
5091     <indexterm>
5092       <primary>AFS initialization script</primary>
5093
5094       <secondary>adding to machine startup sequence</secondary>
5095
5096       <tertiary>first AFS machine</tertiary>
5097     </indexterm>
5098
5099     <indexterm>
5100       <primary>installing</primary>
5101
5102       <secondary>AFS initialization script</secondary>
5103
5104       <tertiary>first AFS machine</tertiary>
5105     </indexterm>
5106
5107     <indexterm>
5108       <primary>first AFS machine</primary>
5109
5110       <secondary>AFS initialization script</secondary>
5111
5112       <tertiary>activating</tertiary>
5113     </indexterm>
5114
5115     <indexterm>
5116       <primary>activating AFS init. script</primary>
5117
5118       <see>installing</see>
5119     </indexterm>
5120   </sect1>
5121
5122   <sect1 id="HDRWQ73">
5123     <title>Activating the AFS Initialization Script</title>
5124
5125     <para>Now that you have confirmed that the AFS initialization script works correctly, take the action necessary to have it run
5126     automatically at each reboot. Proceed to the instructions for your system type: <itemizedlist>
5127         <listitem>
5128           <para><link linkend="HDRWQ74">Activating the Script on AIX Systems</link></para>
5129         </listitem>
5130
5131         <listitem>
5132           <para><link linkend="HDRWQ76">Activating the Script on HP-UX Systems</link></para>
5133         </listitem>
5134
5135         <listitem>
5136           <para><link linkend="HDRWQ77">Activating the Script on IRIX Systems</link></para>
5137         </listitem>
5138
5139         <listitem>
5140           <para><link linkend="HDRWQ78">Activating the Script on Linux Systems</link></para>
5141         </listitem>
5142
5143         <listitem>
5144           <para><link linkend="HDRWQ79">Activating the Script on Solaris Systems</link></para>
5145         </listitem>
5146       </itemizedlist></para>
5147
5148     <indexterm>
5149       <primary>AIX</primary>
5150
5151       <secondary>AFS initialization script</secondary>
5152
5153       <tertiary>on first AFS machine</tertiary>
5154     </indexterm>
5155
5156     <sect2 id="HDRWQ74">
5157       <title>Activating the Script on AIX Systems</title>
5158
5159       <orderedlist>
5160         <listitem>
5161           <para>Edit the AIX initialization file, <emphasis role="bold">/etc/inittab</emphasis>, adding the following line to invoke
5162           the AFS initialization script. Place it just after the line that starts NFS daemons. <programlisting>
5163    rcafs:2:wait:/etc/rc.afs &gt; /dev/console 2&gt;&amp;1 # Start AFS services
5164 </programlisting></para>
5165         </listitem>
5166
5167         <listitem>
5168           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5169           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc</emphasis> directories. If you want to avoid
5170           potential confusion by guaranteeing that they are always the same, create a link between them. You can always retrieve the
5171           original script from the AFS CD-ROM if necessary. <programlisting>
5172    # <emphasis role="bold">cd  /usr/vice/etc</emphasis>
5173    # <emphasis role="bold">rm  rc.afs</emphasis>
5174    # <emphasis role="bold">ln -s  /etc/rc.afs</emphasis>
5175 </programlisting></para>
5176         </listitem>
5177
5178         <listitem>
5179           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5180         </listitem>
5181       </orderedlist>
5182
5183       <indexterm>
5184         <primary>HP-UX</primary>
5185
5186         <secondary>AFS initialization script</secondary>
5187
5188         <tertiary>on first AFS machine</tertiary>
5189       </indexterm>
5190     </sect2>
5191
5192     <sect2 id="HDRWQ76">
5193       <title>Activating the Script on HP-UX Systems</title>
5194
5195       <orderedlist>
5196         <listitem>
5197           <para>Change to the <emphasis role="bold">/sbin/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5198           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the HP-UX startup and
5199           shutdown sequence. <programlisting>
5200    # <emphasis role="bold">cd /sbin/init.d</emphasis>
5201    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/S460afs</emphasis>
5202    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/K800afs</emphasis>
5203 </programlisting></para>
5204         </listitem>
5205
5206         <listitem>
5207           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5208           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/sbin/init.d</emphasis> directories. If you want
5209           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5210           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5211    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5212    # <emphasis role="bold">rm afs.rc</emphasis>
5213    # <emphasis role="bold">ln -s  /sbin/init.d/afs  afs.rc</emphasis>
5214 </programlisting></para>
5215         </listitem>
5216
5217         <listitem>
5218           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5219         </listitem>
5220       </orderedlist>
5221
5222       <indexterm>
5223         <primary>IRIX</primary>
5224
5225         <secondary>AFS initialization script</secondary>
5226
5227         <tertiary>on first AFS machine</tertiary>
5228       </indexterm>
5229     </sect2>
5230
5231     <sect2 id="HDRWQ77">
5232       <title>Activating the Script on IRIX Systems</title>
5233
5234       <orderedlist>
5235         <listitem>
5236           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5237           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the IRIX startup and
5238           shutdown sequence. <programlisting>
5239    # <emphasis role="bold">cd /etc/init.d</emphasis>
5240    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc2.d/S35afs</emphasis>
5241    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K35afs</emphasis>
5242 </programlisting></para>
5243         </listitem>
5244
5245         <listitem>
5246           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5247           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
5248           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5249           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5250    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5251    # <emphasis role="bold">rm afs.rc</emphasis>
5252    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
5253 </programlisting></para>
5254         </listitem>
5255
5256         <listitem>
5257           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5258         </listitem>
5259       </orderedlist>
5260
5261       <indexterm>
5262         <primary>Linux</primary>
5263
5264         <secondary>AFS initialization script</secondary>
5265
5266         <tertiary>on first AFS machine</tertiary>
5267       </indexterm>
5268     </sect2>
5269
5270     <sect2 id="HDRWQ78">
5271       <title>Activating the Script on Linux Systems</title>
5272
5273       <orderedlist>
5274         <listitem>
5275           <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>
5276           configuration variables. Based on the instruction in the AFS initialization file that begins with the string
5277           <computeroutput>#chkconfig</computeroutput>, the command automatically creates the symbolic links that incorporate the
5278           script into the Linux startup and shutdown sequence. <programlisting>
5279    # <emphasis role="bold">/sbin/chkconfig  --add openafs-client</emphasis>
5280    # <emphasis role="bold">/sbin/chkconfig  --add openafs-server</emphasis>
5281 </programlisting></para>
5282         </listitem>
5283
5284         <listitem>
5285           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5286           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/rc.d/init.d</emphasis> directories, and
5287           copies of the <emphasis role="bold">afsd</emphasis> options file in both the <emphasis
5288           role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/sysconfig</emphasis> directories. If you want to avoid
5289           potential confusion by guaranteeing that the two copies of each file are always the same, create a link between them. You
5290           can always retrieve the original script or options file from the AFS CD-ROM if necessary. <programlisting>
5291    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5292    # <emphasis role="bold">rm afs.rc afs.conf</emphasis>
5293    # <emphasis role="bold">ln -s  /etc/rc.d/init.d/afs  afs.rc</emphasis>
5294    # <emphasis role="bold">ln -s  /etc/sysconfig/afs  afs.conf</emphasis>
5295 </programlisting></para>
5296         </listitem>
5297
5298         <listitem>
5299           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5300         </listitem>
5301       </orderedlist>
5302
5303       <indexterm>
5304         <primary>Solaris</primary>
5305
5306         <secondary>AFS initialization script</secondary>
5307
5308         <tertiary>on first AFS machine</tertiary>
5309       </indexterm>
5310     </sect2>
5311
5312     <sect2 id="HDRWQ79">
5313       <title>Activating the Script on Solaris Systems</title>
5314
5315       <orderedlist>
5316         <listitem>
5317           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5318           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the Solaris startup and
5319           shutdown sequence. <programlisting>
5320    # <emphasis role="bold">cd /etc/init.d</emphasis>
5321    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc3.d/S99afs</emphasis>
5322    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K66afs</emphasis>
5323 </programlisting></para>
5324         </listitem>
5325
5326         <listitem>
5327           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5328           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
5329           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5330           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5331    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5332    # <emphasis role="bold">rm afs.rc</emphasis>
5333    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
5334 </programlisting></para>
5335         </listitem>
5336       </orderedlist>
5337
5338       <indexterm>
5339         <primary>AFS filespace</primary>
5340
5341         <secondary>configuring top levels</secondary>
5342       </indexterm>
5343
5344       <indexterm>
5345         <primary>configuring</primary>
5346
5347         <secondary>AFS filespace (top levels)</secondary>
5348       </indexterm>
5349     </sect2>
5350   </sect1>
5351
5352   <sect1 id="HDRWQ80">
5353     <title>Configuring the Top Levels of the AFS Filespace</title>
5354
5355     <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
5356     have run a previous version of AFS, the filespace is already configured. Proceed to <link linkend="HDRWQ83">Storing AFS Binaries
5357     in AFS</link>. <indexterm>
5358         <primary>root.cell volume</primary>
5359
5360         <secondary>creating and replicating</secondary>
5361       </indexterm> <indexterm>
5362         <primary>volume</primary>
5363
5364         <secondary>creating</secondary>
5365
5366         <tertiary>root.cell</tertiary>
5367       </indexterm> <indexterm>
5368         <primary>creating</primary>
5369
5370         <secondary>root.cell volume</secondary>
5371       </indexterm></para>
5372
5373     <para>You created the <emphasis role="bold">root.afs</emphasis> volume in <link linkend="HDRWQ60">Starting the File Server,
5374     Volume Server, and Salvager</link>, and the Cache Manager mounted it automatically on the local <emphasis
5375     role="bold">/afs</emphasis> directory when you ran the AFS initialization script in <link linkend="HDRWQ72">Verifying the AFS
5376     Initialization Script</link>. You now set the access control list (ACL) on the <emphasis role="bold">/afs</emphasis> directory;
5377     creating, mounting, and setting the ACL are the three steps required when creating any volume.</para>
5378
5379     <para>After setting the ACL on the <emphasis role="bold">root.afs</emphasis> volume, you create your cell's <emphasis
5380     role="bold">root.cell</emphasis> volume, mount it as a subdirectory of the <emphasis role="bold">/afs</emphasis> directory, and
5381     set the ACL. Create both a read/write and a regular mount point for the <emphasis role="bold">root.cell</emphasis> volume. The
5382     read/write mount point enables you to access the read/write version of replicated volumes when necessary. Creating both mount
5383     points essentially creates separate read-only and read-write copies of your filespace, and enables the Cache Manager to traverse
5384     the filespace on a read-only path or read/write path as appropriate. For further discussion of these concepts, see the chapter
5385     in the <emphasis>OpenAFS Administration Guide</emphasis> about administering volumes. <indexterm>
5386         <primary>root.afs volume</primary>
5387
5388         <secondary>replicating</secondary>
5389       </indexterm> <indexterm>
5390         <primary>volume</primary>
5391
5392         <secondary>replicating root.afs and root.cell</secondary>
5393       </indexterm> <indexterm>
5394         <primary>replicating volumes</primary>
5395       </indexterm></para>
5396
5397     <para>Then replicate both the <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes.
5398     This is required if you want to replicate any other volumes in your cell, because all volumes mounted above a replicated volume
5399     must themselves be replicated in order for the Cache Manager to access the replica.</para>
5400
5401     <para>When the <emphasis role="bold">root.afs</emphasis> volume is replicated, the Cache Manager is programmed to access its
5402     read-only version (<emphasis role="bold">root.afs.readonly</emphasis>) whenever possible. To make changes to the contents of the
5403     <emphasis role="bold">root.afs</emphasis> volume (when, for example, you mount another cell's <emphasis
5404     role="bold">root.cell</emphasis> volume at the second level in your filespace), you must mount the <emphasis
5405     role="bold">root.afs</emphasis> volume temporarily, make the changes, release the volume and remove the temporary mount point.
5406     For instructions, see <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>. <indexterm>
5407         <primary>fs commands</primary>
5408
5409         <secondary>setacl</secondary>
5410       </indexterm> <indexterm>
5411         <primary>commands</primary>
5412
5413         <secondary>fs setacl</secondary>
5414       </indexterm> <indexterm>
5415         <primary>access control list (ACL), setting</primary>
5416       </indexterm> <indexterm>
5417         <primary>setting</primary>
5418
5419         <secondary>ACL</secondary>
5420       </indexterm> <orderedlist>
5421         <listitem>
5422           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to edit the ACL on the <emphasis
5423           role="bold">/afs</emphasis> directory. Add an entry that grants the <emphasis role="bold">l</emphasis> (<emphasis
5424           role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>) permissions
5425           to the <emphasis role="bold">system:anyuser</emphasis> group, to enable all AFS users who can reach your cell to traverse
5426           through the directory. If you prefer to enable access only to locally authenticated users, substitute the <emphasis
5427           role="bold">system:authuser</emphasis> group.</para>
5428
5429           <para>Note that there is already an ACL entry that grants all seven access rights to the <emphasis
5430           role="bold">system:administrators</emphasis> group. It is a default entry that AFS places on every new volume's root
5431           directory.</para>
5432
5433           <para>The top-level AFS directory, typically /afs, is a special case:
5434             when the client is configured to run in dynroot mode (e.g.
5435             <emphasis role="bold">afsd -dynroot</emphasis>, attempts to set
5436             the ACL on this directory will return <emphasis role="bold">
5437               Connection timed out</emphasis>. This is because the dynamically-
5438             generated root directory is not a part of the global AFS space,
5439             and cannot have an access control list set on it.</para>
5440
5441           <programlisting>
5442    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs system:anyuser rl</emphasis>
5443 </programlisting>
5444
5445           <indexterm>
5446             <primary>commands</primary>
5447
5448             <secondary>vos create</secondary>
5449
5450             <tertiary>root.cell volume</tertiary>
5451           </indexterm>
5452
5453           <indexterm>
5454             <primary>vos commands</primary>
5455
5456             <secondary>create</secondary>
5457
5458             <tertiary>root.cell volume</tertiary>
5459           </indexterm>
5460
5461           <indexterm>
5462             <primary>fs commands</primary>
5463
5464             <secondary>mkmount</secondary>
5465           </indexterm>
5466
5467           <indexterm>
5468             <primary>commands</primary>
5469
5470             <secondary>fs mkmount</secondary>
5471           </indexterm>
5472
5473           <indexterm>
5474             <primary>mount point</primary>
5475           </indexterm>
5476
5477           <indexterm>
5478             <primary>creating</primary>
5479
5480             <secondary>mount point</secondary>
5481           </indexterm>
5482
5483           <indexterm>
5484             <primary>volume</primary>
5485
5486             <secondary>mounting</secondary>
5487           </indexterm>
5488         </listitem>
5489
5490         <listitem>
5491           <para><anchor id="LIWQ81" />Issue the <emphasis role="bold">vos create</emphasis> command to create the <emphasis
5492           role="bold">root.cell</emphasis> volume. Then issue the <emphasis role="bold">fs mkmount</emphasis> command to mount it as
5493           a subdirectory of the <emphasis role="bold">/afs</emphasis> directory, where it serves as the root of your cell's local
5494           AFS filespace. Finally, issue the <emphasis role="bold">fs setacl</emphasis> command to create an ACL entry for the
5495           <emphasis role="bold">system:anyuser</emphasis> group (or <emphasis role="bold">system:authuser</emphasis> group).</para>
5496
5497           <para>For the <replaceable>partition name</replaceable> argument, substitute the name of one of the machine's AFS server
5498           partitions (such as <emphasis role="bold">/vicepa</emphasis>). For the <replaceable>cellname</replaceable> argument,
5499           substitute your cell's fully-qualified Internet domain name (such as <emphasis role="bold">abc.com</emphasis>).</para>
5500
5501           <programlisting>
5502    # <emphasis role="bold">/usr/afs/bin/vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5503               role="bold">root.cell</emphasis>
5504    # <emphasis role="bold">/usr/afs/bin/fs mkmount /afs/</emphasis><replaceable>cellname</replaceable>  <emphasis role="bold">root.cell</emphasis>
5505    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs/</emphasis><replaceable>cellname</replaceable>  <emphasis role="bold">system:anyuser rl</emphasis>
5506 </programlisting>
5507
5508           <indexterm>
5509             <primary>creating</primary>
5510
5511             <secondary>symbolic link</secondary>
5512
5513             <tertiary>for abbreviated cell name</tertiary>
5514           </indexterm>
5515
5516           <indexterm>
5517             <primary>symbolic link</primary>
5518
5519             <secondary>for abbreviated cell name</secondary>
5520           </indexterm>
5521
5522           <indexterm>
5523             <primary>cell name</primary>
5524
5525             <secondary>symbolic link for abbreviated</secondary>
5526           </indexterm>
5527         </listitem>
5528
5529         <listitem>
5530           <para><emphasis role="bold">(Optional)</emphasis> Create a symbolic link to a shortened cell name, to reduce the length of
5531           pathnames for users in the local cell. For example, in the <emphasis role="bold">abc.com</emphasis> cell, <emphasis
5532           role="bold">/afs/abc</emphasis> is a link to <emphasis role="bold">/afs/abc.com</emphasis>. <programlisting>
5533    # <emphasis role="bold">cd /afs</emphasis>
5534    # <emphasis role="bold">ln -s</emphasis>  <replaceable>full_cellname</replaceable>  <replaceable>short_cellname</replaceable>
5535 </programlisting> <indexterm>
5536               <primary>read/write mount point for root.afs volume</primary>
5537             </indexterm> <indexterm>
5538               <primary>root.afs volume</primary>
5539
5540               <secondary>read/write mount point</secondary>
5541             </indexterm> <indexterm>
5542               <primary>creating</primary>
5543
5544               <secondary>read/write mount point</secondary>
5545             </indexterm></para>
5546         </listitem>
5547
5548         <listitem>
5549           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to create a read/write mount point for the <emphasis
5550           role="bold">root.cell</emphasis> volume (you created a regular mount point in Step <link
5551           linkend="LIWQ81">2</link>).</para>
5552
5553           <para>By convention, the name of a read/write mount point begins with a period, both to distinguish it from the regular
5554           mount point and to make it visible only when the <emphasis role="bold">-a</emphasis> flag is used on the <emphasis
5555           role="bold">ls</emphasis> command.</para>
5556
5557           <para>Change directory to <emphasis role="bold">/usr/afs/bin</emphasis> to make it easier to access the command
5558           binaries.</para>
5559
5560           <programlisting>
5561    # <emphasis role="bold">cd /usr/afs/bin</emphasis>
5562    # <emphasis role="bold">./fs mkmount   /afs/.</emphasis><replaceable>cellname</replaceable>   <emphasis role="bold">root.cell -rw</emphasis>
5563 </programlisting>
5564
5565           <indexterm>
5566             <primary>commands</primary>
5567
5568             <secondary>vos addsite</secondary>
5569           </indexterm>
5570
5571           <indexterm>
5572             <primary>vos commands</primary>
5573
5574             <secondary>addsite</secondary>
5575           </indexterm>
5576
5577           <indexterm>
5578             <primary>volume</primary>
5579
5580             <secondary>defining replication site</secondary>
5581           </indexterm>
5582
5583           <indexterm>
5584             <primary>defining</primary>
5585
5586             <secondary>replication site for volume</secondary>
5587           </indexterm>
5588         </listitem>
5589
5590         <listitem>
5591           <para><anchor id="LIWQ82" />Issue the <emphasis role="bold">vos addsite</emphasis> command to define a replication site
5592           for both the <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes. In each
5593           case, substitute for the <replaceable>partition name</replaceable> argument the partition where the volume's read/write
5594           version resides. When you install additional file server machines, it is a good idea to create replication sites on them
5595           as well. <programlisting>
5596    # <emphasis role="bold">./vos addsite</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5597                 role="bold">root.afs</emphasis>
5598    # <emphasis role="bold">./vos addsite</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5599                 role="bold">root.cell</emphasis>
5600 </programlisting> <indexterm>
5601               <primary>fs commands</primary>
5602
5603               <secondary>examine</secondary>
5604             </indexterm> <indexterm>
5605               <primary>commands</primary>
5606
5607               <secondary>fs examine</secondary>
5608             </indexterm></para>
5609         </listitem>
5610
5611         <listitem>
5612           <para>Issue the <emphasis role="bold">fs examine</emphasis> command to verify that the Cache Manager can access both the
5613           <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes, before you attempt to
5614           replicate them. The output lists each volume's name, volumeID number, quota, size, and the size of the partition that
5615           houses them. If you get an error message instead, do not continue before taking corrective action. <programlisting>
5616    # <emphasis role="bold">./fs examine /afs</emphasis>
5617    # <emphasis role="bold">./fs examine /afs/</emphasis><replaceable>cellname</replaceable>
5618 </programlisting> <indexterm>
5619               <primary>commands</primary>
5620
5621               <secondary>vos release</secondary>
5622             </indexterm> <indexterm>
5623               <primary>vos commands</primary>
5624
5625               <secondary>release</secondary>
5626             </indexterm> <indexterm>
5627               <primary>volume</primary>
5628
5629               <secondary>releasing replicated</secondary>
5630             </indexterm> <indexterm>
5631               <primary>releasing replicated volume</primary>
5632             </indexterm></para>
5633         </listitem>
5634
5635         <listitem>
5636           <para>Issue the <emphasis role="bold">vos release</emphasis> command to release a replica of the <emphasis
5637           role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes to the sites you defined in Step
5638           <link linkend="LIWQ82">5</link>. <programlisting>
5639    # <emphasis role="bold">./vos release root.afs</emphasis>
5640    # <emphasis role="bold">./vos release root.cell</emphasis>
5641 </programlisting> <indexterm>
5642               <primary>fs commands</primary>
5643
5644               <secondary>checkvolumes</secondary>
5645             </indexterm> <indexterm>
5646               <primary>commands</primary>
5647
5648               <secondary>fs checkvolumes</secondary>
5649             </indexterm></para>
5650         </listitem>
5651
5652         <listitem>
5653           <para>Issue the <emphasis role="bold">fs checkvolumes</emphasis> to force the Cache Manager to notice that you have
5654           released read-only versions of the volumes, then issue the <emphasis role="bold">fs examine</emphasis> command again. This
5655           time its output mentions the read-only version of the volumes (<emphasis role="bold">root.afs.readonly</emphasis> and
5656           <emphasis role="bold">root.cell.readonly</emphasis>) instead of the read/write versions, because of the Cache Manager's
5657           bias to access the read-only version of the <emphasis role="bold">root.afs</emphasis> volume if it exists.
5658           <programlisting>
5659    # <emphasis role="bold">./fs checkvolumes</emphasis>
5660    # <emphasis role="bold">./fs examine /afs</emphasis>
5661    # <emphasis role="bold">./fs examine /afs/</emphasis><replaceable>cellname</replaceable>
5662 </programlisting></para>
5663         </listitem>
5664       </orderedlist></para>
5665
5666     <indexterm>
5667       <primary>storing</primary>
5668
5669       <secondary>AFS binaries in volumes</secondary>
5670     </indexterm>
5671
5672     <indexterm>
5673       <primary>creating</primary>
5674
5675       <secondary>volume</secondary>
5676
5677       <tertiary>for AFS binaries</tertiary>
5678     </indexterm>
5679
5680     <indexterm>
5681       <primary>volume</primary>
5682
5683       <secondary>for AFS binaries</secondary>
5684     </indexterm>
5685
5686     <indexterm>
5687       <primary>binaries</primary>
5688
5689       <secondary>storing AFS in volume</secondary>
5690     </indexterm>
5691
5692     <indexterm>
5693       <primary>usr/afsws directory</primary>
5694     </indexterm>
5695
5696     <indexterm>
5697       <primary>directories</primary>
5698
5699       <secondary>/usr/afsws</secondary>
5700     </indexterm>
5701   </sect1>
5702
5703   <sect1 id="HDRWQ83">
5704     <title>Storing AFS Binaries in AFS</title>
5705
5706     <note><para>Sites with existing binary distribution mechanisms, including
5707     those which use packaging systems such as RPM, may wish to skip this step,
5708     and use tools native to their operating system to manage AFS configuration
5709     information.</para></note>
5710
5711     <para>In the conventional configuration, you make AFS client binaries and configuration files available in the subdirectories of
5712     the <emphasis role="bold">/usr/afsws</emphasis> directory on client machines (<emphasis role="bold">afsws</emphasis> is an
5713     acronym for <emphasis role="bold">AFS w</emphasis><emphasis>ork</emphasis><emphasis
5714     role="bold">s</emphasis><emphasis>tation</emphasis>). You can conserve local disk space by creating <emphasis
5715     role="bold">/usr/afsws</emphasis> as a link to an AFS volume that houses the AFS client binaries and configuration files for
5716     this system type.</para>
5717
5718     <para>In this section you create the necessary volumes. The conventional location to which to link <emphasis
5719     role="bold">/usr/afsws</emphasis> is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5720     role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis>, where
5721     <replaceable>sysname</replaceable> is the appropriate system type name as specified in the <emphasis>OpenAFS Release
5722     Notes</emphasis>. The instructions in <link linkend="HDRWQ133">Installing Additional Client Machines</link> assume that you have
5723     followed the instructions in this section.</para>
5724
5725     <para>If you have previously run AFS in the cell, the volumes possibly already exist. If so, you need to perform Step <link
5726     linkend="LIWQ86">8</link> only.</para>
5727
5728     <para>The current working directory is still <emphasis role="bold">/usr/afs/bin</emphasis>, which houses the <emphasis
5729     role="bold">fs</emphasis> and <emphasis role="bold">vos</emphasis> command suite binaries. In the following commands, it is
5730     possible you still need to specify the pathname to the commands, depending on how your PATH environment variable is set.
5731     <orderedlist>
5732         <indexterm>
5733           <primary>commands</primary>
5734
5735           <secondary>vos create</secondary>
5736
5737           <tertiary>volume for AFS binaries</tertiary>
5738         </indexterm>
5739
5740         <indexterm>
5741           <primary>vos commands</primary>
5742
5743           <secondary>create</secondary>
5744
5745           <tertiary>volume for AFS binaries</tertiary>
5746         </indexterm>
5747
5748         <listitem>
5749           <para><anchor id="LIWQ84" />Issue the <emphasis role="bold">vos create</emphasis> command to create volumes for storing
5750           the AFS client binaries for this system type. The following example instruction creates volumes called
5751           <replaceable>sysname</replaceable>, <replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis>, and
5752           <replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis>. Refer to the <emphasis>OpenAFS Release
5753           Notes</emphasis> to learn the proper value of <replaceable>sysname</replaceable> for this system type. <programlisting>
5754    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable>
5755    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
5756                 role="bold">.usr</emphasis>
5757    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
5758                 role="bold">.usr.afsws</emphasis>
5759 </programlisting></para>
5760         </listitem>
5761
5762         <listitem>
5763           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the newly created volumes. Because the
5764           <emphasis role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> part
5765           of the pathname with a period to specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos
5766           release</emphasis> command to release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the
5767           <emphasis role="bold">fs checkvolumes</emphasis> command to force the local Cache Manager to access them. <programlisting>
5768    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable> <emphasis
5769                 role="bold">-vol</emphasis> <replaceable>sysname</replaceable>
5770    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5771                 role="bold">/usr</emphasis>  <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
5772                 role="bold">.usr</emphasis>
5773    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5774                 role="bold">/usr/afsws</emphasis> <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
5775                 role="bold">.usr.afsws</emphasis>
5776    # <emphasis role="bold">vos release root.cell</emphasis>
5777    # <emphasis role="bold">fs checkvolumes</emphasis>
5778 </programlisting></para>
5779         </listitem>
5780
5781         <listitem>
5782           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">l</emphasis>
5783           (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>)
5784           permissions to the <emphasis role="bold">system:anyuser</emphasis> group on each new directory's ACL. <programlisting>
5785    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable>
5786    # <emphasis role="bold">fs setacl  -dir  .  usr  usr/afsws  -acl  system:anyuser rl</emphasis>
5787 </programlisting> <indexterm>
5788               <primary>commands</primary>
5789
5790               <secondary>fs setquota</secondary>
5791             </indexterm> <indexterm>
5792               <primary>fs commands</primary>
5793
5794               <secondary>setquota</secondary>
5795             </indexterm> <indexterm>
5796               <primary>quota for volume</primary>
5797             </indexterm> <indexterm>
5798               <primary>volume</primary>
5799
5800               <secondary>setting quota</secondary>
5801             </indexterm> <indexterm>
5802               <primary>setting</primary>
5803
5804               <secondary>volume quota</secondary>
5805             </indexterm></para>
5806         </listitem>
5807
5808         <listitem>
5809           <para><anchor id="LIWQ85" />Issue the <emphasis role="bold">fs setquota</emphasis> command to set an unlimited quota on
5810           the volume mounted at the <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5811           role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory. This
5812           enables you to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's
5813           quota.</para>
5814
5815           <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operation. At that
5816           point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
5817           Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
5818
5819           <programlisting>
5820    # <emphasis role="bold">fs setquota /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5821               role="bold">/usr/afsws  0</emphasis>
5822 </programlisting>
5823         </listitem>
5824
5825         <listitem>
5826           <para>Unpack the distribution tarball into the <emphasis role="bold">/tmp/afsdist</emphasis> directory,
5827           if it is not already. <indexterm>
5828               <primary>copying</primary>
5829
5830               <secondary>AFS binaries into volume</secondary>
5831             </indexterm> <indexterm>
5832               <primary>CD-ROM</primary>
5833
5834               <secondary>copying AFS binaries into volume</secondary>
5835             </indexterm> <indexterm>
5836               <primary>first AFS machine</primary>
5837
5838               <secondary>copying</secondary>
5839
5840               <tertiary>AFS binaries into volume</tertiary>
5841             </indexterm></para>
5842         </listitem>
5843
5844         <listitem>
5845           <para>Copy the contents of the indicated directories from the
5846           distribution into the <emphasis
5847           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5848           role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory.
5849           <programlisting>
5850    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5851                 role="bold">/usr/afsws</emphasis>
5852    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/bin  .</emphasis>
5853    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/etc  .</emphasis>
5854    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/include  .</emphasis>
5855    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/lib  .</emphasis>
5856 </programlisting>
5857 <indexterm>
5858               <primary>creating</primary>
5859
5860               <secondary>symbolic link</secondary>
5861
5862               <tertiary>to AFS binaries</tertiary>
5863             </indexterm> <indexterm>
5864               <primary>symbolic link</primary>
5865
5866               <secondary>to AFS binaries from local disk</secondary>
5867             </indexterm></para>
5868         </listitem>
5869
5870         <listitem>
5871           <para><anchor id="LIWQ86" />Create <emphasis role="bold">/usr/afsws</emphasis> on the local disk as a symbolic link to the
5872           directory <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5873           role="bold">/@sys/usr/afsws</emphasis>. You can specify the actual system name instead of <emphasis
5874           role="bold">@sys</emphasis> if you wish, but the advantage of using <emphasis role="bold">@sys</emphasis> is that it
5875           remains valid if you upgrade this machine to a different system type. <programlisting>
5876    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws  /usr/afsws</emphasis>
5877 </programlisting> <indexterm>
5878               <primary>PATH environment variable for users</primary>
5879             </indexterm> <indexterm>
5880               <primary>variables</primary>
5881
5882               <secondary>PATH, setting for users</secondary>
5883             </indexterm></para>
5884         </listitem>
5885
5886         <listitem>
5887           <para><emphasis role="bold">(Optional)</emphasis> To enable users to issue commands from the AFS suites (such as <emphasis
5888           role="bold">fs</emphasis>) without having to specify a pathname to their binaries, include the <emphasis
5889           role="bold">/usr/afsws/bin</emphasis> and <emphasis role="bold">/usr/afsws/etc</emphasis> directories in the PATH
5890           environment variable you define in each user's shell initialization file (such as <emphasis
5891           role="bold">.cshrc</emphasis>).</para>
5892         </listitem>
5893       </orderedlist></para>
5894
5895     <indexterm>
5896       <primary>storing</primary>
5897
5898       <secondary>AFS documentation in volumes</secondary>
5899     </indexterm>
5900
5901     <indexterm>
5902       <primary>creating</primary>
5903
5904       <secondary>volume</secondary>
5905
5906       <tertiary>for AFS documentation</tertiary>
5907     </indexterm>
5908
5909     <indexterm>
5910       <primary>volume</primary>
5911
5912       <secondary>for AFS documentation</secondary>
5913     </indexterm>
5914
5915     <indexterm>
5916       <primary>documentation, creating volume for AFS</primary>
5917     </indexterm>
5918
5919     <indexterm>
5920       <primary>usr/afsdoc directory</primary>
5921     </indexterm>
5922
5923     <indexterm>
5924       <primary>directories</primary>
5925
5926       <secondary>/usr/afsdoc</secondary>
5927     </indexterm>
5928   </sect1>
5929
5930   <sect1 id="HDRWQ87">
5931     <title>Storing AFS Documents in AFS</title>
5932
5933     <para>The AFS distribution includes the following documents: <itemizedlist>
5934         <listitem>
5935           <para><emphasis>OpenAFS Release Notes</emphasis></para>
5936         </listitem>
5937
5938         <listitem>
5939           <para><emphasis>OpenAFS Quick Beginnings</emphasis></para>
5940         </listitem>
5941
5942         <listitem>
5943           <para><emphasis>OpenAFS User Guide</emphasis></para>
5944         </listitem>
5945
5946         <listitem>
5947           <para><emphasis>OpenAFS Administration Reference</emphasis></para>
5948         </listitem>
5949
5950         <listitem>
5951           <para><emphasis>OpenAFS Administration Guide</emphasis></para>
5952         </listitem>
5953       </itemizedlist></para>
5954
5955     <note><para>OpenAFS Documentation is not currently provided with all
5956     distributions, but may be downloaded separately from the OpenAFS
5957     website</para></note>
5958
5959     <para>The OpenAFS Documentation Distribution has a directory for each
5960     document format provided. The different formats are suitable for online
5961     viewing, printing, or both.</para>
5962
5963     <para>This section explains how to create and mount a volume to house the documents, making them available to your users. The
5964     recommended mount point for the volume is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5965     role="bold">/afsdoc</emphasis>. If you wish, you can create a link to the mount point on each client machine's local disk,
5966     called <emphasis role="bold">/usr/afsdoc</emphasis>. Alternatively, you can create a link to the mount point in each user's home
5967     directory. You can also choose to permit users to access only certain documents (most probably, the <emphasis>OpenAFS User
5968     Guide</emphasis>) by creating different mount points or setting different ACLs on different document directories.</para>
5969
5970     <para>The current working directory is still <emphasis role="bold">/usr/afs/bin</emphasis>, which houses the <emphasis
5971     role="bold">fs</emphasis> and <emphasis role="bold">vos</emphasis> command suite binaries you use to create and mount volumes.
5972     In the following commands, it is possible you still need to specify the pathname to the commands, depending on how your PATH
5973     environment variable is set. <orderedlist>
5974         <indexterm>
5975           <primary>commands</primary>
5976
5977           <secondary>vos create</secondary>
5978
5979           <tertiary>volume for AFS documentation</tertiary>
5980         </indexterm>
5981
5982         <indexterm>
5983           <primary>vos commands</primary>
5984
5985           <secondary>create</secondary>
5986
5987           <tertiary>volume for AFS documentation</tertiary>
5988         </indexterm>
5989
5990         <listitem>
5991           <para>Issue the <emphasis role="bold">vos create</emphasis> command to create a volume for storing the AFS documentation.
5992           Include the <emphasis role="bold">-maxquota</emphasis> argument to set an unlimited quota on the volume. This enables you
5993           to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's quota.</para>
5994
5995           <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operations. At that
5996           point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
5997           Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
5998
5999           <programlisting>
6000    # <emphasis role="bold">vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt;  <emphasis
6001               role="bold">afsdoc  -maxquota  0</emphasis>
6002 </programlisting>
6003         </listitem>
6004
6005         <listitem>
6006           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the new volume. Because the <emphasis
6007           role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> with a period to
6008           specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos release</emphasis> command to
6009           release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the <emphasis role="bold">fs
6010           checkvolumes</emphasis> command to force the local Cache Manager to access them. <programlisting>
6011    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis> <emphasis
6012                 role="bold">-vol</emphasis> <emphasis role="bold">afsdoc</emphasis>
6013    # <emphasis role="bold">vos release root.cell</emphasis>
6014    # <emphasis role="bold">fs checkvolumes</emphasis>
6015 </programlisting></para>
6016         </listitem>
6017
6018         <listitem>
6019           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">rl</emphasis>
6020           permissions to the <emphasis role="bold">system:anyuser</emphasis> group on the new directory's ACL. <programlisting>
6021    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis>
6022    # <emphasis role="bold">fs setacl  .  system:anyuser rl</emphasis>
6023 </programlisting></para>
6024         </listitem>
6025
6026         <listitem>
6027           <para>Unpack the OpenAFS documentation distribution into the
6028           <emphasis role="bold">/tmp/afsdocs</emphasis> directory. You may use
6029           a different directory, in which case the location you use should be
6030           subsituted in the following examples. For instructions on unpacking
6031           the distribution, consult the documentation for your operating
6032           system's <emphasis role="bold">tar</emphasis> command.
6033           <indexterm>
6034               <primary>copying</primary>
6035
6036               <secondary>AFS documentation from distribution</secondary>
6037             </indexterm> <indexterm>
6038               <primary>OpenAFS Distribution</primary>
6039
6040               <secondary>copying AFS documentation from</secondary>
6041             </indexterm> <indexterm>
6042               <primary>first AFS machine</primary>
6043
6044               <secondary>copying</secondary>
6045
6046               <tertiary>AFS documentation from OpenAFS distribution</tertiary>
6047             </indexterm> <indexterm>
6048               <primary>index.htm file</primary>
6049             </indexterm> <indexterm>
6050               <primary>files</primary>
6051
6052               <secondary>index.htm</secondary>
6053             </indexterm></para>
6054         </listitem>
6055
6056         <listitem>
6057           <para>Copy the AFS documents in one or more formats from the unpacked distribution into subdirectories of the <emphasis
6058           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis> directory. Repeat
6059           the commands for each format. <programlisting>
6060    # <emphasis role="bold">mkdir</emphasis> <replaceable>format_name</replaceable>
6061    # <emphasis role="bold">cd</emphasis> <replaceable>format_name</replaceable>
6062    # <emphasis role="bold">cp -rp /tmp/afsdocs/</emphasis><replaceable>format</replaceable>  <emphasis role="bold">.</emphasis>
6063 </programlisting></para>
6064
6065           <para>If you choose to store the HTML version of the documents in AFS, note that in addition to a subdirectory for each
6066           document there are several files with a <emphasis role="bold">.gif</emphasis> extension, which enable readers to move
6067           easily between sections of a document. The file called <emphasis role="bold">index.htm</emphasis> is an introductory HTML
6068           page that contains a hyperlink to each of the documents. For online viewing to work properly, these files must remain in
6069           the top-level HTML directory (the one named, for example, <emphasis
6070           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/html</emphasis>).</para>
6071         </listitem>
6072
6073         <listitem>
6074           <para><emphasis role="bold">(Optional)</emphasis> If you believe it is helpful to your users to access the AFS documents
6075           in a certain format via a local disk directory, create <emphasis role="bold">/usr/afsdoc</emphasis> on the local disk as a
6076           symbolic link to the documentation directory in AFS (<emphasis
6077           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6078           role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable>). <programlisting>
6079    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> <emphasis
6080                 role="bold">/usr/afsdoc</emphasis>
6081 </programlisting></para>
6082
6083           <para>An alternative is to create a link in each user's home directory to the <emphasis
6084           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6085           role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> directory.</para>
6086         </listitem>
6087       </orderedlist></para>
6088
6089     <indexterm>
6090       <primary>storing</primary>
6091
6092       <secondary>system binaries in volumes</secondary>
6093     </indexterm>
6094
6095     <indexterm>
6096       <primary>creating</primary>
6097
6098       <secondary>volume</secondary>
6099
6100       <tertiary>for system binaries</tertiary>
6101     </indexterm>
6102
6103     <indexterm>
6104       <primary>volume</primary>
6105
6106       <secondary>for system binaries</secondary>
6107     </indexterm>
6108
6109     <indexterm>
6110       <primary>binaries</primary>
6111
6112       <secondary>storing system in volumes</secondary>
6113     </indexterm>
6114   </sect1>
6115
6116   <sect1 id="HDRWQ88">
6117     <title>Storing System Binaries in AFS</title>
6118
6119     <para>You can also choose to store other system binaries in AFS volumes, such as the standard UNIX programs conventionally
6120     located in local disk directories such as <emphasis role="bold">/etc</emphasis>, <emphasis role="bold">/bin</emphasis>, and
6121     <emphasis role="bold">/lib</emphasis>. Storing such binaries in an AFS volume not only frees local disk space, but makes it
6122     easier to update binaries on all client machines.</para>
6123
6124     <para>The following is a suggested scheme for storing system binaries in AFS. It does not include instructions, but you can use
6125     the instructions in <link linkend="HDRWQ83">Storing AFS Binaries in AFS</link> (which are for AFS-specific binaries) as a
6126     template.</para>
6127
6128     <para>Some files must remain on the local disk for use when AFS is inaccessible (during bootup and file server or network
6129     outages). The required binaries include the following: <itemizedlist>
6130         <listitem>
6131           <para>A text editor, network commands, and so on</para>
6132         </listitem>
6133
6134         <listitem>
6135           <para>Files used during the boot sequence before the <emphasis role="bold">afsd</emphasis> program runs, such as
6136           initialization and configuration files, and binaries for commands that mount file systems</para>
6137         </listitem>
6138
6139         <listitem>
6140           <para>Files used by dynamic kernel loader programs</para>
6141         </listitem>
6142       </itemizedlist></para>
6143
6144     <para>In most cases, it is more secure to enable only locally authenticated users to access system binaries, by granting the
6145     <emphasis role="bold">l</emphasis> (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis
6146     role="bold">read</emphasis>) permissions to the <emphasis role="bold">system:authuser</emphasis> group on the ACLs of
6147     directories that contain the binaries. If users need to access a binary while unauthenticated, however, the ACL on its directory
6148     must grant those permissions to the <emphasis role="bold">system:anyuser</emphasis> group.</para>
6149
6150     <para>The following chart summarizes the suggested volume and mount point names for storing system binaries. It uses a separate
6151     volume for each directory. You already created a volume called <replaceable>sysname</replaceable> for this machine's system type
6152     when you followed the instructions in <link linkend="HDRWQ83">Storing AFS Binaries in AFS</link>.</para>
6153
6154     <para>You can name volumes in any way you wish, and mount them at other locations than those suggested here. However, this
6155     scheme has several advantages: <itemizedlist>
6156         <listitem>
6157           <para>Volume names clearly identify volume contents</para>
6158         </listitem>
6159
6160         <listitem>
6161           <para>Using the <replaceable>sysname</replaceable> prefix on every volume makes it is easy to back up all of the volumes
6162           together, because the AFS Backup System enables you to define sets of volumes based on a string included in all of their
6163           names</para>
6164         </listitem>
6165
6166         <listitem>
6167           <para>It makes it easy to track related volumes, keeping them together on the same file server machine if desired</para>
6168         </listitem>
6169
6170         <listitem>
6171           <para>There is a clear relationship between volume name and mount point name</para>
6172         </listitem>
6173       </itemizedlist></para>
6174
6175     <informaltable frame="none">
6176       <tgroup cols="2">
6177         <colspec colwidth="50*" />
6178
6179         <colspec colwidth="50*" />
6180
6181         <thead>
6182           <row>
6183             <entry><emphasis role="bold">Volume Name</emphasis></entry>
6184
6185             <entry><emphasis role="bold">Mount Point</emphasis></entry>
6186           </row>
6187         </thead>
6188
6189         <tbody>
6190           <row>
6191             <entry><replaceable>sysname</replaceable></entry>
6192
6193             <entry><emphasis
6194             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable></entry>
6195           </row>
6196
6197           <row>
6198             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">bin</emphasis></entry>
6199
6200             <entry><emphasis
6201             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6202             role="bold">/bin</emphasis></entry>
6203           </row>
6204
6205           <row>
6206             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">etc</emphasis></entry>
6207
6208             <entry><emphasis
6209             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6210             role="bold">/etc</emphasis></entry>
6211           </row>
6212
6213           <row>
6214             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis></entry>
6215
6216             <entry><emphasis
6217             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6218             role="bold">/usr</emphasis></entry>
6219           </row>
6220
6221           <row>
6222             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis></entry>
6223
6224             <entry><emphasis
6225             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6226             role="bold">/usr/afsws</emphasis></entry>
6227           </row>
6228
6229           <row>
6230             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.bin</emphasis></entry>
6231
6232             <entry><emphasis
6233             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6234             role="bold">/usr/bin</emphasis></entry>
6235           </row>
6236
6237           <row>
6238             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.etc</emphasis></entry>
6239
6240             <entry><emphasis
6241             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6242             role="bold">/usr/etc</emphasis></entry>
6243           </row>
6244
6245           <row>
6246             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.inc</emphasis></entry>
6247
6248             <entry><emphasis
6249             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6250             role="bold">/usr/include</emphasis></entry>
6251           </row>
6252
6253           <row>
6254             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.lib</emphasis></entry>
6255
6256             <entry><emphasis
6257             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6258             role="bold">/usr/lib</emphasis></entry>
6259           </row>
6260
6261           <row>
6262             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.loc</emphasis></entry>
6263
6264             <entry><emphasis
6265             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6266             role="bold">/usr/local</emphasis></entry>
6267           </row>
6268
6269           <row>
6270             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.man</emphasis></entry>
6271
6272             <entry><emphasis
6273             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6274             role="bold">/usr/man</emphasis></entry>
6275           </row>
6276
6277           <row>
6278             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.sys</emphasis></entry>
6279
6280             <entry><emphasis
6281             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6282             role="bold">/usr/sys</emphasis></entry>
6283           </row>
6284         </tbody>
6285       </tgroup>
6286     </informaltable>
6287
6288     <indexterm>
6289       <primary>foreign cell, enabling access</primary>
6290     </indexterm>
6291
6292     <indexterm>
6293       <primary>cell</primary>
6294
6295       <secondary>enabling access to foreign</secondary>
6296     </indexterm>
6297
6298     <indexterm>
6299       <primary>access</primary>
6300
6301       <secondary>to local and foreign cells</secondary>
6302     </indexterm>
6303
6304     <indexterm>
6305       <primary>AFS filespace</primary>
6306
6307       <secondary>enabling access to foreign cells</secondary>
6308     </indexterm>
6309
6310     <indexterm>
6311       <primary>root.cell volume</primary>
6312
6313       <secondary>mounting for foreign cells in local filespace</secondary>
6314     </indexterm>
6315
6316     <indexterm>
6317       <primary>database server machine</primary>
6318
6319       <secondary>entry in client CellServDB file</secondary>
6320
6321       <tertiary>for foreign cell</tertiary>
6322     </indexterm>
6323
6324     <indexterm>
6325       <primary>CellServDB file (client)</primary>
6326
6327       <secondary>adding entry</secondary>
6328
6329       <tertiary>for foreign cell</tertiary>
6330     </indexterm>
6331   </sect1>
6332
6333   <sect1 id="HDRWQ91">
6334     <title>Enabling Access to Foreign Cells</title>
6335
6336     <para>With current OpenAFS releases, there exist a number of mechanisms for
6337     providing access to foreign cells. You may add mount points in your AFS
6338     filespace for each foreign cell you wish users to access, or you can
6339     enable a 'synthetic' AFS root, which contains mountpoints for either all
6340     AFS cells defined in the client machine's local
6341     <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis>, or for all cells
6342     providing location information in the DNS.
6343     </para>
6344
6345     <sect2>
6346     <title>Enabling a Synthetic AFS root</title>
6347
6348     <para>When a synthetic root is enabled, the client cache machine creates its
6349     own root.afs volume, rather than using the one provided with your cell. This
6350     allows clients to access all cells in the
6351     <emphasis role="bold">CellServDB</emphasis> file and, optionally, all cells
6352     registered in the DNS, without requiring system administrator action to
6353     enable this access. Using a synthetic root has the additional advantage that
6354     it allows a client to start its AFS service without a network available, as
6355     it is no longer necessary to contact a fileserver to obtain the root volume.
6356     </para>
6357
6358     <para>OpenAFS supports two complimentary mechanisms for creating the
6359     synthetic root. Starting the cache manager with the
6360     <emphasis role="bold">-dynroot</emphasis> option adds all cells listed
6361     in <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> to the client's
6362     AFS root. Adding the <emphasis role="bold">-afsdb</emphasis> option in
6363     addition to this enables DNS lookups for any cells that are not found in
6364     the client's CellServDB file. Both of these options are added to the AFS
6365     initialisation script, or options file, as detailed in
6366     <link linkend="HDRWQ70">Configuring the Cache Manager</link>.</para>
6367     </sect2>
6368     <sect2>
6369       <title>Adding foreign cells to a conventional root volume</title>
6370
6371     <para>In this section you create a mount point in your AFS filespace for the <emphasis role="bold">root.cell</emphasis> volume
6372     of each foreign cell that you want to enable your users to access. For users working on a client machine to access the cell,
6373     there must in addition be an entry for it in the client machine's local <emphasis
6374     role="bold">/usr/vice/etc/CellServDB</emphasis> file. (The instructions in <link linkend="HDRWQ66">Creating the Client
6375     CellServDB File</link> suggest that you use the <emphasis role="bold">CellServDB.sample</emphasis> file included in the AFS
6376     distribution as the basis for your cell's client <emphasis role="bold">CellServDB</emphasis> file. The sample file lists all of
6377     the cells that had agreed to participate in the AFS global namespace at the time your AFS CD-ROM was created. As mentioned in
6378     that section, the AFS Product Support group also maintains a copy of the file, updating it as necessary.)</para>
6379
6380     <para>The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell administration and configuration issues
6381     discusses the implications of participating in the global AFS namespace. The chapter about administering client machines
6382     explains how to maintain knowledge of foreign cells on client machines, and includes suggestions for maintaining a central
6383     version of the file in AFS. <orderedlist>
6384         <listitem>
6385           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount each foreign cell's <emphasis
6386           role="bold">root.cell</emphasis> volume on a directory called <emphasis
6387           role="bold">/afs/</emphasis><replaceable>foreign_cell</replaceable>. Because the <emphasis role="bold">root.afs</emphasis>
6388           volume is replicated, you must create a temporary mount point for its read/write version in a directory to which you have
6389           write access (such as your cell's <emphasis role="bold">/afs/.</emphasis><replaceable>cellname</replaceable> directory).
6390           Create the mount points, issue the <emphasis role="bold">vos release</emphasis> command to release new replicas to the
6391           read-only sites for the <emphasis role="bold">root.afs</emphasis> volume, and issue the <emphasis role="bold">fs
6392           checkvolumes</emphasis> command to force the local Cache Manager to access the new replica.</para>
6393
6394           <note>
6395             <para>You need to issue the <emphasis role="bold">fs mkmount</emphasis> command only once for each foreign cell's
6396             <emphasis role="bold">root.cell</emphasis> volume. You do not need to repeat the command on each client machine.</para>
6397           </note>
6398
6399           <para>Substitute your cell's name for <replaceable>cellname</replaceable>.</para>
6400
6401           <programlisting>
6402    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable>
6403    # <emphasis role="bold">/usr/afs/bin/fs  mkmount  temp  root.afs</emphasis>
6404 </programlisting>
6405
6406           <para>Repeat the <emphasis role="bold">fs mkmount</emphasis> command for each foreign cell you wish to mount at this
6407           time.</para>
6408
6409           <programlisting>
6410    # <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>
6411 </programlisting>
6412
6413           <para>Issue the following commands only once.</para>
6414
6415           <programlisting>
6416    # <emphasis role="bold">/usr/afs/bin/fs rmmount temp</emphasis>
6417    # <emphasis role="bold">/usr/afs/bin/vos release root.afs</emphasis>
6418    # <emphasis role="bold">/usr/afs/bin/fs checkvolumes</emphasis>
6419 </programlisting>
6420
6421           <indexterm>
6422             <primary>fs commands</primary>
6423
6424             <secondary>newcell</secondary>
6425           </indexterm>
6426
6427           <indexterm>
6428             <primary>commands</primary>
6429
6430             <secondary>fs newcell</secondary>
6431           </indexterm>
6432         </listitem>
6433
6434         <listitem>
6435           <para><anchor id="LIWQ92" />If this machine is going to remain an AFS client after you complete the installation, verify
6436           that the local <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file includes an entry for each foreign
6437           cell.</para>
6438
6439           <para>For each cell that does not already have an entry, complete the following instructions: <orderedlist>
6440               <listitem>
6441                 <para>Create an entry in the <emphasis role="bold">CellServDB</emphasis> file. Be sure to comply with the formatting
6442                 instructions in <link linkend="HDRWQ66">Creating the Client CellServDB File</link>.</para>
6443               </listitem>
6444
6445               <listitem>
6446                 <para>Issue the <emphasis role="bold">fs newcell</emphasis> command to add an entry for the cell directly to the
6447                 list that the Cache Manager maintains in kernel memory. Provide each database server machine's fully qualified
6448                 hostname. <programlisting>
6449    # <emphasis role="bold">/usr/afs/bin/fs newcell</emphasis> &lt;<replaceable>foreign_cell</replaceable>&gt; &lt;<replaceable>dbserver1&gt;</replaceable>    \
6450             [&lt;<replaceable>dbserver2&gt;</replaceable>] [&lt;<replaceable>dbserver3&gt;</replaceable>]
6451 </programlisting></para>
6452               </listitem>
6453
6454               <listitem>
6455                 <para>If you plan to maintain a central version of the <emphasis role="bold">CellServDB</emphasis> file (the
6456                 conventional location is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6457                 role="bold">/common/etc/CellServDB</emphasis>), create it now as a copy of the local <emphasis
6458                 role="bold">/usr/vice/etc/CellServDB</emphasis> file. Verify that it includes an entry for each foreign cell you
6459                 want your users to be able to access. <programlisting>
6460    # <emphasis role="bold">mkdir common</emphasis>
6461    # <emphasis role="bold">mkdir common/etc</emphasis>
6462    # <emphasis role="bold">cp  /usr/vice/etc/CellServDB  common/etc</emphasis>
6463    # <emphasis role="bold">/usr/afs/bin/vos release root.cell</emphasis>
6464 </programlisting></para>
6465               </listitem>
6466             </orderedlist></para>
6467         </listitem>
6468
6469         <listitem>
6470           <para>Issue the <emphasis role="bold">ls</emphasis> command to verify that the new cell's mount point is visible in your
6471           filespace. The output lists the directories at the top level of the new cell's AFS filespace. <programlisting>
6472    # <emphasis role="bold">ls /afs/</emphasis><replaceable>foreign_cell</replaceable>
6473 </programlisting></para>
6474         </listitem>
6475
6476         <listitem>
6477           <para>If you wish to participate in the global AFS namespace, and only
6478           intend running one database server, please
6479           register your cell with grand.central.org at this time.
6480           To do so, email the <emphasis role="bold">CellServDB</emphasis> fragment
6481           describing your cell, together with a contact name and email address
6482           for any queries, to cellservdb@grand.central.org. If you intend
6483           on deploying multiple database servers, please wait until you have
6484           installed all of them before registering your cell.</para>
6485         </listitem>
6486         <listitem>
6487           <para>If you wish to allow your cell to be located through DNS lookups,
6488           at this time you should also add the necessary configuration to your
6489           DNS.</para>
6490
6491           <para>AFS database servers may be located by creating AFSDB records
6492           in the DNS for the domain name corresponding to the name of your cell.
6493           It's outside the scope of this guide to give an indepth description of
6494           managing, or configuring, your site's DNS. You should consult the
6495           documentation for your DNS server for further details on AFSDB
6496           records.</para>
6497         </listitem>
6498       </orderedlist></para>
6499     </sect2>
6500   </sect1>
6501
6502   <sect1 id="HDRWQ93">
6503     <title>Improving Cell Security</title>
6504
6505     <indexterm>
6506       <primary>cell</primary>
6507
6508       <secondary>improving security</secondary>
6509     </indexterm>
6510
6511     <indexterm>
6512       <primary>security</primary>
6513
6514       <secondary>improving</secondary>
6515     </indexterm>
6516
6517     <indexterm>
6518       <primary>root superuser</primary>
6519
6520       <secondary>controlling access</secondary>
6521     </indexterm>
6522
6523     <indexterm>
6524       <primary>access</primary>
6525
6526       <secondary>to root and admin accounts</secondary>
6527     </indexterm>
6528
6529     <indexterm>
6530       <primary>admin account</primary>
6531
6532       <secondary>controlling access to</secondary>
6533     </indexterm>
6534
6535     <indexterm>
6536       <primary>AFS filespace</primary>
6537
6538       <secondary>controlling access by root superuser</secondary>
6539     </indexterm>
6540
6541     <para>This section discusses ways to improve the security of AFS data
6542     in your cell. Also see the chapter in the <emphasis>OpenAFS
6543     Administration Guide</emphasis> about configuration and administration
6544     issues.</para>
6545
6546     <sect2 id="HDRWQ94">
6547       <title>Controlling root Access</title>
6548
6549       <para>As on any machine, it is important to prevent unauthorized users from logging onto an AFS server or client machine as
6550       the local superuser <emphasis role="bold">root</emphasis>. Take care to keep the <emphasis role="bold">root</emphasis>
6551       password secret.</para>
6552
6553       <para>The local <emphasis role="bold">root</emphasis> superuser does not have special access to AFS data through the Cache
6554       Manager (as members of the <emphasis role="bold">system:administrators</emphasis> group do), but it does have the following
6555       privileges: <itemizedlist>
6556           <listitem>
6557             <para>On client machines, the ability to issue commands from the <emphasis role="bold">fs</emphasis> suite that affect
6558             AFS performance</para>
6559           </listitem>
6560
6561           <listitem>
6562             <para>On server machines, the ability to disable authorization checking, or to install rogue process binaries</para>
6563           </listitem>
6564         </itemizedlist></para>
6565     </sect2>
6566
6567     <sect2 id="HDRWQ95">
6568       <title>Controlling System Administrator Access</title>
6569
6570       <para>Following are suggestions for managing AFS administrative privilege: <itemizedlist>
6571           <listitem>
6572             <para>Create an administrative account for each administrator named
6573             something like
6574             <replaceable>username</replaceable><emphasis role="bold">.admin</emphasis>.
6575             Administrators authenticate under these identities only when
6576             performing administrative tasks, and destroy the administrative
6577             tokens immediately after finishing the task (either by issuing the
6578             <emphasis role="bold">unlog</emphasis> command, or the
6579             <emphasis role="bold">kinit</emphasis> and
6580             <emphasis role="bold">aklog</emphasis> commands to adopt their
6581             regular identity).</para>
6582           </listitem>
6583
6584           <listitem>
6585             <para>Set a short ticket lifetime for administrator accounts (for example, 20 minutes) by using the
6586             facilities of your KDC. For instance, with a MIT Kerberos KDC, this
6587             can be performed using the
6588             <emphasis role="bold">--max-ticket-life</emphasis> argument to
6589             the <emphasis role="bold">kadmin modify_principal</emphasis>
6590             command. Do not however, use a short lifetime for users
6591             who issue long-running <emphasis role="bold">backup</emphasis> commands.</para>
6592           </listitem>
6593
6594           <listitem>
6595             <para>Limit the number of system administrators in your cell, especially those who belong to the <emphasis
6596             role="bold">system:administrators</emphasis> group. By default they have all ACL rights on all directories in the local
6597             AFS filespace, and therefore must be trusted not to examine private files.</para>
6598           </listitem>
6599
6600           <listitem>
6601             <para>Limit the use of system administrator accounts on machines in public areas. It is especially important not to
6602             leave such machines unattended without first destroying the administrative tokens.</para>
6603           </listitem>
6604
6605           <listitem>
6606             <para>Limit the use by administrators of standard UNIX commands that make connections to remote machines (such as the
6607             <emphasis role="bold">telnet</emphasis> utility). Many of these programs send passwords across the network without
6608             encrypting them.</para>
6609           </listitem>
6610         </itemizedlist></para>
6611
6612       <indexterm>
6613         <primary>BOS Server</primary>
6614
6615         <secondary>checking mode bits on AFS directories</secondary>
6616       </indexterm>
6617
6618       <indexterm>
6619         <primary>mode bits on local AFS directories</primary>
6620       </indexterm>
6621
6622       <indexterm>
6623         <primary>UNIX mode bits on local AFS directories</primary>
6624       </indexterm>
6625     </sect2>
6626
6627     <sect2 id="HDRWQ96">
6628       <title>Protecting Sensitive AFS Directories</title>
6629
6630       <para>Some subdirectories of the <emphasis role="bold">/usr/afs</emphasis> directory contain files crucial to cell security.
6631       Unauthorized users must not read or write to these files because of the potential for misuse of the information they
6632       contain.</para>
6633
6634       <para>As the BOS Server initializes for the first time on a server machine, it creates several files and directories (as
6635       mentioned in <link linkend="HDRWQ50">Starting the BOS Server</link>). It sets their owner to the local superuser <emphasis
6636       role="bold">root</emphasis> and sets their mode bits to enable writing by the owner only; in some cases, it also restricts
6637       reading.</para>
6638
6639       <para>At each subsequent restart, the BOS Server checks that the owner and mode bits on these files are still set
6640       appropriately. If they are not, it write the following message to the <emphasis role="bold">/usr/afs/logs/BosLog</emphasis>
6641       file:</para>
6642
6643       <programlisting>
6644    Bosserver reports inappropriate access on server directories
6645 </programlisting>
6646
6647       <para>The BOS Server does not reset the mode bits, which enables you to set alternate values if you wish.</para>
6648
6649       <para>The following charts lists the expected mode bit settings. A question mark indicates that the BOS Server does not check
6650       that mode bit.</para>
6651
6652       <informaltable frame="none">
6653         <tgroup cols="2">
6654           <colspec colwidth="30*" />
6655
6656           <colspec colwidth="70*" />
6657
6658           <tbody>
6659             <row>
6660               <entry><emphasis role="bold">/usr/afs</emphasis></entry>
6661
6662               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6663             </row>
6664
6665             <row>
6666               <entry><emphasis role="bold">/usr/afs/backup</emphasis></entry>
6667
6668               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6669             </row>
6670
6671             <row>
6672               <entry><emphasis role="bold">/usr/afs/bin</emphasis></entry>
6673
6674               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6675             </row>
6676
6677             <row>
6678               <entry><emphasis role="bold">/usr/afs/db</emphasis></entry>
6679
6680               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6681             </row>
6682
6683             <row>
6684               <entry><emphasis role="bold">/usr/afs/etc</emphasis></entry>
6685
6686               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6687             </row>
6688
6689             <row>
6690               <entry><emphasis role="bold">/usr/afs/etc/KeyFile</emphasis></entry>
6691
6692               <entry><computeroutput>-rw</computeroutput>????<computeroutput>---</computeroutput></entry>
6693             </row>
6694
6695             <row>
6696               <entry><emphasis role="bold">/usr/afs/etc/UserList</emphasis></entry>
6697
6698               <entry><computeroutput>-rw</computeroutput>?????<computeroutput>--</computeroutput></entry>
6699             </row>
6700
6701             <row>
6702               <entry><emphasis role="bold">/usr/afs/local</emphasis></entry>
6703
6704               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6705             </row>
6706
6707             <row>
6708               <entry><emphasis role="bold">/usr/afs/logs</emphasis></entry>
6709
6710               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6711             </row>
6712           </tbody>
6713         </tgroup>
6714       </informaltable>
6715
6716       <indexterm>
6717         <primary>first AFS machine</primary>
6718
6719         <secondary>client functionality</secondary>
6720
6721         <tertiary>removing</tertiary>
6722       </indexterm>
6723
6724       <indexterm>
6725         <primary>removing</primary>
6726
6727         <secondary>client functionality from first AFS machine</secondary>
6728       </indexterm>
6729     </sect2>
6730   </sect1>
6731
6732   <sect1 id="HDRWQ98">
6733     <title>Removing Client Functionality</title>
6734
6735     <para>Follow the instructions in this section only if you do not wish this machine to remain an AFS client. Removing client
6736     functionality means that you cannot use this machine to access AFS files. <orderedlist>
6737         <listitem>
6738           <para>Remove the files from the <emphasis role="bold">/usr/vice/etc</emphasis> directory. The command does not remove the
6739           directory for files used by the dynamic kernel loader program, if it exists on this system type. Those files are still
6740           needed on a server-only machine. <programlisting>
6741    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
6742    # <emphasis role="bold">rm  *</emphasis>
6743    # <emphasis role="bold">rm -rf  C</emphasis>
6744 </programlisting></para>
6745         </listitem>
6746
6747         <listitem>
6748           <para>Create symbolic links to the <emphasis role="bold">ThisCell</emphasis> and <emphasis
6749           role="bold">CellServDB</emphasis> files in the <emphasis role="bold">/usr/afs/etc</emphasis> directory. This makes it
6750           possible to issue commands from the AFS command suites (such as <emphasis role="bold">bos</emphasis> and <emphasis
6751           role="bold">fs</emphasis>) on this machine. <programlisting>
6752    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell ThisCell</emphasis>
6753    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB CellServDB</emphasis>
6754 </programlisting></para>
6755         </listitem>
6756
6757         <listitem>
6758           <para>On IRIX systems, issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
6759           role="bold">afsclient</emphasis> configuration variable. <programlisting>
6760    # <emphasis role="bold">/etc/chkconfig -f afsclient off</emphasis>
6761 </programlisting></para>
6762         </listitem>
6763
6764         <listitem>
6765           <para>Reboot the machine. Most system types use the <emphasis role="bold">shutdown</emphasis> command, but the appropriate
6766           options vary. <programlisting>
6767    # <emphasis role="bold">cd /</emphasis>
6768    # <emphasis role="bold">shutdown</emphasis> <replaceable>appropriate_options</replaceable>
6769 </programlisting></para>
6770         </listitem>
6771       </orderedlist></para>
6772   </sect1>
6773 </chapter>