[svn] commit: r2942 - in /branches/trac341/src/bin: xfrin/b10-xfrin.xml xfrout/b10-xfrout.xml zonemgr/b10-zonemgr.xml
BIND 10 source code commits
bind10-changes at lists.isc.org
Thu Sep 16 16:15:30 UTC 2010
Author: jreed
Date: Thu Sep 16 16:15:30 2010
New Revision: 2942
Log:
Miscellaneous cleanup of manual, like removing
unneeded comments. (Note some minor changes
not related to the ticket.)
More explanation and clarifications for the zonemgr related features.
I chose to somewhat document the internal commands for now
but note that they are not exposed.
Later these will need to go in a BIND 10 developers docs too.
Modified:
branches/trac341/src/bin/xfrin/b10-xfrin.xml
branches/trac341/src/bin/xfrout/b10-xfrout.xml
branches/trac341/src/bin/zonemgr/b10-zonemgr.xml
Modified: branches/trac341/src/bin/xfrin/b10-xfrin.xml
==============================================================================
--- branches/trac341/src/bin/xfrin/b10-xfrin.xml (original)
+++ branches/trac341/src/bin/xfrin/b10-xfrin.xml Thu Sep 16 16:15:30 2010
@@ -103,34 +103,53 @@
</para>
<!-- TODO: formating -->
-<!-- TODO: refresh is code but not in spec -->
-<!-- schedule immediate maintenance for a zone(check soa serial ) -->
<para>
The configuration commands are:
</para>
<para>
- <command>notify</command>
-TODO: what is difference from refresh_from_zonemgr ?
- </para>
-
- <para>
- <command>refresh</command>
-Same as retransfer except it checks the SOA serial first.
-TODO more detail
- </para>
-
- <para>
- <command>refresh_from_zonemgr</command>
+ <command>notify</command> is sent by
+ <citerefentry><refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ when a DNS NOTIFY message is received to initiate a zone
+ transfer.
+<!-- TODO: document that zonemgr or xfrin checks if it needs to or not -->
+ This is an internal command and not exposed to the administrator.
+<!-- not defined in spec -->
+ </para>
+
+ <para>
+ <command>refresh</command> triggers the transfer in for
+ a single zone.
+ It is the same as <command>retransfer</command> except it
+ checks the SOA serial first.
+<!-- TODO more detail -->
+ This is an internal command and not exposed to the administrator.
+<!-- not defined in spec -->
+<!-- TODO: refresh is code but not in spec, see trac ticket #328 -->
+ </para>
+
+ <para>
+ <command>refresh_from_zonemgr</command> is sent by
+ <citerefentry><refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ according to the SOA's REFRESH time
+ to tell <command>b10-xfrin</command> that the zone needs to do
+ a zone refresh.
+ This is an internal command and not exposed to the administrator.
+<!-- not defined in spec -->
</para>
<para>
<command>retransfer</command> triggers the transfer in for
a single zone without checking the zone's serial number.
It has the following arguments: <varname>zone_name</varname>
- to define the zone to request and <varname>master</varname>
- to define the IP address of the authoritative server to
- transfer from.
+ to define the zone to request,
+ <varname>zone_class</varname> to define the class (defaults to
+ <quote>IN</quote>),
+ <varname>master</varname> to define the IP address of
+ the authoritative server to transfer from,
+ and <varname>port</varname> to define the port number on the
+ authoritative server (defaults to 53).
+<!-- TODO: note: not documenting db_file since that will be removed. -->
</para>
<!-- TODO: later hostname for master? -->
@@ -141,11 +160,6 @@
</para>
<!-- TODO:
add a usage example of xfrin -->
-
-<!-- TODO:
-
-port (defaults to 53)
-db_file (defaults to zone.sqlite3) --> <!-- TODO: fix this -->
<!-- TODO:
Modified: branches/trac341/src/bin/xfrout/b10-xfrout.xml
==============================================================================
--- branches/trac341/src/bin/xfrout/b10-xfrout.xml (original)
+++ branches/trac341/src/bin/xfrout/b10-xfrout.xml Thu Sep 16 16:15:30 2010
@@ -54,6 +54,7 @@
<title>DESCRIPTION</title>
<para>The <command>b10-xfrout</command> daemon provides the BIND 10
outgoing DNS zone transfer service.
+ It also used to send outgoing NOTIFY messages.
Normally it is started by the
<citerefentry><refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum></citerefentry>
boss process.
@@ -97,12 +98,16 @@
defines the path to the SQLite3 data store file.
The default is
<filename>/usr/local/var/bind10-devel/zone.sqlite3</filename>.
+<!-- TODO: db_file will be removed -->
</para>
<para>
<varname>transfers_out</varname>
defines the maximum number of outgoing zone transfers
that can run concurrently. The default is 10.
</para>
+
+<!-- TODO: log configurations not documented yet in here. jreed
+ has some but waiting on decisions ... -->
<note><simpara>
This prototype version uses SQLite3 as its data source backend.
@@ -122,12 +127,13 @@
<para>
<command>zone_new_data_ready</command> is sent from
- <command>b10-xfrin</command> to indicate that the zone transferred
- in successfully.
+ <citerefentry><refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ to indicate that the zone transferred in successfully.
This triggers <command>b10-xfrout</command> to send NOTIFY
message(s).
+ This is an internal command and not exposed to the administrator.
+<!-- not defined in spec -->
</para>
-
</refsect1>
@@ -182,8 +188,8 @@
<refsect1>
<title>HISTORY</title>
<para>
- The <command>b10-xfrout</command> daemon was implemented in March 2010
- by Zhang Likun of CNNIC for the ISC BIND 10 project.
+ The <command>b10-xfrout</command> daemon was first implemented
+ in March 2010 by Zhang Likun of CNNIC for the ISC BIND 10 project.
</para>
</refsect1>
</refentry><!--
Modified: branches/trac341/src/bin/zonemgr/b10-zonemgr.xml
==============================================================================
--- branches/trac341/src/bin/zonemgr/b10-zonemgr.xml (original)
+++ branches/trac341/src/bin/zonemgr/b10-zonemgr.xml Thu Sep 16 16:15:30 2010
@@ -90,15 +90,10 @@
<refsect1>
<title>CONFIGURATION AND COMMANDS</title>
+<!--
<para>
The configurable settings are:
</para>
-<!--
- <para>
- <varname>transfers-out</varname>
- defines the maximum number of outgoing zone transfers
- that can run concurrently. The default is 10.
- </para>
-->
<!-- TODO: formating -->
@@ -107,11 +102,14 @@
</para>
<para>
<command>notify</command> (sent by
- <command>b10-auth</command>) tells <command>b10-zonemgr</command>
+ <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
+ tells <command>b10-zonemgr</command>
the zone name and class, and the IP address for the master
(source of the NOTIFY message).
This will set the zone's refresh time to now.
<!-- TODO reword this -->
+ This is an internal command and not exposed to the administrator.
+<!-- not defined in spec -->
</para>
<para>
@@ -121,19 +119,23 @@
<para>
<command>zone_new_data_ready</command> is sent from
- <command>b10-xfrin</command> to indicate that the zone transferred
- in successfully.
+ <citerefentry><refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ to indicate that the zone transferred in successfully.
+ This is an internal command and not exposed to the administrator.
+<!-- not defined in spec -->
</para>
<para>
<command>zone_xfrin_failed</command> is sent from
- <command>b10-xfrin</command> to indicate a failure
- (such as transfer-in was incomplete).
+ <citerefentry><refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ to indicate a failure (such as a transfer-in was incomplete).
The refresh timer for the zone is reset.
<!--
"""Set zone next refresh time after zone refresh fail.
now + retry*3/4 <= next_refresh_time <= now + retry
-->
+ This is an internal command and not exposed to the administrator.
+<!-- not defined in spec -->
</para>
</refsect1>
More information about the bind10-changes
mailing list