getting started
[openafs-wiki.git] / 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.
27
28 In addition to the file servers, OpenAFS provides a specialized lookup service
29 for AFS clients and file servers, the so called AFS database servers. In a
30 recommended configuration, a set of three dedicated machines, physical or
31 virtual, are setup as AFS database servers. It is important to have good
32 availability of the hosts running the database service, and ideally, the IP
33 addresses of these hosts should be changed infrequently.
34
35 OpenAFS file servers and database servers are administratively grouped into a
36 collection called a 'cell'. By convention, a cell name matches an internet
37 domain name registered by the organization running the AFS cell. An
38 organization may have multiple cells.
39
40 ### Kerberos ###
41
42 OpenAFS uses Kerberos v5 to authenticate users and processes accessing files in
43 the AFS filesystem, and to authenticate administrators when running
44 administrative commands. This security model avoids trusting the client machines
45 for user authentication, even if a user is becomes 'root' on a client.
46
47 A Kerberos v5 realm needs to be available before setting up OpenAFS.  An
48 existing Kerberos realm can be used or a new realm will need to be setup.
49 Kerberos 5 implementations such as Active Directory, MIT Kerberos V, or Heimdal
50 are commonly used.  For compatibility with older versions of AFS, OpenAFS
51 includes a deprecated, Kerberos 4 implementation called `kaserver`.  You may
52 see it mentioned in various older how-to guides, however `kaserver` should not
53 be used for new installations of OpenAFS.
54
55 ### Time Synchronization ###
56
57 Kerberos requires servers and clients to have good clock synchronization,
58 using `ntp` or some other synchronization mechanism. Be sure ntp is installed
59 and working on every machine to be used as an OpenAFS client or server.
60
61
62 ### Firewalls ###
63
64 Todo
65