[svn] commit: r2951 - in /trunk: ./ ChangeLog doc/guide/bind10-guide.xml src/bin/auth/b10-auth.xml src/bin/bind10/bind10.xml src/bin/xfrin/b10-xfrin.xml src/bin/xfrout/b10-xfrout.xml src/bin/zonemgr/Makefile.am src/bin/zonemgr/b10-zonemgr.xml
BIND 10 source code commits
bind10-changes at lists.isc.org
Thu Sep 16 20:29:13 UTC 2010
Author: jreed
Date: Thu Sep 16 20:29:13 2010
New Revision: 2951
Log:
For Trac ticket #341
Begin to document zonemgr secondary manager.
Not complete and needs more review.
Note this includes a various minor cleanup in these documents too.
I will generate the docs and commit them next.
Added:
trunk/src/bin/zonemgr/b10-zonemgr.xml
- copied unchanged from r2950, branches/trac341/src/bin/zonemgr/b10-zonemgr.xml
Modified:
trunk/ (props changed)
trunk/ChangeLog
trunk/doc/guide/bind10-guide.xml
trunk/src/bin/auth/b10-auth.xml
trunk/src/bin/bind10/bind10.xml
trunk/src/bin/xfrin/b10-xfrin.xml
trunk/src/bin/xfrout/b10-xfrout.xml
trunk/src/bin/zonemgr/Makefile.am
Modified: trunk/ChangeLog
==============================================================================
--- trunk/ChangeLog (original)
+++ trunk/ChangeLog Thu Sep 16 20:29:13 2010
@@ -1,3 +1,7 @@
+ 95. [doc] jreed
+ Add b10-zonemgr manual page. Update other docs to introduce
+ this secondary manager. (Trac #341, svn r2951)
+
95. [bug] jreed
bin/xfrout and bin/zonemgr: Fixed some stderr output.
(Trac #342, svn r2949)
Modified: trunk/doc/guide/bind10-guide.xml
==============================================================================
--- trunk/doc/guide/bind10-guide.xml (original)
+++ trunk/doc/guide/bind10-guide.xml Thu Sep 16 20:29:13 2010
@@ -42,7 +42,7 @@
<note>
<para>
- BIND 10, at this time, does not provide an recursive
+ BIND 10, at this time, does not provide a recursive
DNS server. It does provide a EDNS0- and DNSSEC-capable
authoritative DNS server.
</para>
@@ -74,9 +74,9 @@
For this development prototype release, the only supported
data source backend is SQLite3. The authoritative server
requires SQLite 3.3.9 or newer.
- The <command>b10-xfrin</command> and <command>b10-xfrout</command>
- modules require the libpython3 library and the Python
- _sqlite3.so module.
+ The <command>b10-xfrin</command>, <command>b10-xfrout</command>,
+ and <command>b10-zonemgr</command> modules require the
+ libpython3 library and the Python _sqlite3.so module.
</para></note>
<!-- TODO: this will change ... -->
@@ -165,6 +165,15 @@
</simpara>
</listitem>
+ <listitem>
+ <simpara>
+ <command>b10-zonemgr</command> —
+ Secondary manager.
+ This process keeps track of timers and other
+ necessary information for BIND 10 to act as a slave server.
+ </simpara>
+ </listitem>
+
</itemizedlist>
</para>
@@ -650,8 +659,9 @@
The <command>bind10</command> master process will also start up
<command>b10-cmdctl</command> for admins to communicate with the
system, <command>b10-auth</command> for Authoritative DNS service,
- <command>b10-xfrin</command> for inbound DNS zone transfers.
- and <command>b10-xfrout</command> for outbound DNS zone transfers.
+ <command>b10-xfrin</command> for inbound DNS zone transfers,
+ <command>b10-xfrout</command> for outbound DNS zone transfers,
+ and <command>b10-zonemgr</command> for secondary service.
</para>
<section id="start">
@@ -1173,14 +1183,14 @@
transfer. When received, it is stored in the BIND 10
data store, and its records can be served by
<command>b10-auth</command>.
- This allows the BIND 10 server to provide
- <quote>secondary</quote> service.
+ In combination with <command>b10-zonemgr</command> (for
+ automated SOA checks), this allows the BIND 10 server to
+ provide <quote>secondary</quote> service.
</para>
<note><simpara>
The current development release of BIND 10 only supports
AXFR. (IXFR is not supported.)
- It also does not yet support automated SOA checks.
</simpara></note>
<para>
@@ -1204,12 +1214,13 @@
sends the zone.
This is used to provide master DNS service to share zones
to secondary name servers.
+ The <command>b10-xfrout</command> is also used to send
+ NOTIFY messages to slaves.
</para>
<note><simpara>
The current development release of BIND 10 only supports
AXFR. (IXFR is not supported.)
- It also does not yet support NOTIFY.
Access control is not yet provided.
</simpara></note>
@@ -1226,6 +1237,31 @@
</chapter>
+ <chapter id="zonemgr">
+ <title>Secondary Manager</title>
+
+ <para>
+ The <command>b10-zonemgr</command> process is started by
+ <command>bind10</command>.
+ It keeps track of SOA refresh, retry, and expire timers
+ and other details for BIND 10 to perform as a slave.
+ When the <command>b10-auth</command> authoritative DNS server
+ receives a NOTIFY message, <command>b10-zonemgr</command>
+ may tell <command>b10-xfrin</command> to do a refresh
+ to start an inbound zone transfer.
+ The secondary manager resets its counters when a new zone is
+ transferred in.
+ </para>
+
+ <note><simpara>
+ Access control (such as allowing notifies) is not yet provided.
+ The primary/secondary service is not yet complete.
+ </simpara></note>
+
+<!-- TODO: lots to describe for zonemgr -->
+
+ </chapter>
+
<!-- TODO: how to help: run unit tests, join lists, review trac tickets -->
<!-- <index> <title>Index</title> </index> -->
Modified: trunk/src/bin/auth/b10-auth.xml
==============================================================================
--- trunk/src/bin/auth/b10-auth.xml (original)
+++ trunk/src/bin/auth/b10-auth.xml Thu Sep 16 20:29:13 2010
@@ -201,6 +201,9 @@
<refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
+ <refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
<refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>BIND 10 Guide</citetitle>.
Modified: trunk/src/bin/bind10/bind10.xml
==============================================================================
--- trunk/src/bin/bind10/bind10.xml (original)
+++ trunk/src/bin/bind10/bind10.xml Thu Sep 16 20:29:13 2010
@@ -189,6 +189,12 @@
<citerefentry>
<refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
+ <citerefentry>
+ <refentrytitle>b10-xfrout</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
<citetitle>BIND 10 Guide</citetitle>.
</para>
</refsect1>
Modified: trunk/src/bin/xfrin/b10-xfrin.xml
==============================================================================
--- trunk/src/bin/xfrin/b10-xfrin.xml (original)
+++ trunk/src/bin/xfrin/b10-xfrin.xml Thu Sep 16 20:29:13 2010
@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
- <date>March 17, 2010</date>
+ <date>September 8, 2010</date>
</refentryinfo>
<refmeta>
@@ -68,7 +68,6 @@
</simpara></note>
<para>
-<!-- TODO: does it really use msgq? what for? -->
This daemon communicates with BIND 10 over a
<citerefentry><refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum></citerefentry>
C-Channel connection. If this connection is not established,
@@ -85,39 +84,82 @@
<refsect1>
<title>CONFIGURATION AND COMMANDS</title>
<para>
- The configurable setting is <varname>transfers-in</varname>
- which defines the maximum number of inbound zone transfers
+ The configurable settings are:
+ </para>
+
+ <para><varname>master_addr</varname>
+<!-- TODO: how can there be a single setting for this? -->
+ The default is 127.0.0.1.
+ </para>
+
+ <para><varname>master_port</varname>
+<!-- TODO: what if custom is needed per zone? -->
+ The default is 53.
+ </para>
+
+ <para><varname>transfers-in</varname>
+ defines the maximum number of inbound zone transfers
that can run concurrently. The default is 10.
</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> 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,
+ <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? -->
+
<para>
<command>shutdown</command> stops all incoming zone transfers
and exits <command>b10-xfrin</command>. (Note that the BIND 10
boss process will restart this service.)
</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.
- </para>
-<!-- TODO: later hostname for master? -->
-
<!-- TODO:
add a usage example of xfrin -->
-
-<!-- TODO:
-
-port (defaults to 53)
-db_file (defaults to zone.sqlite3) --> <!-- TODO: fix this -->
<!-- TODO:
@@ -182,6 +224,9 @@
<refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
+ <refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
<refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>BIND 10 Guide</citetitle>.
Modified: trunk/src/bin/xfrout/b10-xfrout.xml
==============================================================================
--- trunk/src/bin/xfrout/b10-xfrout.xml (original)
+++ trunk/src/bin/xfrout/b10-xfrout.xml Thu Sep 16 20:29:13 2010
@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
- <date>April 20, 2010</date>
+ <date>September 8, 2010</date>
</refentryinfo>
<refmeta>
@@ -54,6 +54,7 @@
<title>DESCRIPTION</title>
<para>The <command>b10-xfrout</command> daemon provides the BIND 10
outgoing DNS zone transfer service.
+ It is 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.
@@ -112,12 +117,22 @@
<!-- TODO: formating -->
<para>
- The configuration command is:
+ The configuration commands are:
</para>
<para>
<command>shutdown</command> stops all outbound zone transfers
and exits <command>b10-xfrout</command>. (Note that the BIND 10
boss process will restart this service.)
+ </para>
+
+ <para>
+ <command>zone_new_data_ready</command> is sent from
+ <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>
@@ -161,6 +176,9 @@
<refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
+ <refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
<refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>BIND 10 Guide</citetitle>.
@@ -170,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: trunk/src/bin/zonemgr/Makefile.am
==============================================================================
--- trunk/src/bin/zonemgr/Makefile.am (original)
+++ trunk/src/bin/zonemgr/Makefile.am Thu Sep 16 20:29:13 2010
@@ -9,6 +9,16 @@
CLEANFILES = b10-zonemgr zonemgr.pyc zonemgr.spec
+man_MANS = b10-zonemgr.8
+EXTRA_DIST = $(man_MANS) b10-zonemgr.xml
+
+if ENABLE_MAN
+
+b10-zonemgr.8: b10-zonemgr.xml
+ xsltproc --novalid --xinclude --nonet -o $@ http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $(srcdir)/b10-zonemgr.xml
+
+endif
+
zonemgr.spec: zonemgr.spec.pre
$(SED) -e "s|@@LOCALSTATEDIR@@|$(localstatedir)|" zonemgr.spec.pre >$@
More information about the bind10-changes
mailing list