Commit 47a55c04 authored by Andrei Pavel's avatar Andrei Pavel

Style changes to documentation

parent f9cad784
<!-- Converted by db4-upgrade version 1.0 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="admin"><info><title>Kea Database Administration</title></info>
<section xml:id="kea-database-version"><info><title>Databases and Database Version Numbers</title></info>
<para>
Kea supports storing leases and host reservations (i.e. static
assignments of addresses, prefixes and options) in one of
......@@ -13,7 +10,7 @@
For example, Kea currently only stores lease information
and host reservations. Future versions of Kea will store
additional data such as subnet definitions: the database
structure will need to be updated to accomdate the extra
structure will need to be updated to accommodate the extra
information.
</para>
......@@ -48,8 +45,6 @@
</section>
<section xml:id="kea-admin"><info><title>The kea-admin Tool</title></info>
<para>
To manage the databases, Kea provides the
<command>kea-admin</command> tool. It is able to initialize
......@@ -67,7 +62,7 @@
<listitem>
<simpara>
<command>lease-init</command>
Initializes a new lease database. This is useful during a new
Initializes a new lease database. This is useful during a new
Kea installation. The database is initialized to the
latest version supported by the version of the software being
installed.
......@@ -145,29 +140,27 @@
</section>
<section xml:id="supported-databases"><info><title>Supported Databases</title></info>
<para>The following table presents the capabilities of available
backends. Please refer to the specific sections dedicated to each backend to
better understand their capabilities and limitations. Choosing the right
backend may be essential for success or failure of your deployment.</para>
<para>
<table frame="all" xml:id="backends"><info><title>List of available backends</title></info>
<tgroup cols="2">
<colspec colname="feature"/>
<colspec colname="memfile"/>
<colspec colname="mysql"/>
<colspec colname="pgsql"/>
<colspec colname="cql"/>
<table frame="all" id="backends">
<title>List of available backends</title>
<tgroup cols='5'>
<colspec colname='feature'/>
<colspec colname='memfile'/>
<colspec colname='mysql'/>
<colspec colname='pgsql'/>
<colspec colname='cql' colwidth='1.5*'/>
<thead>
<row>
<entry>Feature</entry>
<entry>Memfile</entry>
<entry>MySQL</entry>
<entry>PostgreSQL</entry>
<entry>CQL(Cassandra)</entry>
<entry>CQL (Cassandra)</entry>
</row>
</thead>
<tbody>
......@@ -201,7 +194,7 @@
<entry>no</entry>
<entry>yes</entry>
<entry>yes</entry>
<entry>no</entry>
<entry>yes</entry>
</row>
<row>
......@@ -209,7 +202,7 @@
<entry>no</entry>
<entry>yes</entry>
<entry>yes</entry>
<entry>no</entry>
<entry>yes</entry>
</row>
</tbody>
......@@ -218,8 +211,6 @@
</para>
<section><info><title>memfile</title></info>
<para>
The memfile backend is able to store lease information, but is not able to
store host reservation details: these must be stored in the configuration
......@@ -236,7 +227,6 @@
</para>
<section xml:id="memfile-upgrade"><info><title>Upgrading Memfile Lease Files from an Earlier Version of Kea</title></info>
<para>
There are no special steps required to upgrade memfile lease files
from an earlier version of Kea to a new version of Kea.
......@@ -260,8 +250,6 @@
</section>
<section><info><title>MySQL</title></info>
<para>
MySQL is able to store leases, host reservations and options defined on
a per host basis. This section can be safely ignored
......@@ -269,8 +257,6 @@
</para>
<section xml:id="mysql-database-create"><info><title>First Time Creation of the MySQL Database</title></info>
<para>
If you are setting the MySQL database for the first time,
you need to create the database area within MySQL and set up
......@@ -367,8 +353,6 @@ $ <userinput>kea-admin lease-init mysql -u <replaceable>database-user</replaceab
</section>
<section xml:id="mysql-upgrade"><info><title>Upgrading a MySQL Database from an Earlier Version of Kea</title></info>
<para>
Sometimes a new Kea version may use newer database schema, so
there will be a need to upgrade the existing database. This can
......@@ -401,17 +385,15 @@ $ <userinput>kea-admin lease-upgrade mysql -u <replaceable>database-user</replac
</section> <!-- end of MySQL sections -->
<section><info><title>PostgreSQL</title></info>
<para>
PostgreSQL is able to store leases, host reservations and options
defined on a per host basis.
A PostgreSQL database must be set up if you want Kea to store
lease and other information in PostgreSQL. This step can be
safely ignored if you are using other database backends.
</para>
<section xml:id="pgsql-database-create"><info><title>First Time Creation of the PostgreSQL Database</title></info>
<para>
The first task is to create both the lease database and the
user under which the servers will access it. A number of steps
......@@ -542,7 +524,6 @@ host <replaceable>database-name</replaceable> <replaceable>user-name</repl
</section>
<section><info><title>Initialize the PostgreSQL Database Using kea-admin</title></info>
<para>
If you elected not to create the tables manually, you can do
so now by running the <command>kea-admin</command> tool:
......@@ -559,7 +540,6 @@ $ <userinput>kea-admin lease-init pgsql -u <replaceable>database-user</replaceab
</para>
</section>
<section xml:id="pgsql-upgrade"><info><title>Upgrading a PostgreSQL Database from an Earlier Version of Kea</title></info>
<para>
The PostgreSQL database schema can be upgraded using the same tool and
commands as described in <xref linkend="mysql-upgrade"/>, with the
......@@ -580,15 +560,13 @@ $ <userinput>kea-admin lease-upgrade pgsql -u <replaceable>database-user</replac
</section> <!-- end of PostgreSQL sections -->
<section><info><title>CQL (Cassandra)</title></info>
<para>
Cassandra, or Cassandra Query Language (CQL), is the newest backend
added to Kea. Since it was added recently and has not undergone as much
testing as other backends, it is considered experimental: please use
with caution. The CQL backend is currently able to store leases only. The
ability to store host reservations will likely be added some time in the
future.
with caution. The CQL backend is currently able to store leases only.
The ability to store host reservations will likely be added some time in
the future.
</para>
<para>
......@@ -598,8 +576,6 @@ $ <userinput>kea-admin lease-upgrade pgsql -u <replaceable>database-user</replac
</para>
<section xml:id="cql-database-create"><info><title>First Time Creation of the Cassandra Database</title></info>
<para>
If you are setting up the CQL database for the first time, you need to
create the keyspace area within CQL. This needs to be done manually:
......@@ -611,7 +587,7 @@ $ <userinput>kea-admin lease-upgrade pgsql -u <replaceable>database-user</replac
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>
Export CQLSH_HOST environemnt variable:
Export CQLSH_HOST environment variable:
<screen>
$ <userinput>export CQLSH_HOST=localhost</userinput>
</screen>
......@@ -670,8 +646,6 @@ $ <userinput>kea-admin lease-init cql -n <replaceable>database-name</replaceable
</section>
<section xml:id="cql-upgrade"><info><title>Upgrading a CQL Database from an Earlier Version of Kea</title></info>
<para>
Sometimes a new Kea version may use newer database schema, so
there will be a need to upgrade the existing database. This can
......@@ -704,20 +678,17 @@ $ <userinput>kea-admin lease-upgrade cql -n <replaceable>database-name</replacea
</section> <!-- end of CQL sections -->
<section><info><title>Using Read-Only Databases with Host Reservations</title></info>
<para>If a read-only database is used for storing host reservations,
Kea must be explicitly configured to operate on the database in
read-only mode.
Sections <xref linkend="read-only-database-configuration4"/> and
<xref linkend="read-only-database-configuration6"/> describe when
such configuration may be reqired and how to configure Kea to
such configuration may be required and how to configure Kea to
operate using a read-only host database.
</para>
</section>
<section><info><title>Limitations Related to the use of SQL Databases</title></info>
<para>
The lease expiration time is stored in the SQL database for each lease
as a timestamp value. Kea developers observed that MySQL database doesn't
......
<!-- Converted by db4-upgrade version 1.0 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="classify"><info><title>Client Classification</title></info>
<section><info><title>Client Classification Overview</title></info>
<para>
In certain cases it is useful to differentiate between different
types of clients and treat them accordingly. Common reasons include:
......@@ -91,7 +89,6 @@
</section>
<section xml:id="classification-using-host-reservations"><info><title>Using Static Host Reservations In Classification</title></info>
<para>Classes can be statically assigned to the clients using techniques described
in <xref linkend="reservation4-client-classes"/> and
<xref linkend="reservation6-client-classes"/>.
......@@ -99,7 +96,6 @@
</section>
<section xml:id="classification-using-vendor"><info><title>Using Vendor Class Information In Classification</title></info>
<para>
The server checks whether an incoming DHCPv4 packet includes
the vendor class identifier option (60) or an incoming DHCPv6 packet
......@@ -112,7 +108,6 @@
</section>
<section xml:id="classification-using-expressions"><info><title>Using Expressions In Classification</title></info>
<para>
The expression portion of classification contains operators and values.
All values are currently strings and operators take a string or strings and
......@@ -148,7 +143,6 @@
<para>
<table frame="all" xml:id="classification-values-list"><info><title>List of Classification Values</title></info>
<tgroup cols="3">
<colspec colname="name"/>
<colspec colname="example"/>
......@@ -544,7 +538,6 @@
<para>
<table frame="all" xml:id="classification-expressions-list"><info><title>List of Classification Expressions</title></info>
<tgroup cols="3">
<colspec colname="name"/>
<colspec colname="example"/>
......@@ -570,7 +563,6 @@ concatenation of the strings</entry></row>
</para>
<section><info><title>Logical operators</title></info>
The Not, And and Or logical operators are the common operators. Not
has the highest precedence and Or the lowest. And and Or are (left)
associative, parentheses around a logical expression can be used
......@@ -579,7 +571,6 @@ concatenation of the strings</entry></row>
</section>
<section><info><title>Substring</title></info>
The substring operator "substring(value, start, length)" accepts both positive and
negative values for the starting position and the length. For "start", a value of
0 is the first byte in the string while -1 is the last byte. If the starting
......@@ -602,7 +593,6 @@ concatenation of the strings</entry></row>
</screen>
</section>
<section><info><title>Concat</title></info>
The concat function "concat(string1, string2)" returns the
concatenation of its two arguments. For instance:
<screen>
......@@ -620,7 +610,6 @@ concatenation of the strings</entry></row>
</para> </note>
<section xml:id="classification-configuring"><info><title>Configuring Classes</title></info>
<para>
A class contains three items: a name, a test expression and option data.
The name must exist and must be unique amongst all classes. The test
......@@ -696,7 +685,6 @@ concatenation of the strings</entry></row>
</section>
<section xml:id="classification-subnets"><info><title>Configuring Subnets With Class Information</title></info>
<para>
In certain cases it beneficial to restrict access to certain subnets
only to clients that belong to a given class, using the "client-class"
......@@ -776,7 +764,6 @@ concatenation of the strings</entry></row>
</section>
<section><info><title>Using Classes</title></info>
<para>
Currently classes can be used for two functions. They can supply options
to the members of the class and they can be used to choose a subnet from which an
......@@ -792,7 +779,6 @@ concatenation of the strings</entry></row>
</section>
<section><info><title>Classes and Hooks</title></info>
<para>
You may use a hook to classify your packets. This may be useful if the
expression would either be complex or time consuming and be easier or
......@@ -806,7 +792,6 @@ concatenation of the strings</entry></row>
</section>
<section><info><title>Debugging Expressions</title></info>
<para>
While you are constructing your classification expressions you may
find it useful to enable logging see <xref linkend="logging"/> for
......@@ -814,7 +799,7 @@ concatenation of the strings</entry></row>
</para>
<para>
To enable the debug statements in the classifciaton system you will
To enable the debug statements in the classification system you will
need to set the severity to "DEBUG" and the debug level to at least 55.
The specific loggers are "kea-dhcp4.eval" and "kea-dhcp6.eval".
</para>
......
<!-- Converted by db4-upgrade version 1.0 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="kea-config"><info><title>Kea Configuration</title></info>
<para>Kea is using JSON structures to handle configuration. Previously
we there was a concept of other configuration backends, but that never was
implemented and the idea was abandoned.</para>
<section xml:id="json"><info><title>JSON Configuration</title></info>
<para>JSON is notation used throughout the Kea project. The most obvious
usage is for configuration file, but it is also used for sending commands
over Management API (see <xref linkend="ctrl-channel"/>) and for
......@@ -19,7 +17,6 @@
configuration file is specified upon startup using the -c parameter.</para>
<section xml:id="json-format"><info><title>JSON Syntax</title></info>
<para>Configuration files for DHCPv4, DHCPv6 and DDNS modules are defined
in an extended JSON format. Basic JSON is defined in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://tools.ietf.org/html/rfc7159">RFC 7159</link>. Note that Kea
1.2 introduces a new parser that is better at following the JSON spec. In
......@@ -32,27 +29,23 @@
<itemizedlist>
<listitem>
<simpara>shell comments: any text after the hash (#)
character is ignored. Dhcp6 allows # in any column, while
Dhcp4 and Ddns require hash to be in the first
column.</simpara>
character is ignored. Both Dhcp4 and Dhcp6 allow # in any column,
while Ddns requires hash to be in the first column.</simpara>
</listitem>
<listitem>
<simpara>C comments: any text after the double slashes (//)
character is ignored. We're in a process of
migrating the configuation parsers and currently only Dhcp6
supports this feature.</simpara>
character is ignored. Both Dhcp4 and Dhcp6 supports this
feature.</simpara>
</listitem>
<listitem>
<simpara>Multiline comments: any text between /* and */ is
ignored. This commenting can span multiple lines. We're in a
process of migrating the configuation parsers and currently
only Dhcp6 supports this feature.</simpara>
ignored. This commenting can span multiple lines. Both Dhcp4 and
Dhcp6 supports this feature.</simpara>
</listitem>
<listitem>
<simpara>File inclusion: JSON files can include other JSON
files. This can be done by using &lt;?include
"file.json"?&gt;. We're in a process of migrating the
configuation parsers and currently only Dhcp6 supports this
"file.json"?&gt;. Both Dhcp4 and Dhcp6 supports this
feature.</simpara>
</listitem>
</itemizedlist>
......@@ -134,8 +127,6 @@
</section>
<section><info><title>Simplified Notation</title></info>
<para>It is sometimes convenient to refer to a specific element in the
configuration hierarchy. Each hierarchy level is separated by a slash.
If there is an array, a specific instance within that array is referenced by
......
<!-- Converted by db4-upgrade version 1.0 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="ctrl-channel"><info><title>Management API</title></info>
<para>A classic approach to daemon configuration assumes that
the server's configuration is stored in configuration files
......@@ -27,7 +26,6 @@
</para>
<section xml:id="ctrl-channel-syntax"><info><title>Data Syntax</title></info>
<para>Communication over the control channel is conducted using JSON
structures. If configured, Kea will open a socket and listen
for incoming connections. A process connecting to this socket
......@@ -74,8 +72,6 @@
</section>
<section xml:id="ctrl-channel-client"><info><title>Using the Control Channel</title></info>
<para>Kea does not currently provide a client for using the control channel. The primary
reason for this is the expectation is that the entity using the control channel
is typically an IPAM or similar network management/monitoring software which
......@@ -96,17 +92,14 @@ where <command>/path/to/the/kea/socket</command> is the path specified in the
configuration file. Text passed to <command>socat</command>
will be sent to Kea and the responses received from Kea printed to standard output.</para>
<para>It is also easy to open UNIX socket programmatically. An example of
<para>It is also easy to open UNIX socket programatically. An example of
such a simplistic client written in C is available in the Kea Developer's
Guide, chapter Control Channel Overview, section Using Control Channel.</para>
</section>
<section xml:id="commands-common"><info><title>Commands Supported by Both the DHCPv4 and DHCPv6 Servers</title></info>
<section xml:id="command-leases-reclaim"><info><title>leases-reclaim</title></info>
<para>
<emphasis>leases-reclaim</emphasis> command instructs the server to
reclaim all expired leases immediately. The command has the following
......@@ -133,8 +126,6 @@ will be sent to Kea and the responses received from Kea printed to standard outp
</section>
<section xml:id="command-list-commands"><info><title>list-commands</title></info>
<para>
The <emphasis>list-commands</emphasis> command retrieves a list of all
commands supported by the server. It does not take any arguments.
......@@ -154,8 +145,6 @@ will be sent to Kea and the responses received from Kea printed to standard outp
</section> <!-- end of command-list-commands -->
<section xml:id="command-shutdown"><info><title>shutdown</title></info>
<para>
The <emphasis>shutdown</emphasis> command instructs the server to initiate
its shutdown procedure. It is the equivalent of sending a SIGTERM signal
......
<!-- Converted by db4-upgrade version 1.0 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="dhcp-ddns-server"><info><title>The DHCP-DDNS Server</title></info>
<para>
The DHCP-DDNS Server (kea-dhcp-ddns, known informally as D2) conducts the client side of
the DDNS protocol (defined in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://tools.ietf.org/html/rfc2136">RFC 2136</link>)
......@@ -45,8 +45,6 @@
simply disregard the reverse update portion of requests.
</para>
<section xml:id="dhcp-ddns-server-start-stop"><info><title>Starting and Stopping the DHCP-DDNS Server</title></info>
<para>
<command>kea-dhcp-ddns</command> is the Kea DHCP-DDNS server
and, due to the nature of DDNS, it is run alongside either the
......@@ -145,7 +143,6 @@ strings <userinput>path</userinput>/kea-dhcp-ddns | sed -n 's/;;;; //p'
</section> <!-- end start-stop -->
<section xml:id="d2-configuration"><info><title>Configuring the DHCP-DDNS Server</title></info>
<para>
Before starting <command>kea-dhcp-ddns</command> module for the
first time, a configuration file needs to be created. The following default
......@@ -194,7 +191,6 @@ strings <userinput>path</userinput>/kea-dhcp-ddns | sed -n 's/;;;; //p'
</listitem>
</itemizedlist>
<section xml:id="d2-server-parameter-config"><info><title>Global Server Parameters</title></info>
<itemizedlist>
<listitem><simpara>
......@@ -260,7 +256,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
</section> <!-- "d2-server-parameter-config" -->
<section xml:id="d2-tsig-key-list-config"><info><title>TSIG Key List</title></info>
<para>
A DDNS protocol exchange can be conducted with or without TSIG
(defined in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://tools.ietf/org/html/rfc2845">RFC
......@@ -387,7 +382,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
<!-- "d2-tsig-key-list-config" -->
<section xml:id="d2-forward-ddns-config"><info><title>Forward DDNS</title></info>
<para>
The Forward DDNS section is used to configure D2's forward update
behavior. Currently it contains a single parameter, the catalog of
......@@ -405,7 +399,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
the forward update portions of requests.
</para>
<section xml:id="add-forward-ddns-domain"><info><title>Adding Forward DDNS Domains</title></info>
<para>
A forward DDNS Domain maps a forward DNS zone to a set of
DNS servers which maintain the forward DNS data (i.e. name to
......@@ -476,7 +469,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
</para>
<section xml:id="add-forward-dns-servers"><info><title>Adding Forward DNS Servers</title></info>
<para>
This section describes how to add DNS servers to a Forward DDNS Domain.
Repeat them for as many servers as desired for a each domain.
......@@ -545,7 +537,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
</section> <!-- "d2-forward-ddns-config" -->
<section xml:id="d2-reverse-ddns-config"><info><title>Reverse DDNS</title></info>
<para>
The Reverse DDNS section is used to configure D2's reverse update
behavior, and the concepts are the same as for the forward DDNS
......@@ -563,7 +554,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
the reverse update portions of requests.
</para>
<section xml:id="add-reverse-ddns-domain"><info><title>Adding Reverse DDNS Domains</title></info>
<para>
A reverse DDNS Domain maps a reverse DNS zone to a set of DNS
servers which maintain the reverse DNS data (address to name
......@@ -642,7 +632,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
</para>
<section xml:id="add-reverse-dns-servers"><info><title>Adding Reverse DNS Servers</title></info>
<para>
This section describes how to add DNS servers to a Reverse DDNS Domain.
Repeat them for as many servers as desired for each domain.
......@@ -711,15 +700,13 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
</section> <!-- "d2-reverse-ddns-config" -->
<section xml:id="d2-exmaple-config"><info><title>Example DHCP-DDNS Server Configuration</title></info>
<section xml:id="d2-example-config"><info><title>Example DHCP-DDNS Server Configuration</title></info>
<para>
This section provides an example DHCP-DDNS server configuration based
on a small example network. Let's suppose our example network has
three domains, each with their own subnet.
<table><info><title>Our example network</title></info>
<tgroup cols="4" align="left">
<colspec colname="domain"/>
<colspec colname="subnet"/>
......@@ -759,7 +746,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
<para>
We need to construct three forward DDNS Domains:
<table><info><title>Forward DDNS Domains Needed</title></info>
<tgroup cols="3" align="left">
<colspec colname="num"/>
<colspec colname="name"/>
......@@ -835,7 +821,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
<para>
Similarly, we need to construct the three reverse DDNS Domains:
<table><info><title>Reverse DDNS Domains Needed</title></info>
<tgroup cols="3" align="left">
<colspec colname="num"/>
<colspec colname="DDNS Domain name"/>
......@@ -908,7 +893,6 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
</section> <!-- end of "d2-example" -->
</section> <!-- end of section "d2-configuration" -->
<section><info><title>DHCP-DDNS Server Limitations</title></info>
<para>The following are the current limitations of the DHCP-DDNS Server.</para>
<itemizedlist>
<listitem>
......
This diff is collapsed.
This diff is collapsed.
<!-- Converted by db4-upgrade version 1.0 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="faq"><info><title>Frequently Asked Questions</title></info>
<para>This chapter contains a number of frequently asked questions and
troubleshooting tips. It currently lacks content, but it is expected to grow
......@@ -13,20 +12,14 @@
it in the known issues list. -->
<section xml:id="faq-generic"><info><title>General Frequently Asked Questions</title></info>
<section xml:id="q1-generic"><info><title>Where did the Kea name came from?</title></info>
<para>Kea is the name of a high mountain parrot living in New Zealand.
See this <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://lists.isc.org/pipermail/kea-users/2014-October/000032.html">https://lists.isc.org/pipermail/kea-users/2014-October/000032.html</uri>
for an extended answer.</para>
</section>
<section xml:id="q2-generic"><info><title>Feature X is not supported yet. When/if will it be available?</title></info>
<para>Kea is developed by a small team of engineers. Our resources are
limited, so we need to prioritize requests. The complexity of a new
feature (how difficult it is to implement a feature and how likely it
......@@ -84,11 +77,8 @@
</section>
<section xml:id="faq-dhcp4"><info><title>Frequently Asked Questions about DHCPv4</title></info>
<section iq="q1-dhcp4"><info><title>I set up a firewall, but the Kea server still receives the traffic. Why?</title></info>
<para>Any DHCPv4 server must be able to receive from and send traffic to
hosts that don't have an IPv4 address assigned yet. That is typically not
possible with regular UDP sockets, therefore the Kea DHCPv4 server uses raw
......@@ -107,12 +97,9 @@
</section> <!-- end of DHCPv4 FAQ section -->
<section xml:id="faq-dhcp6"><info><title>Frequently Asked Questions about DHCPv6</title></info>
<section iq="q1-dhcp6"><info><title>Kea DHCPv6 doesn't seem to get incoming traffic. I checked with tcpdump (or other traffic
capture software) that the incoming traffic is reaching the box. What's wrong?</title></info>
<para>Please check whether your OS has any IPv6 filtering rules. Many
operating systems are shipped with firewalls that discard incoming IPv6
traffic by default. In particular, many Linux distributions do that. Please
......@@ -126,5 +113,4 @@
</section> <!-- end of DHCPv6 FAQ section -->
</chapter>
\ No newline at end of file
<!-- Converted by db4-upgrade version 1.0 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="hooks-libraries"><info><title>Hooks Libraries</title></info>
<section xml:id="hooks-libraries-introduction"><info><title>Introduction</title></info>
<para>
Although Kea offers a lot of flexibility, there may be cases where
its behavior needs customisation. To accommodate this possibility,
......@@ -34,8 +34,8 @@
Developer's Guide</link>.
</para>
</section> <!-- end Introduction -->
<section><info><title>Configuring Hooks Libraries</title></info>
<para>
The hooks libraries for a given process are configured using the
<command>hooks-libraries</command> keyword in the
......@@ -135,7 +135,6 @@
</section>
<section><info><title>Available Hooks Libraries</title></info>
<para>
As described above, the hooks functionality provides a way to customize
a Kea server without modifying the core code. ISC has chosen to take
......@@ -158,7 +157,6 @@
<para>Currently the following libraries are available or planned from ISC:
<table frame="all" xml:id="hook-libs"><info><title>List of available hooks libraries</title></info>
<tgroup cols="3">
<colspec colname="name"/>
<colspec colname="avail"/>
......@@ -238,8 +236,8 @@
listed there, please send a note to the kea-users or kea-dev
mailing lists and someone will update it.
</para>
<section><info><title>user_chk: Checking User Access</title></info>
<para>
The user_chk library is the first hooks library published by ISC. It
attempts to serve several purposes:
......@@ -265,7 +263,7 @@
</itemizedlist>
</para>
<para>
Once loaded, the library allows segregating incomings requests into
Once loaded, the library allows segregating incoming requests into
known and unknown clients. For known clients, the packets are
processed mostly as usual, except it is possible to override certain
options being sent. That can be done on a per host basis. Clients
......@@ -300,7 +298,7 @@
is "HW_ADDR" for IPv4 users or "DUID" for IPv6
users</para></listitem>
<listitem><para><command>id</command>, whose value is
either the hardware address or the DUID from the equest
either the hardware address or the DUID from the request
formatted as a string of hex digits, with or without
":" delimiters.</para></listitem>
</itemizedlist>
......@@ -330,13 +328,12 @@ and may have the zero or more of the following entries:
our general entries in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://jenkins.isc.org/job/Fedora20_32_doxygen_doc/doxygen/">Hooks
Framework section</link> should give you some pointers how to extend
this library and perhaps even write your own from scratch.</para>
</section>
<section><info><title>Forensic Logging Hooks</title></info>
<para>
This section describes the forensic log hooks library. This library
povides hooks that record a detailed log of lease assignments
provides hooks that record a detailed log of lease assignments
and renewals into a set of log files. Currently this library
is only available to ISC customers with a support contract.
</para>
......@@ -356,8 +353,8 @@ and may have the zero or more of the following entries:
features those users who don't need to log this information can
</