From 6cad049044a08fb5ab33b0bbcb5d2e9e88f3aab8 Mon Sep 17 00:00:00 2001 From: Andrei Pavel Date: Tue, 31 May 2022 15:33:57 +0300 Subject: [PATCH] [#2422] add limits to the list of hook libraries in the ARM --- doc/sphinx/arm/hooks-limits.rst | 14 +++++++++++--- doc/sphinx/arm/hooks.rst | 5 +++++ 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/doc/sphinx/arm/hooks-limits.rst b/doc/sphinx/arm/hooks-limits.rst index 67816b91c0..b720777295 100644 --- a/doc/sphinx/arm/hooks-limits.rst +++ b/doc/sphinx/arm/hooks-limits.rst @@ -28,9 +28,17 @@ it or the hook library configuration. There are two ways to configure which packets get limited. One is through the client classes that are initially assigned to the packet. In this case, the limit is configured in the user context in the client class definition. Class rate limits are checked early in packet processing cycle -and is thus limited to those classes which are assigned to the packet via test expression and that -do not depend on host reservations, the special "BOOTP" or "KNOWN" classes, and is not marked with -"only-if-required". +and are thus limited to those classes which are assigned to the packet via test expression, that do +not depend on host reservations, the special "BOOTP" or "KNOWN" classes, and that are not marked +with "only-if-required". + +.. note:: + + The limits hook library uses the name to identify a client class and the ID to identify a subnet. + Changing a test expression in a client class or the network range of a subnet while leaving the + name, or the ID respectively, unchanged will not reset the limit for the respective client class + or subnet and what counted towards the limit prior to the change, will continue to take effect. + To start over, consider changing the client class name or the subnet ID. .. note:: diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst index 3a8a15155e..5bd28a5ae5 100644 --- a/doc/sphinx/arm/hooks.rst +++ b/doc/sphinx/arm/hooks.rst @@ -466,6 +466,11 @@ loaded by the correct process per the table below. | | customers |update aspects such as generating hostnames via expressions | | | |and skipping DDNS updates for select clients. | +-----------------+---------------+------------------------------------------------------------+ + | Limits | ISC support | Kea servers ``kea-dhcp4`` and ``kea-dhcp6`` can use this | + | | customers | hook library to apply a limit to the rate at which packets | + | | | receive a response. The limit can be applied | + | | | per client class or per subnet. | + +-----------------+---------------+------------------------------------------------------------+ ISC hopes to see more hook libraries become available as time progresses, developed both internally and externally. Since this list