Commit e512e21d authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

Initial zonemgr and related docs (done over a week ago).


git-svn-id: svn://bind10.isc.org/svn/bind10/branches/trac341@2937 e5f2f494-b856-4b98-b285-d166d9295462
parent 1021cc01
......@@ -200,6 +200,9 @@
<citerefentry>
<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>,
......
......@@ -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>
......
......@@ -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,8 +84,21 @@
<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>
......@@ -96,11 +108,22 @@
<para>
The configuration commands are:
</para>
<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.)
<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>
</para>
<para>
<command>retransfer</command> triggers the transfer in for
a single zone without checking the zone's serial number.
......@@ -111,6 +134,11 @@
</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>
<!-- TODO:
add a usage example of xfrin -->
......@@ -181,6 +209,9 @@ operation
<citerefentry>
<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>,
......
......@@ -21,7 +21,7 @@
<refentry>
<refentryinfo>
<date>April 20, 2010</date>
<date>September 8, 2010</date>
</refentryinfo>
<refmeta>
......@@ -112,7 +112,7 @@
<!-- TODO: formating -->
<para>
The configuration command is:
The configuration commands are:
</para>
<para>
<command>shutdown</command> stops all outbound zone transfers
......@@ -120,6 +120,15 @@
boss process will restart this service.)
</para>
<para>
<command>zone_new_data_ready</command> is sent from
<command>b10-xfrin</command> to indicate that the zone transferred
in successfully.
This triggers <command>b10-xfrout</command> to send NOTIFY
message(s).
</para>
</refsect1>
<!--
......@@ -160,6 +169,9 @@
<citerefentry>
<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>,
......
......@@ -9,6 +9,16 @@ b10_zonemgr_DATA = zonemgr.spec
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 >$@
......
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]>
<!--
- Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
- OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
-->
<!-- $Id$ -->
<refentry>
<refentryinfo>
<date>September 8, 2010</date>
</refentryinfo>
<refmeta>
<refentrytitle>b10-zonemgr</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo>BIND10</refmiscinfo>
</refmeta>
<refnamediv>
<refname>b10-zonemgr</refname>
<refpurpose>BIND 10 Secondary zone manager</refpurpose>
</refnamediv>
<docinfo>
<copyright>
<year>2010</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
<refsynopsisdiv>
<cmdsynopsis>
<command>b10-zonemgr</command>
<arg><option>-v</option></arg>
<arg><option>--verbose</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>b10-zonemgr</command> daemon, also known
as the BIND 10 secondary manager, keeps track of timers
and other information necessary for BIND 10 to act as a DNS slave.
Normally it is started by the
<citerefentry><refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum></citerefentry>
boss process.
</para>
<para>
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,
<command>b10-zonemgr</command> will exit.
<!-- TODO what if connection closes later, will b10-zonemgr exit? -->
</para>
<para>
<command>b10-zonemgr</command> receives its configurations from
<citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
<!--
self._send_command(XFRIN_MODULE_NAME, ZONE_NOTIFY_COMMAND, param)
self._clear_zone_notifier_master(zone_name_class)
# Send refresh command to xfrin module
else:
param = {"zone_name" : zone_name_class[0],
"zone_class" : zone_name_class[1]
}
self._send_command(XFRIN_MODULE_NAME, ZONE_REFRESH_COMMAND, param)
-->
</refsect1>
<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 -->
<para>
The configuration commands are:
</para>
<para>
<command>notify</command> (sent by
<command>b10-auth</command>) 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 -->
</para>
<para>
<command>shutdown</command> exits <command>b10-zonemgr</command>.
(Note that the BIND 10 boss process will restart this service.)
</para>
<para>
<command>zone_new_data_ready</command> is sent from
<command>b10-xfrin</command> to indicate that the zone transferred
in successfully.
</para>
<para>
<command>zone_xfrin_failed</command> is sent from
<command>b10-xfrin</command> to indicate a failure
(such as 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
-->
</para>
</refsect1>
<!--
<refsect1>
<title>OPTIONS</title>
<para>The arguments are as follows:</para>
<variablelist>
<varlistentry>
<term><option></option></term>
<listitem><para>
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
-->
<!--
<refsect1>
<title>FILES</title>
<para>
<filename>/tmp/auth_xfrout_conn</filename>
</para>
</refsect1>
-->
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>b10-xfrout</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>bind10</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citetitle>BIND 10 Guide</citetitle>.
</para>
</refsect1>
<refsect1>
<title>HISTORY</title>
<para>
The <command>b10-zonemgr</command> daemon was designed in July 2010
by CNNIC for the ISC BIND 10 project.
</para>
</refsect1>
</refentry><!--
- Local variables:
- mode: sgml
- End:
-->
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment