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

[jreed-docs] update zonemgr manual to catch up on changed configurations.

This removed deprecated setting.
This should have been done when code was committed.

TODO: This still needs docs explaining the jitter features.
parent 938eb7ec
......@@ -2,12 +2,12 @@
.\" Title: b10-zonemgr
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: October 18, 2010
.\" Date: May 19, 2011
.\" Manual: BIND10
.\" Source: BIND10
.\" Language: English
.\"
.TH "B10\-ZONEMGR" "8" "October 18, 2010" "BIND10" "BIND10"
.TH "B10\-ZONEMGR" "8" "May 19, 2011" "BIND10" "BIND10"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
......@@ -46,11 +46,6 @@ receives its configurations from
The configurable settings are:
.PP
\fIjitter_scope\fR
defines the random jitter range subtracted from the refresh and retry timers to avoid many zones from refreshing at the same time\&. The refresh or retry time actually used is a random time between the defined refresh or retry time and it multiplied by the
\fIjitter_scope\fR\&. This is re\-evaluated after each refresh or retry\&. This value is a real number and the maximum is 0\&.5 (half of the refresh or retry time)\&. The default is 0\&.25\&. Set to 0 to disable the jitter\&.
.PP
\fIlowerbound_refresh\fR
defines the minimum SOA REFRESH time in seconds\&. The default is 10\&.
.PP
......@@ -59,10 +54,38 @@ defines the minimum SOA REFRESH time in seconds\&. The default is 10\&.
defines the minimum SOA RETRY time in seconds\&. The default is 5\&.
.PP
\fIrefresh_jitter\fR
This value is a real number\&. The maximum amount is 0\&.5\&. The default is 0\&.25\&.
.PP
\fIreload_jitter\fR
This value is a real number\&. The default is 0\&.75\&.
.PP
\fImax_transfer_timeout\fR
defines the maximum amount of time in seconds for a transfer\&.
The default is 14400 (4 hours)\&.
.PP
\fIsecondary_zones\fR
is a list of slave zones that the
\fBb10\-zonemgr\fR
should keep timers for\&. The list item is the
\fIsecondary_zone\fR
which defines the
\fIclass\fR
(which defaults to
\(lqIN\(rq) and the
\fIname\fR
which contains the zone name\&.
.PP
(A deprecated configuration is
\fIjitter_scope\fR
which is superceded by
\fIrefresh_jitter\fR
and
\fIreload_jitter\fR\&.)
.PP
The configuration commands are:
.PP
......@@ -107,5 +130,5 @@ The
daemon was designed in July 2010 by CNNIC for the ISC BIND 10 project\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2010 Internet Systems Consortium, Inc. ("ISC")
Copyright \(co 2010-2011 Internet Systems Consortium, Inc. ("ISC")
.br
......@@ -2,7 +2,7 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY mdash "&#8212;">]>
<!--
- Copyright (C) 2010 Internet Systems Consortium, Inc. ("ISC")
- Copyright (C) 2010-2011 Internet Systems Consortium, Inc. ("ISC")
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
......@@ -20,7 +20,7 @@
<refentry>
<refentryinfo>
<date>October 18, 2010</date>
<date>May 19, 2011</date>
</refentryinfo>
<refmeta>
......@@ -36,7 +36,7 @@
<docinfo>
<copyright>
<year>2010</year>
<year>2010-2011</year>
<holder>Internet Systems Consortium, Inc. ("ISC")</holder>
</copyright>
</docinfo>
......@@ -92,6 +92,39 @@
<para>
The configurable settings are:
</para>
<para>
<varname>lowerbound_refresh</varname>
defines the minimum SOA REFRESH time in seconds.
The default is 10.
</para>
<para>
<varname>lowerbound_retry</varname>
defines the minimum SOA RETRY time in seconds.
The default is 5.
</para>
<para>
<varname>refresh_jitter</varname>
This value is a real number.
The maximum amount is 0.5.
The default is 0.25.
</para>
<!-- TODO: needs to be documented -->
<!-- TODO: Set to 0 to disable the jitter. -->
<para>
<varname>reload_jitter</varname>
This value is a real number.
The default is 0.75.
</para>
<!-- TODO: needs to be documented -->
<!-- TODO: Set to 0 to disable the jitter. -->
<!-- what does 0 do? -->
<!-- TODO: no max? -->
<!-- TODO: remove this. This is old removed config
<para>
<varname>jitter_scope</varname>
defines the random jitter range subtracted from the refresh
......@@ -106,16 +139,8 @@
The default is 0.25.
Set to 0 to disable the jitter.
</para>
<para>
<varname>lowerbound_refresh</varname>
defines the minimum SOA REFRESH time in seconds.
The default is 10.
</para>
<para>
<varname>lowerbound_retry</varname>
defines the minimum SOA RETRY time in seconds.
The default is 5.
</para>
-->
<para>
<varname>max_transfer_timeout</varname>
defines the maximum amount of time in seconds for a transfer.
......@@ -123,6 +148,22 @@
The default is 14400 (4 hours).
</para>
<!-- TODO: this duplicates list in Xfrin too -->
<para>
<varname>secondary_zones</varname> is a list of slave zones
that the <command>b10-zonemgr</command> should keep timers for.
The list item is the <varname>secondary_zone</varname>
which defines the <varname>class</varname> (which defaults to
<quote>IN</quote>) and the <varname>name</varname> which contains
the zone name.
</para>
<para>
(A deprecated configuration is <varname>jitter_scope</varname>
which is superceded by <varname>refresh_jitter</varname>
and <varname>reload_jitter</varname>.)
</para>
<!-- TODO: formating -->
<para>
The configuration commands are:
......
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