doc/xml/QuickStartUnix/auqbg005.xml

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