From: Andrei Pavel Date: Tue, 13 Jun 2023 16:39:12 +0000 (+0300) Subject: [#2554] add notes about each hook library's packaging X-Git-Tag: Kea-2.4.0~190 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=153ace53c16cad69863bc3023eb013563e137168;p=thirdparty%2Fkea.git [#2554] add notes about each hook library's packaging - Premium libraries were marked as subscription libraries. That has also been fixed. --- diff --git a/doc/sphinx/arm/config-backend.rst b/doc/sphinx/arm/config-backend.rst index 30cf5f639b..df3981fbe8 100644 --- a/doc/sphinx/arm/config-backend.rst +++ b/doc/sphinx/arm/config-backend.rst @@ -95,10 +95,9 @@ Appendix A of this manual for a complete list. .. note:: - :ischooklib:`libdhcp_cb_cmds.so` is available only to ISC support subscribers. - For more information on subscription options, please complete the form - at https://www.isc.org/contact. - + :ischooklib:`libdhcp_cb_cmds.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, please + complete the form at https://www.isc.org/contact. The schema creation scripts can be found at `dhcpdb_create.mysql `__ and ; @@ -178,8 +177,7 @@ C client libraries must be installed, as explained in :ref:`dhcp-install-configu required by the particular Kea version using the :iscman:`kea-admin` tool, as described in :ref:`kea-admin`. -:ischooklib:`libdhcp_cb_cmds.so`, which is available to ISC's paid support -customers, provides a complete set of commands to manage the +:ischooklib:`libdhcp_cb_cmds.so` provides a complete set of commands to manage the servers' configuration information within the database. This library can be attached to both DHCPv4 and DHCPv6 server instances. While it is possible to manage the configuration information without :ischooklib:`libdhcp_cb_cmds.so` diff --git a/doc/sphinx/arm/hooks-bootp.rst b/doc/sphinx/arm/hooks-bootp.rst index 6942376ec1..7f8a749829 100644 --- a/doc/sphinx/arm/hooks-bootp.rst +++ b/doc/sphinx/arm/hooks-bootp.rst @@ -15,8 +15,17 @@ The DHCP-specific options, such as ``dhcp-message-type``, are removed from the server's responses; responses shorter than the BOOTP minimum size of 300 octets are padded to this size. -This open source library is loaded -similarly to other hook libraries by the :iscman:`kea-dhcp4` process, and +.. note:: + + :ischooklib:`libdhcp_bootp.so` is part of the open source code and is + available to every Kea user. + +.. note:: + + This library can only be loaded by the :iscman:`kea-dhcp4` process, + as there is no BOOTP protocol for IPv6. + +This library is loaded similarly to other hook libraries, and it takes no parameters. :: @@ -28,12 +37,6 @@ it takes no parameters. ] } - -.. note:: - - This library can only be loaded by the :iscman:`kea-dhcp4` process, - as there is no BOOTP protocol for IPv6. - .. note:: A host reservation for a BOOTP client should use the hardware address diff --git a/doc/sphinx/arm/hooks-cb-cmds.rst b/doc/sphinx/arm/hooks-cb-cmds.rst index def9b5be92..9f79d9b84b 100644 --- a/doc/sphinx/arm/hooks-cb-cmds.rst +++ b/doc/sphinx/arm/hooks-cb-cmds.rst @@ -22,12 +22,15 @@ More information on how to configure the Configuration Backend hook library for use with a MySQL or PostgreSQL database can be found in the :ref:`dhcp4-cb` and :ref:`dhcp6-cb` sections. -:ischooklib:`libdhcp_cb_cmds.so` is only available to ISC customers with a paid -support contract. +.. note:: + + :ischooklib:`libdhcp_cb_cmds.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. .. note:: - This library may only be loaded by the :iscman:`kea-dhcp4` or + This library can only be loaded by the :iscman:`kea-dhcp4` or :iscman:`kea-dhcp6` process. .. note:: @@ -80,19 +83,6 @@ be specified, the parameter should be omitted. In this case, the server will use the first backend listed in the ``config-control`` map within the configuration of the server receiving the command. -:ischooklib:`libdhcp_cb_cmds.so` is only available to ISC customers with a paid -support contract. - -.. note:: - - This library can only be loaded by the :iscman:`kea-dhcp4` or - :iscman:`kea-dhcp6` process. - -.. note:: - - Please read about :ref:`cb-limitations` before using the commands - described in this section. - .. note:: In the current Kea release, it is only possible to configure the Kea server diff --git a/doc/sphinx/arm/hooks-cb-mysql.rst b/doc/sphinx/arm/hooks-cb-mysql.rst index 30667e2d4e..8e5ab42949 100644 --- a/doc/sphinx/arm/hooks-cb-mysql.rst +++ b/doc/sphinx/arm/hooks-cb-mysql.rst @@ -8,3 +8,11 @@ This hook library works in conjunction with :ischooklib:`libdhcp_cb_cmds.so` to implement the API to create, read, update, and delete (CRUD) the configuration in a MySQL database. Please see :ref:`hooks-cb-cmds` for more details. + +.. note:: + + :ischooklib:`libdhcp_mysql_cb.so` is part of the open source code and is + available to every Kea user, but it requires :ischooklib:`libdhcp_cb_cmds.so` + which is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. diff --git a/doc/sphinx/arm/hooks-cb-pgsql.rst b/doc/sphinx/arm/hooks-cb-pgsql.rst index 238954d786..c652693a79 100644 --- a/doc/sphinx/arm/hooks-cb-pgsql.rst +++ b/doc/sphinx/arm/hooks-cb-pgsql.rst @@ -8,3 +8,11 @@ This hook library works in conjunction with :ischooklib:`libdhcp_cb_cmds.so` to implement the API to create, read, update, and delete (CRUD) the configuration in a PostgreSQL database. Please see :ref:`hooks-cb-cmds` for more details. + +.. note:: + + :ischooklib:`libdhcp_pgsql_cb.so` is part of the open source code and is + available to every Kea user, but it requires :ischooklib:`libdhcp_cb_cmds.so` + which is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. diff --git a/doc/sphinx/arm/hooks-class-cmds.rst b/doc/sphinx/arm/hooks-class-cmds.rst index 2fe6c73b45..5a55cc5e57 100644 --- a/doc/sphinx/arm/hooks-class-cmds.rst +++ b/doc/sphinx/arm/hooks-class-cmds.rst @@ -10,14 +10,17 @@ Kea DHCP servers' configurations) without the need to restart those servers. Using these commands it is possible to add, update, delete, and list the client classes configured for a given server. +.. note:: + + :ischooklib:`libdhcp_class_cmds.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. + .. note:: This library can only be loaded by the :iscman:`kea-dhcp4` or :iscman:`kea-dhcp6` process. -:ischooklib:`libdhcp_class_cmds.so` is only available to ISC customers with a -paid support contract. - .. isccmd:: class-add .. _command-class-add: diff --git a/doc/sphinx/arm/hooks-ddns-tuning.rst b/doc/sphinx/arm/hooks-ddns-tuning.rst index 6feb34189f..30155e89ba 100644 --- a/doc/sphinx/arm/hooks-ddns-tuning.rst +++ b/doc/sphinx/arm/hooks-ddns-tuning.rst @@ -8,8 +8,12 @@ This hook library adds support for fine-tuning various DNS update aspects. It currently supports procedural host-name generation and the ability to skip performing DDNS updates for select clients. -The DDNS Tuning hook library is only available to ISC customers with a paid -support contract. +.. note:: + + :ischooklib:`libdhcp_ddns_tuning.so` is available as a premium + hook library from ISC. Please visit https://www.isc.org/shop/ to purchase + the premium hook libraries, or contact us at https://www.isc.org/contact for + more information. The library, which was added in Kea 2.1.5, can be loaded by the :iscman:`kea-dhcp4` and :iscman:`kea-dhcp6` daemons by adding it to the ``hooks-libraries`` element of the diff --git a/doc/sphinx/arm/hooks-flex-id.rst b/doc/sphinx/arm/hooks-flex-id.rst index 368f032436..0cb7c60395 100644 --- a/doc/sphinx/arm/hooks-flex-id.rst +++ b/doc/sphinx/arm/hooks-flex-id.rst @@ -14,8 +14,12 @@ above, use parts of specific options, or perhaps even use a combination of several options and fields to uniquely identify a client. Those scenarios are addressed by the Flexible Identifiers hook application. -The Flexible Identifier library is only available to ISC customers with a paid support -contract. +.. note:: + + :ischooklib:`libdhcp_flex_id.so` is available as a premium + hook library from ISC. Please visit https://www.isc.org/shop/ to purchase + the premium hook libraries, or contact us at https://www.isc.org/contact for + more information. .. note:: diff --git a/doc/sphinx/arm/hooks-flex-option.rst b/doc/sphinx/arm/hooks-flex-option.rst index b0dcc38dd0..ffac0904e8 100644 --- a/doc/sphinx/arm/hooks-flex-option.rst +++ b/doc/sphinx/arm/hooks-flex-option.rst @@ -10,6 +10,11 @@ out during the final stages of constructing a query response packet, just before it is sent to the client. The three actions currently supported are ``add``, ``supersede``, and ``remove``. +.. note:: + + :ischooklib:`libdhcp_flex_option.so` is part of the open source code and is + available to every Kea user. + The syntax used for the action expressions is the same syntax used for client classification and the Flexible Identifier hook library; see either :ref:`classification-using-expressions` or :ref:`hooks-flex-id` diff --git a/doc/sphinx/arm/hooks-gss-tsig.rst b/doc/sphinx/arm/hooks-gss-tsig.rst index d5817d39d3..7c4e0b9e48 100644 --- a/doc/sphinx/arm/hooks-gss-tsig.rst +++ b/doc/sphinx/arm/hooks-gss-tsig.rst @@ -7,3 +7,9 @@ This hook library allows the :iscman:`kea-dhcp-ddns` server to use GSS-TSIG to sign DNS updates. For a full discussion of GSS-TSIG in Kea, please see :ref:`gss-tsig`. + +.. note:: + + :ischooklib:`libddns_gss_tsig.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst index c81bd920f8..4fa32b8f1f 100644 --- a/doc/sphinx/arm/hooks-ha.rst +++ b/doc/sphinx/arm/hooks-ha.rst @@ -6,8 +6,13 @@ This hook library can be loaded on a pair of DHCPv4 or DHCPv6 servers, to increase the reliability of the DHCP service in the event of an outage on one -server. This library was previously only available to ISC's paid subscribers, -but is now part of the open source Kea, available to all users. +server. + +.. note:: + + :ischooklib:`libdhcp_ha.so` is part of the open source code and is + available to every Kea user. It was previously available only to ISC + customers with a paid support contract. .. note:: diff --git a/doc/sphinx/arm/hooks-host-cache.rst b/doc/sphinx/arm/hooks-host-cache.rst index de7a121e54..ec8851a74e 100644 --- a/doc/sphinx/arm/hooks-host-cache.rst +++ b/doc/sphinx/arm/hooks-host-cache.rst @@ -12,6 +12,12 @@ cache information from the database locally. This includes negative caching, i.e. the ability to remember that there is no client information in the database. +.. note:: + + :ischooklib:`libdhcp_host_cache.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. + .. note:: This library can only be loaded by the :iscman:`kea-dhcp4` or diff --git a/doc/sphinx/arm/hooks-host-cmds.rst b/doc/sphinx/arm/hooks-host-cmds.rst index 0a76c27688..183997433b 100644 --- a/doc/sphinx/arm/hooks-host-cmds.rst +++ b/doc/sphinx/arm/hooks-host-cmds.rst @@ -14,8 +14,12 @@ same subnet - is rejected. Those commands are exposed via the command channel (JSON over UNIX sockets) and the Control Agent (JSON over a RESTful interface). -This library is only available to ISC customers with a paid support -contract. +.. note:: + + :ischooklib:`libdhcp_host_cmds.so` is available as a premium + hook library from ISC. Please visit https://www.isc.org/shop/ to purchase + the premium hook libraries, or contact us at https://www.isc.org/contact for + more information. .. note:: diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst index ac3601602a..61ee7558ca 100644 --- a/doc/sphinx/arm/hooks-lease-cmds.rst +++ b/doc/sphinx/arm/hooks-lease-cmds.rst @@ -17,8 +17,10 @@ of the subnet to which it is supposed to belong. The library also provides a non-programmatic way to manage user contexts associated with leases. -The Lease Commands library is part of the open source code and is -available to every Kea user. +.. note:: + + :ischooklib:`libdhcp_lease_cmds.so` is part of the open source code and is + available to every Kea user. .. note:: diff --git a/doc/sphinx/arm/hooks-lease-query.rst b/doc/sphinx/arm/hooks-lease-query.rst index 2ad2c32889..edc0230d7b 100644 --- a/doc/sphinx/arm/hooks-lease-query.rst +++ b/doc/sphinx/arm/hooks-lease-query.rst @@ -8,6 +8,12 @@ This library provides support for DHCPv4 Leasequery as described in `RFC 4388 `__; and for DHCPv6 Leasequery as described in (`RFC 5007 `__). +.. note:: + + :ischooklib:`libdhcp_lease_query.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. + .. note:: This library can only be loaded by the :iscman:`kea-dhcp4` or @@ -19,8 +25,6 @@ Kea version 2.3.5 added support for DHCPv4 Bulk Leasequery (`RFC 6926 `__) using the memfile lease backend. -The Leasequery library is only available to ISC customers with a paid support contract. - .. _lease-query-dhcpv4: DHCPv4 Leasequery diff --git a/doc/sphinx/arm/hooks-legal-log.rst b/doc/sphinx/arm/hooks-legal-log.rst index daea88fcdf..67ff4efa1d 100644 --- a/doc/sphinx/arm/hooks-legal-log.rst +++ b/doc/sphinx/arm/hooks-legal-log.rst @@ -8,12 +8,16 @@ The Forensic Logging hook library provides hooks that record a detailed log of assignments, renewals, releases, and other lease events into a set of log files. -Currently this library is only available to ISC customers with a paid support -contract. +.. note:: + + :ischooklib:`libdhcp_legal_log.so` is available as a premium + hook library from ISC. Please visit https://www.isc.org/shop/ to purchase + the premium hook libraries, or contact us at https://www.isc.org/contact for + more information. .. note:: - This library may only be loaded by the :iscman:`kea-dhcp4` or :iscman:`kea-dhcp6` + This library can only be loaded by the :iscman:`kea-dhcp4` or :iscman:`kea-dhcp6` process. In many legal jurisdictions, companies - especially ISPs - must record diff --git a/doc/sphinx/arm/hooks-limits.rst b/doc/sphinx/arm/hooks-limits.rst index 6560102df3..73c6d2773b 100644 --- a/doc/sphinx/arm/hooks-limits.rst +++ b/doc/sphinx/arm/hooks-limits.rst @@ -9,7 +9,11 @@ This hook library enables two types of limits: 1. Lease limiting: allow a maximum of ``n`` leases assigned at any one time. 2. Rate limiting: allow a maximum of ``n`` packets per ``time_unit`` to receive a response. -The Limits hook library is only available to ISC customers with a paid support contract. +.. note:: + + :ischooklib:`libdhcp_limits.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. .. _hooks-limits-configuration: diff --git a/doc/sphinx/arm/hooks-radius.rst b/doc/sphinx/arm/hooks-radius.rst index 3ee245bc0d..927aac4537 100644 --- a/doc/sphinx/arm/hooks-radius.rst +++ b/doc/sphinx/arm/hooks-radius.rst @@ -15,6 +15,12 @@ often not flexible enough to send and receive additional RADIUS attributes. As such, the alternative looks more appealing: to extend the DHCP server to talk to RADIUS directly. That is the goal of this library. +.. note:: + + :ischooklib:`libdhcp_radius.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. + .. note:: This library can only be loaded by the :iscman:`kea-dhcp4` or the diff --git a/doc/sphinx/arm/hooks-rbac.rst b/doc/sphinx/arm/hooks-rbac.rst index 7f3026be57..1df4dd5833 100644 --- a/doc/sphinx/arm/hooks-rbac.rst +++ b/doc/sphinx/arm/hooks-rbac.rst @@ -31,6 +31,12 @@ Here is a summary of the steps in processing a response: request processing (when the request was accepted). - Request filters are applied to the response. +.. note:: + + :ischooklib:`libca_rbac.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. + .. _hooks-RBAC-config: Role-Based Access Control Configuration diff --git a/doc/sphinx/arm/hooks-run-script.rst b/doc/sphinx/arm/hooks-run-script.rst index 5e7e182686..3d117244f7 100644 --- a/doc/sphinx/arm/hooks-run-script.rst +++ b/doc/sphinx/arm/hooks-run-script.rst @@ -7,6 +7,11 @@ The Run Script hook library adds support for calling an external script for specific packet-processing hook points. +.. note:: + + :ischooklib:`libdhcp_run_script.so` is part of the open source code and is + available to every Kea user. + The library, which was added in Kea 1.9.5, can be loaded in a similar way to other hook libraries by the :iscman:`kea-dhcp4` and :iscman:`kea-dhcp6` processes. diff --git a/doc/sphinx/arm/hooks-stat-cmds.rst b/doc/sphinx/arm/hooks-stat-cmds.rst index bc751b9005..a5d5d79699 100644 --- a/doc/sphinx/arm/hooks-stat-cmds.rst +++ b/doc/sphinx/arm/hooks-stat-cmds.rst @@ -18,6 +18,11 @@ retrieving lease statistics for a single subnet, a range of subnets, or all subnets. Finally, this library provides commands for retrieving these statistics. +.. note:: + + :ischooklib:`libdhcp_stat_cmds.so` is part of the open source code and is + available to every Kea user. + .. note:: This library can only be loaded by the :iscman:`kea-dhcp4` or @@ -36,8 +41,7 @@ All commands use JSON syntax and can be issued directly to the servers via either the control channel (see :ref:`ctrl-channel`) or the Control Agent (see :ref:`kea-ctrl-agent`). -This library may be loaded by both the :iscman:`kea-dhcp4` and :iscman:`kea-dhcp6` servers. It -is loaded in the same way as other libraries and currently has no +This library is loaded in the same way as other libraries and currently has no parameters: :: @@ -52,7 +56,7 @@ parameters: } In a deployment with multiple Kea DHCP servers sharing a common lease -storage, this hook library may be loaded by any or all of the servers. However, +storage, this hook library can be loaded by any or all of the servers. However, a server's response to a :isccmd:`stat-lease4-get` / :isccmd:`stat-lease6-get` command will only contain data for subnets known to that server. In other words, if a subnet does not appear in a server's diff --git a/doc/sphinx/arm/hooks-subnet-cmds.rst b/doc/sphinx/arm/hooks-subnet-cmds.rst index c1e06cd95a..63cedfe1b2 100644 --- a/doc/sphinx/arm/hooks-subnet-cmds.rst +++ b/doc/sphinx/arm/hooks-subnet-cmds.rst @@ -14,8 +14,11 @@ ability to manage shared networks (listing, retrieving details, adding new ones, removing existing ones, and adding subnets to and removing them from shared networks) is also provided. -This library is only available to ISC customers with a paid support -contract. +.. note:: + + :ischooklib:`libdhcp_subnet_cmds.so` is available only to ISC customers with + a paid support contract. For more information on subscription options, + please complete the form at https://www.isc.org/contact. .. note:: diff --git a/doc/sphinx/arm/hooks-user-chk.rst b/doc/sphinx/arm/hooks-user-chk.rst index 75db216594..37f94b4c88 100644 --- a/doc/sphinx/arm/hooks-user-chk.rst +++ b/doc/sphinx/arm/hooks-user-chk.rst @@ -18,7 +18,10 @@ This library serves several purposes: - To serve as a demonstration of various capabilities possible using the hooks interface. -This library is part of the Kea open source and is available to all users. +.. note:: + + :ischooklib:`libdhcp_user_chk.so` is part of the open source code and is + available to every Kea user. Once loaded, the library allows the separation of incoming requests into known and unknown clients. For known clients, packets are processed