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