]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[master] doc cleanup before 1.4 release
authorWlodek Wencel <wlodek@isc.org>
Wed, 13 Jun 2018 22:09:14 +0000 (00:09 +0200)
committerWlodek Wencel <wlodek@isc.org>
Wed, 13 Jun 2018 22:09:14 +0000 (00:09 +0200)
doc/guide/dhcp4-srv.xml
doc/guide/dhcp6-srv.xml
doc/guide/hooks-radius.xml
doc/guide/hooks.xml
doc/guide/install.xml
doc/guide/intro.xml

index b32566c63f88a874244c6c65809260778e9ce20c..e722d00385d029fff892d3b96705f91fb5b87a5f 100644 (file)
@@ -1344,6 +1344,14 @@ temporarily override a list of interface names and listen on all interfaces.
 }
 </screen>
       </para>
+     <para>
+       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.
+     </para>
 
       <para>
         The currently supported standard DHCPv4 options are
@@ -1966,7 +1974,7 @@ It is merely echoed by the server
       </para>
 
       <para>
-      Another possibility, added in Kea 1.3, is to redefine the option,
+      Another possibility, since Kea 1.3, is to redefine the option,
       see <xref linkend="dhcp4-private-opts"/>.
       </para>
     </section>
index f1e8d8b3da10d3ea2a1abfe7bfa3a7c388994e12..4801625785287127c54857e0a040af84933ce727 100644 (file)
@@ -1238,7 +1238,14 @@ temporarily override a list of interface names and listen on all interfaces.
 }
 </screen>
      </para>
-
+    <para>
+      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.
+    </para>
     <para>
       The currently supported standard DHCPv6 options are
       listed in <xref linkend="dhcp6-std-options-list"/>.
index a0c597c790d68ffc4bea4cb3e2c792a8909a6717..90e0aac8fd75802b8e3d98c816dc897c11f531cf 100644 (file)
@@ -189,7 +189,7 @@ drwxr-xr-x  14 thomson  staff     476 Apr 26 19:04 tools
 </screen>
 
 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.</para>
@@ -210,8 +210,7 @@ should look as follows:</para>
 <screen>
 ./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
 </screen>
 
 <para>
@@ -225,14 +224,13 @@ should look as follows:</para>
 
 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:
 
 <itemizedlist>
-  <listitem>radius listed in tier 2 packages</listitem>
+  <listitem>radius listed in Included Hooks</listitem>
   <listitem>FreeRadius client directories printed and pointing to the right
   directories</listitem>
   <listitem>Boost version is at least 1.65.1. The versions available
index 41dd97bb81d684bec4577b28e7daccaa9d29b7f7..ae7053aea8996d938e27570d858bb0bb7a13eb55 100644 (file)
@@ -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).
 <screen>
-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
 </screen>
         </para>
         <para>
@@ -781,7 +783,8 @@ timestamp address duration device-id {client-info} {relay-info}
         <para>
         Example:
 <screen>
-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
 </screen>
         </para>
         <para>
@@ -795,7 +798,8 @@ timestamp address duration device-id {client-info} {relay-info}
         <para>
         Example:
 <screen>
-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
 </screen>
         </para>
         <para>
@@ -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).
 <screen>
-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
 </screen>
         </para>
         <para>
@@ -890,7 +897,8 @@ timestamp address duration device-id {relay-info}*
         <para>
         Example:
 <screen>
-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
 </screen>
         </para>
         <para>
@@ -903,7 +911,8 @@ timestamp address duration device-id {relay-info}*
         <para>
         Example:
 <screen>
-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
 </screen>
         </para>
         <para>
index 231c85239cabf41eff866d4c63eb3181c6c63e4c..7d300c9df4c93bddf9f47fccc65e176e24d988d4 100644 (file)
 
       <para>
         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 <emphasis>make</emphasis>
         the software.
       </para>
 
-      <para>
-        FreeBSD ports, NetBSD pkgsrc, and Debian
-        <emphasis>testing</emphasis> package collections provide all the
-        prerequisite packages.
-      </para>
     </section>
 
     <section xml:id="install-hierarchy">
               libraries.
             </simpara>
           </listitem>
+          <listitem>
+            <simpara>
+              <filename>lib/hooks</filename> —
+              additional hooks libraries.
+            </simpara>
+          </listitem>
           <listitem>
             <simpara>
               <filename>sbin/</filename> —
@@ -181,6 +182,17 @@ Debian and Ubuntu:
         </para>
         </listitem>
 
+        <listitem>
+        <para>
+          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.
+       </para>
+        </listitem>
+
         <listitem>
         <para>
           googletest (version 1.8 or later), when using the --with-gtest configuration
index 96e136bf8a686ef3fc7e9fe3ccb71feaa16d0789..1d0d1f32c47038380ba9afb0d68d152cdd13ff07 100644 (file)
       <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.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
       </para>
       <para>There are currently no plans to port Kea to Windows platforms.</para>
     </section>
             </simpara>
           </listitem>
 
+          <listitem>
+            <simpara>
+              <command>kea-shell</command> —
+              Simple text client that uses REST interface to connect to Kea
+              Control Agent.
+            </simpara>
+          </listitem>
+
           <listitem>
             <simpara>
               <command>perfdhcp</command> —