From: Marcin Siodelski Date: Wed, 22 Sep 2021 05:59:51 +0000 (+0200) Subject: [#2028] Updated the ARM X-Git-Tag: Kea-2.0.0~70 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4a380c004c09f9fa2e406b19febb89e7c2294f79;p=thirdparty%2Fkea.git [#2028] Updated the ARM Added a note about specifying option data and option definitions when using the configuration backend. This was requested in the review. --- diff --git a/doc/sphinx/arm/config-backend.rst b/doc/sphinx/arm/config-backend.rst index ed6ee93d98..9535c0c786 100644 --- a/doc/sphinx/arm/config-backend.rst +++ b/doc/sphinx/arm/config-backend.rst @@ -138,6 +138,26 @@ The current CB limitations will be gradually removed in subsequent Kea releases. not in the database. Use the ``cb_cmds`` hooks library to manage the subnets information in the database instead. +.. note:: + + Using custom option formats requires creating definitions for these options. + Suppose a user wishes to set option data in the configuration backend. In + that case, we recommend specifying the definition for that option in the + configuration backend as well. It is essential when multiple servers are + managed via the configuration backend, and may differ in their + configurations. The option data parser can search for an option definition + appropriate for the server for which the option data is specified. + + In a single-server deployment, or when all servers share the same + configuration file information, it is possible to specify option + definitions in the configuration files and option data in the configuration + backend. The server receiving a command to set option data must have a + valid definition in its configuration file, even when it sets option data + for another server. + + It is not supported to specify option definitions in the configuration + backend and the corresponding option data in the server configuration files. + CB Components ------------- diff --git a/doc/sphinx/arm/hooks-cb-cmds.rst b/doc/sphinx/arm/hooks-cb-cmds.rst index 5f4547980a..ba414ab5ef 100644 --- a/doc/sphinx/arm/hooks-cb-cmds.rst +++ b/doc/sphinx/arm/hooks-cb-cmds.rst @@ -21,6 +21,11 @@ support contract. This library may only be loaded by the ``kea-dhcp4`` or ``kea-dhcp6`` process. +.. note:: + + Please read about :ref:`cb-limitations` before using the commands + described in this section. + Commands Structure ~~~~~~~~~~~~~~~~~~ @@ -1014,7 +1019,7 @@ These commands create a new DHCP option definition or replace an existing option definition in the database. The structure of the option definition information is the same as in the Kea configuration file (see :ref:`dhcp4-custom-options` and :ref:`dhcp6-custom-options`). -The following command creates the DHCPv4 option definition in the +The following command creates the DHCPv4 option definition at the top-level "dhcp4" option space and associates it with the "server1": .. code-block:: json @@ -1042,7 +1047,8 @@ top-level "dhcp4" option space and associates it with the "server1": The `server-tags` list must include exactly one server tag or the keyword "all". It must not contain the -`null` value. +`null` value. + .. _command-remote-option4-global-del: