From 53f80b391b0e8c65e3c1dc09e5741b896bea9f27 Mon Sep 17 00:00:00 2001 From: Wlodek Wencel Date: Thu, 14 Jun 2018 00:09:14 +0200 Subject: [PATCH] [master] doc cleanup before 1.4 release --- doc/guide/dhcp4-srv.xml | 10 +++++++++- doc/guide/dhcp6-srv.xml | 9 ++++++++- doc/guide/hooks-radius.xml | 20 +++++++++----------- doc/guide/hooks.xml | 21 +++++++++++++++------ doc/guide/install.xml | 24 ++++++++++++++++++------ doc/guide/intro.xml | 14 +++++++++++--- 6 files changed, 70 insertions(+), 28 deletions(-) diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index b32566c63f..e722d00385 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -1344,6 +1344,14 @@ temporarily override a list of interface names and listen on all interfaces. } + + Options can be specified also in class of host reservation scope. + In Kea 1.4 options precedence order is (from most important): + host reservation, pool, subnet, shared network, class, global. + In Kea 1.5 order will be changed to: + host reservation, class, pool, subnet, shared network, global OR it will + be fully configurable. + The currently supported standard DHCPv4 options are @@ -1966,7 +1974,7 @@ It is merely echoed by the server - Another possibility, added in Kea 1.3, is to redefine the option, + Another possibility, since Kea 1.3, is to redefine the option, see . diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index f1e8d8b3da..4801625785 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -1238,7 +1238,14 @@ temporarily override a list of interface names and listen on all interfaces. } - + + Options can be specified also in class of host reservation scope. + In Kea 1.4 options precedence order is (from most important): + host reservation, pool, subnet, shared network, class, global. + In Kea 1.5 order will be changed to: + host reservation, class, pool, subnet, shared network, global OR it will + be fully configurable. + The currently supported standard DHCPv6 options are listed in . diff --git a/doc/guide/hooks-radius.xml b/doc/guide/hooks-radius.xml index a0c597c790..90e0aac8fd 100644 --- a/doc/guide/hooks-radius.xml +++ b/doc/guide/hooks-radius.xml @@ -189,7 +189,7 @@ drwxr-xr-x 14 thomson staff 476 Apr 26 19:04 tools The next step is to configure Kea. There are several essential steps necessary here. -The --with-tier2=yes flag is necessary to compile premium package that contains +Running autoreconf -if is necessary to compile premium package that contains RADIUS. Also, --with-freeradius option is necessary to tell Kea where the FreeRADIUS client sources can be found. Also, since the non-standard boost is used, the path to it has to be specified. @@ -210,8 +210,7 @@ should look as follows: ./configure --with-freeradius=/usr/local \ --with-boost-include=/home/thomson/devel/boost_1_65_1 \ - --with-boost-lib-dir=/home/thomson/devel/boost_1_65_1/stage/lib \ - --with-tier2=yes + --with-boost-lib-dir=/home/thomson/devel/boost_1_65_1/stage/lib @@ -225,14 +224,13 @@ should look as follows: Package: Name: kea - Version: 1.3.0-git - Extended version: 1.3.0-git (git c494c28cc958bb21a9c6cb0f8dc805a721c69893) + Version: 1.4.0-git + Extended version: 1.4.0-git (git ab3cb8afbb7a4cdaa9cbb279fd783aa126a7912a) OS Family: Linux - Using GNU sed: yes - Premium package: yes - Tier1 Packages: host_cmds flex_id legal_log - Tier2 Packages: high_availability subnet_cmds radius - Included Packages: host_cmds flex_id legal_log high_availability subnet_cmds radius + + Hooks directory: /usr/local/lib/hooks + Premium hooks: yes + Included Hooks: forensic_log flex_id host_cmds subnet_cmds radius host_cache C++ Compiler: CXX: g++ --std=c++11 @@ -304,7 +302,7 @@ Developer: Please make sure that your compilation has the following: - radius listed in tier 2 packages + radius listed in Included Hooks FreeRadius client directories printed and pointing to the right directories Boost version is at least 1.65.1. The versions available diff --git a/doc/guide/hooks.xml b/doc/guide/hooks.xml index 41dd97bb81..ae7053aea8 100644 --- a/doc/guide/hooks.xml +++ b/doc/guide/hooks.xml @@ -760,7 +760,9 @@ timestamp address duration device-id {client-info} {relay-info} For instance (line breaks added for readability, they would not be present in the log file). -2018-01-06 01:02:03 CET Address: 192.2.1.100 has been renewed for 1 hrs 52 min 15 secs to a device with hardware address: hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54 connected via relay at address: 192.2.16.33, identified by circuit-id: 68:6f:77:64:79 and remote-id: 87:f6:79:77:ef +2018-01-06 01:02:03 CET Address: 192.2.1.100 has been renewed for 1 hrs 52 min 15 secs to a device with hardware address: +hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54 connected via relay at address: 192.2.16.33, +identified by circuit-id: 68:6f:77:64:79 and remote-id: 87:f6:79:77:ef @@ -781,7 +783,8 @@ timestamp address duration device-id {client-info} {relay-info} Example: -2018-01-06 01:02:03 CET Administrator added a lease of address: 192.0.2.202 to a device with hardware address: 1a:1b:1c:1d:1e:1f for 1 days 0 hrs 0 mins 0 secs +2018-01-06 01:02:03 CET Administrator added a lease of address: 192.0.2.202 to a device with hardware address: +1a:1b:1c:1d:1e:1f for 1 days 0 hrs 0 mins 0 secs @@ -795,7 +798,8 @@ timestamp address duration device-id {client-info} {relay-info} Example: -2018-01-06 01:02:03 CET Administrator updated information on the lease of address: 192.0.2.202 to a device with hardware address: 1a:1b:1c:1d:1e:1f, client-id: 1234567890 +2018-01-06 01:02:03 CET Administrator updated information on the lease of address: 192.0.2.202 to a device +with hardware address: 1a:1b:1c:1d:1e:1f, client-id: 1234567890 @@ -870,7 +874,10 @@ timestamp address duration device-id {relay-info}* For instance (line breaks added for readability, they would not be present in the log file). -2018-01-06 01:02:03 PST Address:2001:db8:1:: has been assigned for 0 hrs 11 mins 53 secs to a device with DUID: 17:34:e2:ff:09:92:54 and hardware address: hwtype=1 08:00:2b:02:3f:4e (from Raw Socket) connected via relay at address: fe80::abcd for client on link address: 3001::1, hop count: 1, identified by remote-id: 01:02:03:04:0a:0b:0c:0d:0e:0f and subscriber-id: 1a:2b:3c:4d:5e:6f +2018-01-06 01:02:03 PST Address:2001:db8:1:: has been assigned for 0 hrs 11 mins 53 secs +to a device with DUID: 17:34:e2:ff:09:92:54 and hardware address: hwtype=1 08:00:2b:02:3f:4e +(from Raw Socket) connected via relay at address: fe80::abcd for client on link address: 3001::1, +hop count: 1, identified by remote-id: 01:02:03:04:0a:0b:0c:0d:0e:0f and subscriber-id: 1a:2b:3c:4d:5e:6f @@ -890,7 +897,8 @@ timestamp address duration device-id {relay-info}* Example: -2018-01-06 01:02:03 PST Administrator added a lease of address: 2001:db8::3 to a device with DUID: 1a:1b:1c:1d:1e:1f:20:21:22:23:24 for 1 days 0 hrs 0 mins 0 secs +2018-01-06 01:02:03 PST Administrator added a lease of address: 2001:db8::3 to a device with DUID: +1a:1b:1c:1d:1e:1f:20:21:22:23:24 for 1 days 0 hrs 0 mins 0 secs @@ -903,7 +911,8 @@ timestamp address duration device-id {relay-info}* Example: -2018-01-06 01:02:03 PST Administrator updated information on the lease of address: 2001:db8::3 to a device with DUID: 1a:1b:1c:1d:1e:1f:20:21:22:23:24, hardware address: 1a:1b:1c:1d:1e:1f +2018-01-06 01:02:03 PST Administrator updated information on the lease of address: 2001:db8::3 to a device with +DUID: 1a:1b:1c:1d:1e:1f:20:21:22:23:24, hardware address: 1a:1b:1c:1d:1e:1f diff --git a/doc/guide/install.xml b/doc/guide/install.xml index 231c85239c..7d300c9df4 100644 --- a/doc/guide/install.xml +++ b/doc/guide/install.xml @@ -15,17 +15,12 @@ Some operating systems or software package vendors may provide - ready-to-use, pre-built software packages for Kea. Installing a + ready-to-use, pre-built software packages for Kea. Installing a pre-built package means you do not need to install the software required only to build Kea and do not need to make the software. - - FreeBSD ports, NetBSD pkgsrc, and Debian - testing package collections provide all the - prerequisite packages. -
@@ -58,6 +53,12 @@ libraries. + + + lib/hooks — + additional hooks libraries. + + sbin/ — @@ -181,6 +182,17 @@ Debian and Ubuntu: + + + Cpp-driver from DataStax is needed when using the --with-cql + configuration flag to build Kea with Cassandra database backend. + In this case an instance of the Cassandra server running locally + or on some other machine, reachable over the network from the + machine running Kea, is required. Note that running the unit + tests requires a local Cassandra server. + + + googletest (version 1.8 or later), when using the --with-gtest configuration diff --git a/doc/guide/intro.xml b/doc/guide/intro.xml index 96e136bf8a..1d0d1f32c4 100644 --- a/doc/guide/intro.xml +++ b/doc/guide/intro.xml @@ -36,10 +36,10 @@ 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.3.0 builds have been tested on (in no + other platforms: Kea 1.4.0 builds have been tested on (in no particular order) Red Hat Enterprise Linux 6.4, Debian GNU/Linux 7, - Ubuntu 12.04, Ubuntu 14.04, Ubuntu 16.04, Fedora 22, Fedora 25, CentOS Linux 7, - FreeBSD 11.0 OS X 10.11, OS X 10.12, Debian 7.11 + Ubuntu 14.04, Ubuntu 16.04, Fedora 25, Fedore 26, Fedora 27, + CentOS Linux 7, FreeBSD 11.0 OS X 10.11, OS X 10.12, Debian 7.11, Debian 9 There are currently no plans to port Kea to Windows platforms.
@@ -176,6 +176,14 @@ + + + kea-shell — + Simple text client that uses REST interface to connect to Kea + Control Agent. + + + perfdhcp — -- 2.47.2