bind10.xml 16 KB
Newer Older
1 2 3 4
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
	       [<!ENTITY mdash "&#8212;">]>
<!--
Jeremy C. Reed's avatar
Jeremy C. Reed committed
5
 - Copyright (C) 2010-2012  Internet Systems Consortium, Inc. ("ISC")
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 -
 - Permission to use, copy, modify, and/or distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->

<refentry>

  <refentryinfo>
23
    <date>March 1, 2012</date>
24 25 26 27 28 29 30 31 32 33
  </refentryinfo>

  <refmeta>
    <refentrytitle>bind10</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo>BIND10</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>bind10</refname>
34
    <refpurpose>BIND 10 boss process</refpurpose>
35 36 37 38
  </refnamediv>

  <docinfo>
    <copyright>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
39
      <year>2010-2012</year>
40 41 42 43 44 45
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
    <cmdsynopsis>
46
      <command>bind10</command>
47
      <arg><option>-c <replaceable>config-filename</replaceable></option></arg>
48 49
      <arg><option>-m <replaceable>file</replaceable></option></arg>
      <arg><option>-n</option></arg>
50
      <arg><option>-p <replaceable>data_path</replaceable></option></arg>
51
      <arg><option>-u <replaceable>user</replaceable></option></arg>
52
      <arg><option>-v</option></arg>
53
      <arg><option>-w <replaceable>wait_time</replaceable></option></arg>
54 55 56
      <arg><option>--cmdctl-port</option> <replaceable>port</replaceable></arg>
      <arg><option>--config-file</option> <replaceable>config-filename</replaceable></arg>
      <arg><option>--data-path</option> <replaceable>directory</replaceable></arg>
57 58
      <arg><option>--msgq-socket-file <replaceable>file</replaceable></option></arg>
      <arg><option>--no-cache</option></arg>
59
      <arg><option>--pid-file</option> <replaceable>filename</replaceable></arg>
Michal Vaner's avatar
Michal Vaner committed
60
      <arg><option>--pretty-name <replaceable>name</replaceable></option></arg>
61
      <arg><option>--user <replaceable>user</replaceable></option></arg>
62
      <arg><option>--verbose</option></arg>
63
      <arg><option>--wait <replaceable>wait_time</replaceable></option></arg>
64 65 66 67 68 69 70 71 72 73
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para>The <command>bind10</command> daemon starts up other
    BIND 10 required daemons.  It handles restarting of exiting
    programs and also the shutdown of all managed daemons.</para>

Jeremy C. Reed's avatar
Jeremy C. Reed committed
74 75
<!-- TODO: list what it starts here? -->

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
<!-- TODO
    <para>The configuration of the <command>bind10</command> daemon
    is defined in the TODO configuration file, as described in the
    <citerefentry><refentrytitle>TODO</refentrytitle><manvolnum>5</manvolnum></citerefentry>
    manual page.</para>
-->

  </refsect1>

  <refsect1>
    <title>ARGUMENTS</title>

    <para>The arguments are as follows:</para>

    <variablelist>
91 92 93 94

      <varlistentry>
        <term>
          <option>-c</option> <replaceable>config-filename</replaceable>,
95 96 97 98
          <option>--config-file</option> <replaceable>config-filename</replaceable>
        </term>
        <listitem>
          <para>The configuration filename to use. Can be either absolute or
99
          relative to data path. In case it is absolute, value of data path is
Jeremy C. Reed's avatar
Jeremy C. Reed committed
100 101
          not considered.
          Defaults to <filename>b10-config.db</filename>.</para>
102 103 104 105 106
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
          <option>--cmdctl-port</option> <replaceable>port</replaceable>
        </term>
        <listitem>
	  <para>The <command>b10-cmdctl</command> daemon will listen
	    on this port.
	    (See
	    <refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum>
            for the default.)
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-p</option> <replaceable>directory</replaceable>,
          <option>--data-path</option> <replaceable>directory</replaceable>
123 124
        </term>
        <listitem>
125
          <para>The path where BIND 10 programs look for various data files.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
126 127 128 129 130
	  Currently only
	  <citerefentry><refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	  uses it to locate the configuration file, but the usage
	  might be extended for other programs and other types of
	  files.</para>
131 132
        </listitem>
      </varlistentry>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
133

134 135 136 137 138 139 140 141 142 143 144 145
      <varlistentry>
        <term><option>-m</option> <replaceable>file</replaceable>,
           <option>--msgq-socket-file</option> <replaceable>file</replaceable></term>

        <listitem>
          <para>The UNIX domain socket file for the
	    <citerefentry><refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum></citerefentry>
            daemon to use.
            The default is
            <filename>/usr/local/var/bind10-devel/msg_socket</filename>.
<!-- @localstatedir@/@PACKAGE_NAME@/msg_socket -->
           </para>
146 147
         </listitem>
      </varlistentry>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
148

149 150 151 152 153 154 155 156 157 158 159
      <varlistentry>
        <term><option>-n</option>, <option>--no-cache</option></term>
        <listitem>
	  <para>Disables the hot-spot caching used by the
	    <citerefentry><refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	  daemon.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-u</option> <replaceable>user</replaceable>, <option>--user</option> <replaceable>name</replaceable></term>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
160
<!-- TODO: example more detail. -->
161 162 163 164 165 166 167 168
        <listitem>
          <para>The username for <command>bind10</command> to run as.
            <command>bind10</command> must be initially ran as the
            root user to use this option.
            The default is to run as the current user.</para>
         </listitem>
      </varlistentry>

169 170 171 172 173 174 175 176 177
      <varlistentry>
        <term><option>--pid-file</option> <replaceable>filename</replaceable></term>
        <listitem>
          <para>If defined, the PID of the <command>bind10</command> is stored
             in this file.
          </para>
         </listitem>
      </varlistentry>

Michal Vaner's avatar
Michal Vaner committed
178 179 180 181 182 183 184
      <varlistentry>
        <term><option>--pretty-name <replaceable>name</replaceable></option></term>

        <listitem>
          <para>The name this process should have in tools like
          <command>ps</command> or <command>top</command>. This
          is handy if you have multiple versions/installations
185 186 187 188 189
          of <command>bind10</command>.
<!-- TODO: only supported with setproctitle feature
The default is the basename of ARG 0.
-->
</para>
Michal Vaner's avatar
Michal Vaner committed
190 191 192
        </listitem>
      </varlistentry>

193 194 195 196 197
      <varlistentry>
        <term><option>-v</option>, <option>--verbose</option></term>
        <listitem>
	  <para>Display more about what is going on for
	  <command>bind10</command> and its child processes.</para>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
198
<!-- TODO: not true about all children yet -->
199 200
        </listitem>
      </varlistentry>
201

202 203 204
      <varlistentry>
        <term><option>-w</option> <replaceable>wait_time</replaceable>, <option>--wait</option> <replaceable>wait_time</replaceable></term>
        <listitem>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
205 206 207 208 209 210
	  <para>Sets the amount of time that BIND 10 will wait for
	  the configuration manager (a key component of BIND 10)
	  to initialize itself before abandoning the start up and
	  terminating with an error.  The
	  <replaceable>wait_time</replaceable> is specified in
	  seconds and has a default value of 10.
211 212 213 214
          </para>
        </listitem>
      </varlistentry>

215 216 217
    </variablelist>
  </refsect1>

218 219 220
<!--
TODO: configuration section
-->
221 222

  <refsect1>
223 224 225 226 227 228
    <title>CONFIGURATION AND COMMANDS</title>

    <para>
      The configuration provides settings for components for
      <command>bind10</command> to manage under
      <varname>/Boss/components/</varname>.
229
      The default elements are:
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
    </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/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>

264 265 266
    <para>
      (Note that the startup of <command>b10-sockcreator</command>,
      <command>b10-cfgmgr</command>, and <command>b10-msgq</command>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
267
      is not configurable. They are hardcoded and <command>bind10</command>
268 269 270
      will not run without them.)
    </para>

271
    <para>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
272
      The named sets for components contain the following settings:
273 274 275 276 277 278 279 280 281
    </para>

    <variablelist>

      <varlistentry>
        <term><varname>address</varname></term>
        <listitem>
	  <para>The name used for communicating to it on the message
	  bus.</para>
282 283 284 285 286 287
<!-- NOTE: vorner said:
These can be null, because the components are special ones, and
the special class there already knows the address. It is (I hope)
explained in the guide. I'd like to get rid of the special components
sometime and I'd like it to teach to guess the address.
-->
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
        </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>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
347
            This defines if the component is started a special, hardcoded
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
            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
sockcreator
xfrin
-->

</para>
        </listitem>
      </varlistentry>

    </variablelist>

<!-- TODO: formating -->
    <para>
      The <varname>Boss</varname> configuration commands are:
    </para>
<!-- TODO: let's just let bind10 be known as bind10 and not Boss -->

Jeremy C. Reed's avatar
Jeremy C. Reed committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
<!-- TODO -->
<!--
    <para>
      <command>drop_socket</command>
      This is an internal command and not exposed to the administrator.
    </para>
-->

<!-- TODO -->
<!--
    <para>
      <command>get_socket</command>
      This is an internal command and not exposed to the administrator.
    </para>
-->

390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
    <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>
432 433 434 435
    <title>STATISTICS DATA</title>

    <para>
      The statistics data collected by the <command>b10-stats</command>
436
      daemon for <quote>Boss</quote> include:
437 438 439 440 441
    </para>

    <variablelist>

      <varlistentry>
442
        <term>boot_time</term>
443 444 445 446 447 448 449 450 451 452 453
        <listitem><para>
          The date and time that the <command>bind10</command>
          process started.
          This is represented in ISO 8601 format.
        </para></listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

454 455
  <refsect1>
    <title>FILES</title>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
456 457 458 459 460 461
    <para><filename>sockcreator-XXXXXX/sockcreator</filename>
    &mdash;
    the Unix Domain socket located in a temporary file directory for
    <command>b10-sockcreator</command>
<!--    <citerefentry><refentrytitle>b10-sockcreator</refentrytitle><manvolnum>8</manvolnum></citerefentry> -->
    communication.
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>bindctl</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-auth</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-cfgmgr</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
481
        <refentrytitle>b10-msgq</refentrytitle><manvolnum>8</manvolnum>
482 483
      </citerefentry>,
      <citerefentry>
484
        <refentrytitle>b10-xfrin</refentrytitle><manvolnum>8</manvolnum>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
485
      </citerefentry>,
486 487 488 489 490 491
      <citerefentry>
        <refentrytitle>b10-xfrout</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>b10-zonemgr</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>,
Jeremy C. Reed's avatar
Jeremy C. Reed committed
492
      <citetitle>BIND 10 Guide</citetitle>.
493 494
    </para>
  </refsect1>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
495 496 497
<!-- <citerefentry>
        <refentrytitle>b10-sockcreator</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>, -->
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515

  <refsect1 id='history'><title>HISTORY</title>
    <para>The development of <command>bind10</command>
    was started in October 2009.</para>
  </refsect1>

  <refsect1>
    <title>AUTHORS</title>
    <para>
      The <command>bind10</command>
      daemon was initially designed by Shane Kerr of ISC.
    </para>
  </refsect1>
</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->