BIND 10 master, updated. b0b09a77b7dab7b961f4424d05c135e9eb045b80 [master] regenerated HTML version of guide
BIND 10 source code commits
bind10-changes at lists.isc.org
Thu Oct 13 14:14:43 UTC 2011
The branch, master has been updated
via b0b09a77b7dab7b961f4424d05c135e9eb045b80 (commit)
via d1897d34676045b89edc09a767f8d0ab14d662c9 (commit)
via acb0565bb4ddaf1d51abc511459478e738dff6d7 (commit)
via 99aa9fc05044158e0f41e56da538bd1162d869e2 (commit)
from e2c88f03e394ed8ebcfcff936ee888bf593e22d1 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit b0b09a77b7dab7b961f4424d05c135e9eb045b80
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Thu Oct 13 09:14:15 2011 -0500
[master] regenerated HTML version of guide
mostly catching up on IXFR documentation additions.
commit d1897d34676045b89edc09a767f8d0ab14d662c9
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Thu Oct 13 09:12:40 2011 -0500
[master] add the rendered text file of bind10-guide.txt
As asked at ISC All Hands.
We can later discuss if we don't want rendered documents in repo.
commit acb0565bb4ddaf1d51abc511459478e738dff6d7
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Thu Oct 13 09:10:35 2011 -0500
[master] build a text version of the guide
This was brought up at ISC All-Hands.
This will be included in the tarball.
For now this will be included in the repo too
(a different commit will add it).
I am using elinks for now. Note for now nothing in make forces it
to be rebuilt, so no tool is needed for this.
commit 99aa9fc05044158e0f41e56da538bd1162d869e2
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Thu Oct 13 09:09:58 2011 -0500
[master] mention other guide formats are available on website
-----------------------------------------------------------------------
Summary of changes:
doc/guide/Makefile.am | 7 +-
doc/guide/bind10-guide.html | 141 ++++--
doc/guide/bind10-guide.txt | 1201 +++++++++++++++++++++++++++++++++++++++++++
doc/guide/bind10-guide.xml | 7 +-
4 files changed, 1303 insertions(+), 53 deletions(-)
create mode 100644 doc/guide/bind10-guide.txt
-----------------------------------------------------------------------
diff --git a/doc/guide/Makefile.am b/doc/guide/Makefile.am
index c84ad06..aaf8960 100644
--- a/doc/guide/Makefile.am
+++ b/doc/guide/Makefile.am
@@ -1,7 +1,12 @@
EXTRA_DIST = bind10-guide.css
-EXTRA_DIST += bind10-guide.xml bind10-guide.html
+EXTRA_DIST += bind10-guide.xml bind10-guide.html bind10-guide.txt
EXTRA_DIST += bind10-messages.xml bind10-messages.html
+HTML2TXT ?= elinks -dump -no-numbering -no-references
+
+bind10-guide.txt: bind10-guide.html
+ $(HTML2TXT) $(srcdir)/bind10-guide.html > $@
+
# This is not a "man" manual, but reuse this for now for docbook.
if ENABLE_MAN
diff --git a/doc/guide/bind10-guide.html b/doc/guide/bind10-guide.html
index 1070a2e..97ffb84 100644
--- a/doc/guide/bind10-guide.html
+++ b/doc/guide/bind10-guide.html
@@ -1,12 +1,14 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>BIND 10 Guide</title><link rel="stylesheet" href="./bind10-guide.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><meta name="description" content="BIND 10 is a Domain Name System (DNS) suite managed by Internet Systems Consortium (ISC). It includes DNS libraries and modular components for controlling authoritative and recursive DNS servers. This is the reference guide for BIND 10 version 20110809. The most up-to-date version of this document, along with other documents for BIND 10, can be found at ."></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="BIND 10 Guide"><div class="titlepage"><div><div><h1 class="title"><a name="id1168229460045"></a>BIND 10 Guide</h1></div><div><h2 class="subtitle">Administrator Reference for BIND 10</h2></div><div><p class="releaseinfo">This is the referenc
e guide for BIND 10 version
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>BIND 10 Guide</title><link rel="stylesheet" href="./bind10-guide.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><meta name="description" content="BIND 10 is a Domain Name System (DNS) suite managed by Internet Systems Consortium (ISC). It includes DNS libraries and modular components for controlling authoritative and recursive DNS servers. This is the reference guide for BIND 10 version 20110809. The most up-to-date version of this document (in PDF, HTML, and plain text formats), along with other documents for BIND 10, can be found at ."></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="BIND 10 Guide"><div class="titlepage"><div><div><h1 class="title"><a name="id1168229451102"></a>BIND 10 Guide</h1></div><div><h2 class="subtitle">Administrator Reference for BIND 10</h2></div><div><p c
lass="releaseinfo">This is the reference guide for BIND 10 version
20110809.</p></div><div><p class="copyright">Copyright © 2010-2011 Internet Systems Consortium, Inc.</p></div><div><div class="abstract" title="Abstract"><p class="title"><b>Abstract</b></p><p>BIND 10 is a Domain Name System (DNS) suite managed by
Internet Systems Consortium (ISC). It includes DNS libraries
and modular components for controlling authoritative and
recursive DNS servers.
</p><p>
This is the reference guide for BIND 10 version 20110809.
- The most up-to-date version of this document, along with
- other documents for BIND 10, can be found at <a class="ulink" href="http://bind10.isc.org/docs" target="_top">http://bind10.isc.org/docs</a>. </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229460181">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168229460208">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#installation">2. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229445988">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">In
stallation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229446178">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168229446197">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168229446258">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168229446356">Build</a></span></dt><dt><span class="section"><a href="#id1168229446371">Install</a></span></dt><dt><span class="section"><a href="#id1168229446394">Install Hierarchy</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#bind10">3. Starting BIND10 with <span class="command"><strong>bind10</strong></span></a></span></dt><dd><dl><dt><span class="section"><a href="#start">Starting BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#msgq">4. Command channel</a></span></dt><dt><span class="chapter"><a href="#cfgmgr">5. Configuration manager</a></span></dt><dt><span class="chapter"><a hr
ef="#cmdctl">6. Remote control daemon</a></span></dt><dd><dl><dt><span class="section"><a href="#cmdctl.spec">Configuration specification for b10-cmdctl</a></span></dt></dl></dd><dt><span class="chapter"><a href="#bindctl">7. Control and configure user interface</a></span></dt><dt><span class="chapter"><a href="#authserver">8. Authoritative Server</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229446979">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168229447044">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168229447074">Loading Master Zones Files</a></span></dt></dl></dd><dt><span class="chapter"><a href="#xfrin">9. Incoming Zone Transfers</a></span></dt><dt><span class="chapter"><a href="#xfrout">10. Outbound Zone Transfers</a></span></dt><dt><span class="chapter"><a href="#zonemgr">11. Secondary Manager</a></span></dt><dt><span class="chapter"><a href="#resolverserver">12. Recursive Name Server<
/a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229447556">Access Control</a></span></dt><dt><span class="section"><a href="#id1168229447671">Forwarding</a></span></dt></dl></dd><dt><span class="chapter"><a href="#statistics">13. Statistics</a></span></dt><dt><span class="chapter"><a href="#logging">14. Logging</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229447788">Logging configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229447799">Loggers</a></span></dt><dt><span class="section"><a href="#id1168229448040">Output Options</a></span></dt><dt><span class="section"><a href="#id1168229448215">Example session</a></span></dt></dl></dd><dt><span class="section"><a href="#id1168229448428">Logging Message Format</a></span></dt></dl></dd></dl></div><div class="chapter" title="Chapter 1. Introduction"><div class="titlepage"><div><div><h2 class="title"><a name="intro"></a>Chapter 1. Introduction</h2></div></div></div><di
v class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229460181">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168229460208">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></div><p>
+ The most up-to-date version of this document (in PDF, HTML,
+ and plain text formats), along with other documents for
+ BIND 10, can be found at <a class="ulink" href="http://bind10.isc.org/docs" target="_top">http://bind10.isc.org/docs</a>.
+ </p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229451238">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168229451265">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#installation">2. Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229436567">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229436859">Download Tar File</a></span></dt><dt><span c
lass="section"><a href="#id1168229436878">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168229436939">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168229437037">Build</a></span></dt><dt><span class="section"><a href="#id1168229437052">Install</a></span></dt><dt><span class="section"><a href="#id1168229437076">Install Hierarchy</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#bind10">3. Starting BIND10 with <span class="command"><strong>bind10</strong></span></a></span></dt><dd><dl><dt><span class="section"><a href="#start">Starting BIND 10</a></span></dt></dl></dd><dt><span class="chapter"><a href="#msgq">4. Command channel</a></span></dt><dt><span class="chapter"><a href="#cfgmgr">5. Configuration manager</a></span></dt><dt><span class="chapter"><a href="#cmdctl">6. Remote control daemon</a></span></dt><dd><dl><dt><span class="section"><a href="#cmdctl.spec">Configuration specification for b
10-cmdctl</a></span></dt></dl></dd><dt><span class="chapter"><a href="#bindctl">7. Control and configure user interface</a></span></dt><dt><span class="chapter"><a href="#authserver">8. Authoritative Server</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229437660">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168229437725">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168229437755">Loading Master Zones Files</a></span></dt></dl></dd><dt><span class="chapter"><a href="#xfrin">9. Incoming Zone Transfers</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229437989">Configuration for Incoming Zone Transfers</a></span></dt><dt><span class="section"><a href="#id1168229438027">Enabling IXFR</a></span></dt><dt><span class="section"><a href="#id1168229438069">Trigger an Incoming Zone Transfer Manually</a></span></dt></dl></dd><dt><span class="chapter"><a href="#xfrout">10. Outbound Zone Transfe
rs</a></span></dt><dt><span class="chapter"><a href="#zonemgr">11. Secondary Manager</a></span></dt><dt><span class="chapter"><a href="#resolverserver">12. Recursive Name Server</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229438327">Access Control</a></span></dt><dt><span class="section"><a href="#id1168229438512">Forwarding</a></span></dt></dl></dd><dt><span class="chapter"><a href="#statistics">13. Statistics</a></span></dt><dt><span class="chapter"><a href="#logging">14. Logging</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229438628">Logging configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229438638">Loggers</a></span></dt><dt><span class="section"><a href="#id1168229439154">Output Options</a></span></dt><dt><span class="section"><a href="#id1168229439328">Example session</a></span></dt></dl></dd><dt><span class="section"><a href="#id1168229439609">Logging Message Format</a></span></dt></dl></dd></dl><
/div><div class="chapter" title="Chapter 1. Introduction"><div class="titlepage"><div><div><h2 class="title"><a name="intro"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229451238">Supported Platforms</a></span></dt><dt><span class="section"><a href="#id1168229451265">Required Software</a></span></dt><dt><span class="section"><a href="#starting_stopping">Starting and Stopping the Server</a></span></dt><dt><span class="section"><a href="#managing_once_running">Managing BIND 10</a></span></dt></dl></div><p>
BIND is the popular implementation of a DNS server, developer
interfaces, and DNS tools.
BIND 10 is a rewrite of BIND 9. BIND 10 is written in C++ and Python
@@ -18,7 +20,7 @@
BIND 10 provides a EDNS0- and DNSSEC-capable
authoritative DNS server and a caching recursive name server
which also provides forwarding.
- </p></div><div class="section" title="Supported Platforms"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229460181"></a>Supported Platforms</h2></div></div></div><p>
+ </p></div><div class="section" title="Supported Platforms"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229451238"></a>Supported Platforms</h2></div></div></div><p>
BIND 10 builds have been tested on Debian GNU/Linux 5,
Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7 and 8, and CentOS
Linux 5.3.
@@ -28,7 +30,7 @@
It is planned for BIND 10 to build, install and run on
Windows and standard Unix-type platforms.
- </p></div><div class="section" title="Required Software"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229460208"></a>Required Software</h2></div></div></div><p>
+ </p></div><div class="section" title="Required Software"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229451265"></a>Required Software</h2></div></div></div><p>
BIND 10 requires Python 3.1. Later versions may work, but Python
3.1 is the minimum version which will work.
</p><p>
@@ -138,7 +140,7 @@
and, of course, DNS. These include detailed developer
documentation and code examples.
- </p></div><div class="chapter" title="Chapter 2. Installation"><div class="titlepage"><div><div><h2 class="title"><a name="installation"></a>Chapter 2. Installation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229445988">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229446178">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168229446197">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168229446258">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168229446356">Build</a></span></dt><dt><span class="section"><a href="#id1168229446371">Install</a></span></dt><dt><span class="section"><a href="#id1168229446394">Install Hierarchy<
/a></span></dt></dl></dd></dl></div><div class="section" title="Building Requirements"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229445988"></a>Building Requirements</h2></div></div></div><p>
+ </p></div><div class="chapter" title="Chapter 2. Installation"><div class="titlepage"><div><div><h2 class="title"><a name="installation"></a>Chapter 2. Installation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229436567">Building Requirements</a></span></dt><dt><span class="section"><a href="#quickstart">Quick start</a></span></dt><dt><span class="section"><a href="#install">Installation from source</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229436859">Download Tar File</a></span></dt><dt><span class="section"><a href="#id1168229436878">Retrieve from Git</a></span></dt><dt><span class="section"><a href="#id1168229436939">Configure before the build</a></span></dt><dt><span class="section"><a href="#id1168229437037">Build</a></span></dt><dt><span class="section"><a href="#id1168229437052">Install</a></span></dt><dt><span class="section"><a href="#id1168229437076">Install Hierarchy<
/a></span></dt></dl></dd></dl></div><div class="section" title="Building Requirements"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229436567"></a>Building Requirements</h2></div></div></div><p>
In addition to the run-time requirements, building BIND 10
from source code requires various development include headers.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
@@ -202,14 +204,14 @@
the Git code revision control system or as a downloadable
tar file. It may also be available in pre-compiled ready-to-use
packages from operating system vendors.
- </p><div class="section" title="Download Tar File"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229446178"></a>Download Tar File</h3></div></div></div><p>
+ </p><div class="section" title="Download Tar File"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229436859"></a>Download Tar File</h3></div></div></div><p>
Downloading a release tar file is the recommended method to
obtain the source code.
</p><p>
The BIND 10 releases are available as tar file downloads from
<a class="ulink" href="ftp://ftp.isc.org/isc/bind10/" target="_top">ftp://ftp.isc.org/isc/bind10/</a>.
Periodic development snapshots may also be available.
- </p></div><div class="section" title="Retrieve from Git"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229446197"></a>Retrieve from Git</h3></div></div></div><p>
+ </p></div><div class="section" title="Retrieve from Git"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229436878"></a>Retrieve from Git</h3></div></div></div><p>
Downloading this "bleeding edge" code is recommended only for
developers or advanced users. Using development code in a production
environment is not recommended.
@@ -243,7 +245,7 @@
<span class="command"><strong>autoheader</strong></span>,
<span class="command"><strong>automake</strong></span>,
and related commands.
- </p></div><div class="section" title="Configure before the build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229446258"></a>Configure before the build</h3></div></div></div><p>
+ </p></div><div class="section" title="Configure before the build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229436939"></a>Configure before the build</h3></div></div></div><p>
BIND 10 uses the GNU Build System to discover build environment
details.
To generate the makefiles using the defaults, simply run:
@@ -274,16 +276,16 @@
</p><p>
If the configure fails, it may be due to missing or old
dependencies.
- </p></div><div class="section" title="Build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229446356"></a>Build</h3></div></div></div><p>
+ </p></div><div class="section" title="Build"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229437037"></a>Build</h3></div></div></div><p>
After the configure step is complete, to build the executables
from the C++ code and prepare the Python scripts, run:
</p><pre class="screen">$ <strong class="userinput"><code>make</code></strong></pre><p>
- </p></div><div class="section" title="Install"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229446371"></a>Install</h3></div></div></div><p>
+ </p></div><div class="section" title="Install"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229437052"></a>Install</h3></div></div></div><p>
To install the BIND 10 executables, support files,
and documentation, run:
</p><pre class="screen">$ <strong class="userinput"><code>make install</code></strong></pre><p>
- </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The install step may require superuser privileges.</p></div></div><div class="section" title="Install Hierarchy"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229446394"></a>Install Hierarchy</h3></div></div></div><p>
+ </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>The install step may require superuser privileges.</p></div></div><div class="section" title="Install Hierarchy"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229437076"></a>Install Hierarchy</h3></div></div></div><p>
The following is the layout of the complete BIND 10 installation:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<code class="filename">bin/</code> —
@@ -505,12 +507,12 @@ shutdown
the details and relays (over a <span class="command"><strong>b10-msgq</strong></span> command
channel) the configuration on to the specified module.
</p><p>
- </p></div><div class="chapter" title="Chapter 8. Authoritative Server"><div class="titlepage"><div><div><h2 class="title"><a name="authserver"></a>Chapter 8. Authoritative Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229446979">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168229447044">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168229447074">Loading Master Zones Files</a></span></dt></dl></div><p>
+ </p></div><div class="chapter" title="Chapter 8. Authoritative Server"><div class="titlepage"><div><div><h2 class="title"><a name="authserver"></a>Chapter 8. Authoritative Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229437660">Server Configurations</a></span></dt><dt><span class="section"><a href="#id1168229437725">Data Source Backends</a></span></dt><dt><span class="section"><a href="#id1168229437755">Loading Master Zones Files</a></span></dt></dl></div><p>
The <span class="command"><strong>b10-auth</strong></span> is the authoritative DNS server.
It supports EDNS0 and DNSSEC. It supports IPv6.
Normally it is started by the <span class="command"><strong>bind10</strong></span> master
process.
- </p><div class="section" title="Server Configurations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229446979"></a>Server Configurations</h2></div></div></div><p>
+ </p><div class="section" title="Server Configurations"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229437660"></a>Server Configurations</h2></div></div></div><p>
<span class="command"><strong>b10-auth</strong></span> is configured via the
<span class="command"><strong>b10-cfgmgr</strong></span> configuration manager.
The module name is <span class="quote">“<span class="quote">Auth</span>”</span>.
@@ -530,7 +532,7 @@ This may be a temporary setting until then.
</p><div class="variablelist"><dl><dt><span class="term">shutdown</span></dt><dd>Stop the authoritative DNS server.
</dd></dl></div><p>
- </p></div><div class="section" title="Data Source Backends"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229447044"></a>Data Source Backends</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ </p></div><div class="section" title="Data Source Backends"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229437725"></a>Data Source Backends</h2></div></div></div><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
For the development prototype release, <span class="command"><strong>b10-auth</strong></span>
supports a SQLite3 data source backend and in-memory data source
backend.
@@ -544,7 +546,7 @@ This may be a temporary setting until then.
The default is <code class="filename">/usr/local/var/</code>.)
This data file location may be changed by defining the
<span class="quote">“<span class="quote">database_file</span>”</span> configuration.
- </p></div><div class="section" title="Loading Master Zones Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229447074"></a>Loading Master Zones Files</h2></div></div></div><p>
+ </p></div><div class="section" title="Loading Master Zones Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229437755"></a>Loading Master Zones Files</h2></div></div></div><p>
RFC 1035 style DNS master zone files may imported
into a BIND 10 data source by using the
<span class="command"><strong>b10-loadzone</strong></span> utility.
@@ -573,28 +575,69 @@ This may be a temporary setting until then.
If you reload a zone already existing in the database,
all records from that prior zone disappear and a whole new set
appears.
- </p></div></div><div class="chapter" title="Chapter 9. Incoming Zone Transfers"><div class="titlepage"><div><div><h2 class="title"><a name="xfrin"></a>Chapter 9. Incoming Zone Transfers</h2></div></div></div><p>
+ </p></div></div><div class="chapter" title="Chapter 9. Incoming Zone Transfers"><div class="titlepage"><div><div><h2 class="title"><a name="xfrin"></a>Chapter 9. Incoming Zone Transfers</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229437989">Configuration for Incoming Zone Transfers</a></span></dt><dt><span class="section"><a href="#id1168229438027">Enabling IXFR</a></span></dt><dt><span class="section"><a href="#id1168229438069">Trigger an Incoming Zone Transfer Manually</a></span></dt></dl></div><p>
Incoming zones are transferred using the <span class="command"><strong>b10-xfrin</strong></span>
process which is started by <span class="command"><strong>bind10</strong></span>.
- When received, the zone is stored in the BIND 10
- data store, and its records can be served by
+ When received, the zone is stored in the corresponding BIND 10
+ data source, and its records can be served by
<span class="command"><strong>b10-auth</strong></span>.
In combination with <span class="command"><strong>b10-zonemgr</strong></span> (for
automated SOA checks), this allows the BIND 10 server to
provide <span class="quote">“<span class="quote">secondary</span>”</span> service.
+ </p><p>
+ The <span class="command"><strong>b10-xfrin</strong></span> process supports both AXFR and
+ IXFR. Due to some implementation limitations of the current
+ development release, however, it only tries AXFR by default,
+ and care should be taken to enable IXFR.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
- The current development release of BIND 10 only supports
- AXFR. (IXFR is not supported.)
-
-
-
- </p></div><p>
- To manually trigger a zone transfer to retrieve a remote zone,
- you may use the <span class="command"><strong>bindctl</strong></span> utility.
- For example, at the <span class="command"><strong>bindctl</strong></span> prompt run:
-
- </p><pre class="screen">> <strong class="userinput"><code>Xfrin retransfer zone_name="<code class="option">foo.example.org</code>" master=<code class="option">192.0.2.99</code></code></strong></pre><p>
- </p></div><div class="chapter" title="Chapter 10. Outbound Zone Transfers"><div class="titlepage"><div><div><h2 class="title"><a name="xfrout"></a>Chapter 10. Outbound Zone Transfers</h2></div></div></div><p>
+ In the current development release of BIND 10, incoming zone
+ transfers are only available for SQLite3-based data sources,
+ that is, they don't work for an in-memory data source.
+ </p></div><div class="section" title="Configuration for Incoming Zone Transfers"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229437989"></a>Configuration for Incoming Zone Transfers</h2></div></div></div><p>
+ In practice, you need to specify a list of secondary zones to
+ enable incoming zone transfers for these zones (you can still
+ trigger a zone transfer manually, without a prior configuration
+ (see below)).
+ </p><p>
+ For example, to enable zone transfers for a zone named "example.com"
+ (whose master address is assumed to be 2001:db8::53 here),
+ run the following at the <span class="command"><strong>bindctl</strong></span> prompt:
+
+ </p><pre class="screen">> <strong class="userinput"><code>config add Xfrin/zones</code></strong>
+> <strong class="userinput"><code>config set Xfrin/zones[0]/name "<code class="option">example.com</code>"</code></strong>
+> <strong class="userinput"><code>config set Xfrin/zones[0]/master_addr "<code class="option">2001:db8::53</code>"</code></strong>
+> <strong class="userinput"><code>config commit</code></strong></pre><p>
+
+ (We assume there has been no zone configuration before).
+ </p></div><div class="section" title="Enabling IXFR"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438027"></a>Enabling IXFR</h2></div></div></div><p>
+ As noted above, <span class="command"><strong>b10-xfrin</strong></span> uses AXFR for
+ zone transfers by default. To enable IXFR for zone transfers
+ for a particular zone, set the <strong class="userinput"><code>use_ixfr</code></strong>
+ configuration parameter to <strong class="userinput"><code>true</code></strong>.
+ In the above example of configuration sequence, you'll need
+ to add the following before performing <strong class="userinput"><code>commit</code></strong>:
+ </p><pre class="screen">> <strong class="userinput"><code>config set Xfrin/zones[0]/use_ixfr true</code></strong></pre><p>
+ </p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
+ One reason why IXFR is disabled by default in the current
+ release is because it does not support automatic fallback from IXFR to
+ AXFR when it encounters a primary server that doesn't support
+ outbound IXFR (and, not many existing implementations support
+ it). Another, related reason is that it does not use AXFR even
+ if it has no knowledge about the zone (like at the very first
+ time the secondary server is set up). IXFR requires the
+ "current version" of the zone, so obviously it doesn't work
+ in this situation and AXFR is the only workable choice.
+ The current release of <span class="command"><strong>b10-xfrin</strong></span> does not
+ make this selection automatically.
+ These features will be implemented in a near future
+ version, at which point we will enable IXFR by default.
+ </p></div></div><div class="section" title="Trigger an Incoming Zone Transfer Manually"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438069"></a>Trigger an Incoming Zone Transfer Manually</h2></div></div></div><p>
+ To manually trigger a zone transfer to retrieve a remote zone,
+ you may use the <span class="command"><strong>bindctl</strong></span> utility.
+ For example, at the <span class="command"><strong>bindctl</strong></span> prompt run:
+
+ </p><pre class="screen">> <strong class="userinput"><code>Xfrin retransfer zone_name="<code class="option">foo.example.org</code>" master=<code class="option">192.0.2.99</code></code></strong></pre><p>
+ </p></div></div><div class="chapter" title="Chapter 10. Outbound Zone Transfers"><div class="titlepage"><div><div><h2 class="title"><a name="xfrout"></a>Chapter 10. Outbound Zone Transfers</h2></div></div></div><p>
The <span class="command"><strong>b10-xfrout</strong></span> process is started by
<span class="command"><strong>bind10</strong></span>.
When the <span class="command"><strong>b10-auth</strong></span> authoritative DNS server
@@ -622,7 +665,7 @@ This may be a temporary setting until then.
</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
Access control (such as allowing notifies) is not yet provided.
The primary/secondary service is not yet complete.
- </p></div></div><div class="chapter" title="Chapter 12. Recursive Name Server"><div class="titlepage"><div><div><h2 class="title"><a name="resolverserver"></a>Chapter 12. Recursive Name Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229447556">Access Control</a></span></dt><dt><span class="section"><a href="#id1168229447671">Forwarding</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 12. Recursive Name Server"><div class="titlepage"><div><div><h2 class="title"><a name="resolverserver"></a>Chapter 12. Recursive Name Server</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229438327">Access Control</a></span></dt><dt><span class="section"><a href="#id1168229438512">Forwarding</a></span></dt></dl></div><p>
The <span class="command"><strong>b10-resolver</strong></span> process is started by
<span class="command"><strong>bind10</strong></span>.
@@ -656,7 +699,7 @@ This may be a temporary setting until then.
</pre><p>
</p><p>(Replace the <span class="quote">“<span class="quote"><em class="replaceable"><code>2</code></em></span>”</span>
as needed; run <span class="quote">“<span class="quote"><strong class="userinput"><code>config show
- Resolver/listen_on</code></strong></span>”</span> if needed.)</p><div class="section" title="Access Control"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229447556"></a>Access Control</h2></div></div></div><p>
+ Resolver/listen_on</code></strong></span>”</span> if needed.)</p><div class="section" title="Access Control"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438327"></a>Access Control</h2></div></div></div><p>
By default, the <span class="command"><strong>b10-resolver</strong></span> daemon only accepts
DNS queries from the localhost (127.0.0.1 and ::1).
The <code class="option">Resolver/query_acl</code> configuration may
@@ -689,7 +732,7 @@ This may be a temporary setting until then.
</pre><p>(Replace the <span class="quote">“<span class="quote"><em class="replaceable"><code>2</code></em></span>”</span>
as needed; run <span class="quote">“<span class="quote"><strong class="userinput"><code>config show
Resolver/query_acl</code></strong></span>”</span> if needed.)</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This prototype access control configuration
- syntax may be changed.</p></div></div><div class="section" title="Forwarding"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229447671"></a>Forwarding</h2></div></div></div><p>
+ syntax may be changed.</p></div></div><div class="section" title="Forwarding"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438512"></a>Forwarding</h2></div></div></div><p>
To enable forwarding, the upstream address and port must be
configured to forward queries to, such as:
@@ -743,7 +786,7 @@ This may be a temporary setting until then.
}
}
</pre><p>
- </p></div><div class="chapter" title="Chapter 14. Logging"><div class="titlepage"><div><div><h2 class="title"><a name="logging"></a>Chapter 14. Logging</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229447788">Logging configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229447799">Loggers</a></span></dt><dt><span class="section"><a href="#id1168229448040">Output Options</a></span></dt><dt><span class="section"><a href="#id1168229448215">Example session</a></span></dt></dl></dd><dt><span class="section"><a href="#id1168229448428">Logging Message Format</a></span></dt></dl></div><div class="section" title="Logging configuration"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229447788"></a>Logging configuration</h2></div></div></div><p>
+ </p></div><div class="chapter" title="Chapter 14. Logging"><div class="titlepage"><div><div><h2 class="title"><a name="logging"></a>Chapter 14. Logging</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id1168229438628">Logging configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#id1168229438638">Loggers</a></span></dt><dt><span class="section"><a href="#id1168229439154">Output Options</a></span></dt><dt><span class="section"><a href="#id1168229439328">Example session</a></span></dt></dl></dd><dt><span class="section"><a href="#id1168229439609">Logging Message Format</a></span></dt></dl></div><div class="section" title="Logging configuration"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229438628"></a>Logging configuration</h2></div></div></div><p>
The logging system in BIND 10 is configured through the
Logging module. All BIND 10 modules will look at the
@@ -752,7 +795,7 @@ This may be a temporary setting until then.
- </p><div class="section" title="Loggers"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229447799"></a>Loggers</h3></div></div></div><p>
+ </p><div class="section" title="Loggers"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229438638"></a>Loggers</h3></div></div></div><p>
Within BIND 10, a message is logged through a component
called a "logger". Different parts of BIND 10 log messages
@@ -773,7 +816,7 @@ This may be a temporary setting until then.
(what to log), and the <code class="option">output_options</code>
(where to log).
- </p><div class="section" title="name (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229447824"></a>name (string)</h4></div></div></div><p>
+ </p><div class="section" title="name (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229438663"></a>name (string)</h4></div></div></div><p>
Each logger in the system has a name, the name being that
of the component using it to log messages. For instance,
if you want to configure logging for the resolver module,
@@ -846,7 +889,7 @@ This may be a temporary setting until then.
<span class="quote">“<span class="quote">Auth.cache</span>”</span> logger will appear in the output
with a logger name of <span class="quote">“<span class="quote">b10-auth.cache</span>”</span>).
- </p></div><div class="section" title="severity (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229447923"></a>severity (string)</h4></div></div></div><p>
+ </p></div><div class="section" title="severity (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439035"></a>severity (string)</h4></div></div></div><p>
This specifies the category of messages logged.
Each message is logged with an associated severity which
@@ -862,7 +905,7 @@ This may be a temporary setting until then.
- </p></div><div class="section" title="output_options (list)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229447973"></a>output_options (list)</h4></div></div></div><p>
+ </p></div><div class="section" title="output_options (list)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439086"></a>output_options (list)</h4></div></div></div><p>
Each logger can have zero or more
<code class="option">output_options</code>. These specify where log
@@ -872,7 +915,7 @@ This may be a temporary setting until then.
The other options for a logger are:
- </p></div><div class="section" title="debuglevel (integer)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229447990"></a>debuglevel (integer)</h4></div></div></div><p>
+ </p></div><div class="section" title="debuglevel (integer)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439102"></a>debuglevel (integer)</h4></div></div></div><p>
When a logger's severity is set to DEBUG, this value
specifies what debug messages should be printed. It ranges
@@ -881,7 +924,7 @@ This may be a temporary setting until then.
If severity for the logger is not DEBUG, this value is ignored.
- </p></div><div class="section" title="additive (true or false)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229448005"></a>additive (true or false)</h4></div></div></div><p>
+ </p></div><div class="section" title="additive (true or false)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439117"></a>additive (true or false)</h4></div></div></div><p>
If this is true, the <code class="option">output_options</code> from
the parent will be used. For example, if there are two
@@ -895,18 +938,18 @@ This may be a temporary setting until then.
- </p></div></div><div class="section" title="Output Options"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229448040"></a>Output Options</h3></div></div></div><p>
+ </p></div></div><div class="section" title="Output Options"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229439154"></a>Output Options</h3></div></div></div><p>
The main settings for an output option are the
<code class="option">destination</code> and a value called
<code class="option">output</code>, the meaning of which depends on
the destination that is set.
- </p><div class="section" title="destination (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229448056"></a>destination (string)</h4></div></div></div><p>
+ </p><div class="section" title="destination (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439169"></a>destination (string)</h4></div></div></div><p>
The destination is the type of output. It can be one of:
- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> console </li><li class="listitem"> file </li><li class="listitem"> syslog </li></ul></div></div><div class="section" title="output (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229448088"></a>output (string)</h4></div></div></div><p>
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> console </li><li class="listitem"> file </li><li class="listitem"> syslog </li></ul></div></div><div class="section" title="output (string)"><div class="titlepage"><div><div><h4 class="title"><a name="id1168229439201"></a>output (string)</h4></div></div></div><p>
Depending on what is set as the output destination, this
value is interpreted as follows:
@@ -928,12 +971,12 @@ This may be a temporary setting until then.
The other options for <code class="option">output_options</code> are:
- </p><div class="section" title="flush (true of false)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229448172"></a>flush (true of false)</h5></div></div></div><p>
+ </p><div class="section" title="flush (true of false)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229439286"></a>flush (true of false)</h5></div></div></div><p>
Flush buffers after each log message. Doing this will
reduce performance but will ensure that if the program
terminates abnormally, all messages up to the point of
termination are output.
- </p></div><div class="section" title="maxsize (integer)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229448182"></a>maxsize (integer)</h5></div></div></div><p>
+ </p></div><div class="section" title="maxsize (integer)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229439296"></a>maxsize (integer)</h5></div></div></div><p>
Only relevant when destination is file, this is maximum
file size of output files in bytes. When the maximum
size is reached, the file is renamed and a new file opened.
@@ -942,11 +985,11 @@ This may be a temporary setting until then.
etc.)
</p><p>
If this is 0, no maximum file size is used.
- </p></div><div class="section" title="maxver (integer)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229448196"></a>maxver (integer)</h5></div></div></div><p>
+ </p></div><div class="section" title="maxver (integer)"><div class="titlepage"><div><div><h5 class="title"><a name="id1168229439308"></a>maxver (integer)</h5></div></div></div><p>
Maximum number of old log files to keep around when
rolling the output file. Only relevant when
<code class="option">destination</code> is <span class="quote">“<span class="quote">file</span>”</span>.
- </p></div></div></div><div class="section" title="Example session"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229448215"></a>Example session</h3></div></div></div><p>
+ </p></div></div></div><div class="section" title="Example session"><div class="titlepage"><div><div><h3 class="title"><a name="id1168229439328"></a>Example session</h3></div></div></div><p>
In this example we want to set the global logging to
write to the file <code class="filename">/var/log/my_bind10.log</code>,
@@ -1107,7 +1150,7 @@ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
And every module will now be using the values from the
logger named <span class="quote">“<span class="quote">*</span>”</span>.
- </p></div></div><div class="section" title="Logging Message Format"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229448428"></a>Logging Message Format</h2></div></div></div><p>
+ </p></div></div><div class="section" title="Logging Message Format"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id1168229439609"></a>Logging Message Format</h2></div></div></div><p>
Each message written by BIND 10 to the configured logging
destinations comprises a number of components that identify
the origin of the message and, if the message indicates
diff --git a/doc/guide/bind10-guide.txt b/doc/guide/bind10-guide.txt
new file mode 100644
index 0000000..619d56f
--- /dev/null
+++ b/doc/guide/bind10-guide.txt
@@ -0,0 +1,1201 @@
+ BIND 10 Guide
+
+Administrator Reference for BIND 10
+
+ This is the reference guide for BIND 10 version 20110809.
+
+ Copyright (c) 2010-2011 Internet Systems Consortium, Inc.
+
+ Abstract
+
+ BIND 10 is a Domain Name System (DNS) suite managed by Internet Systems
+ Consortium (ISC). It includes DNS libraries and modular components for
+ controlling authoritative and recursive DNS servers.
+
+ This is the reference guide for BIND 10 version 20110809. The most
+ up-to-date version of this document (in PDF, HTML, and plain text
+ formats), along with other documents for BIND 10, can be found at
+ http://bind10.isc.org/docs.
+
+ --------------------------------------------------------------------------
+
+ Table of Contents
+
+ 1. Introduction
+
+ Supported Platforms
+
+ Required Software
+
+ Starting and Stopping the Server
+
+ Managing BIND 10
+
+ 2. Installation
+
+ Building Requirements
+
+ Quick start
+
+ Installation from source
+
+ Download Tar File
+
+ Retrieve from Git
+
+ Configure before the build
+
+ Build
+
+ Install
+
+ Install Hierarchy
+
+ 3. Starting BIND10 with bind10
+
+ Starting BIND 10
+
+ 4. Command channel
+
+ 5. Configuration manager
+
+ 6. Remote control daemon
+
+ Configuration specification for b10-cmdctl
+
+ 7. Control and configure user interface
+
+ 8. Authoritative Server
+
+ Server Configurations
+
+ Data Source Backends
+
+ Loading Master Zones Files
+
+ 9. Incoming Zone Transfers
+
+ Configuration for Incoming Zone Transfers
+
+ Enabling IXFR
+
+ Trigger an Incoming Zone Transfer Manually
+
+ 10. Outbound Zone Transfers
+
+ 11. Secondary Manager
+
+ 12. Recursive Name Server
+
+ Access Control
+
+ Forwarding
+
+ 13. Statistics
+
+ 14. Logging
+
+ Logging configuration
+
+ Loggers
+
+ Output Options
+
+ Example session
+
+ Logging Message Format
+
+Chapter 1. Introduction
+
+ Table of Contents
+
+ Supported Platforms
+
+ Required Software
+
+ Starting and Stopping the Server
+
+ Managing BIND 10
+
+ BIND is the popular implementation of a DNS server, developer interfaces,
+ and DNS tools. BIND 10 is a rewrite of BIND 9. BIND 10 is written in C++
+ and Python and provides a modular environment for serving and maintaining
+ DNS.
+
+ Note
+
+ This guide covers the experimental prototype of BIND 10 version 20110809.
+
+ Note
+
+ BIND 10 provides a EDNS0- and DNSSEC-capable authoritative DNS server and
+ a caching recursive name server which also provides forwarding.
+
+Supported Platforms
+
+ BIND 10 builds have been tested on Debian GNU/Linux 5, Ubuntu 9.10, NetBSD
+ 5, Solaris 10, FreeBSD 7 and 8, and CentOS Linux 5.3. It has been tested
+ on Sparc, i386, and amd64 hardware platforms. It is planned for BIND 10 to
+ build, install and run on Windows and standard Unix-type platforms.
+
+Required Software
+
+ BIND 10 requires Python 3.1. Later versions may work, but Python 3.1 is
+ the minimum version which will work.
+
+ BIND 10 uses the Botan crypto library for C++. It requires at least Botan
+ version 1.8.
+
+ BIND 10 uses the log4cplus C++ logging library. It requires at least
+ log4cplus version 1.0.3.
+
+ The authoritative server requires SQLite 3.3.9 or newer. The b10-xfrin,
+ b10-xfrout, and b10-zonemgr modules require the libpython3 library and the
+ Python _sqlite3.so module.
+
+ Note
+
+ Some operating systems do not provide these dependencies in their default
+ installation nor standard packages collections. You may need to install
+ them separately.
+
+Starting and Stopping the Server
+
+ BIND 10 is modular. Part of this modularity is accomplished using multiple
+ cooperating processes which, together, provide the server functionality.
+ This is a change from the previous generation of BIND software, which used
+ a single process.
+
+ At first, running many different processes may seem confusing. However,
+ these processes are started, stopped, and maintained by a single command,
+ bind10. This command starts a master process which will start other
+ processes as needed. The processes started by the bind10 command have
+ names starting with "b10-", including:
+
+ o b10-msgq -- Message bus daemon. This process coordinates communication
+ between all of the other BIND 10 processes.
+ o b10-auth -- Authoritative DNS server. This process serves DNS
+ requests.
+ o b10-cfgmgr -- Configuration manager. This process maintains all of the
+ configuration for BIND 10.
+ o b10-cmdctl -- Command and control service. This process allows
+ external control of the BIND 10 system.
+ o b10-resolver -- Recursive name server. This process handles incoming
+ queries.
+ o b10-stats -- Statistics collection daemon. This process collects and
+ reports statistics data.
+ o b10-xfrin -- Incoming zone transfer service. This process is used to
+ transfer a new copy of a zone into BIND 10, when acting as a secondary
+ server.
+ o b10-xfrout -- Outgoing zone transfer service. This process is used to
+ handle transfer requests to send a local zone to a remote secondary
+ server, when acting as a master server.
+ o b10-zonemgr -- Secondary manager. This process keeps track of timers
+ and other necessary information for BIND 10 to act as a slave server.
+
+ These are ran automatically by bind10 and do not need to be run manually.
+
+Managing BIND 10
+
+ Once BIND 10 is running, a few commands are used to interact directly with
+ the system:
+
+ o bindctl -- interactive administration interface. This is a
+ command-line tool which allows an administrator to control BIND 10.
+ o b10-loadzone -- zone file loader. This tool will load standard
+ masterfile-format zone files into BIND 10.
+ o b10-cmdctl-usermgr -- user access control. This tool allows an
+ administrator to authorize additional users to manage BIND 10.
+
+ The tools and modules are covered in full detail in this guide. In
+ addition, manual pages are also provided in the default installation.
+
+ BIND 10 also provides libraries and programmer interfaces for C++ and
+ Python for the message bus, configuration backend, and, of course, DNS.
+ These include detailed developer documentation and code examples.
+
+Chapter 2. Installation
+
+ Table of Contents
+
+ Building Requirements
+
+ Quick start
+
+ Installation from source
+
+ Download Tar File
+
+ Retrieve from Git
+
+ Configure before the build
+
+ Build
+
+ Install
+
+ Install Hierarchy
+
+Building Requirements
+
+ In addition to the run-time requirements, building BIND 10 from source
+ code requires various development include headers.
+
+ Note
+
+ Some operating systems have split their distribution packages into a
+ run-time and a development package. You will need to install the
+ development package versions, which include header files and libraries, to
+ build BIND 10 from source code.
+
+ Building from source code requires the Boost build-time headers. At least
+ Boost version 1.35 is required.
+
+ To build BIND 10, also install the Botan (at least version 1.8) and the
+ log4cplus (at least version 1.0.3) development include headers.
+
+ The Python Library and Python _sqlite3 module are required to enable the
+ Xfrout and Xfrin support.
+
+ Note
+
+ The Python related libraries and modules need to be built for Python 3.1.
+
+ Building BIND 10 also requires a C++ compiler and standard development
+ headers, make, and pkg-config. BIND 10 builds have been tested with GCC
+ g++ 3.4.3, 4.1.2, 4.1.3, 4.2.1, 4.3.2, and 4.4.1; Clang++ 2.8; and Sun C++
+ 5.10.
+
+Quick start
+
+ Note
+
+ This quickly covers the standard steps for installing and deploying BIND
+ 10 as an authoritative name server using its defaults. For
+ troubleshooting, full customizations and further details, see the
+ respective chapters in the BIND 10 guide.
+
+ To quickly get started with BIND 10, follow these steps.
+
+ 1. Install required build dependencies.
+ 2. Download the BIND 10 source tar file from
+ ftp://ftp.isc.org/isc/bind10/.
+ 3. Extract the tar file:
+
+ $ gzcat bind10-VERSION.tar.gz | tar -xvf -
+
+ 4. Go into the source and run configure:
+
+ $ cd bind10-VERSION
+ $ ./configure
+
+ 5. Build it:
+
+ $ make
+
+ 6. Install it (to default /usr/local):
+
+ $ make install
+
+ 7. Start the server:
+
+ $ /usr/local/sbin/bind10
+
+ 8. Test it; for example:
+
+ $ dig @127.0.0.1 -c CH -t TXT authors.bind
+
+ 9. Load desired zone file(s), for example:
+
+ $ b10-loadzone your.zone.example.org
+
+ 10. Test the new zone.
+
+Installation from source
+
+ BIND 10 is open source software written in C++ and Python. It is freely
+ available in source code form from ISC via the Git code revision control
+ system or as a downloadable tar file. It may also be available in
+ pre-compiled ready-to-use packages from operating system vendors.
+
+ Download Tar File
+
+ Downloading a release tar file is the recommended method to obtain the
+ source code.
+
+ The BIND 10 releases are available as tar file downloads from
+ ftp://ftp.isc.org/isc/bind10/. Periodic development snapshots may also be
+ available.
+
+ Retrieve from Git
+
+ Downloading this "bleeding edge" code is recommended only for developers
+ or advanced users. Using development code in a production environment is
+ not recommended.
+
+ Note
+
+ When using source code retrieved via Git additional software will be
+ required: automake (v1.11 or newer), libtoolize, and autoconf (2.59 or
+ newer). These may need to be installed.
+
+ The latest development code, including temporary experiments and
+ un-reviewed code, is available via the BIND 10 code revision control
+ system. This is powered by Git and all the BIND 10 development is public.
+ The leading development is done in the "master".
+
+ The code can be checked out from git://bind10.isc.org/bind10; for example:
+
+ $ git clone git://bind10.isc.org/bind10
+
+ When checking out the code from the code version control system, it
+ doesn't include the generated configure script, Makefile.in files, nor the
+ related configure files. They can be created by running autoreconf with
+ the --install switch. This will run autoconf, aclocal, libtoolize,
+ autoheader, automake, and related commands.
+
+ Configure before the build
+
+ BIND 10 uses the GNU Build System to discover build environment details.
+ To generate the makefiles using the defaults, simply run:
+
+ $ ./configure
+
+ Run ./configure with the --help switch to view the different options. The
+ commonly-used options are:
+
+ --prefix
+ Define the installation location (the default is /usr/local/).
+
+ --with-boost-include
+ Define the path to find the Boost headers.
+
+ --with-pythonpath
+ Define the path to Python 3.1 if it is not in the standard
+ execution path.
+
+ --with-gtest
+ Enable building the C++ Unit Tests using the Google Tests
+ framework. Optionally this can define the path to the gtest header
+ files and library.
+
+ For example, the following configures it to find the Boost headers, find
+ the Python interpreter, and sets the installation location:
+
+ $ ./configure \
+ --with-boost-include=/usr/pkg/include \
+ --with-pythonpath=/usr/pkg/bin/python3.1 \
+ --prefix=/opt/bind10
+
+ If the configure fails, it may be due to missing or old dependencies.
+
+ Build
+
+ After the configure step is complete, to build the executables from the
+ C++ code and prepare the Python scripts, run:
+
+ $ make
+
+ Install
+
+ To install the BIND 10 executables, support files, and documentation, run:
+
+ $ make install
+
+ Note
+
+ The install step may require superuser privileges.
+
+ Install Hierarchy
+
+ The following is the layout of the complete BIND 10 installation:
+
+ o bin/ -- general tools and diagnostic clients.
+ o etc/bind10-devel/ -- configuration files.
+ o lib/ -- libraries and python modules.
+ o libexec/bind10-devel/ -- executables that a user wouldn't normally run
+ directly and are not run independently. These are the BIND 10 modules
+ which are daemons started by the bind10 tool.
+ o sbin/ -- commands used by the system administrator.
+ o share/bind10-devel/ -- configuration specifications.
+ o share/man/ -- manual pages (online documentation).
+ o var/bind10-devel/ -- data source and configuration databases.
+
+Chapter 3. Starting BIND10 with bind10
+
+ Table of Contents
+
+ Starting BIND 10
+
+ BIND 10 provides the bind10 command which starts up the required
+ processes. bind10 will also restart processes that exit unexpectedly. This
+ is the only command needed to start the BIND 10 system.
+
+ After starting the b10-msgq communications channel, bind10 connects to it,
+ runs the configuration manager, and reads its own configuration. Then it
+ starts the other modules.
+
+ The b10-msgq and b10-cfgmgr services make up the core. The b10-msgq daemon
+ provides the communication channel between every part of the system. The
+ b10-cfgmgr daemon is always needed by every module, if only to send
+ information about themselves somewhere, but more importantly to ask about
+ their own settings, and about other modules. The bind10 master process
+ will also start up b10-cmdctl for admins to communicate with the system,
+ b10-auth for authoritative DNS service or b10-resolver for recursive name
+ service, b10-stats for statistics collection, b10-xfrin for inbound DNS
+ zone transfers, b10-xfrout for outbound DNS zone transfers, and
+ b10-zonemgr for secondary service.
+
+Starting BIND 10
+
+ To start the BIND 10 service, simply run bind10. Run it with the --verbose
+ switch to get additional debugging or diagnostic output.
+
+ Note
+
+ If the setproctitle Python module is detected at start up, the process
+ names for the Python-based daemons will be renamed to better identify them
+ instead of just "python". This is not needed on some operating systems.
+
+Chapter 4. Command channel
+
+ The BIND 10 components use the b10-msgq message routing daemon to
+ communicate with other BIND 10 components. The b10-msgq implements what is
+ called the "Command Channel". Processes intercommunicate by sending
+ messages on the command channel. Example messages include shutdown, get
+ configurations, and set configurations. This Command Channel is not used
+ for DNS message passing. It is used only to control and monitor the BIND
+ 10 system.
+
+ Administrators do not communicate directly with the b10-msgq daemon. By
+ default, BIND 10 uses port 9912 for the b10-msgq service. It listens on
+ 127.0.0.1.
+
+Chapter 5. Configuration manager
+
+ The configuration manager, b10-cfgmgr, handles all BIND 10 system
+ configuration. It provides persistent storage for configuration, and
+ notifies running modules of configuration changes.
+
+ The b10-auth and b10-xfrin daemons and other components receive their
+ configurations from the configuration manager over the b10-msgq command
+ channel.
+
+ The administrator doesn't connect to it directly, but uses a user
+ interface to communicate with the configuration manager via b10-cmdctl's
+ REST-ful interface. b10-cmdctl is covered in Chapter 6, Remote control
+ daemon.
+
+ Note
+
+ The development prototype release only provides the bindctl as a user
+ interface to b10-cmdctl. Upcoming releases will provide another
+ interactive command-line interface and a web-based interface.
+
+ The b10-cfgmgr daemon can send all specifications and all current settings
+ to the bindctl client (via b10-cmdctl).
+
+ b10-cfgmgr relays configurations received from b10-cmdctl to the
+ appropriate modules.
+
+ The stored configuration file is at
+ /usr/local/var/bind10-devel/b10-config.db. (The full path is what was
+ defined at build configure time for --localstatedir. The default is
+ /usr/local/var/.) The format is loosely based on JSON and is directly
+ parseable python, but this may change in a future version. This
+ configuration data file is not manually edited by the administrator.
+
+ The configuration manager does not have any command line arguments.
+ Normally it is not started manually, but is automatically started using
+ the bind10 master process (as covered in Chapter 3, Starting BIND10 with
+ bind10).
+
+Chapter 6. Remote control daemon
+
+ Table of Contents
+
+ Configuration specification for b10-cmdctl
+
+ b10-cmdctl is the gateway between administrators and the BIND 10 system.
+ It is a HTTPS server that uses standard HTTP Digest Authentication for
+ username and password validation. It provides a REST-ful interface for
+ accessing and controlling BIND 10.
+
+ When b10-cmdctl starts, it firsts asks b10-cfgmgr about what modules are
+ running and what their configuration is (over the b10-msgq channel). Then
+ it will start listening on HTTPS for clients -- the user interface -- such
+ as bindctl.
+
+ b10-cmdctl directly sends commands (received from the user interface) to
+ the specified component. Configuration changes are actually commands to
+ b10-cfgmgr so are sent there.
+
+ The HTTPS server requires a private key, such as a RSA PRIVATE KEY. The
+ default location is at /usr/local/etc/bind10-devel/cmdctl-keyfile.pem. (A
+ sample key is at /usr/local/share/bind10-devel/cmdctl-keyfile.pem.) It
+ also uses a certificate located at
+ /usr/local/etc/bind10-devel/cmdctl-certfile.pem. (A sample certificate is
+ at /usr/local/share/bind10-devel/cmdctl-certfile.pem.) This may be a
+ self-signed certificate or purchased from a certification authority.
+
+ Note
+
+ The HTTPS server doesn't support a certificate request from a client (at
+ this time). The b10-cmdctl daemon does not provide a public service. If
+ any client wants to control BIND 10, then a certificate needs to be first
+ received from the BIND 10 administrator. The BIND 10 installation provides
+ a sample PEM bundle that matches the sample key and certificate.
+
+ The b10-cmdctl daemon also requires the user account file located at
+ /usr/local/etc/bind10-devel/cmdctl-accounts.csv. This comma-delimited file
+ lists the accounts with a user name, hashed password, and salt. (A sample
+ file is at /usr/local/share/bind10-devel/cmdctl-accounts.csv. It contains
+ the user named "root" with the password "bind10".)
+
+ The administrator may create a user account with the b10-cmdctl-usermgr
+ tool.
+
+ By default the HTTPS server listens on the localhost port 8080. The port
+ can be set by using the --port command line option. The address to listen
+ on can be set using the --address command line argument. Each HTTPS
+ connection is stateless and timesout in 1200 seconds by default. This can
+ be redefined by using the --idle-timeout command line argument.
+
+Configuration specification for b10-cmdctl
+
+ The configuration items for b10-cmdctl are: key_file cert_file
+ accounts_file
+
+ The control commands are: print_settings shutdown
+
+Chapter 7. Control and configure user interface
+
+ Note
+
+ For this development prototype release, bindctl is the only user
+ interface. It is expected that upcoming releases will provide another
+ interactive command-line interface and a web-based interface for
+ controlling and configuring BIND 10.
+
+ The bindctl tool provides an interactive prompt for configuring,
+ controlling, and querying the BIND 10 components. It communicates directly
+ with a REST-ful interface over HTTPS provided by b10-cmdctl. It doesn't
+ communicate to any other components directly.
+
+ Configuration changes are actually commands to b10-cfgmgr. So when bindctl
+ sends a configuration, it is sent to b10-cmdctl (over a HTTPS connection);
+ then b10-cmdctl sends the command (over a b10-msgq command channel) to
+ b10-cfgmgr which then stores the details and relays (over a b10-msgq
+ command channel) the configuration on to the specified module.
+
+Chapter 8. Authoritative Server
+
+ Table of Contents
+
+ Server Configurations
+
+ Data Source Backends
+
+ Loading Master Zones Files
+
+ The b10-auth is the authoritative DNS server. It supports EDNS0 and
+ DNSSEC. It supports IPv6. Normally it is started by the bind10 master
+ process.
+
+Server Configurations
+
+ b10-auth is configured via the b10-cfgmgr configuration manager. The
+ module name is "Auth". The configuration data item is:
+
+ database_file
+ This is an optional string to define the path to find the SQLite3
+ database file. Note: Later the DNS server will use various data
+ source backends. This may be a temporary setting until then.
+
+ The configuration command is:
+
+ shutdown
+ Stop the authoritative DNS server.
+
+Data Source Backends
+
+ Note
+
+ For the development prototype release, b10-auth supports a SQLite3 data
+ source backend and in-memory data source backend. Upcoming versions will
+ be able to use multiple different data sources, such as MySQL and Berkeley
+ DB.
+
+ By default, the SQLite3 backend uses the data file located at
+ /usr/local/var/bind10-devel/zone.sqlite3. (The full path is what was
+ defined at build configure time for --localstatedir. The default is
+ /usr/local/var/.) This data file location may be changed by defining the
+ "database_file" configuration.
+
+Loading Master Zones Files
+
+ RFC 1035 style DNS master zone files may imported into a BIND 10 data
+ source by using the b10-loadzone utility.
+
+ b10-loadzone supports the following special directives (control entries):
+
+ $INCLUDE
+ Loads an additional zone file. This may be recursive.
+
+ $ORIGIN
+ Defines the relative domain name.
+
+ $TTL
+ Defines the time-to-live value used for following records that
+ don't include a TTL.
+
+ The -o argument may be used to define the default origin for loaded zone
+ file records.
+
+ Note
+
+ In the development prototype release, only the SQLite3 back end is used.
+ By default, it stores the zone data in
+ /usr/local/var/bind10-devel/zone.sqlite3 unless the -d switch is used to
+ set the database filename. Multiple zones are stored in a single SQLite3
+ zone database.
+
+ If you reload a zone already existing in the database, all records from
+ that prior zone disappear and a whole new set appears.
+
+Chapter 9. Incoming Zone Transfers
+
+ Table of Contents
+
+ Configuration for Incoming Zone Transfers
+
+ Enabling IXFR
+
+ Trigger an Incoming Zone Transfer Manually
+
+ Incoming zones are transferred using the b10-xfrin process which is
+ started by bind10. When received, the zone is stored in the corresponding
+ BIND 10 data source, and its records can be served by b10-auth. In
+ combination with b10-zonemgr (for automated SOA checks), this allows the
+ BIND 10 server to provide "secondary" service.
+
+ The b10-xfrin process supports both AXFR and IXFR. Due to some
+ implementation limitations of the current development release, however, it
+ only tries AXFR by default, and care should be taken to enable IXFR.
+
+ Note
+
+ In the current development release of BIND 10, incoming zone transfers are
+ only available for SQLite3-based data sources, that is, they don't work
+ for an in-memory data source.
+
+Configuration for Incoming Zone Transfers
+
+ In practice, you need to specify a list of secondary zones to enable
+ incoming zone transfers for these zones (you can still trigger a zone
+ transfer manually, without a prior configuration (see below)).
+
+ For example, to enable zone transfers for a zone named "example.com"
+ (whose master address is assumed to be 2001:db8::53 here), run the
+ following at the bindctl prompt:
+
+ > config add Xfrin/zones
+ > config set Xfrin/zones[0]/name "example.com"
+ > config set Xfrin/zones[0]/master_addr "2001:db8::53"
+ > config commit
+
+ (We assume there has been no zone configuration before).
+
+Enabling IXFR
+
+ As noted above, b10-xfrin uses AXFR for zone transfers by default. To
+ enable IXFR for zone transfers for a particular zone, set the use_ixfr
+ configuration parameter to true. In the above example of configuration
+ sequence, you'll need to add the following before performing commit:
+
+ > config set Xfrin/zones[0]/use_ixfr true
+
+ Note
+
+ One reason why IXFR is disabled by default in the current release is
+ because it does not support automatic fallback from IXFR to AXFR when it
+ encounters a primary server that doesn't support outbound IXFR (and, not
+ many existing implementations support it). Another, related reason is that
+ it does not use AXFR even if it has no knowledge about the zone (like at
+ the very first time the secondary server is set up). IXFR requires the
+ "current version" of the zone, so obviously it doesn't work in this
+ situation and AXFR is the only workable choice. The current release of
+ b10-xfrin does not make this selection automatically. These features will
+ be implemented in a near future version, at which point we will enable
+ IXFR by default.
+
+Trigger an Incoming Zone Transfer Manually
+
+ To manually trigger a zone transfer to retrieve a remote zone, you may use
+ the bindctl utility. For example, at the bindctl prompt run:
+
+ > Xfrin retransfer zone_name="foo.example.org" master=192.0.2.99
+
+Chapter 10. Outbound Zone Transfers
+
+ The b10-xfrout process is started by bind10. When the b10-auth
+ authoritative DNS server receives an AXFR request, b10-xfrout sends the
+ zone. This is used to provide master DNS service to share zones to
+ secondary name servers. The b10-xfrout is also used to send NOTIFY
+ messages to slaves.
+
+ Note
+
+ The current development release of BIND 10 only supports AXFR. (IXFR is
+ not supported.) Access control is not yet provided.
+
+Chapter 11. Secondary Manager
+
+ The b10-zonemgr process is started by bind10. It keeps track of SOA
+ refresh, retry, and expire timers and other details for BIND 10 to perform
+ as a slave. When the b10-auth authoritative DNS server receives a NOTIFY
+ message, b10-zonemgr may tell b10-xfrin to do a refresh to start an
+ inbound zone transfer. The secondary manager resets its counters when a
+ new zone is transferred in.
+
+ Note
+
+ Access control (such as allowing notifies) is not yet provided. The
+ primary/secondary service is not yet complete.
+
+Chapter 12. Recursive Name Server
+
+ Table of Contents
+
+ Access Control
+
+ Forwarding
+
+ The b10-resolver process is started by bind10.
+
+ The main bind10 process can be configured to select to run either the
+ authoritative or resolver or both. By default, it starts the authoritative
+ service. You may change this using bindctl, for example:
+
+ > config set Boss/start_auth false
+ > config set Boss/start_resolver true
+ > config commit
+
+ The master bind10 will stop and start the desired services.
+
+ By default, the resolver listens on port 53 for 127.0.0.1 and ::1. The
+ following example shows how it can be configured to listen on an
+ additional address (and port):
+
+ > config add Resolver/listen_on
+ > config set Resolver/listen_on[2]/address "192.168.1.1"
+ > config set Resolver/listen_on[2]/port 53
+ > config commit
+
+ (Replace the "2" as needed; run "config show Resolver/listen_on" if
+ needed.)
+
+Access Control
+
+ By default, the b10-resolver daemon only accepts DNS queries from the
+ localhost (127.0.0.1 and ::1). The Resolver/query_acl configuration may be
+ used to reject, drop, or allow specific IPs or networks. This
+ configuration list is first match.
+
+ The configuration's action item may be set to "ACCEPT" to allow the
+ incoming query, "REJECT" to respond with a DNS REFUSED return code, or
+ "DROP" to ignore the query without any response (such as a blackhole). For
+ more information, see the respective debugging messages:
+ RESOLVER_QUERY_ACCEPTED, RESOLVER_QUERY_REJECTED, and
+ RESOLVER_QUERY_DROPPED.
+
+ The required configuration's from item is set to an IPv4 or IPv6 address,
+ addresses with an network mask, or to the special lowercase keywords
+ "any6" (for any IPv6 address) or "any4" (for any IPv4 address).
+
+ For example to allow the 192.168.1.0/24 network to use your recursive name
+ server, at the bindctl prompt run:
+
+ > config add Resolver/query_acl
+ > config set Resolver/query_acl[2]/action "ACCEPT"
+ > config set Resolver/query_acl[2]/from "192.168.1.0/24"
+ > config commit
+
+ (Replace the "2" as needed; run "config show Resolver/query_acl" if
+ needed.)
+
+ Note
+
+ This prototype access control configuration syntax may be changed.
+
+Forwarding
+
+ To enable forwarding, the upstream address and port must be configured to
+ forward queries to, such as:
+
+ > config set Resolver/forward_addresses [{ "address": "192.168.1.1", "port": 53 }]
+ > config commit
+
+ (Replace 192.168.1.1 to point to your full resolver.)
+
+ Normal iterative name service can be re-enabled by clearing the forwarding
+ address(es); for example:
+
+ > config set Resolver/forward_addresses []
+ > config commit
+
+Chapter 13. Statistics
+
+ The b10-stats process is started by bind10. It periodically collects
+ statistics data from various modules and aggregates it.
+
+ This stats daemon provides commands to identify if it is running, show
+ specified or all statistics data, show specified or all statistics data
+ schema, and set specified statistics data. For example, using bindctl:
+
+ > Stats show
+ {
+ "Auth": {
+ "queries.tcp": 1749,
+ "queries.udp": 867868
+ },
+ "Boss": {
+ "boot_time": "2011-01-20T16:59:03Z"
+ },
+ "Stats": {
+ "boot_time": "2011-01-20T16:59:05Z",
+ "last_update_time": "2011-01-20T17:04:05Z",
+ "lname": "4d3869d9_a at jreed.example.net",
+ "report_time": "2011-01-20T17:04:06Z",
+ "timestamp": 1295543046.823504
+ }
+ }
+
+
+Chapter 14. Logging
+
+ Table of Contents
+
+ Logging configuration
+
+ Loggers
+
+ Output Options
+
+ Example session
+
+ Logging Message Format
+
+Logging configuration
+
+ The logging system in BIND 10 is configured through the Logging module.
+ All BIND 10 modules will look at the configuration in Logging to see what
+ should be logged and to where.
+
+ Loggers
+
+ Within BIND 10, a message is logged through a component called a "logger".
+ Different parts of BIND 10 log messages through different loggers, and
+ each logger can be configured independently of one another.
+
+ In the Logging module, you can specify the configuration for zero or more
+ loggers; any that are not specified will take appropriate default values..
+
+ The three most important elements of a logger configuration are the name
+ (the component that is generating the messages), the severity (what to
+ log), and the output_options (where to log).
+
+ name (string)
+
+ Each logger in the system has a name, the name being that of the component
+ using it to log messages. For instance, if you want to configure logging
+ for the resolver module, you add an entry for a logger named "Resolver".
+ This configuration will then be used by the loggers in the Resolver
+ module, and all the libraries used by it.
+
+ If you want to specify logging for one specific library within the module,
+ you set the name to module.library. For example, the logger used by the
+ nameserver address store component has the full name of "Resolver.nsas".
+ If there is no entry in Logging for a particular library, it will use the
+ configuration given for the module.
+
+ To illustrate this, suppose you want the cache library to log messages of
+ severity DEBUG, and the rest of the resolver code to log messages of
+ severity INFO. To achieve this you specify two loggers, one with the name
+ "Resolver" and severity INFO, and one with the name "Resolver.cache" with
+ severity DEBUG. As there are no entries for other libraries (e.g. the
+ nsas), they will use the configuration for the module ("Resolver"), so
+ giving the desired behavior.
+
+ One special case is that of a module name of "*" (asterisks), which is
+ interpreted as any module. You can set global logging options by using
+ this, including setting the logging configuration for a library that is
+ used by multiple modules (e.g. "*.config" specifies the configuration
+ library code in whatever module is using it).
+
+ If there are multiple logger specifications in the configuration that
+ might match a particular logger, the specification with the more specific
+ logger name takes precedence. For example, if there are entries for for
+ both "*" and "Resolver", the resolver module -- and all libraries it uses
+ -- will log messages according to the configuration in the second entry
+ ("Resolver"). All other modules will use the configuration of the first
+ entry ("*"). If there was also a configuration entry for "Resolver.cache",
+ the cache library within the resolver would use that in preference to the
+ entry for "Resolver".
+
+ One final note about the naming. When specifying the module name within a
+ logger, use the name of the module as specified in bindctl, e.g.
+ "Resolver" for the resolver module, "Xfrout" for the xfrout module, etc.
+ When the message is logged, the message will include the name of the
+ logger generating the message, but with the module name replaced by the
+ name of the process implementing the module (so for example, a message
+ generated by the "Auth.cache" logger will appear in the output with a
+ logger name of "b10-auth.cache").
+
+ severity (string)
+
+ This specifies the category of messages logged. Each message is logged
+ with an associated severity which may be one of the following (in
+ descending order of severity):
+
+ o FATAL
+ o ERROR
+ o WARN
+ o INFO
+ o DEBUG
+
+ When the severity of a logger is set to one of these values, it will only
+ log messages of that severity, and the severities above it. The severity
+ may also be set to NONE, in which case all messages from that logger are
+ inhibited.
+
+ output_options (list)
+
+ Each logger can have zero or more output_options. These specify where log
+ messages are sent to. These are explained in detail below.
+
+ The other options for a logger are:
+
+ debuglevel (integer)
+
+ When a logger's severity is set to DEBUG, this value specifies what debug
+ messages should be printed. It ranges from 0 (least verbose) to 99 (most
+ verbose).
+
+ If severity for the logger is not DEBUG, this value is ignored.
+
+ additive (true or false)
+
+ If this is true, the output_options from the parent will be used. For
+ example, if there are two loggers configured; "Resolver" and
+ "Resolver.cache", and additive is true in the second, it will write the
+ log messages not only to the destinations specified for "Resolver.cache",
+ but also to the destinations as specified in the output_options in the
+ logger named "Resolver".
+
+ Output Options
+
+ The main settings for an output option are the destination and a value
+ called output, the meaning of which depends on the destination that is
+ set.
+
+ destination (string)
+
+ The destination is the type of output. It can be one of:
+
+ o console
+ o file
+ o syslog
+
+ output (string)
+
+ Depending on what is set as the output destination, this value is
+ interpreted as follows:
+
+ destination is "console"
+ The value of output must be one of "stdout" (messages printed to
+ standard output) or "stderr" (messages printed to standard error).
+
+ destination is "file"
+ The value of output is interpreted as a file name; log messages
+ will be appended to this file.
+
+ destination is "syslog"
+ The value of output is interpreted as the syslog facility (e.g.
+ local0) that should be used for log messages.
+
+ The other options for output_options are:
+
+ flush (true of false)
+
+ Flush buffers after each log message. Doing this will reduce performance
+ but will ensure that if the program terminates abnormally, all messages up
+ to the point of termination are output.
+
+ maxsize (integer)
+
+ Only relevant when destination is file, this is maximum file size of
+ output files in bytes. When the maximum size is reached, the file is
+ renamed and a new file opened. (For example, a ".1" is appended to the
+ name -- if a ".1" file exists, it is renamed ".2", etc.)
+
+ If this is 0, no maximum file size is used.
+
+ maxver (integer)
+
+ Maximum number of old log files to keep around when rolling the output
+ file. Only relevant when destination is "file".
+
+ Example session
+
+ In this example we want to set the global logging to write to the file
+ /var/log/my_bind10.log, at severity WARN. We want the authoritative server
+ to log at DEBUG with debuglevel 40, to a different file
+ (/tmp/debug_messages).
+
+ Start bindctl.
+
+ ["login success "]
+ > config show Logging
+ Logging/loggers [] list
+
+ By default, no specific loggers are configured, in which case the severity
+ defaults to INFO and the output is written to stderr.
+
+ Let's first add a default logger:
+
+ > config add Logging/loggers
+ > config show Logging
+ Logging/loggers/ list (modified)
+
+ The loggers value line changed to indicate that it is no longer an empty
+ list:
+
+ > config show Logging/loggers
+ Logging/loggers[0]/name "" string (default)
+ Logging/loggers[0]/severity "INFO" string (default)
+ Logging/loggers[0]/debuglevel 0 integer (default)
+ Logging/loggers[0]/additive false boolean (default)
+ Logging/loggers[0]/output_options [] list (default)
+
+ The name is mandatory, so we must set it. We will also change the severity
+ as well. Let's start with the global logger.
+
+ > config set Logging/loggers[0]/name *
+ > config set Logging/loggers[0]/severity WARN
+ > config show Logging/loggers
+ Logging/loggers[0]/name "*" string (modified)
+ Logging/loggers[0]/severity "WARN" string (modified)
+ Logging/loggers[0]/debuglevel 0 integer (default)
+ Logging/loggers[0]/additive false boolean (default)
+ Logging/loggers[0]/output_options [] list (default)
+
+ Of course, we need to specify where we want the log messages to go, so we
+ add an entry for an output option.
+
+ > config add Logging/loggers[0]/output_options
+ > config show Logging/loggers[0]/output_options
+ Logging/loggers[0]/output_options[0]/destination "console" string (default)
+ Logging/loggers[0]/output_options[0]/output "stdout" string (default)
+ Logging/loggers[0]/output_options[0]/flush false boolean (default)
+ Logging/loggers[0]/output_options[0]/maxsize 0 integer (default)
+ Logging/loggers[0]/output_options[0]/maxver 0 integer (default)
+
+ These aren't the values we are looking for.
+
+ > config set Logging/loggers[0]/output_options[0]/destination file
+ > config set Logging/loggers[0]/output_options[0]/output /var/log/bind10.log
+ > config set Logging/loggers[0]/output_options[0]/maxsize 30000
+ > config set Logging/loggers[0]/output_options[0]/maxver 8
+
+ Which would make the entire configuration for this logger look like:
+
+ > config show all Logging/loggers
+ Logging/loggers[0]/name "*" string (modified)
+ Logging/loggers[0]/severity "WARN" string (modified)
+ Logging/loggers[0]/debuglevel 0 integer (default)
+ Logging/loggers[0]/additive false boolean (default)
+ Logging/loggers[0]/output_options[0]/destination "file" string (modified)
+ Logging/loggers[0]/output_options[0]/output "/var/log/bind10.log" string (modified)
+ Logging/loggers[0]/output_options[0]/flush false boolean (default)
+ Logging/loggers[0]/output_options[0]/maxsize 30000 integer (modified)
+ Logging/loggers[0]/output_options[0]/maxver 8 integer (modified)
+
+ That looks OK, so let's commit it before we add the configuration for the
+ authoritative server's logger.
+
+ > config commit
+
+ Now that we have set it, and checked each value along the way, adding a
+ second entry is quite similar.
+
+ > config add Logging/loggers
+ > config set Logging/loggers[1]/name Auth
+ > config set Logging/loggers[1]/severity DEBUG
+ > config set Logging/loggers[1]/debuglevel 40
+ > config add Logging/loggers[1]/output_options
+ > config set Logging/loggers[1]/output_options[0]/destination file
+ > config set Logging/loggers[1]/output_options[0]/output /tmp/auth_debug.log
+ > config commit
+
+ And that's it. Once we have found whatever it was we needed the debug
+ messages for, we can simply remove the second logger to let the
+ authoritative server use the same settings as the rest.
+
+ > config remove Logging/loggers[1]
+ > config commit
+
+ And every module will now be using the values from the logger named "*".
+
+Logging Message Format
+
+ Each message written by BIND 10 to the configured logging destinations
+ comprises a number of components that identify the origin of the message
+ and, if the message indicates a problem, information about the problem
+ that may be useful in fixing it.
+
+ Consider the message below logged to a file:
+
+ 2011-06-15 13:48:22.034 ERROR [b10-resolver.asiolink]
+ ASIODNS_OPENSOCK error 111 opening TCP socket to 127.0.0.1(53)
+
+ Note: the layout of messages written to the system logging file (syslog)
+ may be slightly different. This message has been split across two lines
+ here for display reasons; in the logging file, it will appear on one
+ line.)
+
+ The log message comprises a number of components:
+
+ 2011-06-15 13:48:22.034
+
+ The date and time at which the message was generated.
+
+ ERROR
+
+ The severity of the message.
+
+ [b10-resolver.asiolink]
+
+ The source of the message. This comprises two components: the BIND
+ 10 process generating the message (in this case, b10-resolver) and
+ the module within the program from which the message originated
+ (which in the example is the asynchronous I/O link module,
+ asiolink).
+
+ ASIODNS_OPENSOCK
+
+ The message identification. Every message in BIND 10 has a unique
+ identification, which can be used as an index into the BIND 10
+ Messages Manual (http://bind10.isc.org/docs/bind10-messages.html)
+ from which more information can be obtained.
+
+ error 111 opening TCP socket to 127.0.0.1(53)
+
+ A brief description of the cause of the problem. Within this text,
+ information relating to the condition that caused the message to
+ be logged will be included. In this example, error number 111 (an
+ operating system-specific error number) was encountered when
+ trying to open a TCP connection to port 53 on the local system
+ (address 127.0.0.1). The next step would be to find out the reason
+ for the failure by consulting your system's documentation to
+ identify what error number 111 means.
diff --git a/doc/guide/bind10-guide.xml b/doc/guide/bind10-guide.xml
index 4603818..21bb671 100644
--- a/doc/guide/bind10-guide.xml
+++ b/doc/guide/bind10-guide.xml
@@ -41,9 +41,10 @@
</para>
<para>
This is the reference guide for BIND 10 version &__VERSION__;.
- The most up-to-date version of this document, along with
- other documents for BIND 10, can be found at <ulink
- url="http://bind10.isc.org/docs"/>. </para> </abstract>
+ The most up-to-date version of this document (in PDF, HTML,
+ and plain text formats), along with other documents for
+ BIND 10, can be found at <ulink url="http://bind10.isc.org/docs"/>.
+ </para> </abstract>
<releaseinfo>This is the reference guide for BIND 10 version
&__VERSION__;.</releaseinfo>
More information about the bind10-changes
mailing list