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

[trac1341] add CONFIGURATION AND COMMANDS section

parent a9dc55c6
......@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
<date>August 11, 2011</date>
<date>November 23, 2011</date>
</refentryinfo>
<refmeta>
......@@ -232,6 +232,203 @@ The default is the basename of ARG 0.
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>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment