BIND 10 trac1341, updated. 8fe1dbdadf8ce7aa288ae08320f315ab56433cb6 [trac1341] add CONFIGURATION AND COMMANDS section
BIND 10 source code commits
bind10-changes at lists.isc.org
Wed Nov 23 18:26:11 UTC 2011
The branch, trac1341 has been updated
via 8fe1dbdadf8ce7aa288ae08320f315ab56433cb6 (commit)
from a9dc55c6cc18e2ed28f79cfbbdf7408a64a04ca4 (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 8fe1dbdadf8ce7aa288ae08320f315ab56433cb6
Author: Jeremy C. Reed <jreed at ISC.org>
Date: Wed Nov 23 12:25:33 2011 -0600
[trac1341] add CONFIGURATION AND COMMANDS section
-----------------------------------------------------------------------
Summary of changes:
src/bin/bind10/bind10.xml | 199 ++++++++++++++++++++++++++++++++++++++++++++-
1 files changed, 198 insertions(+), 1 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/bin/bind10/bind10.xml b/src/bin/bind10/bind10.xml
index 6de0947..955895f 100644
--- a/src/bin/bind10/bind10.xml
+++ b/src/bin/bind10/bind10.xml
@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
- <date>August 11, 2011</date>
+ <date>November 23, 2011</date>
</refentryinfo>
<refmeta>
@@ -233,6 +233,203 @@ TODO: configuration section
-->
<refsect1>
+ <title>CONFIGURATION AND COMMANDS</title>
+
+ <para>
+ The configuration provides settings for components for
+ <command>bind10</command> to manage under
+ <varname>/Boss/components/</varname>.
+ The default named sets are:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para> <varname>/Boss/components/b10-auth</varname> </para>
+ </listitem>
+
+ <listitem>
+ <para> <varname>/Boss/components/b10-cmdctl</varname> </para>
+ </listitem>
+
+ <listitem>
+ <para> <varname>/Boss/components/setuid</varname> </para>
+ </listitem>
+
+ <listitem>
+ <para> <varname>/Boss/components/b10-stats</varname> </para>
+ </listitem>
+
+ <listitem>
+ <para> <varname>/Boss/components/b10-stats-httpd</varname> </para>
+ </listitem>
+
+ <listitem>
+ <para> <varname>/Boss/components/b10-xfrin</varname> </para>
+ </listitem>
+
+ <listitem>
+ <para> <varname>/Boss/components/b10-xfrout</varname> </para>
+ </listitem>
+
+ <listitem>
+ <para> <varname>/Boss/components/b10-zonemgr</varname> </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ These named sets (listed above) contain the following settings:
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><varname>address</varname></term>
+ <listitem>
+ <para>The name used for communicating to it on the message
+ bus.</para>
+<!-- TODO: why are some addresses are just null? -->
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>kind</varname></term>
+ <listitem>
+ <para>
+ This defines how required a component is.
+ The possible settings for <varname>kind</varname> are:
+ <varname>core</varname> (system won't start if it won't
+ start and <command>bind10</command> will shutdown if
+ a <quote>core</quote> component crashes),
+ <varname>dispensable</varname> (<command>bind10</command>
+ will restart failing component),
+ and
+ <varname>needed</varname> (<command>bind10</command>
+ will shutdown if component won't initially start, but
+ if crashes later, it will attempt to restart).
+ This setting is required.
+<!-- TODO: formatting -->
+ </para>
+ </listitem>
+ </varlistentry>
+
+<!--
+TODO: currently not used
+ <varlistentry>
+ <term> <varname>params</varname> </term>
+ <listitem>
+ <para>
+list
+</para>
+ </listitem>
+ </varlistentry>
+-->
+
+ <varlistentry>
+ <term> <varname>priority</varname> </term>
+ <listitem>
+ <para>This is an integer. <command>bind10</command>
+ will start the components with largest priority numbers first.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <varname>process</varname> </term>
+ <listitem>
+ <para>This is the filename of the executable to be started.
+ If not defined, then <command>bind10</command> will
+ use the component name instead.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term> <varname>special</varname> </term>
+ <listitem>
+ <para>
+ This defines if the component is started a special
+ way.
+<!--
+TODO: document this ... but maybe some of these will be removed
+once we get rid of some using switches for components?
+
+auth
+cfgmgr
+cmdctl
+msgq
+resolver
+setuid
+sockcreator
+xfrin
+-->
+
+</para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+
+<!--
+
+TODO: what about: why aren't they listed in config show Boss/components ?
+
+socket creator
+cfgmgr
+
+startup of msgq is not configurable?
+
+-->
+
+<!-- TODO: formating -->
+ <para>
+ The <varname>Boss</varname> configuration commands are:
+ </para>
+<!-- TODO: let's just let bind10 be known as bind10 and not Boss -->
+
+ <para>
+ <command>getstats</command> tells <command>bind10</command>
+ to send its statistics data to the <command>b10-stats</command>
+ daemon.
+ This is an internal command and not exposed to the administrator.
+<!-- not defined in spec -->
+<!-- TODO: explain difference with sendstat -->
+ </para>
+
+ <para>
+ <command>ping</command> is used to check the connection with the
+ <command>bind10</command> daemon.
+ It returns the text <quote>pong</quote>.
+ </para>
+
+ <para>
+ <command>sendstats</command> tells <command>bind10</command>
+ to send its statistics data to the <command>b10-stats</command>
+ daemon immediately.
+<!-- TODO: compare with internal command getstats? -->
+ </para>
+
+ <para>
+ <command>show_processes</command> lists the current processes
+ managed by <command>bind10</command>.
+ The output is an array in JSON format containing the process
+ ID and the name for each.
+<!-- TODO: what is name? -->
+<!-- TODO: change to JSON object format? -->
+<!-- TODO: ticket #1406 -->
+ </para>
+
+ <para>
+ <command>shutdown</command> tells <command>bind10</command>
+ to shutdown the BIND 10 servers.
+ It will tell each process it manages to shutdown and, when
+ complete, <command>bind10</command> will exit.
+ </para>
+
+ </refsect1>
+
+ <refsect1>
<title>STATISTICS DATA</title>
<para>
More information about the bind10-changes
mailing list