doc: -afsdb uses SRV records
authorKen Dreyer <kdreyer@usgs.gov>
Mon, 16 May 2011 23:53:43 +0000 (19:53 -0400)
committerDerrick Brashear <shadow@dementia.org>
Tue, 17 May 2011 20:20:26 +0000 (13:20 -0700)
afsd's -afsdb option now uses DNS SRV records (RFC 5864). Update the manpages
to reflect this.

Change-Id: I944df36717b53d8545765bde68c309e0229cfc79
Reviewed-on: http://gerrit.openafs.org/4670
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Reviewed-by: Derrick Brashear <shadow@dementia.org>

doc/man-pages/pod1/cmdebug.pod
doc/man-pages/pod1/fs_checkservers.pod
doc/man-pages/pod5/CellServDB.pod
doc/man-pages/pod8/afsd.pod

index c01cb31..80061e3 100644 (file)
@@ -95,8 +95,8 @@ this option with B<-long>, B<-refcounts>, B<-callbacks>, or B<-addrs>.
 
 Lists all known volume location database records in a
 CellServDB-compatible format. This includes all records in memory,
-including those from the CellServDB file, AFSDB DNS records, and the
-B<fs newcell> command. This option could be used to see if a client
+including those from the CellServDB file, DNS SRV or AFSDB records, and
+the B<fs newcell> command. This option could be used to see if a client
 has the latest copy of the CellServDB file. Do not use this option
 with B<-long>, B<-refcounts>, B<-callbacks>, or B<-cache>.
 
index 9f6996f..3a916dc 100644 (file)
@@ -27,7 +27,7 @@ memory:
 
 =item *
 
-The database server machines in every cell listed in the local
+The database server machines for every cell listed in the local
 F</usr/vice/etc/CellServDB file>, plus any machines added to the memory
 list by the B<fs newcell> command since the last reboot.
 
index 5e0240f..0f33c3e 100644 (file)
@@ -13,8 +13,8 @@ configurations it can be a link to the same file the client uses.
 
 =head2 Client CellServDB
 
-Along with AFSDB entries in DNS, the client version of the CellServDB file
-lists the database server machines in the local cell and any foreign cell
+Along with AFSDB and SRV entries in DNS, the client version of the CellServDB
+file lists the database server machines in the local cell and any foreign cell
 that is to be accessible from the local client machine. Database server
 machines run the Authentication Server (optional), Backup Server
 (optional), Protection Server, and Volume Location (VL) Server (the
@@ -66,8 +66,8 @@ command.
 
 If the client attempts to access an AFS cell not listed in F<CellServDB>
 and B<afsd> was started with the B<-afsdb> option, the Cache Manager will
-attempt an AFSDB DNS record lookup and dynamically add the database server
-locations for that cell based on the result of the DNS query.  If the
+attempt a DNS SRV or AFSDB record lookup and dynamically add the database
+server locations for that cell based on the result of the DNS query.  If the
 B<-afsdb> option was not used, all AFS cells that will be accessed by a
 client machine must either be listed in F<CellServDB> or added with the
 B<fs newcell> command.
@@ -189,8 +189,8 @@ of a cell (so that it's listed by default in F</afs> when the B<-dynroot>
 flag to B<afsd> is in use, for instance) without specifying the database
 server machines for that cell.  This can be done by including only the
 cell line (starting with C<< > >>) and omitting any following database
-server machine lines.  This only works if B<afsd> is configured, with the
-B<-afsdb> option, to use AFSDB record lookups to locate database server
+server machine lines. B<afsd> must be configured with the B<-afsdb> option
+to use DNS SRV or AFSDB record lookups to locate database server
 machines.  If the cell has such records and the client is configured to
 use them, this configuration won't require updates to the client
 F<CellServDB> file when the IP addresses of the database server machines
index d844bbf..9d76326 100644 (file)
@@ -71,7 +71,7 @@ machines, prevents the Cache Manager from accessing files in it.
 By default, the list of database server machines is transferred into the
 kernel from the F</usr/vice/etc/CellServDB> file. Alternatively, when the
 B<-afsdb> option is used, the list of database server machines is taken
-from the AFSDB DNS records for each cell. After initialization, use the
+from the DNS SRV or AFSDB records for each cell. After initialization, use the
 B<fs newcell> command to change the kernel-resident list without having to
 reboot.
 
@@ -411,14 +411,14 @@ It should be considered experimental.
 
 =item B<-afsdb>
 
-Enable afsdb support. This will use DNS to lookup the AFSDB record and
+Enable afsdb support. This will use DNS to lookup the SRV or AFSDB records and
 use that for the database servers for each cell instead of the values
 in the F<CellServDB> file. This has the advantage of only needing to
-update one DNS record to reconfigure the AFS clients for a new
+update one set of DNS records to reconfigure the AFS clients for a new
 database server as opposed to touching all of the clients, and also
 allows one to access a cell without preconfiguring its database
-servers in F<CellServDB>. The format of AFSDB records is defined in
-RFC 1183.
+servers in F<CellServDB>. The format of SRV records is defined in
+RFC 5864, and the AFSDB record format is in RFC 1183.
 
 =item B<-backuptree>
 
@@ -755,7 +755,8 @@ L<afs_cache(5)>,
 L<CellServDB(5)>,
 L<cacheinfo(5)>
 
-RFC 1183 L<http://www.faqs.org/rfcs/rfc1183.html>
+RFC 5864 L<http://www.ietf.org/rfc/rfc5864.txt>
+RFC 1183 L<http://www.ietf.org/rfc/rfc1183.txt>
 
 =head1 COPYRIGHT