2cc7c1e8e887908009233323886f8d7ccd7ed619
[openafs.git] / doc / man-pages / pod5 / CellServDB.pod
1 =head1 NAME
2
3 CellServDB - Lists the database server machines in AFS cells
4
5 =head1 DESCRIPTION
6
7 There are two versions of the F<CellServDB> file, both of which have the
8 same format.  One version is used by an AFS client and lists all of the
9 database server machines in the local cell and any foreign cell that is to
10 be accessible from the local client machine.  The other version is used on
11 servers and lists only the database servers in the local cell.
12
13 =head2 Client CellServDB
14
15 The client version of the CellServDB file lists the database server
16 machines in the local cell and any foreign cell that is to be accessible
17 from the local client machine. Database server machines run the
18 Authentication Server, Backup Server, Protection Server, and Volume
19 Location (VL) Server (the B<kaserver>, B<buserver>, B<ptserver>, and
20 B<vlserver>) processes, which maintain the cell's administrative AFS
21 databases.
22
23 The Cache Manager and other processes running on a client machine use the
24 list of a cell's database server machines when performing several common
25 functions, including:
26
27 =over 4
28
29 =item *
30
31 Fetching files. The Cache Manager contacts the VL Server to learn
32 the location of the volume containing a requested file or directory.
33
34 =item *
35
36 Authenticating users. Client-side authentication programs (such as an
37 AFS-modified login utility or the B<klog> command interpreter) contact the
38 Authentication Server to obtain a server ticket, which the AFS server
39 processes accept as proof that the user is authenticated.
40
41 =item *
42
43 Creating protection groups. The B<pts> command interpreter contacts the
44 Protection Server when users create protection groups or request
45 information from the Protection Database.
46
47 =back
48
49 The Cache Manager reads the CellServDB file into kernel memory as it
50 initializes, and not again until the machine next reboots. To enable users
51 on the local machine to continue accessing the cell correctly, update the
52 file whenever a database server machine is added to or removed from a
53 cell. To update the kernel-resident list of database server machines
54 without rebooting, use the B<fs newcell> command.
55
56 The F<CellServDB> file is in ASCII format and must reside in the
57 F</usr/vice/etc> directory on each AFS client machine. Use a text editor
58 to create and maintain it.
59
60 The client version of the F<CellServDB> file is distinct from the server
61 version, which resides in the F</usr/afs/etc> directory on each AFS server
62 machine. The client version lists the database server machines in every
63 AFS cell that the cell administrator wants the machine's users to be able
64 to access, whereas the server version lists only the local cell's database
65 server machines.
66
67 =head2 Server CellServDB
68
69 The server version of the F<CellServDB> file lists the local cell's
70 database server machines. These machines run the Authentication Server,
71 Backup Server, Protection Server, and Volume Location (VL) Server (the
72 B<kaserver>, B<buserver>, B<ptserver>, and B<vlserver>) processes, which
73 maintain the cell's administrative AFS databases. The initial version of
74 the file is created with the B<bos setcellname> command during the
75 installation of the cell's server machine, which is automatically recorded
76 as the cell's first database server machine. When adding or removing
77 database server machines, be sure to update this file appropriately. It
78 must reside in the F</usr/afs/etc> directory on each AFS server machine.
79
80 The database server processes consult the F<CellServDB> file to learn
81 about their peers, with which they must maintain constant connections in
82 order to coordinate replication of changes across the multiple copies of
83 each database. The other AFS server processes consult the file to learn
84 which machines to contact for information from the databases when they
85 need it.
86
87 Although the server F<CellServDB> file is in ASCII format, do not use a
88 text editor to alter it. Instead always use the appropriate commands from
89 the B<bos> command suite:
90
91 =over 4
92
93 =item *
94
95 The B<bos addhost> command to add a machine to the file.
96
97 =item *
98
99 The B<bos listhosts> command to display the list of machines from the
100 file.
101
102 =item *
103
104 The B<bos removehost> command to remove a machine from the file.
105
106 =back
107
108 In cells that use the Update Server to distribute the contents of the
109 F</usr/afs/etc> directory, it is customary to edit only the copy of the
110 file stored on the system control machine. Otherwise, edit the file on
111 each server machine individually. For instructions on adding and removing
112 database server machine, see the I<IBM AFS Quick Beginnings> chapter on
113 installing additional server machines.
114
115 =head2 CellServDB Format
116
117 Both F<CellServDB> files have the same format:
118
119 =over 4
120
121 =item *
122
123 The first line begins at the left margin with the greater-than character
124 (C<< > >>), followed immediately by the cell's name without an intervening
125 space. Optionally, a comment can follow any number of spaces and a number
126 sign (C<#>), perhaps to identify the organization associated with the
127 cell.
128
129 =item *
130
131 Each subsequent line in the entry identifies one of the cell's database
132 server machines, with the indicated information in order:
133
134 =over 4
135
136 =item *
137
138 The database server machine's IP address in dotted-decimal format.
139
140 =item *
141
142 One or more spaces.
143
144 =item *
145
146 A number sign (#), followed by the machine's fully qualified hostname
147 without an intervening space. This number sign does not indicate that the
148 hostname is a comment. It is a required field.
149
150 =back
151
152 =back
153
154 No extra blank lines or newline characters are allowed in the file, even
155 after the last entry. Their presence can prevent the Cache Manager from
156 reading the file into kernel memory, resulting in an error message.
157
158 grand.central.org maintains a list of the database server machines in all
159 cells that have registered themselves as receptive to access from foreign
160 cells. When a cell's administrators change its database server machines,
161 it is customary to register the change with grand.central.org for
162 inclusion in this file. The file conforms to the required F<CellServDB>
163 format, and so is a suitable basis for the F<CellServDB> file on a client
164 machine.  You can download this file from L<http://grand.central.org/>.
165
166 =head1 EXAMPLES
167
168 The following example shows entries for two cells in a client
169 F<CellServDB> file and illustrates the required format.
170
171    >abc.com        # ABC Corporation
172    192.12.105.2         #db1.abc.com
173    192.12.105.3         #db2.abc.com
174    192.12.107.3         #db3.abc.com
175    >test.abc.com   # ABC Corporation Test Cell
176    192.12.108.57        #testdb1.abc.com
177    192.12.108.55        #testdb2.abc.com
178
179 =head1 SEE ALSO
180
181 L<bos_addhost(8)>,
182 L<bos_listhosts(8)>,
183 L<bos_removehost(8)>,
184 L<bos_setcellname(8)>,
185 L<buserver(8)>,
186 L<fs_newcell(1)>,
187 L<kaserver(8)>,
188 L<klog(1)>,
189 L<ptserver(8)>,
190 L<vlserver(8)>,
191 L<upclient(8)>,
192 L<upserver(8)>
193
194 I<IBM AFS Quick Beginnings>
195
196 =head1 COPYRIGHT
197
198 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
199
200 This documentation is covered by the IBM Public License Version 1.0.  It was
201 converted from HTML to POD by software written by Chas Williams and Russ
202 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.