doc/xml/QuickStartUnix/auqbg004.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <chapter id="HDRWQ6">
   3   <title>Installation Overview</title>
   4
   5   <para>This chapter describes the type of instructions provided in this
   6   guide and the hardware and software requirements for installing
   7   <trademark class="registered">AFS</trademark>.</para>
   8
   9   <para>Before beginning the installation of your cell's first machine,
  10   read this chapter and the material from the <citetitle>OpenAFS
  11   Administration Guide</citetitle> listed in <link
  12   linkend="HDRWQ8">Recommended Reading List</link>. It is also best to
  13   read through <link linkend="HDRWQ17">Installing the First AFS
  14   Machine</link> before beginning the installation, so that you understand
  15   the overall scope of the installation procedure. Similarly, before
  16   installing additional server or client machines it is best to read
  17   through <link linkend="HDRWQ99">Installing Additional Server
  18   Machines</link> and <link linkend="HDRWQ133">Installing Additional
  19   Client Machines</link>.</para>
  20
  21   <para>If you are already running a version of AFS, consult the upgrade
  22   instructions in the <citetitle>OpenAFS Release Notes</citetitle> before
  23   proceeding with the installation.</para>
  24
  25   <sect1 id="HDRWQ7">
  26     <title>The Procedures Described in this Guide</title>
  27
  28     <para>This guide describes two types of installation procedures:
  29     initial procedures (such as installing the first AFS machine or
  30     incorporating AFS into the kernel) and as-needed procedures (such as
  31     installing additional server machines or client machines).</para>
  32
  33     <sect2 id="Header_9">
  34       <title>Required Initial Procedures</title>
  35
  36       <para>You must perform the following basic procedures to start using
  37       AFS.</para>
  38
  39       <sect3 id="Header_10">
  40         <title>Incorporating AFS Into the Kernel</title>
  41
  42         <para>You must incorporate AFS modifications into the kernel of
  43         every AFS file server and client machine. Depending on the
  44         operating system, you either use a program for dynamic kernel
  45         loading, build a new static kernel, or can choose between the
  46         two. For your convenience, the instructions for incorporating AFS
  47         into the kernel appear in full in every chapter where you need to
  48         use them.
  49           <indexterm>
  50             <primary>roles for first AFS machine</primary>
  51           </indexterm>
  52           <indexterm>
  53             <primary>first AFS machine</primary>
  54             <secondary>roles</secondary>
  55           </indexterm>
  56         </para>
  57       </sect3>
  58
  59       <sect3 id="Header_11">
  60         <title>Installing the First AFS Machine</title>
  61
  62         <para>You install the first AFS machine in your cell to function
  63         as both an AFS server and client machine.  You can disable the
  64         client functionality after completing the installation, if you
  65         wish.</para>
  66
  67         <para>The first server machine in a cell performs several
  68         functions:
  69           <itemizedlist>
  70             <listitem>
  71               <para>It acts as the <emphasis>system control
  72               machine</emphasis> (if your AFS distribution includes the
  73               required encryption files), distributing certain
  74               configuration files to the other server machines in the
  75               cell</para>
  76             </listitem>
  77
  78             <listitem>
  79               <para>It acts as the <emphasis>binary distribution
  80               machine</emphasis> for its system type, distributing AFS
  81               binaries to other server machines of its system type</para>
  82             </listitem>
  83
  84             <listitem>
  85               <para>It acts as the first <emphasis>database server
  86               machine</emphasis>, running the server processes that
  87               maintain the AFS administrative databases</para>
  88             </listitem>
  89           </itemizedlist>
  90         </para>
  91
  92         <para>After you install server and client functionality, you
  93         complete other procedures specific to the first machine, including
  94         setting up the top levels of your cell's AFS filespace.</para>
  95       </sect3>
  96     </sect2>
  97
  98     <sect2 id="Header_12">
  99       <title>As-needed Procedures</title>
 100
 101       <sect3 id="Header_13">
 102         <title>Upgrading the Operating System</title>
 103
 104         <para>Upgrading the operating system requires you to take several
 105         steps to protect data and AFS-modified binaries from being lost or
 106         overwritten. For guidelines, see <link linkend="HDRWQ14">About
 107         Upgrading the Operating System</link>.</para>
 108       </sect3>
 109
 110       <sect3 id="Header_14">
 111         <title>Installing Additional File Server Machines</title>
 112
 113         <para>See <link linkend="HDRWQ100">Installing an Additional File
 114         Server Machine</link>.</para>
 115       </sect3>
 116
 117       <sect3 id="Header_15">
 118         <title>Configuring or Decommissioning Database Server Machines</title>
 119
 120         <para>See <link linkend="HDRWQ114">Installing Database Server
 121         Functionality</link> and <link linkend="HDRWQ125">Removing
 122         Database Server Functionality</link>.</para>
 123       </sect3>
 124
 125       <sect3 id="Header_16">
 126         <title>Installing Additional AFS Client Machines</title>
 127
 128         <para>See <link linkend="HDRWQ133">Installing Additional Client
 129         Machines</link>.</para>
 130       </sect3>
 131
 132       <sect3 id="Header_17">
 133         <title>Building AFS from Source Code</title>
 134
 135         <para>See <link linkend="HDRWQ163">Appendix A, Building AFS from
 136         Source Code</link>.
 137           <indexterm>
 138             <primary>background reading list</primary>
 139           </indexterm>
 140           <indexterm>
 141             <primary>reading list for background information</primary>
 142           </indexterm>
 143         </para>
 144       </sect3>
 145     </sect2>
 146   </sect1>
 147
 148   <sect1 id="HDRWQ8">
 149     <title>Recommended Reading List</title>
 150
 151     <para>To develop the best understanding of the overall scope of an
 152     installation procedure, read through the entire chapter or section
 153     that describes it before performing any actions.</para>
 154
 155     <para>In addition, familiarity with some basic AFS concepts can make
 156     the installation more efficient, because you understand better the
 157     purpose of the steps. The following is a prioritized list of material
 158     to read before installing the first AFS machine. At minimum, read the
 159     first chapter of the <citetitle>OpenAFS Administration
 160     Guide</citetitle>.  Then continue your reading in the indicated order,
 161     as extensively as you can. It is more important at this point to read
 162     the conceptual material in each section than the instructions.</para>
 163
 164     <para><emphasis role="bold">Selected Topics in the <emphasis>OpenAFS
 165     Administration Guide</emphasis></emphasis>
 166       <itemizedlist>
 167         <listitem>
 168           <para>The chapter titled <emphasis>An Overview of AFS
 169           Administration</emphasis></para>
 170         </listitem>
 171
 172         <listitem>
 173           <para>Selected sections in the <emphasis>Administering Server
 174           Machines</emphasis> chapter: <emphasis>Local Disk Files on a
 175           Server Machine</emphasis>, <emphasis>The Four Roles for a Server
 176           Machine</emphasis>, <emphasis>Maintaining the Server CellServDB
 177           File</emphasis></para>
 178         </listitem>
 179
 180         <listitem>
 181           <para>Selected sections in the <emphasis>Monitoring and
 182           Controlling Server Processes</emphasis> chapter:
 183           <emphasis>Controlling and Checking Process
 184           Status</emphasis></para>
 185         </listitem>
 186
 187         <listitem>
 188           <para>Selected sections in the <emphasis>Managing Server
 189           Encryption Keys</emphasis> chapter: <emphasis>About Server
 190           Encryption Keys</emphasis></para>
 191         </listitem>
 192
 193         <listitem>
 194           <para>Selected sections in the <emphasis>Managing
 195           Volumes</emphasis> chapter: <emphasis>About Volumes</emphasis>,
 196           <emphasis>Creating Read/write Volumes</emphasis>,
 197           <emphasis>Clones and Cloning</emphasis>, <emphasis>Mounting
 198           Volumes</emphasis></para>
 199         </listitem>
 200
 201         <listitem>
 202           <para>Selected sections in the <emphasis>Administering Client
 203           Machines and the Cache Manager</emphasis> chapter:
 204           <emphasis>Overview of Cache Manager Customization</emphasis>,
 205           <emphasis>Configuration and Cache-related Files on the Local
 206           Disk</emphasis>, <emphasis>Determining the Cache Type, Size, and
 207           Location</emphasis></para>
 208         </listitem>
 209
 210         <listitem>
 211           <para>Selected sections in the <emphasis>Managing Access Control
 212           Lists</emphasis> chapter: <emphasis>Protecting Data in
 213           AFS</emphasis></para>
 214         </listitem>
 215       </itemizedlist></para>
 216
 217     <para><emphasis role="bold">More Selected Topics in the
 218     <emphasis>OpenAFS Administration Guide</emphasis></emphasis>
 219       <itemizedlist>
 220         <listitem>
 221           <para>Selected sections in the <emphasis>Managing
 222           Volumes</emphasis> chapter: <emphasis>Creating and Releasing
 223           Read-only Volumes (Replication)</emphasis>, <emphasis>Creating
 224           Backup Volumes</emphasis></para>
 225         </listitem>
 226
 227         <listitem>
 228           <para>Selected sections in the <emphasis>Administering the
 229           Protection Database</emphasis> chapter: <emphasis>About the
 230           Protection Database</emphasis></para>
 231         </listitem>
 232
 233         <listitem>
 234           <para>Selected sections in the <emphasis>Administering User
 235           Accounts</emphasis> chapter: <emphasis>The Components of an AFS
 236           User Account</emphasis></para>
 237         </listitem>
 238
 239         <listitem>
 240           <para>Selected sections in the <emphasis>Managing Administrative
 241           Privilege</emphasis> chapter: <emphasis>An Overview of
 242           Administrative Privilege</emphasis></para>
 243         </listitem>
 244       </itemizedlist>
 245     </para>
 246   </sect1>
 247
 248   <sect1 id="HDRWQ9">
 249     <title>Requirements</title>
 250
 251     <para>You must comply with the following requirements to install AFS successfully. <indexterm>
 252         <primary>root superuser</primary>
 253
 254         <secondary>as installer's login identity</secondary>
 255       </indexterm></para>
 256
 257     <sect2 id="Header_20">
 258       <title>Login Identity</title>
 259
 260       <para>Log into the machine you are installing as the local superuser <emphasis role="bold">root</emphasis>. When instructed,
 261       also authenticate with AFS as the administrative user <emphasis role="bold">admin</emphasis>. <indexterm>
 262           <primary>overview</primary>
 263
 264           <secondary>general installation requirements</secondary>
 265         </indexterm> <indexterm>
 266           <primary>requirements</primary>
 267
 268           <secondary>general</secondary>
 269         </indexterm></para>
 270     </sect2>
 271
 272     <sect2 id="HDRWQ10">
 273       <title>General Requirements</title>
 274
 275       <itemizedlist>
 276         <listitem>
 277           <para>You must have the AFS Binary Distribution for each system type you are installing. Unless otherwise noted, the
 278           Binary Distribution includes software for both client and server machines. If you are using the CD-ROM version of the
 279           distribution, the machine you are installing must be able to access the CD-ROMs, either through a local CD drive or via an
 280           NFS<superscript>(R)</superscript> mount of a CD drive attached to a machine that is accessible by network.</para>
 281         </listitem>
 282
 283         <listitem>
 284           <para>All AFS machines that belong to a cell must be able to access each other via the network.</para>
 285         </listitem>
 286
 287         <listitem>
 288           <para>The machine must be running the standard, vendor-supplied version of the operating system supported by the current
 289           version of AFS. The operating system must already be installed on the machine's root partition.</para>
 290         </listitem>
 291
 292         <listitem>
 293           <para>You must be familiar with the current operating system and disk configuration of the machine you are
 294           installing.</para>
 295         </listitem>
 296
 297         <listitem>
 298           <para>All hardware and non-AFS software on the machine must be functioning normally.</para>
 299         </listitem>
 300
 301         <listitem>
 302           <para>No critical processes can be running on the machine you are installing, because you must reboot it during the
 303           installation.</para>
 304         </listitem>
 305       </itemizedlist>
 306
 307       <indexterm>
 308         <primary>file server machine</primary>
 309
 310         <secondary>requirements for installation</secondary>
 311       </indexterm>
 312
 313       <indexterm>
 314         <primary>requirements</primary>
 315
 316         <secondary>file server machine (general)</secondary>
 317       </indexterm>
 318     </sect2>
 319
 320     <sect2 id="HDRWQ11">
 321       <title>File Server Machine Requirements</title>
 322
 323       <itemizedlist>
 324         <listitem>
 325           <para>Cell configuration is simplest if the first machine you install has the lowest IP address of any database server
 326           machine you currently plan to install. If you later configure a machine with a lower IP address as a database server
 327           machine, you must update the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on all of your cell's client
 328           machines before the installation. For further discussion, see <link linkend="HDRWQ114">Installing Database Server
 329           Functionality</link>.</para>
 330         </listitem>
 331
 332         <listitem>
 333           <para>The partition mounted on the <emphasis role="bold">/usr</emphasis> directory must have at least 18 MB of disk space
 334           available for storing the AFS server binaries (stored by convention in the <emphasis role="bold">/usr/afs/bin</emphasis>
 335           directory). If the machine is also a client, there must be additional local disk space available, as specified in <link
 336           linkend="HDRWQ12">Client Machine Requirements</link>. The complete set of AFS binaries requires yet more space, but they
 337           are normally stored in an AFS volume rather than on a machine's local disk.</para>
 338
 339           <para>More significant amounts of space on the partition are required by the administrative databases stored in the
 340           <emphasis role="bold">/usr/afs/db</emphasis> directory and the server process log files stored in the <emphasis
 341           role="bold">/usr/afs/logs</emphasis> directory. The exact requirement depends on many factors, such as the size of your
 342           cell and how often you truncate the log files.</para>
 343         </listitem>
 344
 345         <listitem>
 346           <para>There must be at least one partition (or logical volume, if the operating system and AFS support them) dedicated
 347           exclusively to storing AFS volumes. The total number and size of server partitions on all file server machines in the cell
 348           determines how much space is available for AFS files.</para>
 349         </listitem>
 350       </itemizedlist>
 351
 352       <indexterm>
 353         <primary>client machine</primary>
 354
 355         <secondary>requirements for installation</secondary>
 356       </indexterm>
 357
 358       <indexterm>
 359         <primary>requirements</primary>
 360
 361         <secondary>client machine</secondary>
 362       </indexterm>
 363     </sect2>
 364
 365     <sect2 id="HDRWQ12">
 366       <title>Client Machine Requirements</title>
 367
 368       <itemizedlist>
 369         <listitem>
 370           <para>The partition mounted on the <emphasis role="bold">/usr</emphasis> directory must have at least 4 MB of disk space
 371           available for storing the AFS client binaries and kernel library files (stored by convention in the <emphasis
 372           role="bold">/usr/vice/etc</emphasis> directory). The complete set of AFS binaries requires more space, but they are
 373           normally stored in an AFS volume rather than on a machine's local disk. For most system types, the instructions have you
 374           copy only the one kernel library file appropriate for the machine you are installing. If you choose to store all of the
 375           library files on the local disk, the space requirement can be significantly greater.</para>
 376         </listitem>
 377
 378         <listitem>
 379           <para>On a client machine that uses a disk cache, there must be enough free space on the cache partition (by convention,
 380           mounted on the <emphasis role="bold">/usr/vice/cache</emphasis> directory) to accommodate the cache. The minimum
 381           recommended cache size is 10 MB, but larger caches generally perform better.</para>
 382         </listitem>
 383
 384         <listitem>
 385           <para>On a client machine that uses a memory cache, there must be at least 5 MB of machine memory to devote to caching,
 386           but again more memory generally leads to better performance. For further discussion, see the sections in <link
 387           linkend="HDRWQ133">Installing Additional Client Machines</link> about configuring the cache.</para>
 388         </listitem>
 389       </itemizedlist>
 390
 391       <indexterm>
 392         <primary>system types supported</primary>
 393       </indexterm>
 394
 395       <indexterm>
 396         <primary>supported system types</primary>
 397       </indexterm>
 398     </sect2>
 399   </sect1>
 400
 401   <sect1 id="HDRWQ13">
 402     <title>Supported System Types</title>
 403
 404     <para>The <emphasis>OpenAFS Release Notes</emphasis> for each AFS release list the supported system types. Support for
 405     subsequent revisions of an operating system often becomes available between AFS releases. The AFS Product Support group can
 406     provide details.</para>
 407
 408     <para>It is the goal of the AFS Development and Product Support groups to support AFS on a wide range of popular system types.
 409     Furthermore, each time an operating system vendor releases a new general availability version of a supported operating system,
 410     it is a goal to certify and support AFS on it within a short time. Support can be delayed a bit longer if it is necessary to
 411     generate completely new binaries.</para>
 412
 413     <para>It is not always possible to support AFS on every intermediate version of an operating system or for certain processor
 414     types. In some cases, platform limitations make certain AFS functionality (such as file server or NFS/AFS translator
 415     functionality) unavailable on one or more platforms. For a list of limitations, see the <emphasis>OpenAFS Release
 416     Notes</emphasis> or ask the AFS Product Support group. <indexterm>
 417         <primary>operating system upgrades</primary>
 418       </indexterm> <indexterm>
 419         <primary>upgrading the operating system</primary>
 420       </indexterm> <indexterm>
 421         <primary>AFS server partition</primary>
 422
 423         <secondary>protecting during operating system upgrade</secondary>
 424       </indexterm> <indexterm>
 425         <primary>files</primary>
 426
 427         <secondary>protecting during operating system upgrade</secondary>
 428       </indexterm></para>
 429   </sect1>
 430
 431   <sect1 id="HDRWQ14">
 432     <title>About Upgrading the Operating System</title>
 433
 434     <para>Whenever you upgrade an AFS machine to a different operating system, you must take several actions to maintain proper AFS
 435     functionality. These actions include, but are not necessarily limited to, the following. <itemizedlist>
 436         <listitem>
 437           <para>Unmount the AFS server partitions (mounted at <emphasis role="bold">/vicep</emphasis><replaceable>xx</replaceable>
 438           directories) on all file server machines, to prevent the vendor-supplied <emphasis role="bold">fsck</emphasis> program
 439           from running on them when you reboot the machine during installation of the new operating system. Before upgrading the
 440           operating system, it is prudent to comment out commands in the machine's initialization file that remount the server
 441           partitions, to prevent them from being remounted until you can replace the standard <emphasis role="bold">fsck</emphasis>
 442           program with the AFS-modified version. The instructions in this guide for installing AFS server machines explain how to
 443           replace the <emphasis role="bold">fsck</emphasis> program.</para>
 444         </listitem>
 445
 446         <listitem>
 447           <para>Protect the AFS-modified versions of commands and configuration files from being overwritten by vendor-supplied
 448           versions. These include <emphasis role="bold">vfsck</emphasis> (the AFS version of <emphasis role="bold">fsck</emphasis>),
 449           binaries for the UNIX remote services such as <emphasis role="bold">inetd</emphasis>, and configuration files such as the
 450           one for the Pluggable Authentication Module (PAM). After you have successfully installed the operating system, remember to
 451           move the AFS-modified commands and files back to the locations where they are accessed during normal functioning.</para>
 452         </listitem>
 453
 454         <listitem>
 455           <para>Reformat the server partitions to accommodate AFS-specific information, in certain cases. The upgrade instructions
 456           that accompany the new AFS binaries for an affected platform always detail the required procedure.</para>
 457         </listitem>
 458       </itemizedlist></para>
 459
 460     <indexterm>
 461       <primary>AFS Binary Distribution</primary>
 462     </indexterm>
 463
 464     <indexterm>
 465       <primary>Binary Distribution (AFS)</primary>
 466     </indexterm>
 467
 468     <indexterm>
 469       <primary>CD-ROM</primary>
 470
 471       <secondary>packaging of AFS Binary Distribution</secondary>
 472     </indexterm>
 473
 474     <indexterm>
 475       <primary>encryption files</primary>
 476
 477       <secondary>in AFS Binary Distribution</secondary>
 478     </indexterm>
 479   </sect1>
 480
 481   <sect1 id="HDRWQ15">
 482     <title>The AFS Binary Distribution</title>
 483
 484     <para>The AFS Binary Distribution includes a separate CD-ROM for each supported system type, containing all AFS binaries and
 485     files for both server and client machines. The instructions in this guide specify when to mount the CD-ROM and which files or
 486     directories to copy to the local disk or into an AFS volume.</para>
 487   </sect1>
 488
 489   <sect1 id="HDRWQ16">
 490     <title>How to Continue</title>
 491
 492     <para>If you are installing the first AFS machine in your cell, proceed to <link linkend="HDRWQ17">Installing the First AFS
 493     Machine</link>.</para>
 494
 495     <para>If you are installing an additional file server machine, or configuring or decommissioning a database server machine,
 496     proceed to <link linkend="HDRWQ99">Installing Additional Server Machines</link>.</para>
 497
 498     <para>If you are installing an additional client machine, proceed to <link linkend="HDRWQ133">Installing Additional Client
 499     Machines</link>.</para>
 500   </sect1>
 501 </chapter>