From cf1ea90a67a42ee425c644ef0ee4f5b61dbb37fc Mon Sep 17 00:00:00 2001 From: Stephen Morris Date: Tue, 17 Jun 2014 16:12:02 +0100 Subject: [PATCH] [3418] Updated the Introduction as part of the review --- doc/guide/intro.xml | 66 ++++++++++++++++++++++++++------------------- 1 file changed, 38 insertions(+), 28 deletions(-) diff --git a/doc/guide/intro.xml b/doc/guide/intro.xml index 8d6e38e45b..1e30421aa1 100644 --- a/doc/guide/intro.xml +++ b/doc/guide/intro.xml @@ -9,16 +9,16 @@ Introduction - Kea is the next generation of DHCP servers developed by ISC. + 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. - Kea has been initially developed as a part of the BIND 10 framework + 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 servers. As a result, + continue development of Kea as standalone DHCP software. As a result, the components and libraries related to the BIND10 framework and DNS are going to be removed from the Kea source tree over time. In order to remove the dependency on Python 3, the BIND 10 framework @@ -27,9 +27,9 @@ - Kea has been implemented in BIND 10 framework and to certain extent - it still depends on various BIND 10 libraries. It also requires the BIND 10 - framework to run, because BIND 10 configuration mechanisms are used to + Kea was implemented in the BIND 10 framework and to certain extent + still depends on various BIND 10 libraries. It also requires the BIND 10 + framework to run, because the BIND 10 configuration mechanisms are used to configure Kea. As a result, this document still refers to BIND 10 in many paragraphs. The term "BIND 10" in the context of this document means "BIND 10 libraries and applications which are necessary for Kea to run @@ -62,14 +62,16 @@ Running Kea uses various extra software which may - not be provided in some operating systems' default - installations nor standard packages collections. You 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 .) - + + + Kea was developed as a collection of applications within BIND 10 framework and it still relies on the remaining parts of this framework. In particular, the servers' configuration and @@ -77,37 +79,45 @@ in BIND 10. These modules require at least Python 3.1 to run. They also work with Python 3.2, 3.3 or 3.4 (). The dependency on Python will - be removed once a replacing configuration and startup + be removed once replacement configuration and startup mechanisms are developed and released as Kea 0.9. At this point Kea will be written in pure C++. - + + - - Kea uses the Botan crypto library for C++ + + + Kea uses the Botan cryptographic library for C++ (). It requires at least Botan version 1.8. - + + - + + Kea uses the log4cplus C++ logging library (). It requires at least log4cplus version 1.0.3. - + + - - Kea can use MySQL headers and libraries to build MySQL database backend - that can be used to store leases. This is an optional dependency. When - it is missing, Kea will lack the ability to store leases in MySQL - database. - + + + 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. + + - - Kea can use PostgreSQL headers and libraries to build PostgreSQL - database backend that can be used to store leases. This is an optional - dependency. When it is missing, Kea will lack the ability to store - leases in PostgreSQL database. - + + + In order to store lease information in a PostgresSQL database, Kea requires PostgresSQL + headers and libraries. This is an optional dependency in that Kea can be + built without PostgresSQL support. + + +