From: Jeremy C. Reed Date: Mon, 11 Aug 2014 17:29:44 +0000 (+0000) Subject: misc improvements: X-Git-Tag: trac3482_base~41^2~20 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c523ee2f6d4922f1b67608f16ecd5274459027c8;p=thirdparty%2Fkea.git misc improvements: fixed install directories mention openssl fix url for tarball download (note doesn't exist at time of this commit) add some more common configure switches change kea config "BIND10" to "BUNDY" fix some paths from bind10 to kea. minor rewording --- diff --git a/doc/guide/install.xml b/doc/guide/install.xml index e140e000bf..9627d852dd 100644 --- a/doc/guide/install.xml +++ b/doc/guide/install.xml @@ -29,53 +29,40 @@ The following is the directory layout of the complete Kea installation (all directories paths are relative to the installation directory): - - - bin/ — - general tools and diagnostic clients. - - - - etc/bind10/ — + etc/kea/ — configuration files. - lib/ — - libraries and python modules. + include/ — + C++ development header files. - - libexec/bind10/ — - executables that a user wouldn't normally run directly and - are not run independently. - These are the BIND 10 and Kea modules which are daemons started by - the b10-init master process. + lib/ — + libraries. sbin/ — - commands used by the system administrator. + server software and commands used by the system administrator. - - share/bind10/ — - configuration specifications. + share/kea/ — + configuration specifications and examples. - - share/doc/bind10/ — - this guide and other supplementary documentation. + share/doc/kea/ — + this guide, other supplementary documentation, and examples. @@ -86,9 +73,8 @@ - - var/bind10/ — - data source and configuration databases. + var/kea/ — + server identification, lease databases, and log files. @@ -128,15 +114,13 @@ - Botan (at least version - 1.8). + Botan (at least version 1.8) or OpenSSL. log4cplus (at least version 1.0.3) development include headers. - @@ -146,9 +130,6 @@ Debian and Ubuntu: libgmp3-dev and libbz2-dev required for botan too --> - - A C++ compiler and @@ -162,7 +143,7 @@ as a dependency earlier --> The development tools "make" and "pkg-config". - + @@ -179,8 +160,7 @@ as a dependency earlier -->
Installation from Source - Kea is open source software written in C++ (some components of the - BIND 10 framework are written in Python). + Kea is open source software written in C++. It is freely available in source code form from ISC as a downloadable tar file or via Kea Git code revision control service. (It may also be available in pre-compiled ready-to-use @@ -191,10 +171,8 @@ as a dependency earlier --> Download Tar File - Kea 0.8 is available as a part of BIND10 1.2 release, which is a final - release of BIND10 from ISC. This release can be downloaded from: - . The upcoming Kea 0.9 and all - following releases will be shipped as a stand-alone tarball. + The Kea release tarballs may be downloaded from: + (using FTP or HTTP).
@@ -279,11 +257,10 @@ as a dependency earlier --> - --with-pythonpath + --with-botan-config - Define the path to Python 3.x if it is not in the - standard execution path. Python 3.x is mandatory for Kea 0.8, - but will not be required for the upcoming Kea 0.9. + To specific the path to the botan-config + script to build with Botan for the crypto code. @@ -300,6 +277,15 @@ as a dependency earlier --> + + --with-log4cplus + + Define the path to find the Log4cplus headers + and libraries. + + + + --with-openssl @@ -310,8 +296,6 @@ as a dependency earlier --> - - --without-werror @@ -409,34 +393,35 @@ as a dependency earlier --> switchable during compilation phase. The backend is chosen using the --with-kea-config switch when running the configure script. It currently supports two values: BIND10 and JSON. This is currently - only supported by DHCPv6 component. + only supported by DHCPv6 component. JSON is the default. - BIND10 + BUNDY - BIND10 (which is the default value as of April 2014) means - that Kea6 is linked with the BIND10 configuration backend that - connects to the BIND10 framework and in general works exactly the - same as Kea 0.8 and earlier versions. The benefits of that backend - are uniform integration with BIND10 framework, easy on-line - reconfiguration using bindctl, available RESTful API. On the other - hand, it requires the whole heavy BIND10 framework that requires - Python3 to be present. That backend is likely to go away with the - release of Kea 0.9. + BUNDY means + that Kea6 is linked with the Bundy configuration backend that + connects to the Bundy framework and in general works exactly the + same as Kea 0.8 and earlier BIND10 versions. The benefits + of that backend are uniform integration with the Bundy + framework, easy on-line reconfiguration using bindctl, + available RESTful API. On the other hand, it requires + the whole heavy Bundy framework that requires Python3 + to be present. That backend is likely to go away with + the release of Kea 1.0. JSON - JSON is a new configuration backend that causes Kea to read - JSON configuration file from disk. It does not require any framework - and thus is considered more lightweight. It will allow dynamic - on-line reconfiguration, but will lack remote capabilities (i.e. no - RESTful API). This configuration backend is expected to be the - default for upcoming Kea 0.9. + JSON is a new default configuration backend + that causes Kea to read JSON configuration file from + disk. It does not require any framework and thus is + considered more lightweight. It will allow dynamic + on-line reconfiguration, but will lack remote capabilities + (i.e. no RESTful API). @@ -451,7 +436,7 @@ as a dependency earlier --> store the lease information. At present, Kea supports three database backends: MySQL, PostgreSQL and Memfile. To limit external dependencies, both MySQL and PostgreSQL support are disabled by default and only Memfile (which is implemented in pure C++) - is available. Support for a given database backend must be explicitly included when + is available. Support for the optional external database backend must be explicitly included when Kea is built. This section covers the building of Kea with MySQL and/or PostgreSQL and the creation of the lease database. @@ -494,7 +479,7 @@ mysql> 3. Create the database tables by running the dhcpdb_create.mysql script supplied as part of Kea: mysql> CONNECT database-name; -mysql> SOURCE path-to-bind10/share/bind10/dhcpdb_create.mysql +mysql> SOURCE path-to-kea/share/kea/dhcpdb_create.mysql 4. Create the user under which Kea will access the database (and give it a password), then grant it access to the database tables: @@ -571,7 +556,7 @@ $ After entering the following command, you will be prompted for the new user's password. When the command completes you will be returned to the shell prompt. You should see output similar to following: -$ psql -d database-name -U user-name -f path-to-bind10/share/bind10/dhcpdb_create.pgsql +$ psql -d database-name -U user-name -f path-to-kea/share/kea/dhcpdb_create.pgsql Password for user user-name: CREATE TABLE CREATE INDEX