Add new docs to reguser dir
[openafs-wiki.git] / general / GeneralFAQ.mdwn
1 [[!toc levels=3]]
2
3
4 ## 1 General
5
6 The General Section of the [[AFSFrequentlyAskedQuestions]].
7
8 - [[PreambleFAQ]]
9 - [[UsageFAQ]]
10 - [[AdminFAQ]]
11 - [[ResourcesFAQ]]
12 - [[AboutTheFAQ]]
13 - [[FurtherReading]]
14
15 ### 1.01 What is AFS?
16
17 AFS is a distributed filesystem that enables co-operating hosts (clients and servers) to efficiently share filesystem resources across both local area and wide area networks.
18
19 AFS is based on a distributed file system originally developed at the Information Technology Center at Carnegie-Mellon University that was called the "Andrew File System".
20
21 "Andrew" was the name of the research project at CMU - honouring the founders of the University. A spin-off company, Transarc Corporation (now part of IBM), started producing and marketing a commercial version of AFS in 1989.
22
23 In November, 2000, IBM Open-Sourced AFS, creating [[OpenAFS]]. [[OpenAFS]] is under active development; as of this writing, the 1.6.4 release is being prepared for Unix-like platforms, and the 1.7 series for Windows is updated regularly.
24
25 ### 1.02 Who supplies AFS?
26
27 [[OpenAFS]] is available from the [[OpenAFS]] website. An independent open source project, Arla, supports some clients that [[OpenAFS]] does not, but has not been updated since release 0.90 in early 2007; the release of [[OpenAFS]] largely removed the reasons for the development of Arla and its sister project Milka (an open source AFS server).
28
29 There is also an incomplete kernel-based AFS client (only) for Linux, maintained by Red Hat Software.
30
31 IBM no longer markets AFS and has declared an end-of-life for support.
32
33 <table border="1">
34   <tr>
35     <td>[[OpenAFS]]</td>
36     <td>WWW: <a href="http://www.openafs.org/" target="_top">http://www.openafs.org/</a></td>
37   </tr>
38   <tr>
39     <td>Arla </td>
40     <td>WWW: <a href="http://www.stacken.kth.se/projekt/arla/" target="_top">http://www.stacken.kth.se/projekt/arla/</a></td>
41   </tr>
42   <tr>
43     <td>kAFS </td>
44     <td>see <code>Documentation/filesystems/afs.txt</code> in the Linux kernel source tree</td>
45   </tr>
46 </table>
47
48 ### 1.03 What is `/afs`?
49
50 The root of the AFS filetree is `/afs`. If you execute `ls /afs`, you will see directories that correspond to AFS cells (see below). These cells may be local (on same LAN) or remote (e.g. halfway around the world).
51
52 With AFS you can access all the filesystem space under `/afs` with commands you already use (e.g. `cd`, `cp`, `rm`, and so on) provided you have been granted permission (see AFS ACL below).
53
54 ### 1.04 What is an AFS cell?
55
56 An AFS cell is a collection of servers grouped together administratively and presenting a single, cohesive filesystem. Typically, an AFS cell is a set of hosts that use the same Internet domain name.
57
58 Normally, a variation of the domain name is used as the AFS cell name.
59
60 Users log into AFS client workstations which request information and files from the cell's servers on behalf of the users.
61
62 ### 1.05 What are the benefits of using AFS?
63
64 The main strengths of AFS are its:
65
66 - caching facility
67 - security features
68 - simplicity of addressing
69 - scalability
70 - communications protocol
71
72 Here are some of the advantages of using AFS in more detail:
73
74 #### 1.05.a Cache Manager
75
76 AFS client machines run a Cache Manager process. The Cache Manager maintains information about the identities of the users logged into the machine, finds and requests data on their behalf, and keeps chunks of retrieved files on local disk.
77
78 The effect of this is that as soon as a remote file is accessed a chunk of that file gets copied to local disk and so subsequent accesses (warm reads) are almost as fast as to local disk and considerably faster than a cold read (across the network).
79
80 Local caching also significantly reduces the amount of network traffic, improving performance when a cold read is necessary.
81
82 Many modern NFS implementations provide metadata caching, but this caching is limited and the protocol support for it is somewhat weak, with the result that cached NFS can get out of sync with the server. NFS does not support file data caching at all, although some operating systems can be configured to make use of a separate cache filesystem module which must be configured separately from NFS on each client workstation and for each NFS mountpoint. As this cache is separate, it can only avoid becoming out of sync with the remote filesystem at the price of extra validation and additional network traffic to detect updates every time the file is accessed (or, if there is a delay set to minimize this traffic, it will "miss" remote changes made within that window); [[OpenAFS]]'s integrated cache, by comparison, will be notified of changes on the fileserver (by means of "callback breaking") and only needs to check explicitly for remote updates if the callback has expired (roughly 2 hours). In addition, for files on a read-only volume, it is sufficient to check for a volume update to revalidate all locally cached files on that volume.
83
84 #### 1.05.b Location independence
85
86 Unlike NFS, which makes use of a per-client mount table (such as `/etc/filesystems` on AIX or `/etc/fstab` on Linux) to map (mount) between a local directory name and a remote filesystem, AFS does its mapping (filename to location) at the server. This has the tremendous advantage of making the served filespace location independent.
87
88 Location independence means that a user does not need to know which fileserver holds the file, the user only needs to know the pathname of a file. Of course, the user does need to know the name of the AFS cell to which the file belongs. Use of the AFS cellname as the second part of the pathname (e.g. `/afs/$AFSCELL/somefile`) is helpful to distinguish between file namespaces of local and non-local AFS cells.
89
90 To understand why such location independence is useful, consider having 20 clients and 2 servers. Let's say you had to move a filesystem `/home` from server `a` to server `b`.
91
92 Using NFS, you would have to change the `/etc/fstab` file on 20 clients and take `/home` off-line while you moved it between servers.
93
94 With AFS, you simply move the AFS volume(s) which constitute `/home` between the servers. You do this "on-line" while users are actively using files in `/home` with no disruption to their work.
95
96 (Actually, the AFS equivalent of `/home` would be `/afs/$AFSCELL/home`, where `$AFSCELL` is the AFS cellname.)
97
98 #### 1.05.c Scalability
99
100 With location independence comes scalability. An architectural goal of the AFS designers was client/server ratios of 200:1; some sites exceed this ratio. Exactly what ratio your cell can use depends on many factors including:
101
102 - number of AFS files
103 - size of AFS files
104 - rate at which changes are made
105 - rate at which file are being accessed
106 - speed of server's processor(s)
107 - I/O rates
108 - network bandwidth
109
110 AFS cells can range from the small (1 server/client) to the massive (with hundreds of servers and thousands of clients). Cells can be dynamic: it is simple to add new fileservers or clients and grow the computing resources to meet new user requirements.
111
112 #### 1.05.d Improved security
113
114 Firstly, AFS makes use of Kerberos to authenticate users. This improves security for several reasons:
115
116 - passwords do not pass across the network in plaintext
117
118 - encrypted passwords no longer need to be visible
119   - You don't have to use NIS, aka yellow pages, to distribute /etc/passwd - thus "ypcat passwd" can be eliminated.
120   - If you do choose to use NIS, you can replace the password field with "X" so the encrypted password is not visible. (These issues are discussed in detail in [[[AdminGuide|FurtherReading#AdminGuide]]]).
121
122 - AFS uses mutual authentication - both the service provider and service requester prove their identities
123
124 Secondly, AFS uses access control lists (ACLs) to enable users to restrict access to their own directories.
125
126 Some (not all) implmentations of NFS version 3 can use Kerberos authentication; NFS version 4 adds ACLs, but not all NFS4 implementations interoperate well. Additionally, configuring NFS to use Kerberos, even when it is supported, is often painful and can lead to interoperability problems.
127
128 #### 1.05.e Single systems image (SSI)
129
130 Establishing the same view of filestore from each client and server in a network of systems (that comprise an AFS cell) is an order of magnitude simpler with AFS than it is with, say, NFS.
131
132 This is useful to do because it enables users to move from workstation to workstation and still have the same view of filestore. It also simplifies part of the systems management workload.
133
134 In addition, because AFS works well over wide area networks, the SSI is also accessible remotely.
135
136 As an example, consider a company with two widespread divisions (and two AFS cells): `ny.acme.com` and `sf.acme.com`. Mr. Fudd, based in the New York office, is visiting the San Francisco office.
137
138 Mr. Fudd can then use any AFS client workstation in the San Francisco office that he can log into (a unprivileged guest account would suffice). He could authenticate himself to the `ny.acme.com` cell and securely access his New York filespace, and he doesn't need to remember a different path even though he's working from a remote cell.
139
140 For example:
141
142 The following shows a guest in the `sf.acme.com` AFS cell:
143
144 1. add AFS executables directory to `PATH`
145 2. obtaining a PAG with `pagsh` command (see 2.06)
146 3. use `kinit` and `aklog` to authenticate into the `ny.acme.com` AFS cell
147 4. making a `HOME` away from home
148 5. invoking a homely `.profile`
149
150         guest@toontown.sf.acme.com $ PATH=/usr/afsws/bin:$PATH; export PATH    # {1}
151         guest@toontown.sf.acme.com $ pagsh                                     # {2}
152         $ kinit elmer@NY.ACME.COM                                              # {3}
153         Password for elmer@NY.ACME.COM:
154         $ aklog -cell ny.acme.com
155         $ HOME=/afs/ny.acme.com/user/elmer; export HOME                        # {4}
156         $ cd
157         $ . .profile                                                           # {5}
158         you have new mail
159         guest@toontown $ _
160
161 It is not necessary for the San Francisco system administrator to give Mr. Fudd an AFS account in the `sf.acme.com` cell. Mr. Fudd only needs to be able to log into an AFS client that is:
162
163 1. on the same network as his cell and
164 2. his `ny.acme.com` cell is mounted in the `sf.acme.com` cell (as would certainly be the case in a company with two cells).
165
166 #### 1.05.f Replicated AFS volumes
167
168 AFS files are stored in structures called volumes. These volumes reside on the disks of the AFS file server machines. Volumes containing frequently accessed data can be read-only replicated on several servers.
169
170 Cache managers (on users client workstations) will make use of replicate volumes to load balance. If accessing data from one replicate copy, and that copy becomes unavailable due to server or network problems, AFS will automatically start accessing the same data from a different replicate copy.
171
172 An AFS client workstation will access the closest volume copy. By placing replicate volumes on servers closer to clients (eg on same physical LAN) access to those resources is improved and network traffic reduced.
173
174 #### 1.05.g Improved robustness to server crash
175
176 The Cache Manager maintains local copies of remotely accessed files. This is accomplished in the cache by breaking files into chunks of up to 64k (default chunk size). So, for a large file, there may be several chunks in the cache but a small file will occupy a single chunk (which will be only as big as is needed).
177
178 A "working set" of files that have been accessed on the client is established locally in the client's cache (copied from fileserver(s)).
179
180 If a fileserver crashes, the client's locally cached file copies remain readable but updates to cached files fail while the server is down.
181
182 Also, if the AFS configuration has included replicated read-only volumes then alternate fileservers can satisfy requests for files from those volumes.
183
184 #### 1.05.h "Easy to use" networking
185
186 Accessing remote file resources via the network becomes much simpler when using AFS. Users have much less to worry about: want to move a file from a remote site? Just copy it to a different part of /afs.
187
188 Once you have wide-area AFS in place, you don't have to keep local copies of files. Let AFS fetch and cache those files when you need them.
189
190 #### 1.05.i Communications protocol
191
192 The AFS communications protocol is optimized for Wide Area Networks. Retransmitting only the single bad packet in a batch of packets and allowing the number of unacknowledged packets to be higher (than in other protocols, see [[[Johnson90|FurtherReading#Johnson90]]]).
193
194 #### 1.05.j Improved system management capability
195
196 Systems administrators are able to make configuration changes from any client in the AFS cell (it is not necessary to login to a fileserver).
197
198 With AFS it is simple to effect changes without having to take systems off-line.
199
200 Example:
201
202 A department (with its own AFS cell) was relocated to another office. The cell had several fileservers and many clients. How could they move their systems without causing disruption?
203
204 First, the network infrastructure was established to the new location. The AFS volumes on one fileserver were migrated to the other fileservers. The "freed up" fileserver was moved to the new office and connected to the network.
205
206 A second fileserver was "freed up" by moving its AFS volumes across the network to the first fileserver at the new office. The second fileserver was then moved.
207
208 This process was repeated until all the fileservers were moved.
209
210 All this happened with users on client workstations continuing to use the cell's filespace. Unless a user saw a fileserver being physically moved (s)he would have no way to tell the change had taken place.
211
212 Finally, the AFS clients were moved - this was noticed!
213
214 ### 1.06 Which systems is AFS available for?
215
216 [[OpenAFS]], as of the 1.6.2 release for Unix and 1.7.24 for Windows, is currently available in binary releases for:
217
218 - IBM AIX 5.3, 6.1
219 - Fedora Core 15, 16, 17, 18 (Intel)
220 - [[FreeBSD]] 8.2, 8.3, 9.0, 9.1 (Intel)
221 - [[MacOS]] X 10.6-10.8 (Intel) (Snow Leopard, Lion, Mountain Lion)
222 - RHEL 5, 6 (Intel)
223 - SuSE Enterprise 10, 11 (Intel)
224 - Solaris 10, 11 (Sparc and Intel)
225 - Windows 2000/XP/2003/Vista/7
226
227 These are only the platforms for which official binary releases are prepared; it can be built from source for a large number of additional platforms including HP-UX, SGI, OpenBSD, NetBSD, and older releases and other CPU architectures of supported platforms.
228
229 ### 1.07 What does `ls /afs` display in the Internet AFS filetree?
230
231 Essentially this displays the AFS cells that co-operate in the Internet AFS filetree.
232
233 Note that the output of this will depend on the cell you do it from; a given cell may not have all the publicly advertised cells available, and it may have some cells that aren't advertised outside of the given site.
234
235 The definitive source for this information is [[/afs/grand.central.org/service/CellServDB|file:///afs/grand.central.org/service/CellServDB]].
236
237 Note that it is also possible to use AFS "behind the firewall" within the confines of your organization's network - you don't have to participate in the Internet AFS filetree.
238
239 Indeed, there are lots of benefits of using AFS on a local area network without using the WAN capabilities.
240
241 ### 1.08 Why does AFS use Kerberos authentication?
242
243 It improves security.
244
245 Kerberos uses the idea of a trusted third party to prove identification. This is a bit like using a letter of introduction or quoting a referee who will vouch for you.
246
247 When a user authenticates using the klog command (s)he is prompted for a password. If the password is accepted the Kerberos server provides the user with an encrypted token (containing a "ticket granting ticket").
248
249 From that point on, it is the encrypted token that is used to prove the user's identity. These tokens have a limited lifetime (typically a day) and are useless when expired.
250
251 In AFS, it is possible to authenticate into multiple AFS cells. A summary of the current set of tokens held can be displayed by using the "tokens" command.
252
253 For example:
254
255     elmer@toontown $ tokens
256
257     Tokens held by the Cache Manager:
258
259     User's (AFS ID 9997) tokens for afs@ny.acme.com [Expires Sep 15 06:50]
260     User's (AFS ID 5391) tokens for afs@sf.acme.com [Expires Sep 15 06:48]
261        --End of list--
262
263 Kerberos improves security because a users's password need only be entered once (at `kinit` time).
264
265 AFS uses Kerberos to do complex mutual authentication which means that both the service requester and the service provider have to prove their identities before a service is granted.
266
267 Originally AFS shipped with its own version of Kerberos 4, called `kaserver`. `kaserver` still ships at this time (1.6.2 release), but is deprecated in favor of using a true Kerberos 5 implementation. [[OpenAFS]] does not currently ship with a Kerberos 5 implementation; it is up to the administrator(s) to choose a version (MIT krb5, Heimdal, Active Directory, etc) and install it. [[OpenAFS]] will happily work with any KDC.
268
269 For more detail on this and other Kerberos issues see the faq for Kerberos (posted to `news.answers` and `comp.protocols.kerberos`) [[[Jaspan|FurtherReading#Jaspan]]]. (Also, see [[[Miller87|FurtherReading#Miller87]]], [[[Bryant88|FurtherReading#Bryant88]]], [[[Bellovin90|FurtherReading#Bellovin90]]], [[[Steiner88|FurtherReading#Steiner88]]])
270
271 ### 1.09 Does AFS work over protocols other than UDP?
272
273 No. AFS was designed to work over UDP, and does not use TCP.
274
275 There is some work being done (see
276 [here](http://conferences.inf.ed.ac.uk/eakc2012/slides/201210_eakc_oob.pdf)) to
277 allow AFS to make use of other network transports, including TCP, but this is
278 still experimental and undergoing development.
279
280 ### 1.10 How can I access AFS from my PC?
281
282 You can use [[OpenAFS]] for Windows client. In the past year it has become very stable and robust. [[OAfW]] works with Kerberos for Windows in much the same way the Unix clients work with Kerberos.
283
284 There is also [[Samba|http://www.samba.org]], an SMB server for UNIX. There are several ways to integrate AFS with Samba. See [[SMBtoAFS]].
285
286 Mac OS X and Linux users might find [[`sshfs`|http://en.wikipedia.org/wiki/SSHFS]] useful in some circumstances.
287
288 ### 1.11 How does AFS compare with NFS?
289
290 <table border="1" cellpadding="0" cellspacing="0">
291   <tr>
292     <td>   </td>
293     <th align="center" bgcolor="#99CCCC"><strong> AFS </strong></th>
294     <th align="center" bgcolor="#99CCCC"><strong> NFS </strong></th>
295   </tr>
296   <tr>
297     <th bgcolor="#99CCCC"><strong> File Access </strong></th>
298     <td> Common name space from all workstations </td>
299     <td> Different file names from different workstations </td>
300   </tr>
301   <tr>
302     <th bgcolor="#99CCCC"><strong> File Location Tracking </strong></th>
303     <td> Automatic tracking by file system processes and databases </td>
304     <td> Mountpoints to files set by administrators and users </td>
305   </tr>
306   <tr>
307     <th bgcolor="#99CCCC"><strong> Performance </strong></th>
308     <td> Client caching to reduce network load; callbacks to maintain cache consistency </td>
309     <td> No local disk caching without local configuration of `cachefs`; limited cache consistency </td>
310   </tr>
311   <tr>
312     <th bgcolor="#99CCCC"><strong> Andrew Benchmark (5 phases, 8 clients) </strong></th>
313     <td> Average time of 210 seconds/client </td>
314     <td> Average time of 280 seconds/client </td>
315   </tr>
316   <tr>
317     <th bgcolor="#99CCCC"><strong> Scaling capabilities </strong></th>
318     <td> Maintains performance in small and very large installations </td>
319     <td> Best in small to mid-size installations </td>
320   </tr>
321   <tr>
322     <td>   </td>
323     <td> Excellent performance on wide-area configuration </td>
324     <td> Best in local-area configurations </td>
325   </tr>
326   <tr>
327     <th bgcolor="#99CCCC"><strong> Security </strong></th>
328     <td> Kerberos mutual authentication </td>
329     <td> Security based on unencrypted user ID's </td>
330   </tr>
331   <tr>
332     <td>   </td>
333     <td> Access control lists on directories for user and group access </td>
334     <td> No access control lists </td>
335   </tr>
336   <tr>
337     <th bgcolor="#99CCCC"><strong> Availability </strong></th>
338     <td> Replicates read-mostly data and AFS system information </td>
339     <td> No replication </td>
340   </tr>
341   <tr>
342     <th bgcolor="#99CCCC"><strong> Backup Operation </strong></th>
343     <td> No system downtime with specially developed AFS Backup System </td>
344     <td> Standard UNIX backup system </td>
345   </tr>
346   <tr>
347     <th bgcolor="#99CCCC"><strong> Reconfiguration </strong></th>
348     <td> By volumes (groups of files) </td>
349     <td> Per-file movement </td>
350   </tr>
351   <tr>
352     <td>   </td>
353     <td> No user impact; files remain accessible during moves, and file names do not change </td>
354     <td> Users lose access to files and filenames change (mountpoints need to be reset) </td>
355   </tr>
356   <tr>
357     <th bgcolor="#99CCCC"><strong> System Management </strong></th>
358     <td> Most tasks performed from any workstation </td>
359     <td> Frequently involves telnet to other workstations </td>
360   </tr>
361   <tr>
362     <th bgcolor="#99CCCC"><strong> Autonomous Architecture </strong></th>
363     <td> Autonomous administrative units called cells, in addition to file servers and clients </td>
364     <td> File servers and clients </td>
365   </tr>
366   <tr>
367     <td>   </td>
368     <td> No trust required between cells </td>
369     <td> No security distinctions between sites </td>
370   </tr>
371   <tr>
372     <td>
373     </td>
374     <td colspan="2"> [ source: <a href="ftp://ftp.transarc.com/pub/afsps/doc/afs-nfs.comparison" target="_top">ftp://ftp.transarc.com/pub/afsps/doc/afs-nfs.comparison</a> ] </td>
375   </tr>
376 </table>
377
378 Other points:
379
380 - Some vendors offer more secure versions of NFS but implementations vary. Many NFS ports have no extra security features (such as Kerberos).
381
382 - The AFS Cache Manager can be configured to work with a RAM (memory) based cache. This offers signifigant performance benefits over a disk based cache. NFS has no such feature. Imagine how much faster it is to access files cached into RAM!
383
384 - The Andrew benchmark demonstrates that AFS has better performance than NFS as the number of clients increases. A graph of this (taken from Andrew benchmark report) is available in:
385   - ![20050131\_graph\_afs\_nfs.jpg](http://i.imgur.com/Ir6YS.jpg)
386