[#2749] document default HA+MT

diff --git a/doc/examples/kea4/all-keys-netconf.json b/doc/examples/kea4/all-keys-netconf.json
index 2f63bf69438e166444b3feaa3c3bf1b5ef339eb7..3220d769843319b1fc72bfd66c8f15442e466b50 100644 (file)
--- a/doc/examples/kea4/all-keys-netconf.json
+++ b/doc/examples/kea4/all-keys-netconf.json
@@ -637,10 +637,8 @@
 
         // Multi-threading parameters.
         "multi-threading": {
-            // By default Kea processes packets on a single thread (default
-            // 'false' value for this option). To enable multi-threading, this
-            // option can be set ('true' value).
-            "enable-multi-threading": false,
+            // By default, Kea processes packets on multiple threads if the hardware permits.
+            "enable-multi-threading": true,
 
             // When multi-threading is enabled, Kea will process packets on a
             // number of multiple threads configurable through this option. The

diff --git a/doc/examples/kea4/all-keys.json b/doc/examples/kea4/all-keys.json
index 98dc9a431b199cedc6faffd68e0c706b403d2464..0ac496eb125135ab036e3f009fdfc7268468bf98 100644 (file)
--- a/doc/examples/kea4/all-keys.json
+++ b/doc/examples/kea4/all-keys.json
@@ -687,10 +687,8 @@
 
         // Multi-threading parameters.
         "multi-threading": {
-            // By default Kea processes packets on a single thread (default
-            // 'false' value for this option). To enable multi-threading, this
-            // option can be set ('true' value).
-            "enable-multi-threading": false,
+            // By default, Kea processes packets on multiple threads if the hardware permits.
+            "enable-multi-threading": true,
 
             // When multi-threading is enabled, Kea will process packets on a
             // number of multiple threads configurable through this option. The

diff --git a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json
index 3f22ccee751c7bf810344ca3a959f4d6abf04cf9..66afc3238ec163a8ca9affbc75e52bf6be19e2e8 100644 (file)
--- a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json
+++ b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json
@@ -30,7 +30,7 @@
 
     // Multi-threading parameters.
     "multi-threading": {
-        // To enable multi-threading, this option can be set to 'true' value.
+        // By default, Kea processes packets on multiple threads if the hardware permits.
         "enable-multi-threading": true,
 
         // When multi-threading is enabled, Kea will process packets on a
@@ -139,6 +139,7 @@
                     // processing packets on multiple threads, the High Availability module
                     // must have multi-threading enabled.
                     "multi-threading": {
+                        // Enable High Availability to benefit from multi-threading. Default: true.
                         "enable-multi-threading": true,
                         // When running in MT mode, the dedicated listener is used to handle
                         // lease updates.

diff --git a/doc/examples/kea4/ha-load-balancing-server2-mt.json b/doc/examples/kea4/ha-load-balancing-server2-mt.json
index 040d43e9ddae9ea9a46b74679acd965124ea4491..4cc712a43931ea83ac2de67f40606188226e71c6 100644 (file)
--- a/doc/examples/kea4/ha-load-balancing-server2-mt.json
+++ b/doc/examples/kea4/ha-load-balancing-server2-mt.json
@@ -29,7 +29,7 @@
 
     // Multi-threading parameters.
     "multi-threading": {
-        // To enable multi-threading, this option can be set to 'true' value.
+        // By default, Kea processes packets on multiple threads if the hardware permits.
         "enable-multi-threading": true,
 
         // When multi-threading is enabled, Kea will process packets on a
@@ -138,6 +138,7 @@
                     // processing packets on multiple threads, the High Availability module
                     // must have multi-threading enabled.
                     "multi-threading": {
+                        // Enable High Availability to benefit from multi-threading. Default: true.
                         "enable-multi-threading": true,
                         // When running in MT mode, the dedicated listener is used to handle
                         // lease updates.

diff --git a/doc/examples/kea6/all-keys-netconf.json b/doc/examples/kea6/all-keys-netconf.json
index 646253064b14e61091315bb8ec75644d3fb1dfec..ef7e9c041523354b4e92ec909db73d74efc6fa03 100644 (file)
--- a/doc/examples/kea6/all-keys-netconf.json
+++ b/doc/examples/kea6/all-keys-netconf.json
@@ -578,10 +578,8 @@
 
         // Multi-threading parameters.
         "multi-threading": {
-            // By default Kea processes packets on a single thread (default
-            // 'false' value for this option). To enable multi-threading, this
-            // option can be set ('true' value).
-            "enable-multi-threading": false,
+            // By default, Kea processes packets on multiple threads if the hardware permits.
+            "enable-multi-threading": true,
 
             // When multi-threading is enabled, Kea will process packets on a
             // number of multiple threads configurable through this option. The

diff --git a/doc/examples/kea6/all-keys.json b/doc/examples/kea6/all-keys.json
index 5863e2d6f0fc19c91f1428edca7c040b4aaca336..34fdb61cf66c3cffda03cfc8de1c20e9253550aa 100644 (file)
--- a/doc/examples/kea6/all-keys.json
+++ b/doc/examples/kea6/all-keys.json
@@ -616,10 +616,8 @@
 
         // Multi-threading parameters.
         "multi-threading": {
-            // By default Kea processes packets on a single thread (default
-            // 'false' value for this option). To enable multi-threading, this
-            // option can be set ('true' value).
-            "enable-multi-threading": false,
+            // By default, Kea processes packets on multiple threads if the hardware permits.
+            "enable-multi-threading": true,
 
             // When multi-threading is enabled, Kea will process packets on a
             // number of multiple threads configurable through this option. The

diff --git a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf
index 5db639670d9817fc7abf6dfd5388f0f7cecfd915..5b4ae2fa1f0a63f33b2147843a3c9b4a5479d961 100644 (file)
--- a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf
+++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf
@@ -36,9 +36,7 @@
 
     // Multi-threading parameters.
     "multi-threading": {
-        // By default Kea processes packets on a single thread (default
-        // 'false' value for this option). To enable multi-threading, this
-        // option can be set ('true' value).
+        // By default, Kea processes packets on multiple threads if the hardware permits.
         "enable-multi-threading": true,
 
         // When multi-threading is enabled, Kea will process packets on a
@@ -137,6 +135,7 @@
                     // processing packets on multiple threads, the High Availability module
                     // must have multi-threading enabled.
                     "multi-threading": {
+                        // Enable High Availability to benefit from multi-threading. Default: true.
                         "enable-multi-threading": true,
                         // When running in MT mode, the dedicated listener is used to handle
                         // lease updates.

diff --git a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf
index a98e6b3866ff944b0912752e1f88c6f4df2bee05..f1b48ae4be9603590411f1c705c2852e72ac4e77 100644 (file)
--- a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf
+++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf
@@ -36,9 +36,7 @@
 
     // Multi-threading parameters.
     "multi-threading": {
-        // By default Kea processes packets on a single thread (default
-        // 'false' value for this option). To enable multi-threading, this
-        // option can be set ('true' value).
+        // By default, Kea processes packets on multiple threads if the hardware permits.
         "enable-multi-threading": true,
 
         // When multi-threading is enabled, Kea will process packets on a
@@ -137,6 +135,7 @@
                     // processing packets on multiple threads, the High Availability module
                     // must have multi-threading enabled.
                     "multi-threading": {
+                        // Enable High Availability to benefit from multi-threading. Default: true.
                         "enable-multi-threading": true,
                         // When running in MT mode, the dedicated listener is used to handle
                         // lease updates.

diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index 37d815275c532a3d14eeaf63d5544a16cd3c31b6..bc3a923815f9d8609566563ea4ce9b920245256c 100644 (file)
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -1645,28 +1645,28 @@ HA+MT operation:
 
 -  ``enable-multi-threading`` - enables or disables multi-threading HA peer
    communication (HA+MT). Kea core multi-threading must be enabled for HA+MT to
-   operate. When ``false`` (the default), the server operates as in earlier
-   versions, relying on ``kea-ctrl-agent`` and using single-threaded HTTP client
-   processing.
+   operate. When ``false``, the server relies on ``kea-ctrl-agent`` for
+   communication with its peer, and uses single-threaded HTTP client processing.
+   The default is ``true``.
 
 -  ``http-dedicated-listener`` - enables or disables the creation of a dedicated,
    internal HTTP listener through which the server receives HA messages from its
    peers. The internal listener replaces the role of ``kea-ctrl-agent`` traffic,
    allowing peers to send their HA commands directly to each other. The listener
-   listens on the peer's ``url``. When ``false`` (the default), the server
+   listens on the peer's ``url``. When ``false``, the server
    relies on ``kea-ctrl-agent``. This parameter has been provided largely for
    flexibility and testing; running HA+MT without dedicated listeners enabled
-   will substantially limit HA throughput.
+   will substantially limit HA throughput. The default is ``true``.
 
 -  ``http-listener-threads`` - indicates the maximum number of threads the
-   dedicated listener should use. A value of 0 instructs the server to use the
+   dedicated listener should use. A value of ``0`` instructs the server to use the
    same number of threads that the Kea core is using for DHCP multi-threading.
-   The default is 0.
+   The default is ``0``.
 
 -  ``http-client-threads`` - indicates the maximum number of threads that should
-   be used to send HA messages to its peers. A value of 0 instructs the server
+   be used to send HA messages to its peers. A value of ``0`` instructs the server
    to use the same number of threads that the Kea core is using for DHCP
-   multi-threading. The default is 0.
+   multi-threading. The default is ``0``.
 
 These parameters are grouped together under a map element, ``multi-threading``,
 as illustrated below: