[#898] Proposed expansion of bootp docs.

diff --git a/doc/sphinx/Makefile.am b/doc/sphinx/Makefile.am
index d9efa6602276f85e325975f58b0e1e45d90847cb..c3abd4389a55f495c3e094dcad00c8ffbbfc3237 100644 (file)
--- a/doc/sphinx/Makefile.am
+++ b/doc/sphinx/Makefile.am
@@ -31,6 +31,7 @@ rst_arm_sources+=arm/ddns.rst
 rst_arm_sources+=arm/dhcp4-srv.rst
 rst_arm_sources+=arm/dhcp6-srv.rst
 rst_arm_sources+=arm/hammer.rst
+rst_arm_sources+=arm/hooks-bootp.rst
 rst_arm_sources+=arm/hooks-cb-cmds.rst
 rst_arm_sources+=arm/hooks-class-cmds.rst
 rst_arm_sources+=arm/hooks-ha.rst

diff --git a/doc/sphinx/arm/hooks-bootp.rst b/doc/sphinx/arm/hooks-bootp.rst
new file mode 100644 (file)
index 0000000..20b5312
--- /dev/null
+++ b/doc/sphinx/arm/hooks-bootp.rst
@@ -0,0 +1,51 @@
+.. _hooks-bootp:
+
+BOOTP support
+=============
+
+.. note::
+
+   This is library is still in experimental phase. Use with care!
+
+
+This hooks library adds support for BOOTP with vendor information extensions
+(`RFC 1497 <https://tools.ietf.org/html/rfc1497>`__). Received BOOTP
+requests are recognized, translated into DHCPREQUEST packets by adding
+a dhcp-message-type option and put into the "BOOTP" client class.
+Members of this class get infinite lifetime leases but the class can
+be used too for instance to guard a pool of addresses.
+
+The library is available since Kea 1.7.2 and can be loaded in a
+similar way as other hook libraries by the ``kea-dhcp4`` process.
+It takes no parameter.
+
+::
+
+    "Dhcp4": {
+        "hook_libraries": [
+            {   "library": "/usr/local/lib/libdhcp_bootp.so" },
+            ...
+        ]
+    }
+
+
+.. note::
+
+   This library is only meant to be loaded by the ``kea-dhcp4`` process
+   as there is no BOOTP protocol for IPv6.
+
+.. _books-bootp-limitations:
+
+BOOTP Hooks Limitations
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Currently the BOOTP library has the following limitations:
+
+- BOOTP protocol assumes all lease assignments are permanent. Kea does not support
+  infinite leases yet. You may configure arbitrarily long leases (e.g. a year), but
+  after the lease lifetime elapses, Kea will recycle the lease and may assign it
+  to some other device. This limitation will be removed in the near future.
+
+- A basic BOOTP as defined in `RFC 951 <https://tools.ietf.org/html/rfc951>`__ is
+  not supported. Kea only supports the BOOTP with vendor extensions. Depending on
+  the demand, this may or may not be implemented in the future.

diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst
index 6e39d4d593fe3b83c5ef35ab6f53b279123b8437..f4c2b23b024c3b7144a56f1ba82ea02c887fc576 100644 (file)
--- a/doc/sphinx/arm/hooks.rst
+++ b/doc/sphinx/arm/hooks.rst
@@ -2780,31 +2780,7 @@ following:
 The ``network6-subnet-del`` command uses exactly the same syntax for
 both the command and the response.
 
-.. _bootp-library:
-
-bootp BOOTP support
-===================
-
-This library adds support for BOOTP with vendor information extensions
-(`RFC 1497 <https://tools.ietf.org/html/rfc1497>`__). Received BOOTP
-requests are recognized, translated into DHCPREQUEST packets by adding
-a dhcp-message-type option and put into the "BOOTP" client class.
-Members of this class get infinite lifetime leases but the class can
-be used too for instance to guard a pool of addresses.
-
-The library is available since Kea 1.7.2 and can be loaded in a
-similar way as other hook libraries by the ``kea-dhcp4`` process.
-It takes no parameter.
-
-::
-
-    "Dhcp4": {
-        "hook_libraries": [
-            {   "library": "/usr/local/lib/libdhcp_bootp.so" },
-            ...
-        ]
-    }
-
+.. include:: hooks-bootp.rst
 .. include:: hooks-class-cmds.rst
 .. include:: hooks-cb-cmds.rst
 .. include:: hooks-ha.rst