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 10 or 11 on the x86_64 platform:</para>
2143
2144             <programlisting>
2145    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/amd64/afs</emphasis>
2146 </programlisting>
2147
2148             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, its kernel supports NFS server
2149             functionality, and the <emphasis role="bold">nfsd</emphasis> process is running:</para>
2150
2151             <programlisting>
2152    # <emphasis role="bold">cp -p modload/libafs.o /kernel/fs/afs</emphasis>
2153 </programlisting>
2154
2155             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, and its kernel does not support NFS
2156             server functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2157
2158             <programlisting>
2159    # <emphasis role="bold">cp -p modload/libafs.nonfs.o /kernel/fs/afs</emphasis>
2160 </programlisting>
2161
2162             <para>If the machine is running the 64-bit version of Solaris 7, its kernel supports NFS server functionality, and the
2163             <emphasis role="bold">nfsd</emphasis> process is running:</para>
2164
2165             <programlisting>
2166    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/sparcv9/afs</emphasis>
2167 </programlisting>
2168
2169             <para>If the machine is running the 64-bit version of Solaris 7, and its kernel does not support NFS server
2170             functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
2171
2172             <programlisting>
2173    # <emphasis role="bold">cp -p modload/libafs64.nonfs.o /kernel/fs/sparcv9/afs</emphasis>
2174 </programlisting>
2175           </listitem>
2176
2177           <listitem>
2178             <para>Run the AFS initialization script to load AFS modifications into the kernel. You can ignore any error messages
2179             about the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
2180    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2181 </programlisting></para>
2182
2183             <para>When an entry called <computeroutput>afs</computeroutput> does not already exist in the local <emphasis
2184             role="bold">/etc/name_to_sysnum</emphasis> file, the script automatically creates it and reboots the machine to start
2185             using the new version of the file. If this happens, log in again as the superuser <emphasis role="bold">root</emphasis>
2186             after the reboot and run the initialization script again. This time the required entry exists in the <emphasis
2187             role="bold">/etc/name_to_sysnum</emphasis> file, and the <emphasis role="bold">modload</emphasis> program runs.</para>
2188
2189             <programlisting>
2190    login: <emphasis role="bold">root</emphasis>
2191    Password: <replaceable>root_password</replaceable>
2192    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
2193 </programlisting>
2194           </listitem>
2195         </orderedlist></para>
2196
2197       <indexterm>
2198         <primary>replacing fsck program</primary>
2199
2200         <secondary>first AFS machine</secondary>
2201
2202         <tertiary>Solaris</tertiary>
2203       </indexterm>
2204
2205       <indexterm>
2206         <primary>fsck program</primary>
2207
2208         <secondary>on first AFS machine</secondary>
2209
2210         <tertiary>Solaris</tertiary>
2211       </indexterm>
2212
2213       <indexterm>
2214         <primary>first AFS machine</primary>
2215
2216         <secondary>fsck program</secondary>
2217
2218         <tertiary>on Solaris</tertiary>
2219       </indexterm>
2220
2221       <indexterm>
2222         <primary>Solaris</primary>
2223
2224         <secondary>fsck program</secondary>
2225
2226         <tertiary>on first AFS machine</tertiary>
2227       </indexterm>
2228     </sect2>
2229
2230     <sect2 id="HDRWQ47">
2231       <title>Configuring the AFS-modified fsck Program on Solaris Systems</title>
2232
2233       <para>In this section, you make modifications to guarantee that the appropriate <emphasis role="bold">fsck</emphasis> program
2234       runs on AFS server partitions. The <emphasis role="bold">fsck</emphasis> program provided with the operating system must never
2235       run on AFS server partitions. Because it does not recognize the structures that the File Server uses to organize volume data,
2236       it removes all of the data. To repeat:</para>
2237
2238       <para><emphasis role="bold">Never run the standard fsck program on AFS server partitions. It discards AFS volumes.</emphasis>
2239       <orderedlist>
2240           <listitem>
2241             <para>Create the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory to house the AFS-modified <emphasis
2242             role="bold">fsck</emphasis> program and related files. <programlisting>
2243    # <emphasis role="bold">mkdir /usr/lib/fs/afs</emphasis>
2244    # <emphasis role="bold">cd /usr/lib/fs/afs</emphasis>
2245 </programlisting></para>
2246           </listitem>
2247
2248           <listitem>
2249             <para>Copy the <emphasis role="bold">vfsck</emphasis> binary to the newly created directory, changing the name as you do
2250             so. <programlisting>
2251    # <emphasis role="bold">cp  /tmp/afsdist/sun4x_56/dest/root.server/etc/vfsck  fsck</emphasis>
2252 </programlisting></para>
2253           </listitem>
2254
2255           <listitem>
2256             <para>Working in the <emphasis role="bold">/usr/lib/fs/afs</emphasis> directory, create the following links to Solaris
2257             libraries: <programlisting>
2258    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/clri</emphasis>
2259    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/df</emphasis>
2260    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/edquota</emphasis>
2261    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ff</emphasis>
2262    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsdb</emphasis>
2263    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fsirand</emphasis>
2264    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/fstyp</emphasis>
2265    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/labelit</emphasis>
2266    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/lockfs</emphasis>
2267    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mkfs</emphasis>
2268    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/mount</emphasis>
2269    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ncheck</emphasis>
2270    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/newfs</emphasis>
2271    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quot</emphasis>
2272    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quota</emphasis>
2273    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaoff</emphasis>
2274    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/quotaon</emphasis>
2275    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/repquota</emphasis>
2276    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/tunefs</emphasis>
2277    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsdump</emphasis>
2278    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/ufsrestore</emphasis>
2279    # <emphasis role="bold">ln -s /usr/lib/fs/ufs/volcopy</emphasis>
2280 </programlisting></para>
2281           </listitem>
2282
2283           <listitem>
2284             <para>Append the following line to the end of the file <emphasis role="bold">/etc/dfs/fstypes</emphasis>.
2285             <programlisting>
2286    afs AFS Utilities
2287 </programlisting></para>
2288           </listitem>
2289
2290           <listitem>
2291             <para>Edit the <emphasis role="bold">/sbin/mountall</emphasis> file, making two changes. <itemizedlist>
2292                 <listitem>
2293                   <para>Add an entry for AFS to the <computeroutput>case</computeroutput> statement for option 2, so that it reads
2294                   as follows: <programlisting>
2295    case "$2" in
2296    ufs)    foptions="-o p"
2297            ;;
2298    afs)    foptions="-o p"
2299            ;;
2300    s5)     foptions="-y -t /var/tmp/tmp$$ -D"
2301            ;;
2302    *)      foptions="-y"
2303            ;;
2304 </programlisting></para>
2305                 </listitem>
2306
2307                 <listitem>
2308                   <para>Edit the file so that all AFS and UFS partitions are checked in parallel. Replace the following section of
2309                   code: <programlisting>
2310    # For  fsck purposes, we make a distinction between ufs and
2311    # other file systems
2312    #
2313    if [ "$fstype" = "ufs" ]; then
2314         ufs_fscklist="$ufs_fscklist $fsckdev"
2315         saveentry $fstype "$OPTIONS" $special $mountp
2316         continue
2317    fi
2318 </programlisting></para>
2319
2320                   <para>with the following section of code:</para>
2321
2322                   <programlisting>
2323    # For fsck purposes, we make a distinction between ufs/afs
2324    # and other file systems.
2325    #
2326    if [ "$fstype" = "ufs" -o "$fstype" = "afs" ]; then
2327         ufs_fscklist="$ufs_fscklist $fsckdev"
2328         saveentry $fstype "$OPTIONS" $special $mountp
2329         continue
2330    fi
2331 </programlisting>
2332                 </listitem>
2333               </itemizedlist></para>
2334           </listitem>
2335         </orderedlist></para>
2336
2337       <indexterm>
2338         <primary>configuring</primary>
2339
2340         <secondary>AFS server partition on first AFS machine</secondary>
2341
2342         <tertiary>Solaris</tertiary>
2343       </indexterm>
2344
2345       <indexterm>
2346         <primary>AFS server partition</primary>
2347
2348         <secondary>configuring on first AFS machine</secondary>
2349
2350         <tertiary>Solaris</tertiary>
2351       </indexterm>
2352
2353       <indexterm>
2354         <primary>first AFS machine</primary>
2355
2356         <secondary>AFS server partition</secondary>
2357
2358         <tertiary>on Solaris</tertiary>
2359       </indexterm>
2360
2361       <indexterm>
2362         <primary>Solaris</primary>
2363
2364         <secondary>AFS server partition</secondary>
2365
2366         <tertiary>on first AFS machine</tertiary>
2367       </indexterm>
2368     </sect2>
2369
2370     <sect2 id="HDRWQ48">
2371       <title>Configuring Server Partitions on Solaris Systems</title>
2372
2373       <para>Every AFS file server machine must have at least one partition or logical volume dedicated to storing AFS volumes. Each
2374       server partition is mounted at a directory named <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>, where
2375       <replaceable>xx</replaceable> is one or two lowercase letters. The <emphasis
2376       role="bold">/vicep</emphasis><replaceable>xx</replaceable> directories must reside in the file server machine's root
2377       directory, not in one of its subdirectories (for example, <emphasis role="bold">/usr/vicepa</emphasis> is not an acceptable
2378       directory location). For additional information, see <link linkend="HDRWQ20">Performing Platform-Specific Procedures</link>.
2379       <orderedlist>
2380           <listitem>
2381             <para>Create a directory called <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable> for each AFS server
2382             partition you are configuring (there must be at least one). Repeat the command for each partition. <programlisting>
2383    # <emphasis role="bold">mkdir /vicep</emphasis><replaceable>xx</replaceable>
2384 </programlisting></para>
2385           </listitem>
2386
2387           <listitem>
2388             <para>Add a line with the following format to the file systems registry file, <emphasis
2389             role="bold">/etc/vfstab</emphasis>, for each partition to be mounted on a directory created in the previous step. Note
2390             the value <computeroutput>afs</computeroutput> in the fourth field, which tells Solaris to use the AFS-modified
2391             <emphasis role="bold">fsck</emphasis> program on this partition. <programlisting>
2392    /dev/dsk/<replaceable>disk</replaceable>   /dev/rdsk/<replaceable>disk</replaceable>   /vicep<replaceable>xx</replaceable>   afs   <replaceable>boot_order</replaceable>  yes
2393 </programlisting></para>
2394
2395             <para>The following is an example for the first partition being configured.</para>
2396
2397             <programlisting>
2398    /dev/dsk/c0t6d0s1 /dev/rdsk/c0t6d0s1 /vicepa afs 3 yes
2399 </programlisting>
2400           </listitem>
2401
2402           <listitem>
2403             <para>Create a file system on each partition that is to be mounted at a <emphasis
2404             role="bold">/vicep</emphasis><replaceable>xx</replaceable> directory. The following command is probably appropriate, but
2405             consult the Solaris documentation for more information. <programlisting>
2406    # <emphasis role="bold">newfs -v /dev/rdsk/</emphasis><replaceable>disk</replaceable>
2407 </programlisting></para>
2408           </listitem>
2409
2410           <listitem>
2411             <para>Issue the <emphasis role="bold">mountall</emphasis> command to mount all partitions at once.</para>
2412           </listitem>
2413
2414           <listitem>
2415             <para>If you plan to retain client functionality on this machine after completing the installation, proceed to <link
2416             linkend="HDRWQ49">Enabling AFS Login and Editing the File Systems Clean-up Script on Solaris Systems</link>. Otherwise,
2417             proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2418           </listitem>
2419         </orderedlist></para>
2420     </sect2>
2421
2422     <sect2 id="HDRWQ49">
2423       <title>Enabling AFS Login on Solaris Systems</title>
2424       <indexterm>
2425         <primary>enabling AFS login</primary>
2426
2427         <secondary>file server machine</secondary>
2428
2429         <tertiary>Solaris</tertiary>
2430       </indexterm>
2431
2432       <indexterm>
2433         <primary>AFS login</primary>
2434
2435         <secondary>on file server machine</secondary>
2436
2437         <tertiary>Solaris</tertiary>
2438       </indexterm>
2439
2440       <indexterm>
2441         <primary>first AFS machine</primary>
2442
2443         <secondary>AFS login</secondary>
2444
2445         <tertiary>on Solaris</tertiary>
2446       </indexterm>
2447
2448       <indexterm>
2449         <primary>Solaris</primary>
2450
2451         <secondary>AFS login</secondary>
2452
2453         <tertiary>on file server machine</tertiary>
2454       </indexterm>
2455
2456       <indexterm>
2457         <primary>PAM</primary>
2458
2459         <secondary>on Solaris</secondary>
2460
2461         <tertiary>file server machine</tertiary>
2462       </indexterm>
2463
2464       <note>
2465         <para>If you plan to remove client functionality from this machine after completing the installation, skip this section and
2466         proceed to <link linkend="HDRWQ50">Starting the BOS Server</link>.</para>
2467       </note>
2468
2469       <para>At this point you incorporate AFS into the operating system's
2470       Pluggable Authentication Module (PAM) scheme.  PAM integrates all
2471       authentication mechanisms on the machine, including login, to provide
2472       the security infrastructure for authenticated access to and from the
2473       machine.</para>
2474
2475       <para>Explaining PAM is beyond the scope of this document.  It is
2476       assumed that you understand the syntax and meanings of settings in the
2477       PAM configuration file (for example, how the
2478       <computeroutput>other</computeroutput> entry works, the effect of
2479       marking an entry as <computeroutput>required</computeroutput>,
2480       <computeroutput>optional</computeroutput>, or
2481       <computeroutput>sufficient</computeroutput>, and so on).</para>
2482
2483       <para>You should first configure your system to obtain Kerberos v5
2484       tickets as part of the authentication process, and then run an AFS PAM
2485       module to obtain tokens from those tickets after authentication.
2486       Current versions of Solaris come with a Kerberos v5 PAM module that
2487       will work, or you can download and install <ulink
2488       url="http://www.eyrie.org/~eagle/software/pam-krb5">Russ Allbery's
2489       Kerberos v5 PAM module</ulink>, which is tested regularly with AFS.
2490       See the instructions of whatever PAM module you use for how to
2491       configure it.</para>
2492
2493       <para>Some Kerberos v5 PAM modules do come with native AFS support
2494       (usually requiring the Heimdal Kerberos implementation rather than the
2495       MIT Kerberos implementation).  If you are using one of those PAM
2496       modules, you can configure it to obtain AFS tokens.  It's more common,
2497       however, to separate the AFS token acquisition into a separate PAM
2498       module.</para>
2499
2500       <para>The recommended AFS PAM module is <ulink
2501       url="http://www.eyrie.org/~eagle/software/pam-afs-session/">Russ
2502       Allbery's pam-afs-session module</ulink>.  It should work with any of
2503       the Kerberos v5 PAM modules.  To add it to the PAM configuration, you
2504       often only need to add configuration to the session group in
2505       <filename>pam.conf</filename>:</para>
2506
2507       <example>
2508         <title>Solaris PAM session example</title>
2509         <literallayout>login session required pam_afs_session.so</literallayout>
2510       </example>
2511
2512       <para>This example enables PAM authentication only for console login.
2513       You may want to add a similar line for the ssh service and for any
2514       other login service that you use, including possibly the
2515       <literal>other</literal> service (which serves as a catch-all).  You
2516       may also want to add options to the AFS PAM session module
2517       (particularly <literal>retain_after_close</literal>, which is
2518       necessary for some versions of Solaris.</para>
2519
2520       <para>For additional configuration examples and the configuration
2521       options of the AFS PAM module, see its documentation.  For more
2522       details on the available options for the PAM configuration, see the
2523       <filename>pam.conf</filename> manual page.</para>
2524
2525       <para>Sites which still require <emphasis
2526       role="bold">kaserver</emphasis> or external Kerberos v4 authentication
2527       should consult <link linkend="KAS016">"Enabling kaserver based AFS
2528       Login on Solaris Systems"</link> for details of how to enable AFS
2529       login on Solaris.</para>
2530
2531       <para>Proceed to <link linkend="HDRWQ49a">Editing the File Systems
2532       Clean-up Script on Solaris Systems</link></para>
2533     </sect2>
2534     <sect2 id="HDRWQ49a">
2535       <title>Editing the File Systems Clean-up Script on Solaris Systems</title>
2536       <indexterm>
2537         <primary>Solaris</primary>
2538
2539         <secondary>file systems clean-up script</secondary>
2540
2541         <tertiary>on file server machine</tertiary>
2542       </indexterm>
2543
2544       <indexterm>
2545         <primary>file systems clean-up script (Solaris)</primary>
2546
2547         <secondary>file server machine</secondary>
2548       </indexterm>
2549
2550       <indexterm>
2551         <primary>scripts</primary>
2552
2553         <secondary>file systems clean-up (Solaris)</secondary>
2554
2555         <tertiary>file server machine</tertiary>
2556       </indexterm>
2557
2558
2559         <orderedlist>
2560           <listitem>
2561             <para>Some Solaris distributions include a script that locates and removes unneeded files from various file systems. Its
2562             conventional location is <emphasis role="bold">/usr/lib/fs/nfs/nfsfind</emphasis>. The script generally uses an argument
2563             to the <emphasis role="bold">find</emphasis> command to define which file systems to search. In this step you modify the
2564             command to exclude the <emphasis role="bold">/afs</emphasis> directory. Otherwise, the command traverses the AFS
2565             filespace of every cell that is accessible from the machine, which can take many hours. The following alterations are
2566             possibilities, but you must verify that they are appropriate for your cell.</para>
2567
2568             <para>The first possible alteration is to add the <emphasis role="bold">-local</emphasis> flag to the existing command,
2569             so that it looks like the following:</para>
2570
2571             <programlisting>
2572    find $dir -local -name .nfs\* -mtime +7 -mount -exec rm -f {} \;
2573 </programlisting>
2574
2575             <para>Another alternative is to exclude any directories whose names begin with the lowercase letter <emphasis
2576             role="bold">a</emphasis> or a non-alphabetic character.</para>
2577
2578             <programlisting>
2579    find /[A-Zb-z]*  <replaceable>remainder of existing command</replaceable>
2580 </programlisting>
2581
2582             <para>Do not use the following command, which still searches under the <emphasis role="bold">/afs</emphasis> directory,
2583             looking for a subdirectory of type <emphasis role="bold">4.2</emphasis>.</para>
2584
2585             <programlisting>
2586    find / -fstype 4.2     /* <replaceable>do not use</replaceable> */
2587 </programlisting>
2588           </listitem>
2589
2590           <listitem>
2591             <para>Proceed to <link linkend="HDRWQ50">Starting the BOS Server</link> (or if referring to these instructions while
2592             installing an additional file server machine, return to <link linkend="HDRWQ108">Starting Server
2593             Programs</link>).</para>
2594           </listitem>
2595         </orderedlist>
2596
2597       <indexterm>
2598         <primary>Basic OverSeer Server</primary>
2599
2600         <see>BOS Server</see>
2601       </indexterm>
2602
2603       <indexterm>
2604         <primary>BOS Server</primary>
2605
2606         <secondary>starting</secondary>
2607
2608         <tertiary>first AFS machine</tertiary>
2609       </indexterm>
2610
2611       <indexterm>
2612         <primary>starting</primary>
2613
2614         <secondary>BOS Server</secondary>
2615
2616         <tertiary>first AFS machine</tertiary>
2617       </indexterm>
2618
2619       <indexterm>
2620         <primary>first AFS machine</primary>
2621
2622         <secondary>BOS Server</secondary>
2623       </indexterm>
2624
2625       <indexterm>
2626         <primary>authorization checking (disabling)</primary>
2627
2628         <secondary>first AFS machine</secondary>
2629       </indexterm>
2630
2631       <indexterm>
2632         <primary>disabling authorization checking</primary>
2633
2634         <secondary>first AFS machine</secondary>
2635       </indexterm>
2636
2637       <indexterm>
2638         <primary>first AFS machine</primary>
2639
2640         <secondary>authorization checking (disabling)</secondary>
2641       </indexterm>
2642     </sect2>
2643   </sect1>
2644   <sect1 id="HDRWQ50">
2645     <title>Starting the BOS Server</title>
2646
2647     <para>You are now ready to start the AFS server processes on this machine.
2648     If you are not working from a packaged distribution, begin by copying the
2649     AFS server binaries from the distribution to the conventional local disk
2650     location, the <emphasis role="bold">/usr/afs/bin</emphasis> directory. The
2651     following instructions also create files in other subdirectories of the
2652     <emphasis role="bold">/usr/afs</emphasis> directory.</para>
2653
2654     <para>Then issue the <emphasis role="bold">bosserver</emphasis> command to initialize the Basic OverSeer (BOS) Server, which
2655     monitors and controls other AFS server processes on its server machine. Include the <emphasis role="bold">-noauth</emphasis>
2656     flag to disable authorization checking. Because you have not yet configured your cell's AFS authentication and authorization
2657     mechanisms, the BOS Server cannot perform authorization checking as it does during normal operation. In no-authorization mode,
2658     it does not verify the identity or privilege of the issuer of a <emphasis role="bold">bos</emphasis> command, and so performs
2659     any operation for anyone.</para>
2660
2661     <para>Disabling authorization checking gravely compromises cell security. You must complete all subsequent steps in one
2662     uninterrupted pass and must not leave the machine unattended until you restart the BOS Server with authorization checking
2663     enabled, in <link linkend="HDRWQ72">Verifying the AFS Initialization Script</link>.</para>
2664
2665     <para>As it initializes for the first time, the BOS Server creates the following directories and files, setting the owner to the
2666     local superuser <emphasis role="bold">root</emphasis> and the mode bits to limit the ability to write (and in some cases, read)
2667     them. For a description of the contents and function of these directories and files, see the chapter in the <emphasis>OpenAFS
2668     Administration Guide</emphasis> about administering server machines. For further discussion of the mode bit settings, see <link
2669     linkend="HDRWQ96">Protecting Sensitive AFS Directories</link>. <indexterm>
2670         <primary>Binary Distribution</primary>
2671
2672         <secondary>copying server files from</secondary>
2673
2674         <tertiary>first AFS machine</tertiary>
2675       </indexterm> <indexterm>
2676         <primary>first AFS machine</primary>
2677
2678         <secondary>subdirectories of /usr/afs</secondary>
2679       </indexterm> <indexterm>
2680         <primary>creating</primary>
2681
2682         <secondary>/usr/afs/bin directory</secondary>
2683
2684         <tertiary>first AFS machine</tertiary>
2685       </indexterm> <indexterm>
2686         <primary>creating</primary>
2687
2688         <secondary>/usr/afs/etc directory</secondary>
2689
2690         <tertiary>first AFS machine</tertiary>
2691       </indexterm> <indexterm>
2692         <primary>copying</primary>
2693
2694         <secondary>server files to local disk</secondary>
2695
2696         <tertiary>first AFS machine</tertiary>
2697       </indexterm> <indexterm>
2698         <primary>first AFS machine</primary>
2699
2700         <secondary>copying</secondary>
2701
2702         <tertiary>server files to local disk</tertiary>
2703       </indexterm> <indexterm>
2704         <primary>usr/afs/bin directory</primary>
2705
2706         <secondary>first AFS machine</secondary>
2707       </indexterm> <indexterm>
2708         <primary>usr/afs/etc directory</primary>
2709
2710         <secondary>first AFS machine</secondary>
2711       </indexterm> <indexterm>
2712         <primary>usr/afs/db directory</primary>
2713       </indexterm> <indexterm>
2714         <primary>usr/afs/local directory</primary>
2715       </indexterm> <indexterm>
2716         <primary>usr/afs/logs directory</primary>
2717       </indexterm> <itemizedlist>
2718         <listitem>
2719           <para><emphasis role="bold">/usr/afs/db</emphasis></para>
2720         </listitem>
2721
2722         <listitem>
2723           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis></para>
2724         </listitem>
2725
2726         <listitem>
2727           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis></para>
2728         </listitem>
2729
2730         <listitem>
2731           <para><emphasis role="bold">/usr/afs/local</emphasis></para>
2732         </listitem>
2733
2734         <listitem>
2735           <para><emphasis role="bold">/usr/afs/logs</emphasis></para>
2736         </listitem>
2737       </itemizedlist></para>
2738
2739     <para>The BOS Server also creates symbolic links called <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2740     role="bold">/usr/vice/etc/CellServDB</emphasis> to the corresponding files in the <emphasis role="bold">/usr/afs/etc</emphasis>
2741     directory. The AFS command interpreters consult the <emphasis role="bold">CellServDB</emphasis> and <emphasis
2742     role="bold">ThisCell</emphasis> files in the <emphasis role="bold">/usr/vice/etc</emphasis> directory because they generally run
2743     on client machines. On machines that are AFS servers only (as this machine currently is), the files reside only in the <emphasis
2744     role="bold">/usr/afs/etc</emphasis> directory; the links enable the command interpreters to retrieve the information they need.
2745     Later instructions for installing the client functionality replace the links with actual files. <orderedlist>
2746         <listitem>
2747           <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.
2748 <programlisting>
2749    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.server/usr/afs</emphasis>
2750    # <emphasis role="bold">cp -rp  *  /usr/afs</emphasis>
2751 </programlisting> <indexterm>
2752               <primary>commands</primary>
2753
2754               <secondary>bosserver</secondary>
2755             </indexterm> <indexterm>
2756               <primary>bosserver command</primary>
2757             </indexterm></para>
2758         </listitem>
2759
2760         <listitem>
2761           <para>Issue the <emphasis role="bold">bosserver</emphasis> command. Include the <emphasis role="bold">-noauth</emphasis>
2762           flag to disable authorization checking. <programlisting>
2763    # <emphasis role="bold">/usr/afs/bin/bosserver -noauth &amp;</emphasis>
2764 </programlisting></para>
2765         </listitem>
2766
2767         <listitem>
2768           <para>Verify that the BOS Server created <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2769           role="bold">/usr/vice/etc/CellServDB</emphasis> as symbolic links to the corresponding files in the <emphasis
2770           role="bold">/usr/afs/etc</emphasis> directory. <programlisting>
2771    # <emphasis role="bold">ls -l  /usr/vice/etc</emphasis>
2772 </programlisting></para>
2773
2774           <para>If either or both of <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> and <emphasis
2775           role="bold">/usr/vice/etc/CellServDB</emphasis> do not exist, or are not links, issue the following commands.</para>
2776
2777           <programlisting>
2778    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2779    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell</emphasis>
2780    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB</emphasis>
2781 </programlisting>
2782         </listitem>
2783       </orderedlist></para>
2784
2785     <indexterm>
2786       <primary>cell name</primary>
2787
2788       <secondary>defining during installation of first machine</secondary>
2789     </indexterm>
2790
2791     <indexterm>
2792       <primary>defining</primary>
2793
2794       <secondary>cell name during installation of first machine</secondary>
2795     </indexterm>
2796
2797     <indexterm>
2798       <primary>cell name</primary>
2799
2800       <secondary>setting in server ThisCell file</secondary>
2801
2802       <tertiary>first AFS machine</tertiary>
2803     </indexterm>
2804
2805     <indexterm>
2806       <primary>setting</primary>
2807
2808       <secondary>cell name in server ThisCell file</secondary>
2809
2810       <tertiary>first AFS machine</tertiary>
2811     </indexterm>
2812
2813     <indexterm>
2814       <primary>first AFS machine</primary>
2815
2816       <secondary>ThisCell file (server)</secondary>
2817     </indexterm>
2818
2819     <indexterm>
2820       <primary>usr/afs/etc/ThisCell</primary>
2821
2822       <see>ThisCell file (server)</see>
2823     </indexterm>
2824
2825     <indexterm>
2826       <primary>ThisCell file (server)</primary>
2827
2828       <secondary>first AFS machine</secondary>
2829     </indexterm>
2830
2831     <indexterm>
2832       <primary>files</primary>
2833
2834       <secondary>ThisCell (server)</secondary>
2835     </indexterm>
2836
2837     <indexterm>
2838       <primary>database server machine</primary>
2839
2840       <secondary>entry in server CellServDB file</secondary>
2841
2842       <tertiary>on first AFS machine</tertiary>
2843     </indexterm>
2844
2845     <indexterm>
2846       <primary>first AFS machine</primary>
2847
2848       <secondary>cell membership, defining</secondary>
2849
2850       <tertiary>for server processes</tertiary>
2851     </indexterm>
2852
2853     <indexterm>
2854       <primary>usr/afs/etc/CellServDB file</primary>
2855
2856       <see>CellServDB file (server)</see>
2857     </indexterm>
2858
2859     <indexterm>
2860       <primary>CellServDB file (server)</primary>
2861
2862       <secondary>creating</secondary>
2863
2864       <tertiary>on first AFS machine</tertiary>
2865     </indexterm>
2866
2867     <indexterm>
2868       <primary>creating</primary>
2869
2870       <secondary>CellServDB file (server)</secondary>
2871
2872       <tertiary>first AFS machine</tertiary>
2873     </indexterm>
2874
2875     <indexterm>
2876       <primary>files</primary>
2877
2878       <secondary>CellServDB (server)</secondary>
2879     </indexterm>
2880
2881     <indexterm>
2882       <primary>first AFS machine</primary>
2883
2884       <secondary>CellServDB file (server)</secondary>
2885     </indexterm>
2886
2887     <indexterm>
2888       <primary>first AFS machine</primary>
2889
2890       <secondary>defining</secondary>
2891
2892       <tertiary>as database server</tertiary>
2893     </indexterm>
2894
2895     <indexterm>
2896       <primary>defining</primary>
2897
2898       <secondary>first AFS machine as database server</secondary>
2899     </indexterm>
2900   </sect1>
2901
2902   <sect1 id="HDRWQ51">
2903     <title>Defining Cell Name and Membership for Server Processes</title>
2904
2905     <para>Now assign your cell's name. The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration
2906     and administration issues discusses the important considerations, explains why changing the name is difficult, and outlines the
2907     restrictions on name format. Two of the most important restrictions are that the name cannot include uppercase letters or more
2908     than 64 characters.</para>
2909
2910     <para>Use the <emphasis role="bold">bos setcellname</emphasis> command to assign the cell name. It creates two files:
2911     <itemizedlist>
2912         <listitem>
2913           <para><emphasis role="bold">/usr/afs/etc/ThisCell</emphasis>, which defines this machine's cell membership</para>
2914         </listitem>
2915
2916         <listitem>
2917           <para><emphasis role="bold">/usr/afs/etc/CellServDB</emphasis>, which lists the cell's database server machines; the
2918           machine named on the command line is placed on the list automatically</para>
2919         </listitem>
2920       </itemizedlist> <note>
2921         <para>In the following and every instruction in this guide, for the <replaceable>machine name</replaceable> argument
2922         substitute the fully-qualified hostname (such as <emphasis role="bold">fs1.example.com</emphasis>) of the machine you are
2923         installing. For the <replaceable>cell name</replaceable> argument substitute your cell's complete name (such as <emphasis
2924         role="bold">example.com</emphasis>).</para>
2925       </note></para>
2926
2927     <indexterm>
2928       <primary>commands</primary>
2929
2930       <secondary>bos setcellname</secondary>
2931     </indexterm>
2932
2933     <indexterm>
2934       <primary>bos commands</primary>
2935
2936       <secondary>setcellname</secondary>
2937     </indexterm>
2938
2939     <orderedlist>
2940       <listitem>
2941         <para>If necessary, add the directory containing the <emphasis role="bold">bos</emphasis> command to your path.
2942       <programlisting>
2943    # <emphasis role="bold">export PATH=$PATH:/usr/afs/bin</emphasis>
2944       </programlisting>
2945         </para>
2946       </listitem>
2947
2948       <listitem>
2949         <para>Issue the <emphasis role="bold">bos setcellname</emphasis> command to set the cell name. <programlisting>
2950    # <emphasis role="bold">bos setcellname</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>cell name</replaceable>&gt; <emphasis
2951               role="bold">-noauth</emphasis>
2952 </programlisting></para>
2953
2954         <para>Because you are not authenticated and authorization checking is disabled, the <emphasis role="bold">bos</emphasis>
2955         command interpreter possibly produces error messages about being unable to obtain tickets and running unauthenticated. You
2956         can safely ignore the messages. <indexterm>
2957             <primary>commands</primary>
2958
2959             <secondary>bos listhosts</secondary>
2960           </indexterm> <indexterm>
2961             <primary>bos commands</primary>
2962
2963             <secondary>listhosts</secondary>
2964           </indexterm> <indexterm>
2965             <primary>CellServDB file (server)</primary>
2966
2967             <secondary>displaying entries</secondary>
2968           </indexterm> <indexterm>
2969             <primary>displaying</primary>
2970
2971             <secondary>CellServDB file (server) entries</secondary>
2972           </indexterm></para>
2973       </listitem>
2974
2975       <listitem>
2976         <para>Issue the <emphasis role="bold">bos listhosts</emphasis> command to verify that the machine you are installing is now
2977         registered as the cell's first database server machine. <programlisting>
2978    # <emphasis role="bold">bos listhosts</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
2979    Cell name is <replaceable>cell_name</replaceable>
2980        Host 1 is <replaceable>machine_name</replaceable>
2981 </programlisting></para>
2982       </listitem>
2983     </orderedlist>
2984
2985     <indexterm>
2986       <primary>database server machine</primary>
2987
2988       <secondary>installing</secondary>
2989
2990       <tertiary>first</tertiary>
2991     </indexterm>
2992
2993     <indexterm>
2994       <primary>instructions</primary>
2995
2996       <secondary>database server machine, installing first</secondary>
2997     </indexterm>
2998
2999     <indexterm>
3000       <primary>installing</primary>
3001
3002       <secondary>database server machine</secondary>
3003
3004       <tertiary>first</tertiary>
3005     </indexterm>
3006
3007     <indexterm>
3008       <primary>Backup Server</primary>
3009
3010       <secondary>starting</secondary>
3011
3012       <tertiary>first AFS machine</tertiary>
3013     </indexterm>
3014
3015     <indexterm>
3016       <primary>buserver process</primary>
3017
3018       <see>Backup Server</see>
3019     </indexterm>
3020
3021     <indexterm>
3022       <primary>starting</primary>
3023
3024       <secondary>Backup Server</secondary>
3025
3026       <tertiary>first AFS machine</tertiary>
3027     </indexterm>
3028
3029     <indexterm>
3030       <primary>first AFS machine</primary>
3031
3032       <secondary>Backup Server</secondary>
3033     </indexterm>
3034
3035     <indexterm>
3036       <primary>Protection Server</primary>
3037
3038       <secondary>starting</secondary>
3039
3040       <tertiary>first AFS machine</tertiary>
3041     </indexterm>
3042
3043     <indexterm>
3044       <primary>ptserver process</primary>
3045
3046       <see>Protection Server</see>
3047     </indexterm>
3048
3049     <indexterm>
3050       <primary>starting</primary>
3051
3052       <secondary>Protection Server</secondary>
3053
3054       <tertiary>first AFS machine</tertiary>
3055     </indexterm>
3056
3057     <indexterm>
3058       <primary>first AFS machine</primary>
3059
3060       <secondary>Protection Server</secondary>
3061     </indexterm>
3062
3063     <indexterm>
3064       <primary>VL Server (vlserver process)</primary>
3065
3066       <secondary>starting</secondary>
3067
3068       <tertiary>first AFS machine</tertiary>
3069     </indexterm>
3070
3071     <indexterm>
3072       <primary>Volume Location Server</primary>
3073
3074       <see>VL Server</see>
3075     </indexterm>
3076
3077     <indexterm>
3078       <primary>starting</primary>
3079
3080       <secondary>VL Server</secondary>
3081
3082       <tertiary>first AFS machine</tertiary>
3083     </indexterm>
3084
3085     <indexterm>
3086       <primary>first AFS machine</primary>
3087
3088       <secondary>VL Server</secondary>
3089     </indexterm>
3090
3091     <indexterm>
3092       <primary>usr/afs/local/BosConfig</primary>
3093
3094       <see>BosConfig file</see>
3095     </indexterm>
3096
3097     <indexterm>
3098       <primary>BosConfig file</primary>
3099
3100       <secondary>adding entries</secondary>
3101
3102       <tertiary>first AFS machine</tertiary>
3103     </indexterm>
3104
3105     <indexterm>
3106       <primary>adding</primary>
3107
3108       <secondary>entries to BosConfig file</secondary>
3109
3110       <tertiary>first AFS machine</tertiary>
3111     </indexterm>
3112
3113     <indexterm>
3114       <primary>files</primary>
3115
3116       <secondary>BosConfig</secondary>
3117     </indexterm>
3118
3119     <indexterm>
3120       <primary>initializing</primary>
3121
3122       <secondary>server process</secondary>
3123
3124       <see>starting</see>
3125     </indexterm>
3126
3127     <indexterm>
3128       <primary>server process</primary>
3129
3130       <secondary>see also entry for each server's name</secondary>
3131     </indexterm>
3132   </sect1>
3133
3134   <sect1 id="HDRWQ52">
3135     <title>Starting the Database Server Processes</title>
3136
3137     <para>Next use the <emphasis role="bold">bos create</emphasis> command to create entries for the three database server processes
3138     in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file and start them running. The three processes run on database
3139     server machines only: <itemizedlist>
3140
3141         <listitem>
3142           <para>The Backup Server (the <emphasis role="bold">buserver</emphasis> process) maintains the Backup Database</para>
3143         </listitem>
3144
3145         <listitem>
3146           <para>The Protection Server (the <emphasis role="bold">ptserver</emphasis> process) maintains the Protection
3147           Database</para>
3148         </listitem>
3149
3150         <listitem>
3151           <para>The Volume Location (VL) Server (the <emphasis role="bold">vlserver</emphasis> process) maintains the Volume
3152           Location Database (VLDB)</para>
3153         </listitem>
3154       </itemizedlist></para>
3155
3156     <indexterm>
3157       <primary>Kerberos</primary>
3158     </indexterm>
3159
3160     <note>
3161       <para>AFS ships with an additional database server named 'kaserver', which
3162       was historically used to provide authentication services to AFS cells.
3163       kaserver was based on <emphasis>Kerberos v4</emphasis>, as such, it is
3164       not recommended for new cells. This guide assumes you have already
3165       configured a Kerberos v5 realm for your site, and details the procedures
3166       required to use AFS with this realm. If you do wish to use
3167       <emphasis role="bold">kaserver</emphasis>, please see the modifications
3168       to these instructions detailed in
3169       <link linkend="KAS006">Starting the kaserver Database Server Process</link>
3170       </para>
3171     </note>
3172
3173     <para>The remaining instructions in this chapter include the <emphasis role="bold">-cell</emphasis> argument on all applicable
3174     commands. Provide the cell name you assigned in <link linkend="HDRWQ51">Defining Cell Name and Membership for Server
3175     Processes</link>. If a command appears on multiple lines, it is only for legibility. <indexterm>
3176         <primary>commands</primary>
3177
3178         <secondary>bos create</secondary>
3179       </indexterm> <indexterm>
3180         <primary>bos commands</primary>
3181
3182         <secondary>create</secondary>
3183       </indexterm> <orderedlist>
3184         <listitem>
3185           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Backup Server. <programlisting>
3186    # <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>
3187 </programlisting></para>
3188         </listitem>
3189
3190         <listitem>
3191           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the Protection Server. <programlisting>
3192    # <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>
3193 </programlisting></para>
3194         </listitem>
3195
3196         <listitem>
3197           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the VL Server. <programlisting>
3198    # <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>
3199 </programlisting></para>
3200         </listitem>
3201       </orderedlist></para>
3202
3203     <indexterm>
3204       <primary>admin account</primary>
3205
3206       <secondary>creating</secondary>
3207     </indexterm>
3208
3209     <indexterm>
3210       <primary>afs entry in Kerberos Database</primary>
3211     </indexterm>
3212
3213     <indexterm>
3214       <primary>Kerberos Database</primary>
3215     </indexterm>
3216
3217     <indexterm>
3218       <primary>creating</primary>
3219
3220       <secondary>afs entry in Kerberos Database</secondary>
3221     </indexterm>
3222
3223     <indexterm>
3224       <primary>creating</primary>
3225
3226       <secondary>admin account in Kerberos Database</secondary>
3227     </indexterm>
3228
3229     <indexterm>
3230       <primary>security</primary>
3231
3232       <secondary>initializing cell-wide</secondary>
3233     </indexterm>
3234
3235     <indexterm>
3236       <primary>cell</primary>
3237
3238       <secondary>initializing security mechanisms</secondary>
3239     </indexterm>
3240
3241     <indexterm>
3242       <primary>initializing</primary>
3243
3244       <secondary>cell security mechanisms</secondary>
3245     </indexterm>
3246
3247     <indexterm>
3248       <primary>usr/afs/etc/KeyFile</primary>
3249
3250       <see>KeyFile file</see>
3251     </indexterm>
3252
3253     <indexterm>
3254       <primary>KeyFile file</primary>
3255
3256       <secondary>first AFS machine</secondary>
3257     </indexterm>
3258
3259     <indexterm>
3260       <primary>files</primary>
3261
3262       <secondary>KeyFile</secondary>
3263     </indexterm>
3264
3265     <indexterm>
3266       <primary>key</primary>
3267
3268       <see>server encryption key</see>
3269     </indexterm>
3270
3271     <indexterm>
3272       <primary>encryption key</primary>
3273
3274       <see>server encryption key</see>
3275     </indexterm>
3276   </sect1>
3277
3278   <sect1 id="HDRWQ53">
3279     <title>Initializing Cell Security </title>
3280
3281     <para>If you are working with an existing cell which uses
3282     <emphasis role="bold">kaserver</emphasis> or Kerberos v4 for authentication,
3283     please see
3284     <link linkend="HDRWQ53">Initializing Cell Security with kaserver</link>
3285     for installation instructions which replace this section.</para>
3286
3287     <para>Now initialize the cell's security mechanisms. Begin by creating the following two entires in your site's Kerberos database: <itemizedlist>
3288         <listitem>
3289           <para>A generic administrative account, called <emphasis role="bold">admin</emphasis> by convention. If you choose to
3290           assign a different name, substitute it throughout the remainder of this document.</para>
3291
3292           <para>After you complete the installation of the first machine, you can continue to have all administrators use the
3293           <emphasis role="bold">admin</emphasis> account, or you can create a separate administrative account for each of them. The
3294           latter scheme implies somewhat more overhead, but provides a more informative audit trail for administrative
3295           operations.</para>
3296         </listitem>
3297
3298         <listitem>
3299           <para>The entry for AFS server processes, called either
3300           <emphasis role="bold">afs</emphasis> or
3301           <emphasis role="bold">afs/<replaceable>cell</replaceable></emphasis>.
3302           The latter form is preferred since it works regardless of whether
3303           your cell name matches your Kerberos realm name and allows multiple
3304           AFS cells to be served from a single Kerberos realm.
3305           No user logs in under this identity, but it is used to encrypt the
3306           server tickets that granted to AFS clients for presentation to
3307           server processes during mutual authentication. (The
3308           chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell configuration and administration describes the
3309           role of server encryption keys in mutual authentication.)</para>
3310
3311           <para>In Step <link linkend="LIWQ58">7</link>, you also place the initial AFS server encryption key into the <emphasis
3312           role="bold">/usr/afs/etc/KeyFile</emphasis> file. The AFS server processes refer to this file to learn the server
3313           encryption key when they need to decrypt server tickets.</para>
3314         </listitem>
3315       </itemizedlist></para>
3316
3317     <para>You also issue several commands that enable the new <emphasis role="bold">admin</emphasis> user to issue privileged
3318     commands in all of the AFS suites.</para>
3319
3320     <para>The following instructions do not configure all of the security mechanisms related to the AFS Backup System. See the
3321     chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about configuring the Backup System.</para>
3322
3323     <para>The examples below assume you are using MIT Kerberos. Please refer
3324     to the documentation for your KDC's administrative interface if you are
3325     using a different vendor</para>
3326
3327     <orderedlist>
3328         <listitem>
3329           <para>Enter <emphasis role="bold">kadmin</emphasis> interactive mode.
3330 <programlisting>
3331    # <emphasis role="bold">kadmin</emphasis>
3332 Authenticating as principal <replaceable>you</replaceable>/admin@<replaceable>YOUR REALM</replaceable> with password
3333 Password for <replaceable>you/admin@REALM</replaceable>: <replaceable>your_password</replaceable>
3334 </programlisting> <indexterm>
3335               <primary>server encryption key</primary>
3336
3337               <secondary>in Kerberos Database</secondary>
3338             </indexterm> <indexterm>
3339               <primary>creating</primary>
3340
3341               <secondary>server encryption key</secondary>
3342
3343               <tertiary>Kerberos Database</tertiary>
3344             </indexterm></para>
3345         </listitem>
3346
3347         <listitem id="LIWQ54">
3348           <para>Issue the
3349           <emphasis role="bold">add_principal</emphasis> command to create
3350           Kerberos Database entries called
3351           <emphasis role="bold">admin</emphasis> and
3352           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>.</para>
3353
3354           <para>You should make the <replaceable>admin_passwd</replaceable> as
3355           long and complex as possible, but keep in mind that administrators
3356           need to enter it often. It must be at least six characters long.</para>
3357           <para>Note that when creating the
3358           <emphasis role="bold">afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3359           entry, the encryption types should be restricted to des-cbc-crc:v4.
3360           For more details regarding encryption types, see the documentation
3361           for your Kerberos installation.
3362
3363 <programlisting>
3364    kadmin: <emphasis role="bold">add_principal -randkey -e des-cbc-crc:v4 afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3365    Principal "afs/<replaceable>cell name</replaceable>@<replaceable>REALM</replaceable>" created.
3366    kadmin:  <emphasis role="bold">add_principal admin</emphasis>
3367    Enter password for principal "admin@<replaceable>REALM</replaceable>": <emphasis role="bold"><replaceable>admin_password</replaceable></emphasis>
3368    Principal "admin@<replaceable>REALM</replaceable>" created.
3369 </programlisting>
3370           </para>
3371
3372           <indexterm>
3373             <primary>commands</primary>
3374
3375             <secondary>kas examine</secondary>
3376           </indexterm>
3377
3378           <indexterm>
3379             <primary>kas commands</primary>
3380
3381             <secondary>examine</secondary>
3382           </indexterm>
3383
3384           <indexterm>
3385             <primary>displaying</primary>
3386
3387             <secondary>server encryption key</secondary>
3388
3389             <tertiary>Authentication Database</tertiary>
3390           </indexterm>
3391         </listitem>
3392
3393         <listitem id="LIWQ55">
3394           <para>Issue the <emphasis role="bold">kadmin
3395           get_principal</emphasis> command to display the <emphasis
3396           role="bold">afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt; entry.
3397 <programlisting>
3398   kadmin: <emphasis role="bold">get_principal afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3399   Principal: afs/<replaceable>cell</replaceable>
3400   [ ... ]
3401   Key: vno 2, DES cbc mode with CRC-32, no salt
3402   [ ... ]
3403 </programlisting>
3404 </para>
3405         </listitem>
3406         <listitem>
3407           <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>
3408
3409           <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>
3410
3411 <programlisting>
3412   kadmin: <emphasis role="bold">ktadd -k /etc/afs.keytab -e des-cbc-crc:v4 afs/&lt;<replaceable>cell name</replaceable>&gt;</emphasis>
3413 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
3414 </programlisting>
3415           <para>Make a note of the key version number (kvno) given in the
3416           response, as you will need it to load the key into bos in a later
3417           step</para>
3418
3419           <note><para>Note that each time you run
3420           <emphasis role="bold">ktadd</emphasis> a new key is generated
3421           for the item being extracted. This means that you cannot run ktadd
3422           multiple times and end up with the same key material each time.
3423           </para></note>
3424
3425         </listitem>
3426         <listitem>
3427           <para>Issue the <emphasis role="bold">quit</emphasis> command to leave <emphasis role="bold">kadmin</emphasis>
3428           interactive mode. <programlisting>
3429    kadmin: <emphasis role="bold">quit</emphasis>
3430 </programlisting> <indexterm>
3431               <primary>commands</primary>
3432
3433               <secondary>bos adduser</secondary>
3434             </indexterm> <indexterm>
3435               <primary>bos commands</primary>
3436
3437               <secondary>adduser</secondary>
3438             </indexterm> <indexterm>
3439               <primary>usr/afs/etc/UserList</primary>
3440
3441               <see>UserList file</see>
3442             </indexterm> <indexterm>
3443               <primary>UserList file</primary>
3444
3445               <secondary>first AFS machine</secondary>
3446             </indexterm> <indexterm>
3447               <primary>files</primary>
3448
3449               <secondary>UserList</secondary>
3450             </indexterm> <indexterm>
3451               <primary>creating</primary>
3452
3453               <secondary>UserList file entry</secondary>
3454             </indexterm> <indexterm>
3455               <primary>admin account</primary>
3456
3457               <secondary>adding</secondary>
3458
3459               <tertiary>to UserList file</tertiary>
3460             </indexterm></para>
3461         </listitem>
3462
3463         <listitem id="LIWQ57">
3464           <para>Issue the <emphasis role="bold">bos adduser</emphasis> command to add the <emphasis
3465           role="bold">admin</emphasis> user to the <emphasis role="bold">/usr/afs/etc/UserList</emphasis> file. This enables the
3466           <emphasis role="bold">admin</emphasis> user to issue privileged <emphasis role="bold">bos</emphasis> and <emphasis
3467           role="bold">vos</emphasis> commands. <programlisting>
3468    # <emphasis role="bold">./bos adduser</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">admin -noauth</emphasis>
3469 </programlisting>
3470             <indexterm>
3471               <primary>commands</primary>
3472               <secondary>asetkey</secondary>
3473             </indexterm>
3474             <indexterm>
3475               <primary>creating</primary>
3476               <secondary>server encryption key</secondary>
3477               <tertiary>KeyFile file</tertiary>
3478             </indexterm>
3479             <indexterm>
3480               <primary>server encryption key</primary>
3481               <secondary>in KeyFile file</secondary>
3482             </indexterm></para>
3483         </listitem>
3484
3485         <listitem id="LIWQ58">
3486           <para>Issue the
3487           <emphasis role="bold">asetkey</emphasis> command to set the AFS
3488           server encryption key in the
3489           <emphasis role="bold">/usr/afs/etc/KeyFile</emphasis> file. This key
3490           is created from the <emphasis role="bold">/etc/afs.keytab</emphasis>
3491           file created earlier.</para>
3492
3493           <para>asetkey requires the key version number (or kvno) of the
3494           <emphasis role="bold">afs/</emphasis><replaceable>cell</replaceable>
3495           key. You should have made note of the kvno when creating the key
3496           earlier.  The key version number can also be found by running the
3497           <emphasis role="bold">kvno</emphasis> command</para>
3498 <programlisting>
3499    # <emphasis role="bold">kvno -k /etc/afs.keytab afs/</emphasis>&lt;<replaceable>cell name</replaceable>&gt;
3500 </programlisting>
3501
3502           <para>Once the kvno is known, the key can then be extracted using
3503           asetkey</para>
3504 <programlisting>
3505    # <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;
3506 </programlisting>
3507
3508           <indexterm>
3509             <primary>commands</primary>
3510             <secondary>bos listkeys</secondary>
3511           </indexterm>
3512
3513           <indexterm>
3514             <primary>bos commands</primary>
3515             <secondary>listkeys</secondary>
3516           </indexterm>
3517
3518           <indexterm>
3519             <primary>displaying</primary>
3520             <secondary>server encryption key</secondary>
3521             <tertiary>KeyFile file</tertiary>
3522           </indexterm>
3523         </listitem>
3524
3525         <listitem id="LIWQ59">
3526           <para>Issue the
3527           <emphasis role="bold">bos listkeys</emphasis> command to verify that
3528           the key version number for the new key in the
3529           <emphasis role="bold">KeyFile</emphasis> file is the same as the key
3530           version number in the Authentication Database's
3531           <emphasis role="bold">afs/<replaceable>cell name</replaceable></emphasis>
3532           entry, which you displayed in Step <link linkend="LIWQ55">3</link>.
3533 <programlisting>
3534    # <emphasis role="bold">./bos listkeys</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-noauth</emphasis>
3535    key 0 has cksum <replaceable>checksum</replaceable>
3536 </programlisting></para>
3537
3538           <para>You can safely ignore any error messages indicating that <emphasis role="bold">bos</emphasis> failed to get tickets
3539           or that authentication failed.</para>
3540         </listitem>
3541       </orderedlist>
3542     </sect1>
3543     <sect1 id="HDRWQ53a">
3544       <title>Initializing the Protection Database</title>
3545
3546       <para>Now continue to configure your cell's security systems by
3547       populating the Protection Database with the newly created
3548       <emphasis role="bold">admin</emphasis> user, and permitting it
3549       to issue priviledged commands on the AFS filesystem.</para>
3550
3551         <orderedlist>
3552           <listitem>
3553           <indexterm>
3554             <primary>commands</primary>
3555             <secondary>pts createuser</secondary>
3556           </indexterm>
3557
3558           <indexterm>
3559             <primary>pts commands</primary>
3560             <secondary>createuser</secondary>
3561           </indexterm>
3562
3563           <indexterm>
3564             <primary>Protection Database</primary>
3565           </indexterm>
3566           <para>Issue the <emphasis role="bold">pts createuser</emphasis> command to create a Protection Database entry for the
3567           <emphasis role="bold">admin</emphasis> user.</para>
3568
3569           <para>By default, the Protection Server assigns AFS UID 1 (one) to the <emphasis role="bold">admin</emphasis> user,
3570           because it is the first user entry you are creating. If the local password file (<emphasis
3571           role="bold">/etc/passwd</emphasis> or equivalent) already has an entry for <emphasis role="bold">admin</emphasis> that
3572           assigns it a UNIX UID other than 1, it is best to use the <emphasis role="bold">-id</emphasis> argument to the <emphasis
3573           role="bold">pts createuser</emphasis> command to make the new AFS UID match the existing UNIX UID. Otherwise, it is best
3574           to accept the default.</para>
3575
3576           <programlisting>
3577    # <emphasis role="bold">pts createuser -name admin</emphasis> [<emphasis
3578               role="bold">-id</emphasis> &lt;<replaceable>AFS UID</replaceable>&gt;]  <emphasis role="bold">-noauth</emphasis>
3579    User admin has id <replaceable>AFS UID</replaceable>
3580 </programlisting>
3581
3582           <indexterm>
3583             <primary>commands</primary>
3584             <secondary>pts adduser</secondary>
3585           </indexterm>
3586
3587           <indexterm>
3588             <primary>pts commands</primary>
3589             <secondary>adduser</secondary>
3590           </indexterm>
3591
3592           <indexterm>
3593             <primary>system:administrators group</primary>
3594           </indexterm>
3595
3596           <indexterm>
3597             <primary>admin account</primary>
3598             <secondary>adding</secondary>
3599             <tertiary>to system:administrators group</tertiary>
3600           </indexterm>
3601         </listitem>
3602
3603         <listitem>
3604           <para>Issue the <emphasis role="bold">pts adduser</emphasis> command to make the <emphasis role="bold">admin</emphasis>
3605           user a member of the <emphasis role="bold">system:administrators</emphasis> group, and the <emphasis role="bold">pts
3606           membership</emphasis> command to verify the new membership. Membership in the group enables the <emphasis
3607           role="bold">admin</emphasis> user to issue privileged <emphasis role="bold">pts</emphasis> commands and some privileged
3608           <emphasis role="bold">fs</emphasis> commands. <programlisting>
3609    # <emphasis role="bold">./pts adduser admin system:administrators</emphasis> <emphasis role="bold">-noauth</emphasis>
3610    # <emphasis role="bold">./pts membership admin</emphasis> <emphasis role="bold">-noauth</emphasis>
3611    Groups admin (id: 1) is a member of:
3612      system:administrators
3613 </programlisting> <indexterm>
3614               <primary>commands</primary>
3615               <secondary>bos restart</secondary>
3616               <tertiary>on first AFS machine</tertiary>
3617             </indexterm> <indexterm>
3618               <primary>bos commands</primary>
3619               <secondary>restart</secondary>
3620               <tertiary>on first AFS machine</tertiary>
3621             </indexterm> <indexterm>
3622               <primary>restarting server process</primary>
3623               <secondary>on first AFS machine</secondary>
3624             </indexterm> <indexterm>
3625               <primary>server process</primary>
3626               <secondary>restarting</secondary>
3627               <tertiary>on first AFS machine</tertiary>
3628             </indexterm></para>
3629         </listitem>
3630
3631         <listitem>
3632           <para>Issue the <emphasis role="bold">bos restart</emphasis> command with the <emphasis role="bold">-all</emphasis> flag
3633           to restart the database server processes, so that they start using the new server encryption key. <programlisting>
3634    # <emphasis role="bold">./bos restart</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">-all</emphasis>
3635    <emphasis role="bold">-noauth</emphasis>
3636 </programlisting></para>
3637         </listitem>
3638       </orderedlist>
3639
3640     <indexterm>
3641       <primary>File Server</primary>
3642
3643       <secondary>first AFS machine</secondary>
3644     </indexterm>
3645
3646     <indexterm>
3647       <primary>fileserver process</primary>
3648
3649       <see>File Server</see>
3650     </indexterm>
3651
3652     <indexterm>
3653       <primary>starting</primary>
3654
3655       <secondary>File Server</secondary>
3656
3657       <tertiary>first AFS machine</tertiary>
3658     </indexterm>
3659
3660     <indexterm>
3661       <primary>first AFS machine</primary>
3662
3663       <secondary>File Server, fs process</secondary>
3664     </indexterm>
3665
3666     <indexterm>
3667       <primary>Volume Server</primary>
3668
3669       <secondary>first AFS machine</secondary>
3670     </indexterm>
3671
3672     <indexterm>
3673       <primary>volserver process</primary>
3674
3675       <see>Volume Server</see>
3676     </indexterm>
3677
3678     <indexterm>
3679       <primary>starting</primary>
3680
3681       <secondary>Volume Server</secondary>
3682
3683       <tertiary>first AFS machine</tertiary>
3684     </indexterm>
3685
3686     <indexterm>
3687       <primary>first AFS machine</primary>
3688
3689       <secondary>Volume Server</secondary>
3690     </indexterm>
3691
3692     <indexterm>
3693       <primary>Salvager (salvager process)</primary>
3694
3695       <secondary>first AFS machine</secondary>
3696     </indexterm>
3697
3698     <indexterm>
3699       <primary>fs process</primary>
3700
3701       <secondary>first AFS machine</secondary>
3702     </indexterm>
3703
3704     <indexterm>
3705       <primary>starting</primary>
3706
3707       <secondary>fs process</secondary>
3708
3709       <tertiary>first AFS machine</tertiary>
3710     </indexterm>
3711
3712     <indexterm>
3713       <primary>first AFS machine</primary>
3714
3715       <secondary>Salvager</secondary>
3716     </indexterm>
3717   </sect1>
3718
3719   <sect1 id="HDRWQ60">
3720     <title>Starting the File Server processes</title>
3721
3722     <para>Start either the <emphasis role="bold">fs</emphasis> process or, if you want to run the Demand-Attach File Server, the
3723     <emphasis role="bold">dafs</emphasis> process. The <emphasis role="bold">fs</emphasis> process consists of the File Server,
3724     Volume Server, and Salvager (<emphasis role="bold">fileserver</emphasis>, <emphasis role="bold">volserver</emphasis> and
3725     <emphasis role="bold">salvager</emphasis> processes). The <emphasis role="bold">dafs</emphasis> process consists of the
3726     Demand-Attach File Server, Volume Server, Salvage Server, and Salvager (<emphasis role="bold">dafileserver</emphasis>,
3727     <emphasis role="bold"> davolserver</emphasis>, <emphasis role="bold">salvageserver</emphasis>, and <emphasis
3728     role="bold">dasalvager</emphasis> processes). For information about the Demand-Attach File Server and to see whether or not
3729     you should run it, see <link linkend="DAFS">Appendix C, The Demand-Attach File Server</link>.
3730      <orderedlist>
3731         <listitem>
3732           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">fs</emphasis>
3733           process or the <emphasis role="bold">dafs</emphasis> process. The commands appear here on multiple lines only for legibility.
3734
3735             <itemizedlist>
3736               <listitem>
3737                 <para>If you are not planning on running the Demand-Attach File Server, create the <emphasis role="bold">fs</emphasis>
3738                 process:
3739                   <programlisting>
3740    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs fs /usr/afs/bin/fileserver</emphasis>   \
3741                    <emphasis role="bold">/usr/afs/bin/volserver /usr/afs/bin/salvager</emphasis>  \
3742                    <emphasis role="bold">-noauth</emphasis>
3743 </programlisting></para>
3744              </listitem>
3745              <listitem>
3746                <para>If you are planning on running the Demand-Attach File Server, create the <emphasis
3747                role="bold">dafs</emphasis> process:
3748                   <programlisting>
3749    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">dafs dafs /usr/afs/bin/dafileserver</emphasis>   \
3750                    <emphasis role="bold">/usr/afs/bin/davolserver /usr/afs/bin/salvageserver</emphasis> \
3751                    <emphasis role="bold">/usr/afs/bin/dasalvager</emphasis> <emphasis role="bold">-noauth</emphasis>
3752 </programlisting></para>
3753              </listitem>
3754             </itemizedlist>
3755           </para>
3756
3757           <para>Sometimes a message about Volume Location Database (VLDB) initialization appears, along with one or more instances
3758           of an error message similar to the following:</para>
3759
3760           <programlisting>
3761    FSYNC_clientInit temporary failure (will retry)
3762 </programlisting>
3763
3764           <para>This message appears when the <emphasis role="bold">volserver</emphasis> process tries to start before the <emphasis
3765           role="bold">fileserver</emphasis> process has completed its initialization. Wait a few minutes after the last such message
3766           before continuing, to guarantee that both processes have started successfully. <indexterm>
3767               <primary>commands</primary>
3768
3769               <secondary>bos status</secondary>
3770             </indexterm> <indexterm>
3771               <primary>bos commands</primary>
3772
3773               <secondary>status</secondary>
3774             </indexterm></para>
3775
3776           <para>You can verify that the <emphasis role="bold">fs</emphasis> or <emphasis role="bold">dafs</emphasis> process has started
3777           successfully by issuing the <emphasis role="bold">bos status</emphasis> command. Its output mentions two <computeroutput>proc
3778           starts</computeroutput>.</para>
3779
3780           <itemizedlist>
3781             <listitem>
3782               <para>If you are not running the Demand-Attach File Server:
3783
3784           <programlisting>
3785    # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">fs -long -noauth</emphasis>
3786 </programlisting></para></listitem>
3787
3788             <listitem>
3789               <para>If you are running the Demand-Attach File Server:
3790           <programlisting>
3791    # <emphasis role="bold">./bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis role="bold">dafs -long -noauth</emphasis>
3792 </programlisting></para></listitem>
3793           </itemizedlist>
3794
3795         </listitem>
3796
3797         <listitem>
3798           <para>Your next action depends on whether you have ever run AFS file server machines in the cell: <itemizedlist>
3799               <indexterm>
3800                 <primary>commands</primary>
3801
3802                 <secondary>vos create</secondary>
3803
3804                 <tertiary>root.afs volume</tertiary>
3805               </indexterm>
3806
3807               <indexterm>
3808                 <primary>vos commands</primary>
3809
3810                 <secondary>create</secondary>
3811
3812                 <tertiary>root.afs volume</tertiary>
3813               </indexterm>
3814
3815               <indexterm>
3816                 <primary>root.afs volume</primary>
3817
3818                 <secondary>creating</secondary>
3819               </indexterm>
3820
3821               <indexterm>
3822                 <primary>volume</primary>
3823
3824                 <secondary>creating</secondary>
3825
3826                 <tertiary>root.afs</tertiary>
3827               </indexterm>
3828
3829               <indexterm>
3830                 <primary>creating</primary>
3831
3832                 <secondary>root.afs volume</secondary>
3833               </indexterm>
3834
3835               <listitem>
3836                 <para>If you are installing the first AFS server machine ever in the cell (that is, you are not upgrading the AFS
3837                 software from a previous version), create the first AFS volume, <emphasis role="bold">root.afs</emphasis>.</para>
3838
3839                 <para>For the <replaceable>partition name</replaceable> argument, substitute the name of one of the machine's AFS
3840                 server partitions (such as <emphasis role="bold">/vicepa</emphasis>).</para>
3841
3842                 <programlisting>
3843    # <emphasis role="bold">./vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
3844                     role="bold">root.afs</emphasis>   \
3845                    <emphasis role="bold">-noauth</emphasis>
3846 </programlisting>
3847
3848                 <para>The Volume Server produces a message confirming that it created the volume on the specified partition. You can
3849                 ignore error messages indicating that tokens are missing, or that authentication failed. <indexterm>
3850                     <primary>commands</primary>
3851
3852                     <secondary>vos syncvldb</secondary>
3853                   </indexterm> <indexterm>
3854                     <primary>vos commands</primary>
3855
3856                     <secondary>syncvldb</secondary>
3857                   </indexterm> <indexterm>
3858                     <primary>commands</primary>
3859
3860                     <secondary>vos syncserv</secondary>
3861                   </indexterm> <indexterm>
3862                     <primary>vos commands</primary>
3863
3864                     <secondary>syncserv</secondary>
3865                   </indexterm></para>
3866               </listitem>
3867
3868               <listitem>
3869                 <para>If there are existing AFS file server machines and volumes in the cell, issue the <emphasis role="bold">vos
3870                 syncvldb</emphasis> and <emphasis role="bold">vos syncserv</emphasis> commands to synchronize the VLDB with the
3871                 actual state of volumes on the local machine. To follow the progress of the synchronization operation, which can
3872                 take several minutes, use the <emphasis role="bold">-verbose</emphasis> flag. <programlisting>
3873    # <emphasis role="bold">./vos syncvldb</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
3874                       role="bold">-verbose  -noauth</emphasis>
3875    # <emphasis role="bold">./vos syncserv</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
3876                       role="bold">-verbose  -noauth</emphasis>
3877 </programlisting></para>
3878
3879                 <para>You can ignore error messages indicating that tokens are missing, or that authentication failed.</para>
3880               </listitem>
3881             </itemizedlist></para>
3882         </listitem>
3883       </orderedlist></para>
3884
3885     <indexterm>
3886       <primary>Update Server</primary>
3887
3888       <secondary>starting server portion</secondary>
3889
3890       <tertiary>first AFS machine</tertiary>
3891     </indexterm>
3892
3893     <indexterm>
3894       <primary>upserver process</primary>
3895
3896       <see>Update Server</see>
3897     </indexterm>
3898
3899     <indexterm>
3900       <primary>starting</primary>
3901
3902       <secondary>Update Server server portion</secondary>
3903
3904       <tertiary>first AFS machine</tertiary>
3905     </indexterm>
3906
3907     <indexterm>
3908       <primary>first AFS machine</primary>
3909
3910       <secondary>Update Server server portion</secondary>
3911     </indexterm>
3912
3913     <indexterm>
3914       <primary>first AFS machine</primary>
3915
3916       <secondary>defining</secondary>
3917
3918       <tertiary>as binary distribution machine</tertiary>
3919     </indexterm>
3920
3921     <indexterm>
3922       <primary>first AFS machine</primary>
3923
3924       <secondary>defining</secondary>
3925
3926       <tertiary>as system control machine</tertiary>
3927     </indexterm>
3928
3929     <indexterm>
3930       <primary>system control machine</primary>
3931     </indexterm>
3932
3933     <indexterm>
3934       <primary>binary distribution machine</primary>
3935     </indexterm>
3936   </sect1>
3937
3938   <sect1 id="HDRWQ61">
3939     <title>Starting the Server Portion of the Update Server</title>
3940
3941     <para>Start the server portion of the Update Server (the <emphasis role="bold">upserver</emphasis> process), to distribute the
3942     contents of directories on this machine to other server machines in the cell. It becomes active when you configure the client
3943     portion of the Update Server on additional server machines.</para>
3944
3945     <para>Distributing the contents of its <emphasis role="bold">/usr/afs/etc</emphasis> directory makes this machine the cell's
3946     <emphasis>system control machine</emphasis>. The other server machines in the cell run the <emphasis
3947     role="bold">upclientetc</emphasis> process (an instance of the client portion of the Update Server) to retrieve the
3948     configuration files. Use the <emphasis role="bold">-crypt</emphasis> argument to the <emphasis role="bold">upserver</emphasis>
3949     initialization command to specify that the Update Server distributes the contents of the <emphasis
3950     role="bold">/usr/afs/etc</emphasis> directory only in encrypted form, as shown in the following instruction. Several of the
3951     files in the directory, particularly the <emphasis role="bold">KeyFile</emphasis> file, are crucial to cell security and so must
3952     never cross the network unencrypted.</para>
3953
3954     <para>(You can choose not to configure a system control machine, in which case you must update the configuration files in each
3955     server machine's <emphasis role="bold">/usr/afs/etc</emphasis> directory individually. The <emphasis role="bold">bos</emphasis>
3956     commands used for this purpose also encrypt data before sending it across the network.)</para>
3957
3958     <para>Distributing the contents of its <emphasis role="bold">/usr/afs/bin</emphasis> directory to other server machines of its
3959     system type makes this machine a <emphasis>binary distribution machine</emphasis>. The other server machines of its system type
3960     run the <emphasis role="bold">upclientbin</emphasis> process (an instance of the client portion of the Update Server) to
3961     retrieve the binaries. If your platform has a package management system,
3962     such as 'rpm' or 'apt', running the Update Server to distribute binaries
3963     may interfere with this system.</para>
3964
3965     <para>The binaries in the <emphasis role="bold">/usr/afs/bin</emphasis> directory are not sensitive, so it is not necessary to
3966     encrypt them before transfer across the network. Include the <emphasis role="bold">-clear</emphasis> argument to the <emphasis
3967     role="bold">upserver</emphasis> initialization command to specify that the Update Server distributes the contents of the
3968     <emphasis role="bold">/usr/afs/bin</emphasis> directory in unencrypted form unless an <emphasis
3969     role="bold">upclientbin</emphasis> process requests encrypted transfer.</para>
3970
3971     <para>Note that the server and client portions of the Update Server always mutually authenticate with one another, regardless of
3972     whether you use the <emphasis role="bold">-clear</emphasis> or <emphasis role="bold">-crypt</emphasis> arguments. This protects
3973     their communications from eavesdropping to some degree.</para>
3974
3975     <para>For more information on the <emphasis role="bold">upclient</emphasis> and <emphasis role="bold">upserver</emphasis>
3976     processes, see their reference pages in the <emphasis>OpenAFS Administration Reference</emphasis>. The commands appear on
3977     multiple lines here only for legibility. <orderedlist>
3978         <listitem>
3979           <para>Issue the <emphasis role="bold">bos create</emphasis> command to start the <emphasis role="bold">upserver</emphasis>
3980           process. <programlisting>
3981    # <emphasis role="bold">./bos create</emphasis>  &lt;<replaceable>machine name&gt;</replaceable> <emphasis role="bold">upserver simple</emphasis>  \
3982              <emphasis role="bold">"/usr/afs/bin/upserver  -crypt /usr/afs/etc</emphasis>    \
3983              <emphasis role="bold">-clear /usr/afs/bin"</emphasis> <emphasis role="bold">-noauth</emphasis>
3984 </programlisting></para>
3985         </listitem>
3986       </orderedlist></para>
3987   </sect1>
3988
3989   <sect1 id="HDRWQ62">
3990     <title>Clock Sync Considerations</title>
3991
3992     <para>Keeping the clocks on all server and client machines in your cell synchronized is crucial to several functions, and in
3993     particular to the correct operation of AFS's distributed database technology, Ubik. The chapter in the <emphasis>OpenAFS
3994     Administration Guide</emphasis> about administering server machines explains how time skew can disturb Ubik's performance and
3995     cause service outages in your cell.</para>
3996
3997     <para>You should install and configure your time service independently of
3998     AFS. Your Kerberos realm will also require a reliable time source, so your site
3999     may already have one available.</para>
4000
4001     <indexterm>
4002       <primary>overview</primary>
4003
4004       <secondary>installing client functionality on first machine</secondary>
4005     </indexterm>
4006
4007     <indexterm>
4008       <primary>first AFS machine</primary>
4009
4010       <secondary>client functionality</secondary>
4011
4012       <tertiary>installing</tertiary>
4013     </indexterm>
4014
4015     <indexterm>
4016       <primary>installing</primary>
4017
4018       <secondary>client functionality</secondary>
4019
4020       <tertiary>first AFS machine</tertiary>
4021     </indexterm>
4022   </sect1>
4023
4024   <sect1 id="HDRWQ63">
4025     <title>Overview: Installing Client Functionality</title>
4026
4027     <para>The machine you are installing is now an AFS file server machine,
4028     database server machine, system control machine, and binary distribution
4029     machine. Now make it a client machine by completing the following tasks:
4030     <orderedlist>
4031         <listitem>
4032           <para>Define the machine's cell membership for client processes</para>
4033         </listitem>
4034
4035         <listitem>
4036           <para>Create the client version of the <emphasis role="bold">CellServDB</emphasis> file</para>
4037         </listitem>
4038
4039         <listitem>
4040           <para>Define cache location and size</para>
4041         </listitem>
4042
4043         <listitem>
4044           <para>Create the <emphasis role="bold">/afs</emphasis> directory and start the Cache Manager</para>
4045         </listitem>
4046       </orderedlist></para>
4047
4048     <indexterm>
4049       <primary>Distribution</primary>
4050
4051       <secondary>copying client files from</secondary>
4052
4053       <tertiary>first AFS machine</tertiary>
4054     </indexterm>
4055
4056     <indexterm>
4057       <primary>first AFS machine</primary>
4058
4059       <secondary>copying</secondary>
4060
4061       <tertiary>client files to local disk</tertiary>
4062     </indexterm>
4063
4064     <indexterm>
4065       <primary>copying</primary>
4066
4067       <secondary>client files to local disk</secondary>
4068
4069       <tertiary>first AFS machine</tertiary>
4070     </indexterm>
4071   </sect1>
4072
4073   <sect1 id="HDRWQ64">
4074     <title>Copying Client Files to the Local Disk</title>
4075
4076     <para>You need only undertake the steps in this section, if you are using
4077     a tar file distribution, or one built from scratch. Packaged distributions,
4078     such as RPMs or DEBs will already have installed the necessary files in
4079     the correct locations.</para>
4080
4081     <para>Before installing and configuring the AFS client, copy the necessary files from the tarball to the local <emphasis
4082     role="bold">/usr/vice/etc</emphasis> directory. <orderedlist>
4083         <listitem>
4084           <para>If you have not already done so, unpack the distribution
4085           tarball for this machine's system type into a suitable location on
4086           the filesystem, such as <emphasis role="bold">/tmp/afsdist</emphasis>.
4087           If you use a different location, substitue that in the examples that
4088           follow.</para>
4089         </listitem>
4090
4091         <listitem>
4092           <para>Copy files to the local <emphasis role="bold">/usr/vice/etc</emphasis> directory.</para>
4093
4094           <para>This step places a copy of the AFS initialization script (and related files, if applicable) into the <emphasis
4095           role="bold">/usr/vice/etc</emphasis> directory. In the preceding instructions for incorporating AFS into the kernel, you
4096           copied the script directly to the operating system's conventional location for initialization files. When you incorporate
4097           AFS into the machine's startup sequence in a later step, you can choose to link the two files.</para>
4098
4099           <para>On some system types that use a dynamic kernel loader program, you previously copied AFS library files into a
4100           subdirectory of the <emphasis role="bold">/usr/vice/etc</emphasis> directory. On other system types, you copied the
4101           appropriate AFS library file directly to the directory where the operating system accesses it. The following commands do
4102           not copy or recopy the AFS library files into the <emphasis role="bold">/usr/vice/etc</emphasis> directory, because on
4103           some system types the library files consume a large amount of space. If you want to copy them, add the <emphasis
4104           role="bold">-r</emphasis> flag to the first <emphasis role="bold">cp</emphasis> command and skip the second <emphasis
4105           role="bold">cp</emphasis> command.</para>
4106
4107           <programlisting>
4108    # <emphasis role="bold">cd /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.client/usr/vice/etc</emphasis>
4109    # <emphasis role="bold">cp -p  *  /usr/vice/etc</emphasis>
4110    # <emphasis role="bold">cp -rp  C  /usr/vice/etc</emphasis>
4111 </programlisting>
4112         </listitem>
4113       </orderedlist></para>
4114
4115     <indexterm>
4116       <primary>cell name</primary>
4117
4118       <secondary>setting in client ThisCell file</secondary>
4119
4120       <tertiary>first AFS machine</tertiary>
4121     </indexterm>
4122
4123     <indexterm>
4124       <primary>setting</primary>
4125
4126       <secondary>cell name in client ThisCell file</secondary>
4127
4128       <tertiary>first AFS machine</tertiary>
4129     </indexterm>
4130
4131     <indexterm>
4132       <primary>first AFS machine</primary>
4133
4134       <secondary>ThisCell file (client)</secondary>
4135     </indexterm>
4136
4137     <indexterm>
4138       <primary>first AFS machine</primary>
4139
4140       <secondary>cell membership, defining</secondary>
4141
4142       <tertiary>for client processes</tertiary>
4143     </indexterm>
4144
4145     <indexterm>
4146       <primary>usr/vice/etc/ThisCell</primary>
4147
4148       <see>ThisCell file (client)</see>
4149     </indexterm>
4150
4151     <indexterm>
4152       <primary>ThisCell file (client)</primary>
4153
4154       <secondary>first AFS machine</secondary>
4155     </indexterm>
4156
4157     <indexterm>
4158       <primary>files</primary>
4159
4160       <secondary>ThisCell (client)</secondary>
4161     </indexterm>
4162   </sect1>
4163
4164   <sect1 id="HDRWQ65">
4165     <title>Defining Cell Membership for Client Processes</title>
4166
4167     <para>Every AFS client machine has a copy of the <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> file on its local disk
4168     to define the machine's cell membership for the AFS client programs that run on it. The <emphasis
4169     role="bold">ThisCell</emphasis> file you created in the <emphasis role="bold">/usr/afs/etc</emphasis> directory (in <link
4170     linkend="HDRWQ51">Defining Cell Name and Membership for Server Processes</link>) is used only by server processes.</para>
4171
4172     <para>Among other functions, the <emphasis role="bold">ThisCell</emphasis> file on a client machine determines the following:
4173     <itemizedlist>
4174         <listitem>
4175           <para>The cell in which users gain tokens when they log onto the
4176           machine, assuming it is using an AFS-modified login utility</para>
4177         </listitem>
4178
4179         <listitem>
4180           <para>The cell in which users gain tokens by default when they issue
4181           the <emphasis role="bold">aklog</emphasis> command</para>
4182         </listitem>
4183
4184         <listitem>
4185           <para>The cell membership of the AFS server processes that the AFS
4186           command interpreters on this machine contact by default</para>
4187         </listitem>
4188       </itemizedlist>
4189     <orderedlist>
4190         <listitem>
4191           <para>Change to the <emphasis role="bold">/usr/vice/etc</emphasis> directory and remove the symbolic link created in <link
4192           linkend="HDRWQ50">Starting the BOS Server</link>. <programlisting>
4193    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
4194    # <emphasis role="bold">rm ThisCell</emphasis>
4195 </programlisting></para>
4196         </listitem>
4197
4198         <listitem>
4199           <para>Create the <emphasis role="bold">ThisCell</emphasis> file as a copy of the <emphasis
4200           role="bold">/usr/afs/etc/ThisCell</emphasis> file. Defining the same local cell for both server and client processes leads
4201           to the most consistent AFS performance. <programlisting>
4202    # <emphasis role="bold">cp  /usr/afs/etc/ThisCell  ThisCell</emphasis>
4203 </programlisting></para>
4204         </listitem>
4205       </orderedlist></para>
4206
4207     <indexterm>
4208       <primary>database server machine</primary>
4209
4210       <secondary>entry in client CellServDB file</secondary>
4211
4212       <tertiary>on first AFS machine</tertiary>
4213     </indexterm>
4214
4215     <indexterm>
4216       <primary>usr/vice/etc/CellServDB</primary>
4217
4218       <see>CellServDB file (client)</see>
4219     </indexterm>
4220
4221     <indexterm>
4222       <primary>CellServDB file (client)</primary>
4223
4224       <secondary>creating</secondary>
4225
4226       <tertiary>on first AFS machine</tertiary>
4227     </indexterm>
4228
4229     <indexterm>
4230       <primary>creating</primary>
4231
4232       <secondary>CellServDB file (client)</secondary>
4233
4234       <tertiary>first AFS machine</tertiary>
4235     </indexterm>
4236
4237     <indexterm>
4238       <primary>CellServDB file (client)</primary>
4239
4240       <secondary>required format</secondary>
4241     </indexterm>
4242
4243     <indexterm>
4244       <primary>requirements</primary>
4245
4246       <secondary>CellServDB file format (client version)</secondary>
4247     </indexterm>
4248
4249     <indexterm>
4250       <primary>files</primary>
4251
4252       <secondary>CellServDB (client)</secondary>
4253     </indexterm>
4254
4255     <indexterm>
4256       <primary>first AFS machine</primary>
4257
4258       <secondary>CellServDB file (client)</secondary>
4259     </indexterm>
4260   </sect1>
4261
4262   <sect1 id="HDRWQ66">
4263     <title>Creating the Client CellServDB File</title>
4264
4265     <para>The <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on a client machine's local disk lists the database
4266     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
4267     list of database server machines is wrong, then users working on this machine cannot access the cell. The chapter in the
4268     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines explains how to maintain the file after
4269     creating it.</para>
4270
4271     <para>As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it copies the contents of the
4272     <emphasis role="bold">CellServDB</emphasis> file into kernel memory. The Cache Manager always consults the list in kernel memory
4273     rather than the <emphasis role="bold">CellServDB</emphasis> file itself. Between reboots of the machine, you can use the
4274     <emphasis role="bold">fs newcell</emphasis> command to update the list in kernel memory directly; see the chapter in the
4275     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines.</para>
4276
4277     <para>The AFS distribution includes the file
4278     <emphasis role="bold">CellServDB.dist</emphasis>. It includes an entry for
4279     all AFS cells that agreed to share their database server machine
4280     information at the time the distribution was
4281     created. The definitive copy of this file is maintained at
4282     grand.central.org, and updates may be obtained from
4283     /afs/grand.central.org/service/CellServDB or
4284     <ulink url="http://grand.central.org/dl/cellservdb/CellServDB">
4285     http://grand.central.org/dl/cellservdb/CellServDB</ulink></para>
4286
4287     <para>The <emphasis role="bold">CellServDB.dist</emphasis> file can be a
4288     good basis for the client <emphasis role="bold">CellServDB</emphasis> file,
4289     because all of the entries in it use the correct format. You can add or
4290     remove cell entries as you see fit. Depending on your cache manager
4291     configuration, additional steps (as detailed in
4292     <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>) may be
4293     required to enable the Cache Manager to actually reach the cells.</para>
4294
4295     <para>In this section, you add an entry for the local cell to the local <emphasis role="bold">CellServDB</emphasis> file. The
4296     current working directory is still <emphasis role="bold">/usr/vice/etc</emphasis>. <orderedlist>
4297         <listitem>
4298           <para>Remove the symbolic link created in <link linkend="HDRWQ50">Starting the BOS Server</link> and rename the <emphasis
4299           role="bold">CellServDB.sample</emphasis> file to <emphasis role="bold">CellServDB</emphasis>. <programlisting>
4300    # <emphasis role="bold">rm CellServDB</emphasis>
4301    # <emphasis role="bold">mv CellServDB.sample CellServDB</emphasis>
4302 </programlisting></para>
4303         </listitem>
4304
4305         <listitem>
4306           <para>Add an entry for the local cell to the <emphasis role="bold">CellServDB</emphasis> file. One easy method is to use
4307           the <emphasis role="bold">cat</emphasis> command to append the contents of the server <emphasis
4308           role="bold">/usr/afs/etc/CellServDB</emphasis> file to the client version. <programlisting>
4309     # <emphasis role="bold">cat  /usr/afs/etc/CellServDB &gt;&gt;  CellServDB</emphasis>
4310 </programlisting></para>
4311
4312           <para>Then open the file in a text editor to verify that there are no blank lines, and that all entries have the required
4313           format, which is described just following. The ordering of cells is not significant, but it can be convenient to have the
4314           client machine's home cell at the top; move it there now if you wish. <itemizedlist>
4315               <listitem>
4316                 <para>The first line of a cell's entry has the following format: <programlisting>
4317    &gt;<replaceable>cell_name</replaceable>      #<replaceable>organization</replaceable>
4318 </programlisting></para>
4319
4320                 <para>where <replaceable>cell_name</replaceable> is the cell's complete Internet domain name (for example, <emphasis
4321                 role="bold">example.com</emphasis>) and <replaceable>organization</replaceable> is an optional field that follows any
4322                 number of spaces and the number sign (<computeroutput>#</computeroutput>). By convention it names the organization
4323                 to which the cell corresponds (for example, the Example Corporation).</para>
4324               </listitem>
4325
4326               <listitem>
4327                 <para>After the first line comes a separate line for each database server machine. Each line has the following
4328                 format: <programlisting>
4329    <replaceable>IP_address</replaceable>   #<replaceable>machine_name</replaceable>
4330 </programlisting></para>
4331
4332                 <para>where <replaceable>IP_address</replaceable> is the machine's IP address in dotted decimal format (for example,
4333                 192.12.105.3). Following any number of spaces and the number sign (<computeroutput>#</computeroutput>) is
4334                 <replaceable>machine_name</replaceable>, the machine's fully-qualified hostname (for example, <emphasis
4335                 role="bold">db1.example.com</emphasis>). In this case, the number sign does not indicate a comment;
4336                 <replaceable>machine_name</replaceable> is a required field.</para>
4337               </listitem>
4338             </itemizedlist></para>
4339         </listitem>
4340
4341         <listitem>
4342           <para>If the file includes cells that you do not wish users of this machine to access, remove their entries.</para>
4343         </listitem>
4344       </orderedlist></para>
4345
4346     <para>The following example shows entries for two cells, each of which has three database server machines:</para>
4347
4348     <programlisting>
4349    &gt;example.com       #Example Corporation (home cell)
4350    192.12.105.3      #db1.example.com
4351    192.12.105.4      #db2.example.com
4352    192.12.105.55     #db3.example.com
4353    &gt;example.org    #Example Organization cell
4354    138.255.68.93     #serverA.example.org
4355    138.255.68.72     #serverB.example.org
4356    138.255.33.154    #serverC.example.org
4357 </programlisting>
4358
4359     <indexterm>
4360       <primary>cache</primary>
4361
4362       <secondary>configuring</secondary>
4363
4364       <tertiary>first AFS machine</tertiary>
4365     </indexterm>
4366
4367     <indexterm>
4368       <primary>configuring</primary>
4369
4370       <secondary>cache</secondary>
4371
4372       <tertiary>first AFS machine</tertiary>
4373     </indexterm>
4374
4375     <indexterm>
4376       <primary>setting</primary>
4377
4378       <secondary>cache size and location</secondary>
4379
4380       <tertiary>first AFS machine</tertiary>
4381     </indexterm>
4382
4383     <indexterm>
4384       <primary>first AFS machine</primary>
4385
4386       <secondary>cache size and location</secondary>
4387     </indexterm>
4388   </sect1>
4389
4390   <sect1 id="HDRWQ67">
4391     <title>Configuring the Cache</title>
4392
4393     <para>The Cache Manager uses a cache on the local disk or in machine memory to store local copies of files fetched from file
4394     server machines. As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it sets basic cache
4395     configuration parameters according to definitions in the local <emphasis role="bold">/usr/vice/etc/cacheinfo</emphasis> file.
4396     The file has three fields: <orderedlist>
4397         <listitem>
4398           <para>The first field names the local directory on which to mount the AFS filespace. The conventional location is the
4399           <emphasis role="bold">/afs</emphasis> directory.</para>
4400         </listitem>
4401
4402         <listitem>
4403           <para>The second field defines the local disk directory to use for the disk cache. The conventional location is the
4404           <emphasis role="bold">/usr/vice/cache</emphasis> directory, but you can specify an alternate directory if another
4405           partition has more space available. There must always be a value in this field, but the Cache Manager ignores it if the
4406           machine uses a memory cache.</para>
4407         </listitem>
4408
4409         <listitem>
4410           <para>The third field specifies the number of kilobyte (1024 byte) blocks to allocate for the cache.</para>
4411         </listitem>
4412       </orderedlist></para>
4413
4414     <para>The values you define must meet the following requirements. <itemizedlist>
4415         <listitem>
4416           <para>On a machine using a disk cache, the Cache Manager expects always to be able to use the amount of space specified in
4417           the third field. Failure to meet this requirement can cause serious problems, some of which can be repaired only by
4418           rebooting. You must prevent non-AFS processes from filling up the cache partition. The simplest way is to devote a
4419           partition to the cache exclusively.</para>
4420         </listitem>
4421
4422         <listitem>
4423           <para>The amount of space available in memory or on the partition housing the disk cache directory imposes an absolute
4424           limit on cache size.</para>
4425         </listitem>
4426
4427         <listitem>
4428           <para>The maximum supported cache size can vary in each AFS release; see the <emphasis>OpenAFS Release Notes</emphasis>
4429           for the current version.</para>
4430         </listitem>
4431
4432         <listitem>
4433           <para>For a disk cache, you cannot specify a value in the third field that exceeds 95% of the space available on the
4434           partition mounted at the directory named in the second field. If you violate this restriction, the <emphasis
4435           role="bold">afsd</emphasis> program exits without starting the Cache Manager and prints an appropriate message on the
4436           standard output stream. A value of 90% is more appropriate on most machines. Some operating systems (such as AIX) do not
4437           automatically reserve some space to prevent the partition from filling completely; for them, a smaller value (say, 80% to
4438           85% of the space available) is more appropriate.</para>
4439         </listitem>
4440
4441         <listitem>
4442           <para>For a memory cache, you must leave enough memory for other processes and applications to run. If you try to allocate
4443           more memory than is actually available, the <emphasis role="bold">afsd</emphasis> program exits without initializing the
4444           Cache Manager and produces the following message on the standard output stream. <programlisting>
4445    afsd: memCache allocation failure at <replaceable>number</replaceable> KB
4446 </programlisting></para>
4447
4448           <para>The <replaceable>number</replaceable> value is how many kilobytes were allocated just before the failure, and so
4449           indicates the approximate amount of memory available.</para>
4450         </listitem>
4451       </itemizedlist></para>
4452
4453     <para>Within these hard limits, the factors that determine appropriate cache size include the number of users working on the
4454     machine, the size of the files with which they work, and (for a memory cache) the number of processes that run on the machine.
4455     The higher the demand from these factors, the larger the cache needs to be to maintain good performance.</para>
4456
4457     <para>Disk caches smaller than 10 MB do not generally perform well. Machines serving multiple users usually perform better with
4458     a cache of at least 60 to 70 MB. The point at which enlarging the cache further does not really improve performance depends on
4459     the factors mentioned previously and is difficult to predict.</para>
4460
4461     <para>Memory caches smaller than 1 MB are nonfunctional, and the performance of caches smaller than 5 MB is usually
4462     unsatisfactory. Suitable upper limits are similar to those for disk caches but are probably determined more by the demands on
4463     memory from other sources on the machine (number of users and processes). Machines running only a few processes possibly can use
4464     a smaller memory cache.</para>
4465
4466     <sect2 id="HDRWQ68">
4467       <title>Configuring a Disk Cache</title>
4468
4469       <note>
4470         <para>Not all file system types that an operating system supports are necessarily supported for use as the cache partition.
4471         For possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
4472       </note>
4473
4474       <para>To configure the disk cache, perform the following procedures: <orderedlist>
4475           <listitem>
4476             <para>Create the local directory to use for caching. The following instruction shows the conventional location,
4477             <emphasis role="bold">/usr/vice/cache</emphasis>. If you are devoting a partition exclusively to caching, as
4478             recommended, you must also configure it, make a file system on it, and mount it at the directory created in this step.
4479             <programlisting>
4480    # <emphasis role="bold">mkdir /usr/vice/cache</emphasis>
4481 </programlisting></para>
4482           </listitem>
4483
4484           <listitem>
4485             <para>Create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration parameters discussed
4486             previously. The following instruction shows the standard mount location, <emphasis role="bold">/afs</emphasis>, and the
4487             standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis>. <programlisting>
4488    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
4489 </programlisting></para>
4490
4491             <para>The following example defines the disk cache size as 50,000 KB:</para>
4492
4493             <programlisting>
4494    # <emphasis role="bold">echo "/afs:/usr/vice/cache:50000" &gt; /usr/vice/etc/cacheinfo</emphasis>
4495 </programlisting>
4496           </listitem>
4497         </orderedlist></para>
4498     </sect2>
4499
4500     <sect2 id="HDRWQ69">
4501       <title>Configuring a Memory Cache</title>
4502
4503       <para>To configure a memory cache, create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration
4504       parameters discussed previously. The following instruction shows the standard mount location, <emphasis
4505       role="bold">/afs</emphasis>, and the standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis> (though the
4506       exact value of the latter is irrelevant for a memory cache).</para>
4507
4508       <programlisting>
4509    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
4510 </programlisting>
4511
4512       <para>The following example allocates 25,000 KB of memory for the cache.</para>
4513
4514       <programlisting>
4515    # <emphasis role="bold">echo "/afs:/usr/vice/cache:25000" &gt; /usr/vice/etc/cacheinfo</emphasis>
4516 </programlisting>
4517
4518       <indexterm>
4519         <primary>Cache Manager</primary>
4520
4521         <secondary>first AFS machine</secondary>
4522       </indexterm>
4523
4524       <indexterm>
4525         <primary>configuring</primary>
4526
4527         <secondary>Cache Manager</secondary>
4528
4529         <tertiary>first AFS machine</tertiary>
4530       </indexterm>
4531
4532       <indexterm>
4533         <primary>first AFS machine</primary>
4534
4535         <secondary>Cache Manager</secondary>
4536       </indexterm>
4537
4538       <indexterm>
4539         <primary>afs (/afs) directory</primary>
4540
4541         <secondary>creating</secondary>
4542
4543         <tertiary>first AFS machine</tertiary>
4544       </indexterm>
4545
4546       <indexterm>
4547         <primary>AFS initialization script</primary>
4548
4549         <secondary>setting afsd parameters</secondary>
4550
4551         <tertiary>first AFS machine</tertiary>
4552       </indexterm>
4553
4554       <indexterm>
4555         <primary>first AFS machine</primary>
4556
4557         <secondary>afsd command parameters</secondary>
4558       </indexterm>
4559     </sect2>
4560   </sect1>
4561
4562   <sect1 id="HDRWQ70">
4563     <title>Configuring the Cache Manager</title>
4564
4565     <para>By convention, the Cache Manager mounts the AFS filespace on the local <emphasis role="bold">/afs</emphasis> directory. In
4566     this section you create that directory.</para>
4567
4568     <para>The <emphasis role="bold">afsd</emphasis> program sets several cache configuration parameters as it initializes the Cache
4569     Manager, and starts daemons that improve performance. You can use the <emphasis role="bold">afsd</emphasis> command's arguments
4570     to override the parameters' default values and to change the number of some of the daemons. Depending on the machine's cache
4571     size, its amount of RAM, and how many people work on it, you can sometimes improve Cache Manager performance by overriding the
4572     default values. For a discussion of all of the <emphasis role="bold">afsd</emphasis> command's arguments, see its reference page
4573     in the <emphasis>OpenAFS Administration Reference</emphasis>.</para>
4574
4575     <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
4576     <computeroutput>OPTIONS</computeroutput> variable. You can use it to set nondefault values for the command's arguments, in one
4577     of the following ways: <itemizedlist>
4578         <listitem>
4579           <para>You can create an <emphasis role="bold">afsd</emphasis> <emphasis>options file</emphasis> that sets values for
4580           arguments to the <emphasis role="bold">afsd</emphasis> command. If the file exists, its contents are automatically
4581           substituted for the <computeroutput>OPTIONS</computeroutput> variable in the AFS initialization script. The AFS
4582           distribution for some system types includes an options file; on other system types, you must create it.</para>
4583
4584           <para>You use two variables in the AFS initialization script to specify the path to the options file:
4585           <computeroutput>CONFIG</computeroutput> and <computeroutput>AFSDOPT</computeroutput>. On system types that define a
4586           conventional directory for configuration files, the <computeroutput>CONFIG</computeroutput> variable indicates it by
4587           default; otherwise, the variable indicates an appropriate location.</para>
4588
4589           <para>List the desired <emphasis role="bold">afsd</emphasis> options on a single line in the options file, separating each
4590           option with one or more spaces. The following example sets the <emphasis role="bold">-stat</emphasis> argument to 2500,
4591           the <emphasis role="bold">-daemons</emphasis> argument to 4, and the <emphasis role="bold">-volumes</emphasis> argument to
4592           100.</para>
4593
4594           <programlisting>
4595    -stat 2500 -daemons 4 -volumes 100
4596 </programlisting>
4597         </listitem>
4598
4599         <listitem>
4600           <para>On a machine that uses a disk cache, you can set the <computeroutput>OPTIONS</computeroutput> variable in the AFS
4601           initialization script to one of <computeroutput>$SMALL</computeroutput>, <computeroutput>$MEDIUM</computeroutput>, or
4602           <computeroutput>$LARGE</computeroutput>. The AFS initialization script uses one of these settings if the <emphasis
4603           role="bold">afsd</emphasis> options file named by the <computeroutput>AFSDOPT</computeroutput> variable does not exist. In
4604           the script as distributed, the <computeroutput>OPTIONS</computeroutput> variable is set to the value
4605           <computeroutput>$MEDIUM</computeroutput>.</para>
4606
4607           <note>
4608             <para>Do not set the <computeroutput>OPTIONS</computeroutput> variable to <computeroutput>$SMALL</computeroutput>,
4609             <computeroutput>$MEDIUM</computeroutput>, or <computeroutput>$LARGE</computeroutput> on a machine that uses a memory
4610             cache. The arguments it sets are appropriate only on a machine that uses a disk cache.</para>
4611           </note>
4612
4613           <para>The script (or on some system types the <emphasis role="bold">afsd</emphasis> options file named by the
4614           <computeroutput>AFSDOPT</computeroutput> variable) defines a value for each of <computeroutput>SMALL</computeroutput>,
4615           <computeroutput>MEDIUM</computeroutput>, and <computeroutput>LARGE</computeroutput> that sets <emphasis
4616           role="bold">afsd</emphasis> command arguments appropriately for client machines of different sizes: <itemizedlist>
4617               <listitem>
4618                 <para><computeroutput>SMALL</computeroutput> is suitable for a small machine that serves one or two users and has
4619                 approximately 8 MB of RAM and a 20-MB cache</para>
4620               </listitem>
4621
4622               <listitem>
4623                 <para><computeroutput>MEDIUM</computeroutput> is suitable for a medium-sized machine that serves two to six users
4624                 and has 16 MB of RAM and a 40-MB cache</para>
4625               </listitem>
4626
4627               <listitem>
4628                 <para><computeroutput>LARGE</computeroutput> is suitable for a large machine that serves five to ten users and has
4629                 32 MB of RAM and a 100-MB cache</para>
4630               </listitem>
4631             </itemizedlist></para>
4632         </listitem>
4633
4634         <listitem>
4635           <para>You can choose not to create an <emphasis role="bold">afsd</emphasis> options file and to set the
4636           <computeroutput>OPTIONS</computeroutput> variable in the initialization script to a null value rather than to the default
4637           <computeroutput>$MEDIUM</computeroutput> value. You can then either set arguments directly on the <emphasis
4638           role="bold">afsd</emphasis> command line in the script, or set no arguments (and so accept default values for all Cache
4639           Manager parameters).</para>
4640         </listitem>
4641       </itemizedlist>
4642
4643       <note>
4644       <para>If you are running on a Fedora or RHEL based system, the
4645       openafs-client initialization script behaves differently from that
4646       described above. It sources /etc/sysconfig/openafs, in which the
4647       AFSD_ARGS variable may be set to contain any, or all, of the afsd options
4648       detailed. Note that this script does not support setting an OPTIONS
4649       variable, or the SMALL, MEDIUM and LARGE methods of defining cache size
4650       </para>
4651       </note>
4652
4653  <orderedlist>
4654         <listitem>
4655           <para>Create the local directory on which to mount the AFS filespace, by convention <emphasis role="bold">/afs</emphasis>.
4656           If the directory already exists, verify that it is empty. <programlisting>
4657    # <emphasis role="bold">mkdir /afs</emphasis>
4658 </programlisting></para>
4659         </listitem>
4660
4661         <listitem>
4662           <para>On AIX systems, add the following line to the <emphasis role="bold">/etc/vfs</emphasis> file. It enables AIX to
4663           unmount AFS correctly during shutdown. <programlisting>
4664    afs     4     none     none
4665 </programlisting></para>
4666         </listitem>
4667
4668         <listitem>
4669           <para>On non-package based Linux systems, copy the <emphasis role="bold">afsd</emphasis> options file from the <emphasis
4670           role="bold">/usr/vice/etc</emphasis> directory to the <emphasis role="bold">/etc/sysconfig</emphasis> directory, removing
4671           the <emphasis role="bold">.conf</emphasis> extension as you do so. <programlisting>
4672    # <emphasis role="bold">cp /usr/vice/etc/afs.conf /etc/sysconfig/afs</emphasis>
4673 </programlisting></para>
4674         </listitem>
4675
4676         <listitem>
4677           <para>Edit the machine's AFS initialization script or <emphasis role="bold">afsd</emphasis> options file to set
4678           appropriate values for <emphasis role="bold">afsd</emphasis> command parameters. The script resides in the indicated
4679           location on each system type: <itemizedlist>
4680               <listitem>
4681                 <para>On AIX systems, <emphasis role="bold">/etc/rc.afs</emphasis></para>
4682               </listitem>
4683
4684               <listitem>
4685                 <para>On HP-UX systems, <emphasis role="bold">/sbin/init.d/afs</emphasis></para>
4686               </listitem>
4687
4688               <listitem>
4689                 <para>On IRIX systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
4690               </listitem>
4691
4692                   <listitem>
4693                 <para>On Fedora and RHEL systems, <emphasis role="bold">/etc/sysconfg/openafs</emphasis></para>
4694               </listitem>
4695
4696               <listitem>
4697                 <para>On non-package based Linux systems, <emphasis role="bold">/etc/sysconfig/afs</emphasis> (the <emphasis
4698                 role="bold">afsd</emphasis> options file)</para>
4699               </listitem>
4700
4701               <listitem>
4702                 <para>On Solaris systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
4703               </listitem>
4704             </itemizedlist></para>
4705
4706           <para>Use one of the methods described in the introduction to this section to add the following flags to the <emphasis
4707           role="bold">afsd</emphasis> command line. If you intend for the machine to remain an AFS client, also set any
4708           performance-related arguments you wish. <itemizedlist>
4709               <listitem>
4710                 <para>Add the <emphasis role="bold">-memcache</emphasis> flag if the machine is to use a memory cache.</para>
4711               </listitem>
4712
4713               <listitem>
4714                 <para>Add the <emphasis role="bold">-verbose</emphasis> flag to display a trace of the Cache Manager's
4715                 initialization on the standard output stream.</para>
4716               </listitem>
4717             </itemizedlist></para>
4718         </listitem>
4719       </orderedlist>
4720       <note><para>In order to successfully complete the instructions in the
4721       remainder of this guide, it is important that the machine does not have
4722       a synthetic root (as discussed in <link linkend="HDRWQ91">Enabling Access
4723       to Foreign Cells</link>). As some distributions ship with this enabled, it
4724       may be necessary to remove any occurences of the
4725       <emphasis role="bold">-dynroot</emphasis> and
4726       <emphasis role="bold">-afsdb</emphasis> options from both the AFS
4727       initialisation script and options file. If this functionality is
4728       required it may be renabled as detailed in
4729       <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>.
4730       </para></note>
4731       </para>
4732
4733     <indexterm>
4734       <primary>overview</primary>
4735
4736       <secondary>completing installation of first machine</secondary>
4737     </indexterm>
4738
4739     <indexterm>
4740       <primary>first AFS machine</primary>
4741
4742       <secondary>completion of installation</secondary>
4743     </indexterm>
4744   </sect1>
4745
4746   <sect1 id="HDRWQ71">
4747     <title>Overview: Completing the Installation of the First AFS Machine</title>
4748
4749     <para>The machine is now configured as an AFS file server and client machine. In this final phase of the installation, you
4750     initialize the Cache Manager and then create the upper levels of your AFS filespace, among other procedures. The procedures are:
4751     <orderedlist>
4752         <listitem>
4753           <para>Verify that the initialization script works correctly, and incorporate it into the operating system's startup and
4754           shutdown sequence</para>
4755         </listitem>
4756
4757         <listitem>
4758           <para>Create and mount top-level volumes</para>
4759         </listitem>
4760
4761         <listitem>
4762           <para>Create and mount volumes to store system binaries in AFS</para>
4763         </listitem>
4764
4765         <listitem>
4766           <para>Enable access to foreign cells</para>
4767         </listitem>
4768
4769         <listitem>
4770           <para>Institute additional security measures</para>
4771         </listitem>
4772
4773         <listitem>
4774           <para>Remove client functionality if desired</para>
4775         </listitem>
4776       </orderedlist></para>
4777
4778     <indexterm>
4779       <primary>AFS initialization script</primary>
4780
4781       <secondary>verifying on first AFS machine</secondary>
4782     </indexterm>
4783
4784     <indexterm>
4785       <primary>AFS initialization script</primary>
4786
4787       <secondary>running</secondary>
4788
4789       <tertiary>first AFS machine</tertiary>
4790     </indexterm>
4791
4792     <indexterm>
4793       <primary>first AFS machine</primary>
4794
4795       <secondary>AFS initialization script</secondary>
4796
4797       <tertiary>running/verifying</tertiary>
4798     </indexterm>
4799
4800     <indexterm>
4801       <primary>running AFS init. script</primary>
4802
4803       <secondary>first AFS machine</secondary>
4804     </indexterm>
4805
4806     <indexterm>
4807       <primary>invoking AFS init. script</primary>
4808
4809       <see>running</see>
4810     </indexterm>
4811   </sect1>
4812
4813   <sect1 id="HDRWQ72">
4814     <title>Verifying the AFS Initialization Script</title>
4815
4816     <para>At this point you run the AFS initialization script to verify that it correctly invokes all of the necessary programs and
4817     AFS processes, and that they start correctly. The following are the relevant commands: <itemizedlist>
4818         <listitem>
4819           <para>The command that dynamically loads AFS modifications into the kernel, on some system types (not applicable if the
4820           kernel has AFS modifications built in)</para>
4821         </listitem>
4822
4823         <listitem>
4824           <para>The <emphasis role="bold">bosserver</emphasis> command, which starts the BOS Server; it in turn starts the server
4825           processes for which you created entries in the <emphasis role="bold">/usr/afs/local/BosConfig</emphasis> file</para>
4826         </listitem>
4827
4828         <listitem>
4829           <para>The <emphasis role="bold">afsd</emphasis> command, which initializes the Cache Manager</para>
4830         </listitem>
4831       </itemizedlist></para>
4832
4833     <para>On system types that use a dynamic loader program, you must reboot the machine before running the initialization script,
4834     so that it can freshly load AFS modifications into the kernel.</para>
4835
4836     <para>If there are problems during the initialization, attempt to resolve them. The OpenAFS mailing lists can provide assistance if necessary.
4837
4838      <orderedlist>
4839         <indexterm>
4840           <primary>commands</primary>
4841
4842           <secondary>bos shutdown</secondary>
4843         </indexterm>
4844
4845         <indexterm>
4846           <primary>bos commands</primary>
4847
4848           <secondary>shutdown</secondary>
4849         </indexterm>
4850
4851         <listitem>
4852           <para>Issue the <emphasis role="bold">bos shutdown</emphasis> command to shut down the AFS server processes other than the
4853           BOS Server. Include the <emphasis role="bold">-wait</emphasis> flag to delay return of the command shell prompt until all
4854           processes shut down completely. <programlisting>
4855    # <emphasis role="bold">/usr/afs/bin/bos shutdown</emphasis> &lt;<replaceable>machine name</replaceable>&gt; <emphasis
4856                 role="bold">-wait</emphasis>
4857 </programlisting></para>
4858         </listitem>
4859
4860         <listitem>
4861           <para>Issue the <emphasis role="bold">ps</emphasis> command to learn the <emphasis role="bold">bosserver</emphasis>
4862           process's process ID number (PID), and then the <emphasis role="bold">kill</emphasis> command to stop it. <programlisting>
4863    # <emphasis role="bold">ps</emphasis> <replaceable>appropriate_ps_options</replaceable> <emphasis role="bold">| grep bosserver</emphasis>
4864    # <emphasis role="bold">kill</emphasis> <replaceable>bosserver_PID</replaceable>
4865 </programlisting></para>
4866         </listitem>
4867
4868         <listitem>
4869           <para>Issue the appropriate commands to run the AFS initialization script for this system type.</para>
4870
4871           <indexterm>
4872             <primary>AIX</primary>
4873
4874             <secondary>AFS initialization script</secondary>
4875
4876             <tertiary>on first AFS machine</tertiary>
4877           </indexterm>
4878
4879           <para><emphasis role="bold">On AIX systems:</emphasis> <orderedlist>
4880               <listitem>
4881                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
4882                 <programlisting>
4883    # <emphasis role="bold">cd /</emphasis>
4884    # <emphasis role="bold">shutdown -r now</emphasis>
4885    login: <emphasis role="bold">root</emphasis>
4886    Password: <replaceable>root_password</replaceable>
4887 </programlisting></para>
4888               </listitem>
4889
4890               <listitem>
4891                 <para>Run the AFS initialization script. <programlisting>
4892    # <emphasis role="bold">/etc/rc.afs</emphasis>
4893 </programlisting></para>
4894               </listitem>
4895             </orderedlist></para>
4896
4897           <indexterm>
4898             <primary>HP-UX</primary>
4899
4900             <secondary>AFS initialization script</secondary>
4901
4902             <tertiary>on first AFS machine</tertiary>
4903           </indexterm>
4904
4905           <para><emphasis role="bold">On HP-UX systems:</emphasis> <orderedlist>
4906               <listitem>
4907                 <para>Run the AFS initialization script. <programlisting>
4908    # <emphasis role="bold">/sbin/init.d/afs  start</emphasis>
4909 </programlisting></para>
4910               </listitem>
4911             </orderedlist></para>
4912
4913           <indexterm>
4914             <primary>IRIX</primary>
4915
4916             <secondary>AFS initialization script</secondary>
4917
4918             <tertiary>on first AFS machine</tertiary>
4919           </indexterm>
4920
4921           <indexterm>
4922             <primary>afsclient variable (IRIX)</primary>
4923
4924             <secondary>first AFS machine</secondary>
4925           </indexterm>
4926
4927           <indexterm>
4928             <primary>variables</primary>
4929
4930             <secondary>afsclient (IRIX)</secondary>
4931
4932             <tertiary>first AFS machine</tertiary>
4933           </indexterm>
4934
4935           <indexterm>
4936             <primary>IRIX</primary>
4937
4938             <secondary>afsclient variable</secondary>
4939
4940             <tertiary>first AFS machine</tertiary>
4941           </indexterm>
4942
4943           <indexterm>
4944             <primary>afsserver variable (IRIX)</primary>
4945
4946             <secondary>first AFS machine</secondary>
4947           </indexterm>
4948
4949           <indexterm>
4950             <primary>variables</primary>
4951
4952             <secondary>afsserver (IRIX)</secondary>
4953
4954             <tertiary>first AFS machine</tertiary>
4955           </indexterm>
4956
4957           <indexterm>
4958             <primary>IRIX</primary>
4959
4960             <secondary>afsserver variable</secondary>
4961
4962             <tertiary>first AFS machine</tertiary>
4963           </indexterm>
4964
4965           <para><emphasis role="bold">On IRIX systems:</emphasis> <orderedlist>
4966               <listitem>
4967                 <para>If you have configured the machine to use the <emphasis role="bold">ml</emphasis> dynamic loader program,
4968                 reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
4969    # <emphasis role="bold">cd /</emphasis>
4970    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
4971    login: <emphasis role="bold">root</emphasis>
4972    Password: <replaceable>root_password</replaceable>
4973 </programlisting></para>
4974               </listitem>
4975
4976               <listitem>
4977                 <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
4978                 role="bold">afsserver</emphasis> and <emphasis role="bold">afsclient</emphasis> configuration variables.
4979                 <programlisting>
4980    # <emphasis role="bold">/etc/chkconfig -f afsserver on</emphasis>
4981    # <emphasis role="bold">/etc/chkconfig -f afsclient on</emphasis>
4982 </programlisting></para>
4983               </listitem>
4984
4985               <listitem>
4986                 <para>Run the AFS initialization script. <programlisting>
4987    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
4988 </programlisting></para>
4989               </listitem>
4990             </orderedlist></para>
4991
4992           <indexterm>
4993             <primary>Linux</primary>
4994
4995             <secondary>AFS initialization script</secondary>
4996
4997             <tertiary>on first AFS machine</tertiary>
4998           </indexterm>
4999
5000           <para><emphasis role="bold">On Linux systems:</emphasis> <orderedlist>
5001               <listitem>
5002                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
5003                 <programlisting>
5004    # <emphasis role="bold">cd /</emphasis>
5005    # <emphasis role="bold">shutdown -r now</emphasis>
5006    login: <emphasis role="bold">root</emphasis>
5007    Password: <replaceable>root_password</replaceable>
5008 </programlisting></para>
5009               </listitem>
5010
5011               <listitem>
5012                 <para>Run the AFS initialization scripts.
5013 <programlisting>
5014    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
5015    # <emphasis role="bold">/etc/rc.d/init.d/openafs-server  start</emphasis>
5016 </programlisting></para>
5017               </listitem>
5018             </orderedlist></para>
5019
5020           <indexterm>
5021             <primary>Solaris</primary>
5022
5023             <secondary>AFS initialization script</secondary>
5024
5025             <tertiary>on first AFS machine</tertiary>
5026           </indexterm>
5027
5028           <para><emphasis role="bold">On Solaris systems:</emphasis> <orderedlist>
5029               <listitem>
5030                 <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>.
5031                 <programlisting>
5032    # <emphasis role="bold">cd /</emphasis>
5033    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
5034    login: <emphasis role="bold">root</emphasis>
5035    Password: <replaceable>root_password</replaceable>
5036 </programlisting></para>
5037               </listitem>
5038
5039               <listitem>
5040                 <para>Run the AFS initialization script. <programlisting>
5041    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
5042 </programlisting></para>
5043               </listitem>
5044             </orderedlist></para>
5045         </listitem>
5046
5047         <listitem>
5048           <para>Wait for the message that confirms that Cache Manager initialization is complete.</para>
5049
5050           <para>On machines that use a disk cache, it can take a while to initialize the Cache Manager for the first time, because
5051           the <emphasis role="bold">afsd</emphasis> program must create all of the <emphasis
5052           role="bold">V</emphasis><replaceable>n</replaceable> files in the cache directory. Subsequent Cache Manager
5053           initializations do not take nearly as long, because the <emphasis role="bold">V</emphasis><replaceable>n</replaceable>
5054           files already exist.</para>
5055         </listitem>
5056         <listitem>
5057
5058           <indexterm>
5059             <primary>commands</primary>
5060             <secondary>aklog</secondary>
5061           </indexterm>
5062
5063           <indexterm>
5064             <primary>aklog command</primary>
5065           </indexterm>
5066
5067           <para>If you are working with an existing cell which uses
5068           <emphasis role="bold">kaserver</emphasis> for authentication,
5069           please recall the note in
5070           <link linkend="KAS003">Using this Appendix</link> detailing the
5071           substitution of <emphasis role="bold">kinit</emphasis> and
5072           <emphasis role="bold">aklog</emphasis> with
5073           <emphasis role="bold">klog</emphasis>.</para>
5074
5075           <para>As a basic test of correct AFS functioning, issue the
5076           <emphasis role="bold">kinit</emphasis> and
5077           <emphasis role="bold">aklog</emphasis> commands to authenticate
5078           as the <emphasis role="bold">admin</emphasis> user.
5079           Provide the password (<replaceable>admin_passwd</replaceable>) you
5080           defined in <link linkend="HDRWQ53">Initializing Cell Security</link>.</para>
5081
5082           <programlisting>
5083    # <emphasis role="bold">kinit admin</emphasis>
5084    Password:  <replaceable>admin_passwd</replaceable>
5085    # <emphasis role="bold">aklog</emphasis>
5086 </programlisting>
5087
5088           <indexterm>
5089             <primary>commands</primary>
5090
5091             <secondary>tokens</secondary>
5092           </indexterm>
5093
5094           <indexterm>
5095             <primary>tokens command</primary>
5096           </indexterm>
5097         </listitem>
5098
5099         <listitem>
5100           <para>Issue the <emphasis role="bold">tokens</emphasis> command to
5101           verify that the <emphasis role="bold">aklog</emphasis>
5102           command worked correctly. If it did, the output looks similar to the following example for the <emphasis
5103           role="bold">example.com</emphasis> cell, where <emphasis role="bold">admin</emphasis>'s AFS UID is 1. If the output does not
5104           seem correct, resolve the problem. Changes to the AFS initialization script are possibly necessary. The OpenAFS mailing lists can provide assistance as necessary. <programlisting>
5105    # <emphasis role="bold">tokens</emphasis>
5106    Tokens held by the Cache Manager:
5107    User's (AFS ID 1) tokens for afs@example.com [Expires May 22 11:52]
5108        --End of list--
5109 </programlisting></para>
5110         </listitem>
5111
5112         <listitem>
5113           <para>Issue the <emphasis role="bold">bos status</emphasis> command to verify that the output for each process reads
5114           <computeroutput>Currently running normally</computeroutput>. <programlisting>
5115    # <emphasis role="bold">/usr/afs/bin/bos status</emphasis> &lt;<replaceable>machine name</replaceable>&gt;
5116 </programlisting> <indexterm>
5117               <primary>fs commands</primary>
5118
5119               <secondary>checkvolumes</secondary>
5120             </indexterm> <indexterm>
5121               <primary>commands</primary>
5122
5123               <secondary>fs checkvolumes</secondary>
5124             </indexterm></para>
5125         </listitem>
5126
5127         <listitem>
5128           <para>Change directory to the local file system root (<emphasis role="bold">/</emphasis>) and issue the <emphasis
5129           role="bold">fs checkvolumes</emphasis> command. <programlisting>
5130    # <emphasis role="bold">cd /</emphasis>
5131    # <emphasis role="bold">/usr/afs/bin/fs checkvolumes</emphasis>
5132 </programlisting></para>
5133         </listitem>
5134       </orderedlist></para>
5135
5136     <indexterm>
5137       <primary>AFS initialization script</primary>
5138
5139       <secondary>adding to machine startup sequence</secondary>
5140
5141       <tertiary>first AFS machine</tertiary>
5142     </indexterm>
5143
5144     <indexterm>
5145       <primary>installing</primary>
5146
5147       <secondary>AFS initialization script</secondary>
5148
5149       <tertiary>first AFS machine</tertiary>
5150     </indexterm>
5151
5152     <indexterm>
5153       <primary>first AFS machine</primary>
5154
5155       <secondary>AFS initialization script</secondary>
5156
5157       <tertiary>activating</tertiary>
5158     </indexterm>
5159
5160     <indexterm>
5161       <primary>activating AFS init. script</primary>
5162
5163       <see>installing</see>
5164     </indexterm>
5165   </sect1>
5166
5167   <sect1 id="HDRWQ73">
5168     <title>Activating the AFS Initialization Script</title>
5169
5170     <para>Now that you have confirmed that the AFS initialization script works correctly, take the action necessary to have it run
5171     automatically at each reboot. Proceed to the instructions for your system type: <itemizedlist>
5172         <listitem>
5173           <para><link linkend="HDRWQ74">Activating the Script on AIX Systems</link></para>
5174         </listitem>
5175
5176         <listitem>
5177           <para><link linkend="HDRWQ76">Activating the Script on HP-UX Systems</link></para>
5178         </listitem>
5179
5180         <listitem>
5181           <para><link linkend="HDRWQ77">Activating the Script on IRIX Systems</link></para>
5182         </listitem>
5183
5184         <listitem>
5185           <para><link linkend="HDRWQ78">Activating the Script on Linux Systems</link></para>
5186         </listitem>
5187
5188         <listitem>
5189           <para><link linkend="HDRWQ79">Activating the Script on Solaris Systems</link></para>
5190         </listitem>
5191       </itemizedlist></para>
5192
5193     <indexterm>
5194       <primary>AIX</primary>
5195
5196       <secondary>AFS initialization script</secondary>
5197
5198       <tertiary>on first AFS machine</tertiary>
5199     </indexterm>
5200
5201     <sect2 id="HDRWQ74">
5202       <title>Activating the Script on AIX Systems</title>
5203
5204       <orderedlist>
5205         <listitem>
5206           <para>Edit the AIX initialization file, <emphasis role="bold">/etc/inittab</emphasis>, adding the following line to invoke
5207           the AFS initialization script. Place it just after the line that starts NFS daemons. <programlisting>
5208    rcafs:2:wait:/etc/rc.afs &gt; /dev/console 2&gt;&amp;1 # Start AFS services
5209 </programlisting></para>
5210         </listitem>
5211
5212         <listitem>
5213           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5214           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc</emphasis> directories. If you want to avoid
5215           potential confusion by guaranteeing that they are always the same, create a link between them. You can always retrieve the
5216           original script from the AFS CD-ROM if necessary. <programlisting>
5217    # <emphasis role="bold">cd  /usr/vice/etc</emphasis>
5218    # <emphasis role="bold">rm  rc.afs</emphasis>
5219    # <emphasis role="bold">ln -s  /etc/rc.afs</emphasis>
5220 </programlisting></para>
5221         </listitem>
5222
5223         <listitem>
5224           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5225         </listitem>
5226       </orderedlist>
5227
5228       <indexterm>
5229         <primary>HP-UX</primary>
5230
5231         <secondary>AFS initialization script</secondary>
5232
5233         <tertiary>on first AFS machine</tertiary>
5234       </indexterm>
5235     </sect2>
5236
5237     <sect2 id="HDRWQ76">
5238       <title>Activating the Script on HP-UX Systems</title>
5239
5240       <orderedlist>
5241         <listitem>
5242           <para>Change to the <emphasis role="bold">/sbin/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5243           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the HP-UX startup and
5244           shutdown sequence. <programlisting>
5245    # <emphasis role="bold">cd /sbin/init.d</emphasis>
5246    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/S460afs</emphasis>
5247    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/K800afs</emphasis>
5248 </programlisting></para>
5249         </listitem>
5250
5251         <listitem>
5252           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5253           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/sbin/init.d</emphasis> directories. If you want
5254           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5255           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5256    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5257    # <emphasis role="bold">rm afs.rc</emphasis>
5258    # <emphasis role="bold">ln -s  /sbin/init.d/afs  afs.rc</emphasis>
5259 </programlisting></para>
5260         </listitem>
5261
5262         <listitem>
5263           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5264         </listitem>
5265       </orderedlist>
5266
5267       <indexterm>
5268         <primary>IRIX</primary>
5269
5270         <secondary>AFS initialization script</secondary>
5271
5272         <tertiary>on first AFS machine</tertiary>
5273       </indexterm>
5274     </sect2>
5275
5276     <sect2 id="HDRWQ77">
5277       <title>Activating the Script on IRIX Systems</title>
5278
5279       <orderedlist>
5280         <listitem>
5281           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5282           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the IRIX startup and
5283           shutdown sequence. <programlisting>
5284    # <emphasis role="bold">cd /etc/init.d</emphasis>
5285    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc2.d/S35afs</emphasis>
5286    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K35afs</emphasis>
5287 </programlisting></para>
5288         </listitem>
5289
5290         <listitem>
5291           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5292           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
5293           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5294           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5295    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5296    # <emphasis role="bold">rm afs.rc</emphasis>
5297    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
5298 </programlisting></para>
5299         </listitem>
5300
5301         <listitem>
5302           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5303         </listitem>
5304       </orderedlist>
5305
5306       <indexterm>
5307         <primary>Linux</primary>
5308
5309         <secondary>AFS initialization script</secondary>
5310
5311         <tertiary>on first AFS machine</tertiary>
5312       </indexterm>
5313     </sect2>
5314
5315     <sect2 id="HDRWQ78">
5316       <title>Activating the Script on Linux Systems</title>
5317
5318       <orderedlist>
5319         <listitem>
5320           <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>
5321           configuration variables. Based on the instruction in the AFS initialization file that begins with the string
5322           <computeroutput>#chkconfig</computeroutput>, the command automatically creates the symbolic links that incorporate the
5323           script into the Linux startup and shutdown sequence. <programlisting>
5324    # <emphasis role="bold">/sbin/chkconfig  --add openafs-client</emphasis>
5325    # <emphasis role="bold">/sbin/chkconfig  --add openafs-server</emphasis>
5326 </programlisting></para>
5327         </listitem>
5328
5329         <listitem>
5330           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5331           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/rc.d/init.d</emphasis> directories, and
5332           copies of the <emphasis role="bold">afsd</emphasis> options file in both the <emphasis
5333           role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/sysconfig</emphasis> directories. If you want to avoid
5334           potential confusion by guaranteeing that the two copies of each file are always the same, create a link between them. You
5335           can always retrieve the original script or options file from the AFS CD-ROM if necessary. <programlisting>
5336    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5337    # <emphasis role="bold">rm afs.rc afs.conf</emphasis>
5338    # <emphasis role="bold">ln -s  /etc/rc.d/init.d/afs  afs.rc</emphasis>
5339    # <emphasis role="bold">ln -s  /etc/sysconfig/afs  afs.conf</emphasis>
5340 </programlisting></para>
5341         </listitem>
5342
5343         <listitem>
5344           <para>Proceed to <link linkend="HDRWQ80">Configuring the Top Levels of the AFS Filespace</link>.</para>
5345         </listitem>
5346       </orderedlist>
5347
5348       <indexterm>
5349         <primary>Solaris</primary>
5350
5351         <secondary>AFS initialization script</secondary>
5352
5353         <tertiary>on first AFS machine</tertiary>
5354       </indexterm>
5355     </sect2>
5356
5357     <sect2 id="HDRWQ79">
5358       <title>Activating the Script on Solaris Systems</title>
5359
5360       <orderedlist>
5361         <listitem>
5362           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
5363           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the Solaris startup and
5364           shutdown sequence. <programlisting>
5365    # <emphasis role="bold">cd /etc/init.d</emphasis>
5366    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc3.d/S99afs</emphasis>
5367    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K66afs</emphasis>
5368 </programlisting></para>
5369         </listitem>
5370
5371         <listitem>
5372           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
5373           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
5374           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
5375           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
5376    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
5377    # <emphasis role="bold">rm afs.rc</emphasis>
5378    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
5379 </programlisting></para>
5380         </listitem>
5381       </orderedlist>
5382
5383       <indexterm>
5384         <primary>AFS filespace</primary>
5385
5386         <secondary>configuring top levels</secondary>
5387       </indexterm>
5388
5389       <indexterm>
5390         <primary>configuring</primary>
5391
5392         <secondary>AFS filespace (top levels)</secondary>
5393       </indexterm>
5394     </sect2>
5395   </sect1>
5396
5397   <sect1 id="HDRWQ80">
5398     <title>Configuring the Top Levels of the AFS Filespace</title>
5399
5400     <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
5401     have run a previous version of AFS, the filespace is already configured. Proceed to <link linkend="HDRWQ83">Storing AFS Binaries
5402     in AFS</link>. <indexterm>
5403         <primary>root.cell volume</primary>
5404
5405         <secondary>creating and replicating</secondary>
5406       </indexterm> <indexterm>
5407         <primary>volume</primary>
5408
5409         <secondary>creating</secondary>
5410
5411         <tertiary>root.cell</tertiary>
5412       </indexterm> <indexterm>
5413         <primary>creating</primary>
5414
5415         <secondary>root.cell volume</secondary>
5416       </indexterm></para>
5417
5418     <para>You created the <emphasis role="bold">root.afs</emphasis> volume in <link linkend="HDRWQ60">Starting the File Server,
5419     Volume Server, and Salvager</link>, and the Cache Manager mounted it automatically on the local <emphasis
5420     role="bold">/afs</emphasis> directory when you ran the AFS initialization script in <link linkend="HDRWQ72">Verifying the AFS
5421     Initialization Script</link>. You now set the access control list (ACL) on the <emphasis role="bold">/afs</emphasis> directory;
5422     creating, mounting, and setting the ACL are the three steps required when creating any volume.</para>
5423
5424     <para>After setting the ACL on the <emphasis role="bold">root.afs</emphasis> volume, you create your cell's <emphasis
5425     role="bold">root.cell</emphasis> volume, mount it as a subdirectory of the <emphasis role="bold">/afs</emphasis> directory, and
5426     set the ACL. Create both a read/write and a regular mount point for the <emphasis role="bold">root.cell</emphasis> volume. The
5427     read/write mount point enables you to access the read/write version of replicated volumes when necessary. Creating both mount
5428     points essentially creates separate read-only and read-write copies of your filespace, and enables the Cache Manager to traverse
5429     the filespace on a read-only path or read/write path as appropriate. For further discussion of these concepts, see the chapter
5430     in the <emphasis>OpenAFS Administration Guide</emphasis> about administering volumes. <indexterm>
5431         <primary>root.afs volume</primary>
5432
5433         <secondary>replicating</secondary>
5434       </indexterm> <indexterm>
5435         <primary>volume</primary>
5436
5437         <secondary>replicating root.afs and root.cell</secondary>
5438       </indexterm> <indexterm>
5439         <primary>replicating volumes</primary>
5440       </indexterm></para>
5441
5442     <para>Then replicate both the <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes.
5443     This is required if you want to replicate any other volumes in your cell, because all volumes mounted above a replicated volume
5444     must themselves be replicated in order for the Cache Manager to access the replica.</para>
5445
5446     <para>When the <emphasis role="bold">root.afs</emphasis> volume is replicated, the Cache Manager is programmed to access its
5447     read-only version (<emphasis role="bold">root.afs.readonly</emphasis>) whenever possible. To make changes to the contents of the
5448     <emphasis role="bold">root.afs</emphasis> volume (when, for example, you mount another cell's <emphasis
5449     role="bold">root.cell</emphasis> volume at the second level in your filespace), you must mount the <emphasis
5450     role="bold">root.afs</emphasis> volume temporarily, make the changes, release the volume and remove the temporary mount point.
5451     For instructions, see <link linkend="HDRWQ91">Enabling Access to Foreign Cells</link>. <indexterm>
5452         <primary>fs commands</primary>
5453
5454         <secondary>setacl</secondary>
5455       </indexterm> <indexterm>
5456         <primary>commands</primary>
5457
5458         <secondary>fs setacl</secondary>
5459       </indexterm> <indexterm>
5460         <primary>access control list (ACL), setting</primary>
5461       </indexterm> <indexterm>
5462         <primary>setting</primary>
5463
5464         <secondary>ACL</secondary>
5465       </indexterm> <orderedlist>
5466         <listitem>
5467           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to edit the ACL on the <emphasis
5468           role="bold">/afs</emphasis> directory. Add an entry that grants the <emphasis role="bold">l</emphasis> (<emphasis
5469           role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>) permissions
5470           to the <emphasis role="bold">system:anyuser</emphasis> group, to enable all AFS users who can reach your cell to traverse
5471           through the directory. If you prefer to enable access only to locally authenticated users, substitute the <emphasis
5472           role="bold">system:authuser</emphasis> group.</para>
5473
5474           <para>Note that there is already an ACL entry that grants all seven access rights to the <emphasis
5475           role="bold">system:administrators</emphasis> group. It is a default entry that AFS places on every new volume's root
5476           directory.</para>
5477
5478           <para>The top-level AFS directory, typically /afs, is a special case:
5479             when the client is configured to run in dynroot mode (e.g.
5480             <emphasis role="bold">afsd -dynroot</emphasis>, attempts to set
5481             the ACL on this directory will return <emphasis role="bold">
5482               Connection timed out</emphasis>. This is because the dynamically-
5483             generated root directory is not a part of the global AFS space,
5484             and cannot have an access control list set on it.</para>
5485
5486           <programlisting>
5487    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs system:anyuser rl</emphasis>
5488 </programlisting>
5489
5490           <indexterm>
5491             <primary>commands</primary>
5492
5493             <secondary>vos create</secondary>
5494
5495             <tertiary>root.cell volume</tertiary>
5496           </indexterm>
5497
5498           <indexterm>
5499             <primary>vos commands</primary>
5500
5501             <secondary>create</secondary>
5502
5503             <tertiary>root.cell volume</tertiary>
5504           </indexterm>
5505
5506           <indexterm>
5507             <primary>fs commands</primary>
5508
5509             <secondary>mkmount</secondary>
5510           </indexterm>
5511
5512           <indexterm>
5513             <primary>commands</primary>
5514
5515             <secondary>fs mkmount</secondary>
5516           </indexterm>
5517
5518           <indexterm>
5519             <primary>mount point</primary>
5520           </indexterm>
5521
5522           <indexterm>
5523             <primary>creating</primary>
5524
5525             <secondary>mount point</secondary>
5526           </indexterm>
5527
5528           <indexterm>
5529             <primary>volume</primary>
5530
5531             <secondary>mounting</secondary>
5532           </indexterm>
5533         </listitem>
5534
5535         <listitem id="LIWQ81">
5536           <para>Issue the <emphasis role="bold">vos create</emphasis> command to create the <emphasis
5537           role="bold">root.cell</emphasis> volume. Then issue the <emphasis role="bold">fs mkmount</emphasis> command to mount it as
5538           a subdirectory of the <emphasis role="bold">/afs</emphasis> directory, where it serves as the root of your cell's local
5539           AFS filespace. Finally, issue the <emphasis role="bold">fs setacl</emphasis> command to create an ACL entry for the
5540           <emphasis role="bold">system:anyuser</emphasis> group (or <emphasis role="bold">system:authuser</emphasis> group).</para>
5541
5542           <para>For the <replaceable>partition name</replaceable> argument, substitute the name of one of the machine's AFS server
5543           partitions (such as <emphasis role="bold">/vicepa</emphasis>). For the <replaceable>cellname</replaceable> argument,
5544           substitute your cell's fully-qualified Internet domain name (such as <emphasis role="bold">example.com</emphasis>).</para>
5545
5546           <programlisting>
5547    # <emphasis role="bold">/usr/afs/bin/vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5548               role="bold">root.cell</emphasis>
5549    # <emphasis role="bold">/usr/afs/bin/fs mkmount /afs/</emphasis><replaceable>cellname</replaceable>  <emphasis role="bold">root.cell</emphasis>
5550    # <emphasis role="bold">/usr/afs/bin/fs setacl /afs/</emphasis><replaceable>cellname</replaceable>  <emphasis role="bold">system:anyuser rl</emphasis>
5551 </programlisting>
5552
5553           <indexterm>
5554             <primary>creating</primary>
5555
5556             <secondary>symbolic link</secondary>
5557
5558             <tertiary>for abbreviated cell name</tertiary>
5559           </indexterm>
5560
5561           <indexterm>
5562             <primary>symbolic link</primary>
5563
5564             <secondary>for abbreviated cell name</secondary>
5565           </indexterm>
5566
5567           <indexterm>
5568             <primary>cell name</primary>
5569
5570             <secondary>symbolic link for abbreviated</secondary>
5571           </indexterm>
5572         </listitem>
5573
5574         <listitem>
5575           <para><emphasis role="bold">(Optional)</emphasis> Create a symbolic link to a shortened cell name, to reduce the length of
5576           pathnames for users in the local cell. For example, in the <emphasis role="bold">example.com</emphasis> cell, <emphasis
5577           role="bold">/afs/example</emphasis> is a link to <emphasis role="bold">/afs/example.com</emphasis>. <programlisting>
5578    # <emphasis role="bold">cd /afs</emphasis>
5579    # <emphasis role="bold">ln -s</emphasis>  <replaceable>full_cellname</replaceable>  <replaceable>short_cellname</replaceable>
5580 </programlisting> <indexterm>
5581               <primary>read/write mount point for root.afs volume</primary>
5582             </indexterm> <indexterm>
5583               <primary>root.afs volume</primary>
5584
5585               <secondary>read/write mount point</secondary>
5586             </indexterm> <indexterm>
5587               <primary>creating</primary>
5588
5589               <secondary>read/write mount point</secondary>
5590             </indexterm></para>
5591         </listitem>
5592
5593         <listitem>
5594           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to create a read/write mount point for the <emphasis
5595           role="bold">root.cell</emphasis> volume (you created a regular mount point in Step <link
5596           linkend="LIWQ81">2</link>).</para>
5597
5598           <para>By convention, the name of a read/write mount point begins with a period, both to distinguish it from the regular
5599           mount point and to make it visible only when the <emphasis role="bold">-a</emphasis> flag is used on the <emphasis
5600           role="bold">ls</emphasis> command.</para>
5601
5602           <para>Change directory to <emphasis role="bold">/usr/afs/bin</emphasis> to make it easier to access the command
5603           binaries.</para>
5604
5605           <programlisting>
5606    # <emphasis role="bold">cd /usr/afs/bin</emphasis>
5607    # <emphasis role="bold">./fs mkmount   /afs/.</emphasis><replaceable>cellname</replaceable>   <emphasis role="bold">root.cell -rw</emphasis>
5608 </programlisting>
5609
5610           <indexterm>
5611             <primary>commands</primary>
5612
5613             <secondary>vos addsite</secondary>
5614           </indexterm>
5615
5616           <indexterm>
5617             <primary>vos commands</primary>
5618
5619             <secondary>addsite</secondary>
5620           </indexterm>
5621
5622           <indexterm>
5623             <primary>volume</primary>
5624
5625             <secondary>defining replication site</secondary>
5626           </indexterm>
5627
5628           <indexterm>
5629             <primary>defining</primary>
5630
5631             <secondary>replication site for volume</secondary>
5632           </indexterm>
5633         </listitem>
5634
5635         <listitem id="LIWQ82">
5636           <para>Issue the <emphasis role="bold">vos addsite</emphasis> command to define a replication site
5637           for both the <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes. In each
5638           case, substitute for the <replaceable>partition name</replaceable> argument the partition where the volume's read/write
5639           version resides. When you install additional file server machines, it is a good idea to create replication sites on them
5640           as well. <programlisting>
5641    # <emphasis role="bold">./vos addsite</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5642                 role="bold">root.afs</emphasis>
5643    # <emphasis role="bold">./vos addsite</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <emphasis
5644                 role="bold">root.cell</emphasis>
5645 </programlisting> <indexterm>
5646               <primary>fs commands</primary>
5647
5648               <secondary>examine</secondary>
5649             </indexterm> <indexterm>
5650               <primary>commands</primary>
5651
5652               <secondary>fs examine</secondary>
5653             </indexterm></para>
5654         </listitem>
5655
5656         <listitem>
5657           <para>Issue the <emphasis role="bold">fs examine</emphasis> command to verify that the Cache Manager can access both the
5658           <emphasis role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes, before you attempt to
5659           replicate them. The output lists each volume's name, volumeID number, quota, size, and the size of the partition that
5660           houses them. If you get an error message instead, do not continue before taking corrective action. <programlisting>
5661    # <emphasis role="bold">./fs examine /afs</emphasis>
5662    # <emphasis role="bold">./fs examine /afs/</emphasis><replaceable>cellname</replaceable>
5663 </programlisting> <indexterm>
5664               <primary>commands</primary>
5665
5666               <secondary>vos release</secondary>
5667             </indexterm> <indexterm>
5668               <primary>vos commands</primary>
5669
5670               <secondary>release</secondary>
5671             </indexterm> <indexterm>
5672               <primary>volume</primary>
5673
5674               <secondary>releasing replicated</secondary>
5675             </indexterm> <indexterm>
5676               <primary>releasing replicated volume</primary>
5677             </indexterm></para>
5678         </listitem>
5679
5680         <listitem>
5681           <para>Issue the <emphasis role="bold">vos release</emphasis> command to release a replica of the <emphasis
5682           role="bold">root.afs</emphasis> and <emphasis role="bold">root.cell</emphasis> volumes to the sites you defined in Step
5683           <link linkend="LIWQ82">5</link>. <programlisting>
5684    # <emphasis role="bold">./vos release root.afs</emphasis>
5685    # <emphasis role="bold">./vos release root.cell</emphasis>
5686 </programlisting> <indexterm>
5687               <primary>fs commands</primary>
5688
5689               <secondary>checkvolumes</secondary>
5690             </indexterm> <indexterm>
5691               <primary>commands</primary>
5692
5693               <secondary>fs checkvolumes</secondary>
5694             </indexterm></para>
5695         </listitem>
5696
5697         <listitem>
5698           <para>Issue the <emphasis role="bold">fs checkvolumes</emphasis> to force the Cache Manager to notice that you have
5699           released read-only versions of the volumes, then issue the <emphasis role="bold">fs examine</emphasis> command again. This
5700           time its output mentions the read-only version of the volumes (<emphasis role="bold">root.afs.readonly</emphasis> and
5701           <emphasis role="bold">root.cell.readonly</emphasis>) instead of the read/write versions, because of the Cache Manager's
5702           bias to access the read-only version of the <emphasis role="bold">root.afs</emphasis> volume if it exists.
5703           <programlisting>
5704    # <emphasis role="bold">./fs checkvolumes</emphasis>
5705    # <emphasis role="bold">./fs examine /afs</emphasis>
5706    # <emphasis role="bold">./fs examine /afs/</emphasis><replaceable>cellname</replaceable>
5707 </programlisting></para>
5708         </listitem>
5709       </orderedlist></para>
5710
5711     <indexterm>
5712       <primary>storing</primary>
5713
5714       <secondary>AFS binaries in volumes</secondary>
5715     </indexterm>
5716
5717     <indexterm>
5718       <primary>creating</primary>
5719
5720       <secondary>volume</secondary>
5721
5722       <tertiary>for AFS binaries</tertiary>
5723     </indexterm>
5724
5725     <indexterm>
5726       <primary>volume</primary>
5727
5728       <secondary>for AFS binaries</secondary>
5729     </indexterm>
5730
5731     <indexterm>
5732       <primary>binaries</primary>
5733
5734       <secondary>storing AFS in volume</secondary>
5735     </indexterm>
5736
5737     <indexterm>
5738       <primary>usr/afsws directory</primary>
5739     </indexterm>
5740
5741     <indexterm>
5742       <primary>directories</primary>
5743
5744       <secondary>/usr/afsws</secondary>
5745     </indexterm>
5746   </sect1>
5747
5748   <sect1 id="HDRWQ83">
5749     <title>Storing AFS Binaries in AFS</title>
5750
5751     <note><para>Sites with existing binary distribution mechanisms, including
5752     those which use packaging systems such as RPM, may wish to skip this step,
5753     and use tools native to their operating system to manage AFS configuration
5754     information.</para></note>
5755
5756     <para>In the conventional configuration, you make AFS client binaries and configuration files available in the subdirectories of
5757     the <emphasis role="bold">/usr/afsws</emphasis> directory on client machines (<emphasis role="bold">afsws</emphasis> is an
5758     acronym for <emphasis role="bold">AFS w</emphasis><emphasis>ork</emphasis><emphasis
5759     role="bold">s</emphasis><emphasis>tation</emphasis>). You can conserve local disk space by creating <emphasis
5760     role="bold">/usr/afsws</emphasis> as a link to an AFS volume that houses the AFS client binaries and configuration files for
5761     this system type.</para>
5762
5763     <para>In this section you create the necessary volumes. The conventional location to which to link <emphasis
5764     role="bold">/usr/afsws</emphasis> is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5765     role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis>, where
5766     <replaceable>sysname</replaceable> is the appropriate system type name as specified in the <emphasis>OpenAFS Release
5767     Notes</emphasis>. The instructions in <link linkend="HDRWQ133">Installing Additional Client Machines</link> assume that you have
5768     followed the instructions in this section.</para>
5769
5770     <para>If you have previously run AFS in the cell, the volumes possibly already exist. If so, you need to perform Step <link
5771     linkend="LIWQ86">8</link> only.</para>
5772
5773     <para>The current working directory is still <emphasis role="bold">/usr/afs/bin</emphasis>, which houses the <emphasis
5774     role="bold">fs</emphasis> and <emphasis role="bold">vos</emphasis> command suite binaries. In the following commands, it is
5775     possible you still need to specify the pathname to the commands, depending on how your PATH environment variable is set.
5776     <orderedlist>
5777         <indexterm>
5778           <primary>commands</primary>
5779
5780           <secondary>vos create</secondary>
5781
5782           <tertiary>volume for AFS binaries</tertiary>
5783         </indexterm>
5784
5785         <indexterm>
5786           <primary>vos commands</primary>
5787
5788           <secondary>create</secondary>
5789
5790           <tertiary>volume for AFS binaries</tertiary>
5791         </indexterm>
5792
5793         <listitem id="LIWQ84">
5794           <para>Issue the <emphasis role="bold">vos create</emphasis> command to create volumes for storing
5795           the AFS client binaries for this system type. The following example instruction creates volumes called
5796           <replaceable>sysname</replaceable>, <replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis>, and
5797           <replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis>. Refer to the <emphasis>OpenAFS Release
5798           Notes</emphasis> to learn the proper value of <replaceable>sysname</replaceable> for this system type. <programlisting>
5799    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable>
5800    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
5801                 role="bold">.usr</emphasis>
5802    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
5803                 role="bold">.usr.afsws</emphasis>
5804 </programlisting></para>
5805         </listitem>
5806
5807         <listitem>
5808           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the newly created volumes. Because the
5809           <emphasis role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> part
5810           of the pathname with a period to specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos
5811           release</emphasis> command to release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the
5812           <emphasis role="bold">fs checkvolumes</emphasis> command to force the local Cache Manager to access them. <programlisting>
5813    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable> <emphasis
5814                 role="bold">-vol</emphasis> <replaceable>sysname</replaceable>
5815    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5816                 role="bold">/usr</emphasis>  <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
5817                 role="bold">.usr</emphasis>
5818    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5819                 role="bold">/usr/afsws</emphasis> <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
5820                 role="bold">.usr.afsws</emphasis>
5821    # <emphasis role="bold">vos release root.cell</emphasis>
5822    # <emphasis role="bold">fs checkvolumes</emphasis>
5823 </programlisting></para>
5824         </listitem>
5825
5826         <listitem>
5827           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">l</emphasis>
5828           (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>)
5829           permissions to the <emphasis role="bold">system:anyuser</emphasis> group on each new directory's ACL. <programlisting>
5830    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable>
5831    # <emphasis role="bold">fs setacl  -dir  .  usr  usr/afsws  -acl  system:anyuser rl</emphasis>
5832 </programlisting> <indexterm>
5833               <primary>commands</primary>
5834
5835               <secondary>fs setquota</secondary>
5836             </indexterm> <indexterm>
5837               <primary>fs commands</primary>
5838
5839               <secondary>setquota</secondary>
5840             </indexterm> <indexterm>
5841               <primary>quota for volume</primary>
5842             </indexterm> <indexterm>
5843               <primary>volume</primary>
5844
5845               <secondary>setting quota</secondary>
5846             </indexterm> <indexterm>
5847               <primary>setting</primary>
5848
5849               <secondary>volume quota</secondary>
5850             </indexterm></para>
5851         </listitem>
5852
5853         <listitem id="LIWQ85">
5854           <para>Issue the <emphasis role="bold">fs setquota</emphasis> command to set an unlimited quota on
5855           the volume mounted at the <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5856           role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory. This
5857           enables you to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's
5858           quota.</para>
5859
5860           <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operation. At that
5861           point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
5862           Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
5863
5864           <programlisting>
5865    # <emphasis role="bold">fs setquota /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5866               role="bold">/usr/afsws  0</emphasis>
5867 </programlisting>
5868         </listitem>
5869
5870         <listitem>
5871           <para>Unpack the distribution tarball into the <emphasis role="bold">/tmp/afsdist</emphasis> directory,
5872           if it is not already. <indexterm>
5873               <primary>copying</primary>
5874
5875               <secondary>AFS binaries into volume</secondary>
5876             </indexterm> <indexterm>
5877               <primary>CD-ROM</primary>
5878
5879               <secondary>copying AFS binaries into volume</secondary>
5880             </indexterm> <indexterm>
5881               <primary>first AFS machine</primary>
5882
5883               <secondary>copying</secondary>
5884
5885               <tertiary>AFS binaries into volume</tertiary>
5886             </indexterm></para>
5887         </listitem>
5888
5889         <listitem>
5890           <para>Copy the contents of the indicated directories from the
5891           distribution into the <emphasis
5892           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5893           role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory.
5894           <programlisting>
5895    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
5896                 role="bold">/usr/afsws</emphasis>
5897    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/bin  .</emphasis>
5898    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/etc  .</emphasis>
5899    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/include  .</emphasis>
5900    # <emphasis role="bold">cp -rp /tmp/afsdist/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/lib  .</emphasis>
5901 </programlisting>
5902 <indexterm>
5903               <primary>creating</primary>
5904
5905               <secondary>symbolic link</secondary>
5906
5907               <tertiary>to AFS binaries</tertiary>
5908             </indexterm> <indexterm>
5909               <primary>symbolic link</primary>
5910
5911               <secondary>to AFS binaries from local disk</secondary>
5912             </indexterm></para>
5913         </listitem>
5914
5915         <listitem id="LIWQ86">
5916           <para>Create <emphasis role="bold">/usr/afsws</emphasis> on the local disk as a symbolic link to the
5917           directory <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
5918           role="bold">/@sys/usr/afsws</emphasis>. You can specify the actual system name instead of <emphasis
5919           role="bold">@sys</emphasis> if you wish, but the advantage of using <emphasis role="bold">@sys</emphasis> is that it
5920           remains valid if you upgrade this machine to a different system type. <programlisting>
5921    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws  /usr/afsws</emphasis>
5922 </programlisting> <indexterm>
5923               <primary>PATH environment variable for users</primary>
5924             </indexterm> <indexterm>
5925               <primary>variables</primary>
5926
5927               <secondary>PATH, setting for users</secondary>
5928             </indexterm></para>
5929         </listitem>
5930
5931         <listitem>
5932           <para><emphasis role="bold">(Optional)</emphasis> To enable users to issue commands from the AFS suites (such as <emphasis
5933           role="bold">fs</emphasis>) without having to specify a pathname to their binaries, include the <emphasis
5934           role="bold">/usr/afsws/bin</emphasis> and <emphasis role="bold">/usr/afsws/etc</emphasis> directories in the PATH
5935           environment variable you define in each user's shell initialization file (such as <emphasis
5936           role="bold">.cshrc</emphasis>).</para>
5937         </listitem>
5938       </orderedlist></para>
5939
5940     <indexterm>
5941       <primary>storing</primary>
5942
5943       <secondary>AFS documentation in volumes</secondary>
5944     </indexterm>
5945
5946     <indexterm>
5947       <primary>creating</primary>
5948
5949       <secondary>volume</secondary>
5950
5951       <tertiary>for AFS documentation</tertiary>
5952     </indexterm>
5953
5954     <indexterm>
5955       <primary>volume</primary>
5956
5957       <secondary>for AFS documentation</secondary>
5958     </indexterm>
5959
5960     <indexterm>
5961       <primary>documentation, creating volume for AFS</primary>
5962     </indexterm>
5963
5964     <indexterm>
5965       <primary>usr/afsdoc directory</primary>
5966     </indexterm>
5967
5968     <indexterm>
5969       <primary>directories</primary>
5970
5971       <secondary>/usr/afsdoc</secondary>
5972     </indexterm>
5973   </sect1>
5974
5975   <sect1 id="HDRWQ87">
5976     <title>Storing AFS Documents in AFS</title>
5977
5978     <para>The AFS distribution includes the following documents: <itemizedlist>
5979         <listitem>
5980           <para><emphasis>OpenAFS Release Notes</emphasis></para>
5981         </listitem>
5982
5983         <listitem>
5984           <para><emphasis>OpenAFS Quick Beginnings</emphasis></para>
5985         </listitem>
5986
5987         <listitem>
5988           <para><emphasis>OpenAFS User Guide</emphasis></para>
5989         </listitem>
5990
5991         <listitem>
5992           <para><emphasis>OpenAFS Administration Reference</emphasis></para>
5993         </listitem>
5994
5995         <listitem>
5996           <para><emphasis>OpenAFS Administration Guide</emphasis></para>
5997         </listitem>
5998       </itemizedlist></para>
5999
6000     <note><para>OpenAFS Documentation is not currently provided with all
6001     distributions, but may be downloaded separately from the OpenAFS
6002     website</para></note>
6003
6004     <para>The OpenAFS Documentation Distribution has a directory for each
6005     document format provided. The different formats are suitable for online
6006     viewing, printing, or both.</para>
6007
6008     <para>This section explains how to create and mount a volume to house the documents, making them available to your users. The
6009     recommended mount point for the volume is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6010     role="bold">/afsdoc</emphasis>. If you wish, you can create a link to the mount point on each client machine's local disk,
6011     called <emphasis role="bold">/usr/afsdoc</emphasis>. Alternatively, you can create a link to the mount point in each user's home
6012     directory. You can also choose to permit users to access only certain documents (most probably, the <emphasis>OpenAFS User
6013     Guide</emphasis>) by creating different mount points or setting different ACLs on different document directories.</para>
6014
6015     <para>The current working directory is still <emphasis role="bold">/usr/afs/bin</emphasis>, which houses the <emphasis
6016     role="bold">fs</emphasis> and <emphasis role="bold">vos</emphasis> command suite binaries you use to create and mount volumes.
6017     In the following commands, it is possible you still need to specify the pathname to the commands, depending on how your PATH
6018     environment variable is set. <orderedlist>
6019         <indexterm>
6020           <primary>commands</primary>
6021
6022           <secondary>vos create</secondary>
6023
6024           <tertiary>volume for AFS documentation</tertiary>
6025         </indexterm>
6026
6027         <indexterm>
6028           <primary>vos commands</primary>
6029
6030           <secondary>create</secondary>
6031
6032           <tertiary>volume for AFS documentation</tertiary>
6033         </indexterm>
6034
6035         <listitem>
6036           <para>Issue the <emphasis role="bold">vos create</emphasis> command to create a volume for storing the AFS documentation.
6037           Include the <emphasis role="bold">-maxquota</emphasis> argument to set an unlimited quota on the volume. This enables you
6038           to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's quota.</para>
6039
6040           <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operations. At that
6041           point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
6042           Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
6043
6044           <programlisting>
6045    # <emphasis role="bold">vos create</emphasis>  &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt;  <emphasis
6046               role="bold">afsdoc  -maxquota  0</emphasis>
6047 </programlisting>
6048         </listitem>
6049
6050         <listitem>
6051           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the new volume. Because the <emphasis
6052           role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> with a period to
6053           specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos release</emphasis> command to
6054           release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the <emphasis role="bold">fs
6055           checkvolumes</emphasis> command to force the local Cache Manager to access them. <programlisting>
6056    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis> <emphasis
6057                 role="bold">-vol</emphasis> <emphasis role="bold">afsdoc</emphasis>
6058    # <emphasis role="bold">vos release root.cell</emphasis>
6059    # <emphasis role="bold">fs checkvolumes</emphasis>
6060 </programlisting></para>
6061         </listitem>
6062
6063         <listitem>
6064           <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">rl</emphasis>
6065           permissions to the <emphasis role="bold">system:anyuser</emphasis> group on the new directory's ACL. <programlisting>
6066    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis>
6067    # <emphasis role="bold">fs setacl  .  system:anyuser rl</emphasis>
6068 </programlisting></para>
6069         </listitem>
6070
6071         <listitem>
6072           <para>Unpack the OpenAFS documentation distribution into the
6073           <emphasis role="bold">/tmp/afsdocs</emphasis> directory. You may use
6074           a different directory, in which case the location you use should be
6075           subsituted in the following examples. For instructions on unpacking
6076           the distribution, consult the documentation for your operating
6077           system's <emphasis role="bold">tar</emphasis> command.
6078           <indexterm>
6079               <primary>copying</primary>
6080
6081               <secondary>AFS documentation from distribution</secondary>
6082             </indexterm> <indexterm>
6083               <primary>OpenAFS Distribution</primary>
6084
6085               <secondary>copying AFS documentation from</secondary>
6086             </indexterm> <indexterm>
6087               <primary>first AFS machine</primary>
6088
6089               <secondary>copying</secondary>
6090
6091               <tertiary>AFS documentation from OpenAFS distribution</tertiary>
6092             </indexterm> <indexterm>
6093               <primary>index.htm file</primary>
6094             </indexterm> <indexterm>
6095               <primary>files</primary>
6096
6097               <secondary>index.htm</secondary>
6098             </indexterm></para>
6099         </listitem>
6100
6101         <listitem>
6102           <para>Copy the AFS documents in one or more formats from the unpacked distribution into subdirectories of the <emphasis
6103           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc</emphasis> directory. Repeat
6104           the commands for each format. <programlisting>
6105    # <emphasis role="bold">mkdir</emphasis> <replaceable>format_name</replaceable>
6106    # <emphasis role="bold">cd</emphasis> <replaceable>format_name</replaceable>
6107    # <emphasis role="bold">cp -rp /tmp/afsdocs/</emphasis><replaceable>format</replaceable>  <emphasis role="bold">.</emphasis>
6108 </programlisting></para>
6109
6110           <para>If you choose to store the HTML version of the documents in AFS, note that in addition to a subdirectory for each
6111           document there are several files with a <emphasis role="bold">.gif</emphasis> extension, which enable readers to move
6112           easily between sections of a document. The file called <emphasis role="bold">index.htm</emphasis> is an introductory HTML
6113           page that contains a hyperlink to each of the documents. For online viewing to work properly, these files must remain in
6114           the top-level HTML directory (the one named, for example, <emphasis
6115           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/html</emphasis>).</para>
6116         </listitem>
6117
6118         <listitem>
6119           <para><emphasis role="bold">(Optional)</emphasis> If you believe it is helpful to your users to access the AFS documents
6120           in a certain format via a local disk directory, create <emphasis role="bold">/usr/afsdoc</emphasis> on the local disk as a
6121           symbolic link to the documentation directory in AFS (<emphasis
6122           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6123           role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable>). <programlisting>
6124    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> <emphasis
6125                 role="bold">/usr/afsdoc</emphasis>
6126 </programlisting></para>
6127
6128           <para>An alternative is to create a link in each user's home directory to the <emphasis
6129           role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6130           role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> directory.</para>
6131         </listitem>
6132       </orderedlist></para>
6133
6134     <indexterm>
6135       <primary>storing</primary>
6136
6137       <secondary>system binaries in volumes</secondary>
6138     </indexterm>
6139
6140     <indexterm>
6141       <primary>creating</primary>
6142
6143       <secondary>volume</secondary>
6144
6145       <tertiary>for system binaries</tertiary>
6146     </indexterm>
6147
6148     <indexterm>
6149       <primary>volume</primary>
6150
6151       <secondary>for system binaries</secondary>
6152     </indexterm>
6153
6154     <indexterm>
6155       <primary>binaries</primary>
6156
6157       <secondary>storing system in volumes</secondary>
6158     </indexterm>
6159   </sect1>
6160
6161   <sect1 id="HDRWQ88">
6162     <title>Storing System Binaries in AFS</title>
6163
6164     <para>You can also choose to store other system binaries in AFS volumes, such as the standard UNIX programs conventionally
6165     located in local disk directories such as <emphasis role="bold">/etc</emphasis>, <emphasis role="bold">/bin</emphasis>, and
6166     <emphasis role="bold">/lib</emphasis>. Storing such binaries in an AFS volume not only frees local disk space, but makes it
6167     easier to update binaries on all client machines.</para>
6168
6169     <para>The following is a suggested scheme for storing system binaries in AFS. It does not include instructions, but you can use
6170     the instructions in <link linkend="HDRWQ83">Storing AFS Binaries in AFS</link> (which are for AFS-specific binaries) as a
6171     template.</para>
6172
6173     <para>Some files must remain on the local disk for use when AFS is inaccessible (during bootup and file server or network
6174     outages). The required binaries include the following: <itemizedlist>
6175         <listitem>
6176           <para>A text editor, network commands, and so on</para>
6177         </listitem>
6178
6179         <listitem>
6180           <para>Files used during the boot sequence before the <emphasis role="bold">afsd</emphasis> program runs, such as
6181           initialization and configuration files, and binaries for commands that mount file systems</para>
6182         </listitem>
6183
6184         <listitem>
6185           <para>Files used by dynamic kernel loader programs</para>
6186         </listitem>
6187       </itemizedlist></para>
6188
6189     <para>In most cases, it is more secure to enable only locally authenticated users to access system binaries, by granting the
6190     <emphasis role="bold">l</emphasis> (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis
6191     role="bold">read</emphasis>) permissions to the <emphasis role="bold">system:authuser</emphasis> group on the ACLs of
6192     directories that contain the binaries. If users need to access a binary while unauthenticated, however, the ACL on its directory
6193     must grant those permissions to the <emphasis role="bold">system:anyuser</emphasis> group.</para>
6194
6195     <para>The following chart summarizes the suggested volume and mount point names for storing system binaries. It uses a separate
6196     volume for each directory. You already created a volume called <replaceable>sysname</replaceable> for this machine's system type
6197     when you followed the instructions in <link linkend="HDRWQ83">Storing AFS Binaries in AFS</link>.</para>
6198
6199     <para>You can name volumes in any way you wish, and mount them at other locations than those suggested here. However, this
6200     scheme has several advantages: <itemizedlist>
6201         <listitem>
6202           <para>Volume names clearly identify volume contents</para>
6203         </listitem>
6204
6205         <listitem>
6206           <para>Using the <replaceable>sysname</replaceable> prefix on every volume makes it is easy to back up all of the volumes
6207           together, because the AFS Backup System enables you to define sets of volumes based on a string included in all of their
6208           names</para>
6209         </listitem>
6210
6211         <listitem>
6212           <para>It makes it easy to track related volumes, keeping them together on the same file server machine if desired</para>
6213         </listitem>
6214
6215         <listitem>
6216           <para>There is a clear relationship between volume name and mount point name</para>
6217         </listitem>
6218       </itemizedlist></para>
6219
6220     <informaltable frame="none">
6221       <tgroup cols="2">
6222         <colspec colwidth="50*" />
6223
6224         <colspec colwidth="50*" />
6225
6226         <thead>
6227           <row>
6228             <entry><emphasis role="bold">Volume Name</emphasis></entry>
6229
6230             <entry><emphasis role="bold">Mount Point</emphasis></entry>
6231           </row>
6232         </thead>
6233
6234         <tbody>
6235           <row>
6236             <entry><replaceable>sysname</replaceable></entry>
6237
6238             <entry><emphasis
6239             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable></entry>
6240           </row>
6241
6242           <row>
6243             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">bin</emphasis></entry>
6244
6245             <entry><emphasis
6246             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6247             role="bold">/bin</emphasis></entry>
6248           </row>
6249
6250           <row>
6251             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">etc</emphasis></entry>
6252
6253             <entry><emphasis
6254             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6255             role="bold">/etc</emphasis></entry>
6256           </row>
6257
6258           <row>
6259             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis></entry>
6260
6261             <entry><emphasis
6262             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6263             role="bold">/usr</emphasis></entry>
6264           </row>
6265
6266           <row>
6267             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis></entry>
6268
6269             <entry><emphasis
6270             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6271             role="bold">/usr/afsws</emphasis></entry>
6272           </row>
6273
6274           <row>
6275             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.bin</emphasis></entry>
6276
6277             <entry><emphasis
6278             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6279             role="bold">/usr/bin</emphasis></entry>
6280           </row>
6281
6282           <row>
6283             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.etc</emphasis></entry>
6284
6285             <entry><emphasis
6286             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6287             role="bold">/usr/etc</emphasis></entry>
6288           </row>
6289
6290           <row>
6291             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.inc</emphasis></entry>
6292
6293             <entry><emphasis
6294             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6295             role="bold">/usr/include</emphasis></entry>
6296           </row>
6297
6298           <row>
6299             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.lib</emphasis></entry>
6300
6301             <entry><emphasis
6302             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6303             role="bold">/usr/lib</emphasis></entry>
6304           </row>
6305
6306           <row>
6307             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.loc</emphasis></entry>
6308
6309             <entry><emphasis
6310             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6311             role="bold">/usr/local</emphasis></entry>
6312           </row>
6313
6314           <row>
6315             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.man</emphasis></entry>
6316
6317             <entry><emphasis
6318             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6319             role="bold">/usr/man</emphasis></entry>
6320           </row>
6321
6322           <row>
6323             <entry><replaceable>sysname</replaceable>.<emphasis role="bold">usr.sys</emphasis></entry>
6324
6325             <entry><emphasis
6326             role="bold">/afs/</emphasis><replaceable>cellname</replaceable>/<replaceable>sysname</replaceable><emphasis
6327             role="bold">/usr/sys</emphasis></entry>
6328           </row>
6329         </tbody>
6330       </tgroup>
6331     </informaltable>
6332
6333     <indexterm>
6334       <primary>foreign cell, enabling access</primary>
6335     </indexterm>
6336
6337     <indexterm>
6338       <primary>cell</primary>
6339
6340       <secondary>enabling access to foreign</secondary>
6341     </indexterm>
6342
6343     <indexterm>
6344       <primary>access</primary>
6345
6346       <secondary>to local and foreign cells</secondary>
6347     </indexterm>
6348
6349     <indexterm>
6350       <primary>AFS filespace</primary>
6351
6352       <secondary>enabling access to foreign cells</secondary>
6353     </indexterm>
6354
6355     <indexterm>
6356       <primary>root.cell volume</primary>
6357
6358       <secondary>mounting for foreign cells in local filespace</secondary>
6359     </indexterm>
6360
6361     <indexterm>
6362       <primary>database server machine</primary>
6363
6364       <secondary>entry in client CellServDB file</secondary>
6365
6366       <tertiary>for foreign cell</tertiary>
6367     </indexterm>
6368
6369     <indexterm>
6370       <primary>CellServDB file (client)</primary>
6371
6372       <secondary>adding entry</secondary>
6373
6374       <tertiary>for foreign cell</tertiary>
6375     </indexterm>
6376   </sect1>
6377
6378   <sect1 id="HDRWQ91">
6379     <title>Enabling Access to Foreign Cells</title>
6380
6381     <para>With current OpenAFS releases, there exist a number of mechanisms for
6382     providing access to foreign cells. You may add mount points in your AFS
6383     filespace for each foreign cell you wish users to access, or you can
6384     enable a 'synthetic' AFS root, which contains mountpoints for either all
6385     AFS cells defined in the client machine's local
6386     <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis>, or for all cells
6387     providing location information in the DNS.
6388     </para>
6389
6390     <sect2>
6391     <title>Enabling a Synthetic AFS root</title>
6392
6393     <para>When a synthetic root is enabled, the client cache machine creates its
6394     own root.afs volume, rather than using the one provided with your cell. This
6395     allows clients to access all cells in the
6396     <emphasis role="bold">CellServDB</emphasis> file and, optionally, all cells
6397     registered in the DNS, without requiring system administrator action to
6398     enable this access. Using a synthetic root has the additional advantage that
6399     it allows a client to start its AFS service without a network available, as
6400     it is no longer necessary to contact a fileserver to obtain the root volume.
6401     </para>
6402
6403     <para>OpenAFS supports two complimentary mechanisms for creating the
6404     synthetic root. Starting the cache manager with the
6405     <emphasis role="bold">-dynroot</emphasis> option adds all cells listed
6406     in <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> to the client's
6407     AFS root. Adding the <emphasis role="bold">-afsdb</emphasis> option in
6408     addition to this enables DNS lookups for any cells that are not found in
6409     the client's CellServDB file. Both of these options are added to the AFS
6410     initialisation script, or options file, as detailed in
6411     <link linkend="HDRWQ70">Configuring the Cache Manager</link>.</para>
6412     </sect2>
6413     <sect2>
6414       <title>Adding foreign cells to a conventional root volume</title>
6415
6416     <para>In this section you create a mount point in your AFS filespace for the <emphasis role="bold">root.cell</emphasis> volume
6417     of each foreign cell that you want to enable your users to access. For users working on a client machine to access the cell,
6418     there must in addition be an entry for it in the client machine's local <emphasis
6419     role="bold">/usr/vice/etc/CellServDB</emphasis> file. (The instructions in <link linkend="HDRWQ66">Creating the Client
6420     CellServDB File</link> suggest that you use the <emphasis role="bold">CellServDB.sample</emphasis> file included in the AFS
6421     distribution as the basis for your cell's client <emphasis role="bold">CellServDB</emphasis> file. The sample file lists all of
6422     the cells that had agreed to participate in the AFS global namespace at the time your AFS CD-ROM was created. As mentioned in
6423     that section, the AFS Product Support group also maintains a copy of the file, updating it as necessary.)</para>
6424
6425     <para>The chapter in the <emphasis>OpenAFS Administration Guide</emphasis> about cell administration and configuration issues
6426     discusses the implications of participating in the global AFS namespace. The chapter about administering client machines
6427     explains how to maintain knowledge of foreign cells on client machines, and includes suggestions for maintaining a central
6428     version of the file in AFS. <orderedlist>
6429         <listitem>
6430           <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount each foreign cell's <emphasis
6431           role="bold">root.cell</emphasis> volume on a directory called <emphasis
6432           role="bold">/afs/</emphasis><replaceable>foreign_cell</replaceable>. Because the <emphasis role="bold">root.afs</emphasis>
6433           volume is replicated, you must create a temporary mount point for its read/write version in a directory to which you have
6434           write access (such as your cell's <emphasis role="bold">/afs/.</emphasis><replaceable>cellname</replaceable> directory).
6435           Create the mount points, issue the <emphasis role="bold">vos release</emphasis> command to release new replicas to the
6436           read-only sites for the <emphasis role="bold">root.afs</emphasis> volume, and issue the <emphasis role="bold">fs
6437           checkvolumes</emphasis> command to force the local Cache Manager to access the new replica.</para>
6438
6439           <note>
6440             <para>You need to issue the <emphasis role="bold">fs mkmount</emphasis> command only once for each foreign cell's
6441             <emphasis role="bold">root.cell</emphasis> volume. You do not need to repeat the command on each client machine.</para>
6442           </note>
6443
6444           <para>Substitute your cell's name for <replaceable>cellname</replaceable>.</para>
6445
6446           <programlisting>
6447    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable>
6448    # <emphasis role="bold">/usr/afs/bin/fs  mkmount  temp  root.afs</emphasis>
6449 </programlisting>
6450
6451           <para>Repeat the <emphasis role="bold">fs mkmount</emphasis> command for each foreign cell you wish to mount at this
6452           time.</para>
6453
6454           <programlisting>
6455    # <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>
6456 </programlisting>
6457
6458           <para>Issue the following commands only once.</para>
6459
6460           <programlisting>
6461    # <emphasis role="bold">/usr/afs/bin/fs rmmount temp</emphasis>
6462    # <emphasis role="bold">/usr/afs/bin/vos release root.afs</emphasis>
6463    # <emphasis role="bold">/usr/afs/bin/fs checkvolumes</emphasis>
6464 </programlisting>
6465
6466           <indexterm>
6467             <primary>fs commands</primary>
6468
6469             <secondary>newcell</secondary>
6470           </indexterm>
6471
6472           <indexterm>
6473             <primary>commands</primary>
6474
6475             <secondary>fs newcell</secondary>
6476           </indexterm>
6477         </listitem>
6478
6479         <listitem id="LIWQ92">
6480           <para>If this machine is going to remain an AFS client after you complete the installation, verify
6481           that the local <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file includes an entry for each foreign
6482           cell.</para>
6483
6484           <para>For each cell that does not already have an entry, complete the following instructions: <orderedlist>
6485               <listitem>
6486                 <para>Create an entry in the <emphasis role="bold">CellServDB</emphasis> file. Be sure to comply with the formatting
6487                 instructions in <link linkend="HDRWQ66">Creating the Client CellServDB File</link>.</para>
6488               </listitem>
6489
6490               <listitem>
6491                 <para>Issue the <emphasis role="bold">fs newcell</emphasis> command to add an entry for the cell directly to the
6492                 list that the Cache Manager maintains in kernel memory. Provide each database server machine's fully qualified
6493                 hostname. <programlisting>
6494    # <emphasis role="bold">/usr/afs/bin/fs newcell</emphasis> &lt;<replaceable>foreign_cell</replaceable>&gt; &lt;<replaceable>dbserver1&gt;</replaceable>    \
6495             [&lt;<replaceable>dbserver2&gt;</replaceable>] [&lt;<replaceable>dbserver3&gt;</replaceable>]
6496 </programlisting></para>
6497               </listitem>
6498
6499               <listitem>
6500                 <para>If you plan to maintain a central version of the <emphasis role="bold">CellServDB</emphasis> file (the
6501                 conventional location is <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
6502                 role="bold">/common/etc/CellServDB</emphasis>), create it now as a copy of the local <emphasis
6503                 role="bold">/usr/vice/etc/CellServDB</emphasis> file. Verify that it includes an entry for each foreign cell you
6504                 want your users to be able to access. <programlisting>
6505    # <emphasis role="bold">mkdir common</emphasis>
6506    # <emphasis role="bold">mkdir common/etc</emphasis>
6507    # <emphasis role="bold">cp  /usr/vice/etc/CellServDB  common/etc</emphasis>
6508    # <emphasis role="bold">/usr/afs/bin/vos release root.cell</emphasis>
6509 </programlisting></para>
6510               </listitem>
6511             </orderedlist></para>
6512         </listitem>
6513
6514         <listitem>
6515           <para>Issue the <emphasis role="bold">ls</emphasis> command to verify that the new cell's mount point is visible in your
6516           filespace. The output lists the directories at the top level of the new cell's AFS filespace. <programlisting>
6517    # <emphasis role="bold">ls /afs/</emphasis><replaceable>foreign_cell</replaceable>
6518 </programlisting></para>
6519         </listitem>
6520
6521         <listitem>
6522           <para>If you wish to participate in the global AFS namespace, and only
6523           intend running one database server, please
6524           register your cell with grand.central.org at this time.
6525           To do so, email the <emphasis role="bold">CellServDB</emphasis> fragment
6526           describing your cell, together with a contact name and email address
6527           for any queries, to cellservdb@grand.central.org. If you intend
6528           on deploying multiple database servers, please wait until you have
6529           installed all of them before registering your cell.</para>
6530         </listitem>
6531         <listitem>
6532           <para>If you wish to allow your cell to be located through DNS lookups,
6533           at this time you should also add the necessary configuration to your
6534           DNS.</para>
6535
6536           <para>AFS database servers may be located by creating AFSDB records
6537           in the DNS for the domain name corresponding to the name of your cell.
6538           It's outside the scope of this guide to give an indepth description of
6539           managing, or configuring, your site's DNS. You should consult the
6540           documentation for your DNS server for further details on AFSDB
6541           records.</para>
6542         </listitem>
6543       </orderedlist></para>
6544     </sect2>
6545   </sect1>
6546
6547   <sect1 id="HDRWQ93">
6548     <title>Improving Cell Security</title>
6549
6550     <indexterm>
6551       <primary>cell</primary>
6552
6553       <secondary>improving security</secondary>
6554     </indexterm>
6555
6556     <indexterm>
6557       <primary>security</primary>
6558
6559       <secondary>improving</secondary>
6560     </indexterm>
6561
6562     <indexterm>
6563       <primary>root superuser</primary>
6564
6565       <secondary>controlling access</secondary>
6566     </indexterm>
6567
6568     <indexterm>
6569       <primary>access</primary>
6570
6571       <secondary>to root and admin accounts</secondary>
6572     </indexterm>
6573
6574     <indexterm>
6575       <primary>admin account</primary>
6576
6577       <secondary>controlling access to</secondary>
6578     </indexterm>
6579
6580     <indexterm>
6581       <primary>AFS filespace</primary>
6582
6583       <secondary>controlling access by root superuser</secondary>
6584     </indexterm>
6585
6586     <para>This section discusses ways to improve the security of AFS data
6587     in your cell. Also see the chapter in the <emphasis>OpenAFS
6588     Administration Guide</emphasis> about configuration and administration
6589     issues.</para>
6590
6591     <sect2 id="HDRWQ94">
6592       <title>Controlling root Access</title>
6593
6594       <para>As on any machine, it is important to prevent unauthorized users from logging onto an AFS server or client machine as
6595       the local superuser <emphasis role="bold">root</emphasis>. Take care to keep the <emphasis role="bold">root</emphasis>
6596       password secret.</para>
6597
6598       <para>The local <emphasis role="bold">root</emphasis> superuser does not have special access to AFS data through the Cache
6599       Manager (as members of the <emphasis role="bold">system:administrators</emphasis> group do), but it does have the following
6600       privileges: <itemizedlist>
6601           <listitem>
6602             <para>On client machines, the ability to issue commands from the <emphasis role="bold">fs</emphasis> suite that affect
6603             AFS performance</para>
6604           </listitem>
6605
6606           <listitem>
6607             <para>On server machines, the ability to disable authorization checking, or to install rogue process binaries</para>
6608           </listitem>
6609         </itemizedlist></para>
6610     </sect2>
6611
6612     <sect2 id="HDRWQ95">
6613       <title>Controlling System Administrator Access</title>
6614
6615       <para>Following are suggestions for managing AFS administrative privilege: <itemizedlist>
6616           <listitem>
6617             <para>Create an administrative account for each administrator named
6618             something like
6619             <replaceable>username</replaceable><emphasis role="bold">.admin</emphasis>.
6620             Administrators authenticate under these identities only when
6621             performing administrative tasks, and destroy the administrative
6622             tokens immediately after finishing the task (either by issuing the
6623             <emphasis role="bold">unlog</emphasis> command, or the
6624             <emphasis role="bold">kinit</emphasis> and
6625             <emphasis role="bold">aklog</emphasis> commands to adopt their
6626             regular identity).</para>
6627           </listitem>
6628
6629           <listitem>
6630             <para>Set a short ticket lifetime for administrator accounts (for example, 20 minutes) by using the
6631             facilities of your KDC. For instance, with a MIT Kerberos KDC, this
6632             can be performed using the
6633             <emphasis role="bold">--max-ticket-life</emphasis> argument to
6634             the <emphasis role="bold">kadmin modify_principal</emphasis>
6635             command. Do not however, use a short lifetime for users
6636             who issue long-running <emphasis role="bold">backup</emphasis> commands.</para>
6637           </listitem>
6638
6639           <listitem>
6640             <para>Limit the number of system administrators in your cell, especially those who belong to the <emphasis
6641             role="bold">system:administrators</emphasis> group. By default they have all ACL rights on all directories in the local
6642             AFS filespace, and therefore must be trusted not to examine private files.</para>
6643           </listitem>
6644
6645           <listitem>
6646             <para>Limit the use of system administrator accounts on machines in public areas. It is especially important not to
6647             leave such machines unattended without first destroying the administrative tokens.</para>
6648           </listitem>
6649
6650           <listitem>
6651             <para>Limit the use by administrators of standard UNIX commands that make connections to remote machines (such as the
6652             <emphasis role="bold">telnet</emphasis> utility). Many of these programs send passwords across the network without
6653             encrypting them.</para>
6654           </listitem>
6655         </itemizedlist></para>
6656
6657       <indexterm>
6658         <primary>BOS Server</primary>
6659
6660         <secondary>checking mode bits on AFS directories</secondary>
6661       </indexterm>
6662
6663       <indexterm>
6664         <primary>mode bits on local AFS directories</primary>
6665       </indexterm>
6666
6667       <indexterm>
6668         <primary>UNIX mode bits on local AFS directories</primary>
6669       </indexterm>
6670     </sect2>
6671
6672     <sect2 id="HDRWQ96">
6673       <title>Protecting Sensitive AFS Directories</title>
6674
6675       <para>Some subdirectories of the <emphasis role="bold">/usr/afs</emphasis> directory contain files crucial to cell security.
6676       Unauthorized users must not read or write to these files because of the potential for misuse of the information they
6677       contain.</para>
6678
6679       <para>As the BOS Server initializes for the first time on a server machine, it creates several files and directories (as
6680       mentioned in <link linkend="HDRWQ50">Starting the BOS Server</link>). It sets their owner to the local superuser <emphasis
6681       role="bold">root</emphasis> and sets their mode bits to enable writing by the owner only; in some cases, it also restricts
6682       reading.</para>
6683
6684       <para>At each subsequent restart, the BOS Server checks that the owner and mode bits on these files are still set
6685       appropriately. If they are not, it write the following message to the <emphasis role="bold">/usr/afs/logs/BosLog</emphasis>
6686       file:</para>
6687
6688       <programlisting>
6689    Bosserver reports inappropriate access on server directories
6690 </programlisting>
6691
6692       <para>The BOS Server does not reset the mode bits, which enables you to set alternate values if you wish.</para>
6693
6694       <para>The following charts lists the expected mode bit settings. A question mark indicates that the BOS Server does not check
6695       that mode bit.</para>
6696
6697       <informaltable frame="none">
6698         <tgroup cols="2">
6699           <colspec colwidth="30*" />
6700
6701           <colspec colwidth="70*" />
6702
6703           <tbody>
6704             <row>
6705               <entry><emphasis role="bold">/usr/afs</emphasis></entry>
6706
6707               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6708             </row>
6709
6710             <row>
6711               <entry><emphasis role="bold">/usr/afs/backup</emphasis></entry>
6712
6713               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6714             </row>
6715
6716             <row>
6717               <entry><emphasis role="bold">/usr/afs/bin</emphasis></entry>
6718
6719               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6720             </row>
6721
6722             <row>
6723               <entry><emphasis role="bold">/usr/afs/db</emphasis></entry>
6724
6725               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6726             </row>
6727
6728             <row>
6729               <entry><emphasis role="bold">/usr/afs/etc</emphasis></entry>
6730
6731               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6732             </row>
6733
6734             <row>
6735               <entry><emphasis role="bold">/usr/afs/etc/KeyFile</emphasis></entry>
6736
6737               <entry><computeroutput>-rw</computeroutput>????<computeroutput>---</computeroutput></entry>
6738             </row>
6739
6740             <row>
6741               <entry><emphasis role="bold">/usr/afs/etc/UserList</emphasis></entry>
6742
6743               <entry><computeroutput>-rw</computeroutput>?????<computeroutput>--</computeroutput></entry>
6744             </row>
6745
6746             <row>
6747               <entry><emphasis role="bold">/usr/afs/local</emphasis></entry>
6748
6749               <entry><computeroutput>drwx</computeroutput>???<computeroutput>---</computeroutput></entry>
6750             </row>
6751
6752             <row>
6753               <entry><emphasis role="bold">/usr/afs/logs</emphasis></entry>
6754
6755               <entry><computeroutput>drwxr</computeroutput>?<computeroutput>xr-x</computeroutput></entry>
6756             </row>
6757           </tbody>
6758         </tgroup>
6759       </informaltable>
6760
6761       <indexterm>
6762         <primary>first AFS machine</primary>
6763
6764         <secondary>client functionality</secondary>
6765
6766         <tertiary>removing</tertiary>
6767       </indexterm>
6768
6769       <indexterm>
6770         <primary>removing</primary>
6771
6772         <secondary>client functionality from first AFS machine</secondary>
6773       </indexterm>
6774     </sect2>
6775   </sect1>
6776
6777   <sect1 id="HDRWQ98">
6778     <title>Removing Client Functionality</title>
6779
6780     <para>Follow the instructions in this section only if you do not wish this machine to remain an AFS client. Removing client
6781     functionality means that you cannot use this machine to access AFS files. <orderedlist>
6782         <listitem>
6783           <para>Remove the files from the <emphasis role="bold">/usr/vice/etc</emphasis> directory. The command does not remove the
6784           directory for files used by the dynamic kernel loader program, if it exists on this system type. Those files are still
6785           needed on a server-only machine. <programlisting>
6786    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
6787    # <emphasis role="bold">rm  *</emphasis>
6788    # <emphasis role="bold">rm -rf  C</emphasis>
6789 </programlisting></para>
6790         </listitem>
6791
6792         <listitem>
6793           <para>Create symbolic links to the <emphasis role="bold">ThisCell</emphasis> and <emphasis
6794           role="bold">CellServDB</emphasis> files in the <emphasis role="bold">/usr/afs/etc</emphasis> directory. This makes it
6795           possible to issue commands from the AFS command suites (such as <emphasis role="bold">bos</emphasis> and <emphasis
6796           role="bold">fs</emphasis>) on this machine. <programlisting>
6797    # <emphasis role="bold">ln -s /usr/afs/etc/ThisCell ThisCell</emphasis>
6798    # <emphasis role="bold">ln -s /usr/afs/etc/CellServDB CellServDB</emphasis>
6799 </programlisting></para>
6800         </listitem>
6801
6802         <listitem>
6803           <para>On IRIX systems, issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
6804           role="bold">afsclient</emphasis> configuration variable. <programlisting>
6805    # <emphasis role="bold">/etc/chkconfig -f afsclient off</emphasis>
6806 </programlisting></para>
6807         </listitem>
6808
6809         <listitem>
6810           <para>Reboot the machine. Most system types use the <emphasis role="bold">shutdown</emphasis> command, but the appropriate
6811           options vary. <programlisting>
6812    # <emphasis role="bold">cd /</emphasis>
6813    # <emphasis role="bold">shutdown</emphasis> <replaceable>appropriate_options</replaceable>
6814 </programlisting></para>
6815         </listitem>
6816       </orderedlist></para>
6817   </sect1>
6818 </chapter>