summaryrefslogtreecommitdiffstats
path: root/doc/sphinx
diff options
context:
space:
mode:
authorRazvan Becheriu <razvan@isc.org>2023-12-14 08:44:43 +0100
committerRazvan Becheriu <razvan@isc.org>2023-12-14 09:06:33 +0100
commit303292599a72eb5ead443b247ef62ae631a97239 (patch)
tree869ffd9a5b1bb3bfd8e5a59eaab0c1f4168134ee /doc/sphinx
parent[#3019] addressed review comments (diff)
downloadkea-303292599a72eb5ead443b247ef62ae631a97239.tar.xz
kea-303292599a72eb5ead443b247ef62ae631a97239.zip
[#3019] updated documentation and added ChangeLog entry
Diffstat (limited to 'doc/sphinx')
-rw-r--r--doc/sphinx/arm/database-connectivity.rst4
-rw-r--r--doc/sphinx/arm/dhcp4-srv.rst4
-rw-r--r--doc/sphinx/arm/dhcp6-srv.rst4
-rw-r--r--doc/sphinx/arm/hooks-limits.rst7
4 files changed, 19 insertions, 0 deletions
diff --git a/doc/sphinx/arm/database-connectivity.rst b/doc/sphinx/arm/database-connectivity.rst
index d470c34002..2d4e2f5217 100644
--- a/doc/sphinx/arm/database-connectivity.rst
+++ b/doc/sphinx/arm/database-connectivity.rst
@@ -23,6 +23,10 @@ system allows nanny scripts to detect the problem.
If ``retry-on-startup`` is set to ``true``, the server will start reconnection
attempts even at server startup or on reconfigure events, and will honor the
action specified in the ``on-fail`` parameter.
+Database connection retries are not attempted on startup if the
+:ischooklib:`libdhcp_limits.so` is loaded because the hook library requires a
+valid connection to the database to check if JSON format is supported and to
+recount class limits.
During dynamic reconfiguration, all backends are disconnected and then
reconnected using the new configuration. If connectivity to any of the
diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index 307c488cfe..0edf138aba 100644
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -825,6 +825,10 @@ system allows nanny scripts to detect the problem.
If ``retry-on-startup`` is set to ``true``, the server will start reconnection
attempts even at server startup or on reconfigure events, and will honor the
action specified in the ``on-fail`` parameter.
+Database connection retries are not attempted on startup if the
+:ischooklib:`libdhcp_limits.so` is loaded because the hook library requires a
+valid connection to the database to check if JSON format is supported and to
+recount class limits.
Finally, the credentials of the account under which the server will
access the database should be set:
diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index 9c19b1460d..bb81b7e250 100644
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -781,6 +781,10 @@ system allows nanny scripts to detect the problem.
If ``retry-on-startup`` is set to ``true``, the server will start reconnection
attempts even at server startup or on reconfigure events, and will honor the
action specified in the ``on-fail`` parameter.
+Database connection retries are not attempted on startup if the
+:ischooklib:`libdhcp_limits.so` is loaded because the hook library requires a
+valid connection to the database to check if JSON format is supported and to
+recount class limits.
Finally, the credentials of the account under which the server will
access the database should be set:
diff --git a/doc/sphinx/arm/hooks-limits.rst b/doc/sphinx/arm/hooks-limits.rst
index 73c6d2773b..42bb39a0d0 100644
--- a/doc/sphinx/arm/hooks-limits.rst
+++ b/doc/sphinx/arm/hooks-limits.rst
@@ -117,6 +117,13 @@ This is how a lease limit is defined for a subnet inside a shared network:
respective client class or subnet. To reset the lease count, change the client class name
or the subnet ID.
+.. note::
+
+ Database connection retries are not attempted on startup if the
+ :ischooklib:`libdhcp_limits.so` is loaded because the hook library requires a
+ valid connection to the database to check if JSON format is supported and to
+ recount class limits.
+
.. _hooks-limits-lease-limiting:
Lease Limiting