kea/doc/guide/intro.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY mdash  "&#x2014;" >
<!ENTITY % version SYSTEM "version.ent">
%version;
]>

  <chapter id="intro">
    <title>Introduction</title>
    <para>
      Kea is the next generation of DHCP software developed by ISC.
      It supports both DHCPv4 and DHCPv6 protocols along with their
      extensions, e.g. prefix delegation and dynamic updates to DNS.
    </para>

    <para>
      Kea was initially developed as a part of the BIND 10 framework.
      In early 2014, ISC made the decision to discontinue active
      development of BIND 10 and continue development of Kea as
      standalone DHCP software.
    </para>

    <para>
      This guide covers Kea version &__VERSION__;.
    </para>

    <section>
      <title>Supported Platforms</title>
      <para>
        Kea is officially supported on Red Hat Enterprise Linux,
	    CentOS, Fedora and FreeBSD systems. It is also likely to work on many
	    other platforms: Kea 1.1.0 builds have been tested on (in no
        particular order) Red Hat Enteprise Linux 6.4, Debian GNU/Linux 7,
        Ubuntu 12.04, Ubuntu 14.04, Ubuntu 16.04, Fedora Linux 19,
        Fedora 20, Fedora 22, CentOS Linux 7, NetBSD 6, FreeBSD 10.3,
        OpenBSD 5.7, OpenBSD 6.0, OS X 10.10, OS X 10.11.
      </para>
      <para>There are currently no plans to port Kea to Windows platforms.</para>
    </section>

    <section id="required-software">
      <title>Required Software at Run-time</title>

      <para>
        Running Kea uses various extra software which may
        not be provided in the default installation of some operating systems,
        nor in the standard package collections. You may
        need to install this required software separately.
        (For the build requirements, also see
        <xref linkend="build-requirements"/>.)
      </para>

      <itemizedlist>

        <listitem>
            <simpara>
        Kea supports two cryptographic libraries: Botan and OpenSSL. Only one of
        them is required to be installed during compilation. If using Botan, Kea
        requires the Botan cryptographic library for C++ (<ulink
        url="http://botan.randombit.net/"/>), version 1.8, 1.9 or 1.10. If
        OpenSSL is used, (<ulink url="http://www.openssl.org/"/>), then Kea
        requires the OpenSSL C++ library version 1.0.*. Support for later
        versions of Botan and OpenSSL will be added in future releases of Kea.
            </simpara>
        </listitem>

        <listitem>
            <simpara>
        Kea uses the log4cplus C++ logging library
        (<ulink url="http://log4cplus.sourceforge.net/"/>).
        It requires log4cplus version 1.0.3 or later.
            </simpara>
        </listitem>

        <listitem>
            <simpara>
	In order to store lease information in a MySQL database, Kea requires MySQL
    headers and libraries.  This is an optional dependency in that Kea can be
    built without MySQL support.
            </simpara>
        </listitem>

        <listitem>
            <simpara>
	In order to store lease information in a PostgreSQL database, Kea requires PostgreSQL
    headers and libraries.  This is an optional dependency in that Kea can be
    built without PostgreSQL support.
            </simpara>
        </listitem>

        <listitem>
            <simpara>
	In order to store lease information in a Cassandra  database (CQL), Kea
    requires Cassandra headers and libraries. This is an optional dependency
    in that Kea can be built without Cassandra support.
            </simpara>
        </listitem>
      </itemizedlist>
    </section>

    <section id="kea_software">
      <title>Kea Software</title>
      <para>
        Kea is modular.  Part of this modularity is
        accomplished using multiple cooperating processes which, together,
        provide the server functionality.
        The following software is included with Kea:
      </para>

      <para>

        <itemizedlist>

          <listitem>
            <simpara>
              <command>keactrl</command> &mdash;
              Tool to start, stop, reconfigure, and report status
              for the Kea servers.
            </simpara>
          </listitem>

          <listitem>
            <simpara>
              <command>kea-dhcp4</command> &mdash;
              The DHCPv4 server process.
              This process responds to DHCPv4 queries from clients.
            </simpara>
          </listitem>

          <listitem>
            <simpara>
              <command>kea-dhcp6</command> &mdash;
              The DHCPv6 server process.
              This process responds to DHCPv6 queries from clients.
            </simpara>
          </listitem>

          <listitem>
            <simpara>
              <command>kea-dhcp-ddns</command> &mdash;
              The DHCP Dynamic DNS process.
              This process acts as an intermediary between the DHCP servers
              and DNS servers. It receives name update requests from the DHCP
              servers and sends DNS Update messages to the DNS servers.
            </simpara>
          </listitem>

          <listitem>
            <simpara>
              <command>kea-admin</command> &mdash;
              A useful tool for database backend maintenance (creating a new
              database, checking versions, upgrading etc.)
            </simpara>
          </listitem>

          <listitem>
            <simpara>
              <command>kea-lfc</command> &mdash;
              This process removes redundant information from the files used
              to provide persistent storage for the memfile data base backend.
              While it can be run standalone, it is normally run as and when 
              required by the Kea DHCP servers.
            </simpara>
          </listitem>

          <listitem>
            <simpara>
              <command>perfdhcp</command> &mdash;
              A DHCP benchmarking tool which simulates multiple clients to
              test both DHCPv4 and DHCPv6 server performance.
            </simpara>
          </listitem>

        </itemizedlist>
      </para>

    </section>

    <para>
      The tools and modules are covered in full detail in this guide.
<!-- TODO point to these -->
      In addition, manual pages are also provided in the default installation.
    </para>

    <para>
      Kea also provides C++ libraries and programmer interfaces for
      DHCP.  These include detailed developer documentation and
      code examples.
<!-- TODO point to this -->
    </para>

  </chapter>