From: Marcin Siodelski Date: Mon, 11 Jun 2018 14:27:14 +0000 (+0200) Subject: [5613] Be more explicit where the hooks libs should be installed. X-Git-Tag: 136-add-global-host-reservation-examples_base~4^2~7^2~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=11b36a275c503ec98add6bf98d217c2c766fe173;p=thirdparty%2Fkea.git [5613] Be more explicit where the hooks libs should be installed. --- diff --git a/doc/guide/hooks-ha.xml b/doc/guide/hooks-ha.xml index 5d07a40e46..db8a49ef75 100644 --- a/doc/guide/hooks-ha.xml +++ b/doc/guide/hooks-ha.xml @@ -14,6 +14,12 @@ the DHCP service in case of outage of one of the servers. This library used to be only available to ISC customers, but is now part of the open source Kea, available to all users. + + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + High Availability (HA) of the DHCP service is provided by running multiple diff --git a/doc/guide/hooks-host-cache.xml b/doc/guide/hooks-host-cache.xml index 51dc1e4f79..79942c4450 100644 --- a/doc/guide/hooks-host-cache.xml +++ b/doc/guide/hooks-host-cache.xml @@ -14,11 +14,16 @@ - The RADIUS Host cache is a library that has to be loaded by either - DHCPv4 or DHCPv6 Kea servers. In principle it can be used with any - backend that may introduce performance degradation (MySQL, - PostgreSQL, Cassandra, RADIUS). Host Cache is required to be - loaded for the RADIUS accounting mechanism to work. + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + + + In principle it can be used with any backend that may introduce + performance degradation (MySQL, PostgreSQL, Cassandra, RADIUS). + Host Cache is required to be loaded for the RADIUS accounting + mechanism to work. diff --git a/doc/guide/hooks-radius.xml b/doc/guide/hooks-radius.xml index 9550f3c368..188e4b9a7c 100644 --- a/doc/guide/hooks-radius.xml +++ b/doc/guide/hooks-radius.xml @@ -24,6 +24,12 @@ receive additional RADIUS attributes. As such, the alternative looks more appealing: to extend DHCP server to talk to RADIUS directly. That is the goal this library intends to fulfill. + + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + The major feature of the library is the ability to use RADIUS diff --git a/doc/guide/hooks-stat-cmds.xml b/doc/guide/hooks-stat-cmds.xml index 2201b640c5..5a950d9664 100644 --- a/doc/guide/hooks-stat-cmds.xml +++ b/doc/guide/hooks-stat-cmds.xml @@ -16,6 +16,12 @@ Finally, this library was constructed to provide commands for retrieving these statistics. Additional statistics commands may be added to this library in future releases. + + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + diff --git a/doc/guide/hooks.xml b/doc/guide/hooks.xml index 271a0bc1c9..4210b70222 100644 --- a/doc/guide/hooks.xml +++ b/doc/guide/hooks.xml @@ -311,19 +311,36 @@ $ ls -l /usr/local/lib/hooks/*.so making Kea sustainable in the long term. - Currently the following libraries are available or planned from ISC: + The following table provides a list of libraries currently available + from ISC. It is important to pay attention which process a library should + be loaded to. It is a common error to load a library to the + kea-ctrl-agent (Control Agent) process rather than to the + kea-dhcp4 or kea-dhcp6 processes. + If the library from ISC doesn't work as expected, please make sure that + it has been loaded to the appropriate process (consult the table below to + see which processes are supported by which hooks libraries). + + + + Even though the Kea Control Agent includes the "hooks" functionality, + i.e. hooks libraries can be attached to this process, currently ISC + supplies no hooks libraries to be attched to the Control Agent. + + List of available hooks libraries + Name Availability Since + Load to process Description @@ -333,6 +350,12 @@ $ ls -l /usr/local/lib/hooks/*.souser_chkKea sourcesKea 0.8 + + + kea-dhcp4 + kea-dhcp6 + + Reads known users list from a file. Unknown users will be assigned a lease from the last subnet defined in the configuration file, @@ -345,6 +368,12 @@ $ ls -l /usr/local/lib/hooks/*.so Forensic Logging Support customers Kea 1.1.0 + + + kea-dhcp4 + kea-dhcp6 + + This library provides hooks that record a detailed log of lease assignments and renewals into a set of log files. In many legal jurisdictions companies, especially ISPs, must record @@ -359,6 +388,12 @@ $ ls -l /usr/local/lib/hooks/*.so Flexible Identifier Support customers Kea 1.2.0 + + + kea-dhcp4 + kea-dhcp6 + + Kea software provides a way to handle host reservations that include addresses, prefixes, options, client classes and other features. The reservation can be based on hardware address, @@ -379,6 +414,12 @@ $ ls -l /usr/local/lib/hooks/*.so Host Commands Support customers Kea 1.2.0 + + + kea-dhcp4 + kea-dhcp6 + + Kea provides a way to store host reservations in a database. In many larger deployments it is useful to be able to manage that information while the server is running. This library @@ -396,6 +437,12 @@ $ ls -l /usr/local/lib/hooks/*.so Subnet Commands Support customers Kea 1.3.0 + + + kea-dhcp4 + kea-dhcp6 + + In deployments in which subnet configuration needs to be frequently updated, it is a hard requirement that such updates be performed without the need for a full DHCP server reconfiguration @@ -412,6 +459,12 @@ $ ls -l /usr/local/lib/hooks/*.so Lease Commands Kea sources Kea 1.3.0 + + + kea-dhcp4 + kea-dhcp6 + + The lease commands hook library offers a number of new commands used to manage leases. Kea provides a way to store lease information in various backends: memfile, MySQL, PostgreSQL and @@ -430,6 +483,12 @@ $ ls -l /usr/local/lib/hooks/*.so High Availability Kea sources Kea 1.4.0 + + + kea-dhcp4 + kea-dhcp6 + + Minimizing a risk of DHCP service unavailability is achieved by setting up a pair of the DHCP servers in a network. Two modes of operation are supported. The first one is called load @@ -455,6 +514,12 @@ $ ls -l /usr/local/lib/hooks/*.so Radius Support customers Kea 1.4.0 + + + kea-dhcp4 + kea-dhcp6 + + The RADIUS Hook library allows Kea to interact with the RADIUS servers using access and accounting mechanisms. The access mechanism may be used for access control, assigning specific IPv4 @@ -468,6 +533,12 @@ $ ls -l /usr/local/lib/hooks/*.so Host Cache Support customers Kea 1.4.0 + + + kea-dhcp4 + kea-dhcp6 + + Some of the database backends, such as RADIUS, are considered slow and may take a long time to respond. Since Kea in general is synchronous, the backend performance directly affects @@ -596,6 +667,12 @@ and may have the zero or more of the following entries: provides hooks that record a detailed log of lease assignments and renewals into a set of log files. Currently this library is only available to ISC customers with a support contract. + + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + In many legal jurisdictions companies, especially ISPs, must record @@ -1036,7 +1113,14 @@ $ hook application. Currently this library is only available to ISC customers with a - support contract. + support contract. + + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + + The library allows for defining an expression, using notation initially used for client classification only. See for detailed description @@ -1274,7 +1358,14 @@ $ Currently this library is only available to ISC customers with a - support contract. + support contract. + + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + + Currently three commands are supported: reservation-add (which adds @@ -1572,6 +1663,12 @@ An example deletion by (subnet-id, identifier-type, identifier) looks as follows errors, like adding a lease with subnet-id that does not exist in the configuration or configuring a lease to use an address that is outside of the subnet to which it is supposed to belong. + + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + There are many use cases when an administrative command may be @@ -2162,7 +2259,14 @@ An example IPv4 lease deletion by "hw-address" looks as follows: Currently this library is only available to ISC customers with a - support contract. + support contract. + + + This library may only be attached to kea-dhcp4 + or kea-dhcp6 process. + + + The following commands are currently supported: