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