doc/xml/QuickStartUnix/auqbg005.xml

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