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