GettingStarted.mdwn

   1 This page provides information and tips to get started setting up OpenAFS
   2 clients and servers.  Read the [OpenAFS documentation](http://docs.openafs.org/)
   3 for detailed instructions for installing and configuring OpenAFS.
   4
   5 [[!toc levels=3]]
   6
   7 ## Planning ##
   8
   9 This section outlines some considerations when planning a new OpenAFS
  10 installation.
  11
  12 ### Servers ###
  13
  14 An OpenAFS installation requires one or more servers for file storage. These
  15 may be physical or virtual machines, running a unix-like operating system, such
  16 as Solaris, Linux, *BSD.  Not all the servers for a site need to be running the
  17 same architecture and operating system, and it is not uncommon to have a
  18 mixture of file servers running different operating systems or versions.  Each
  19 file storage servers should have one or more unix filesystem partitions for
  20 data and AFS-metadata storage. The files stored in these partitions can only be
  21 accessed using a machine running the AFS client software.
  22
  23 The file server machines must support IPv4 and may have multiple interfaces.
  24 By default, OpenAFS will try to use all the non-loopback interfaces available
  25 on a file server machine. A configuration can be used to set which addresses
  26 are actually reachable by clients. Changing the IP address of a fileserver
  27 requires a restart of the file service process.
  28
  29 In addition to the file servers, OpenAFS provides a specialized lookup service
  30 for AFS clients and file servers, the so called AFS database servers. In a
  31 recommended configuration, a set of three dedicated machines are deployed as
  32 AFS database servers. These hosts may be physical or virtual machines, running
  33 a unix-like operating system.  Availability of the hosts running the database
  34 service is important to the reliability of the AFS cell. Each database host
  35 must support IPv4 and must have one IPv4 address.  Once deployed, it is best to
  36 avoid changing the IP address of an AFS database server.
  37
  38 OpenAFS file servers and database servers are administratively grouped into a
  39 collection called a 'cell'. By convention, a cell name matches an internet
  40 domain name registered by the organization running the AFS cell. An
  41 organization may have multiple cells.
  42
  43 ### Kerberos ###
  44
  45 OpenAFS uses Kerberos v5 to authenticate users and processes accessing files in
  46 the AFS filesystem, and to authenticate administrators when running
  47 administrative commands. This security model avoids trusting the client machines
  48 for user authentication, even if a user is becomes 'root' on a client.
  49
  50 A Kerberos v5 realm needs to be available before setting up OpenAFS.  An
  51 existing Kerberos realm can be used or a new realm will need to be setup.
  52 Kerberos 5 implementations such as Active Directory, MIT Kerberos V, or Heimdal
  53 are commonly used.  OpenAFS includes a deprecated, Kerberos 4 implementation
  54 called `kaserver` for compatibility with older versions of AFS.  You may see it
  55 mentioned in various older how-to guides, however `kaserver` should not be used
  56 in new installations of OpenAFS.
  57
  58 ### Time Synchronization ###
  59
  60 Kerberos requires servers and clients to have good clock synchronization,
  61 using `ntp` or some other synchronization mechanism. Be sure ntp is installed
  62 and working on every machine to be used as an OpenAFS client or server.
  63
  64
  65 ### Firewalls ###
  66
  67 Todo
  68