mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-03 07:25:18 +00:00
Code Issues Releases Wiki Activity

[#2749] document default HA+MT

Browse Source
This commit is contained in:
Andrei Pavel
2023-03-28 19:38:59 +03:00
parent 84672202c2
commit c86d074590
9 changed files with 25 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/examples/kea4/all-keys-netconf.json
View File

@@ -637,10 +637,8 @@
// Multi-threading parameters. // Multi-threading parameters.
"multi-threading": { "multi-threading": {
// By default Kea processes packets on a single thread (default // By default, Kea processes packets on multiple threads if the hardware permits.
// 'false' value for this option). To enable multi-threading, this "enable-multi-threading": true,
// option can be set ('true' value).
"enable-multi-threading": false,
// When multi-threading is enabled, Kea will process packets on a // When multi-threading is enabled, Kea will process packets on a
// number of multiple threads configurable through this option. The // number of multiple threads configurable through this option. The

6
doc/examples/kea4/all-keys.json
View File

@@ -687,10 +687,8 @@
// Multi-threading parameters. // Multi-threading parameters.
"multi-threading": { "multi-threading": {
// By default Kea processes packets on a single thread (default // By default, Kea processes packets on multiple threads if the hardware permits.
// 'false' value for this option). To enable multi-threading, this "enable-multi-threading": true,
// option can be set ('true' value).
"enable-multi-threading": false,
// When multi-threading is enabled, Kea will process packets on a // When multi-threading is enabled, Kea will process packets on a
// number of multiple threads configurable through this option. The // number of multiple threads configurable through this option. The

3
doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json
View File

@@ -30,7 +30,7 @@
// Multi-threading parameters. // Multi-threading parameters.
"multi-threading": { "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, "enable-multi-threading": true,
// When multi-threading is enabled, Kea will process packets on a // When multi-threading is enabled, Kea will process packets on a
@@ -139,6 +139,7 @@
// processing packets on multiple threads, the High Availability module // processing packets on multiple threads, the High Availability module
// must have multi-threading enabled. // must have multi-threading enabled.
"multi-threading": { "multi-threading": {
// Enable High Availability to benefit from multi-threading. Default: true.
"enable-multi-threading": true, "enable-multi-threading": true,
// When running in MT mode, the dedicated listener is used to handle // When running in MT mode, the dedicated listener is used to handle
// lease updates. // lease updates.

3
doc/examples/kea4/ha-load-balancing-server2-mt.json
View File

@@ -29,7 +29,7 @@
// Multi-threading parameters. // Multi-threading parameters.
"multi-threading": { "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, "enable-multi-threading": true,
// When multi-threading is enabled, Kea will process packets on a // When multi-threading is enabled, Kea will process packets on a
@@ -138,6 +138,7 @@
// processing packets on multiple threads, the High Availability module // processing packets on multiple threads, the High Availability module
// must have multi-threading enabled. // must have multi-threading enabled.
"multi-threading": { "multi-threading": {
// Enable High Availability to benefit from multi-threading. Default: true.
"enable-multi-threading": true, "enable-multi-threading": true,
// When running in MT mode, the dedicated listener is used to handle // When running in MT mode, the dedicated listener is used to handle
// lease updates. // lease updates.

6
doc/examples/kea6/all-keys-netconf.json
View File

@@ -578,10 +578,8 @@
// Multi-threading parameters. // Multi-threading parameters.
"multi-threading": { "multi-threading": {
// By default Kea processes packets on a single thread (default // By default, Kea processes packets on multiple threads if the hardware permits.
// 'false' value for this option). To enable multi-threading, this "enable-multi-threading": true,
// option can be set ('true' value).
"enable-multi-threading": false,
// When multi-threading is enabled, Kea will process packets on a // When multi-threading is enabled, Kea will process packets on a
// number of multiple threads configurable through this option. The // number of multiple threads configurable through this option. The

6
doc/examples/kea6/all-keys.json
View File

@@ -616,10 +616,8 @@
// Multi-threading parameters. // Multi-threading parameters.
"multi-threading": { "multi-threading": {
// By default Kea processes packets on a single thread (default // By default, Kea processes packets on multiple threads if the hardware permits.
// 'false' value for this option). To enable multi-threading, this "enable-multi-threading": true,
// option can be set ('true' value).
"enable-multi-threading": false,
// When multi-threading is enabled, Kea will process packets on a // When multi-threading is enabled, Kea will process packets on a
// number of multiple threads configurable through this option. The // number of multiple threads configurable through this option. The

5
doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf
View File

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

5
doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf
View File

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

18
doc/sphinx/arm/hooks-ha.rst
View File

@@ -1645,28 +1645,28 @@ HA+MT operation:
- ``enable-multi-threading`` - enables or disables multi-threading HA peer - ``enable-multi-threading`` - enables or disables multi-threading HA peer
communication (HA+MT). Kea core multi-threading must be enabled for HA+MT to 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 operate. When ``false``, the server relies on ``kea-ctrl-agent`` for
versions, relying on ``kea-ctrl-agent`` and using single-threaded HTTP client communication with its peer, and uses single-threaded HTTP client processing.
processing. The default is ``true``.
- ``http-dedicated-listener`` - enables or disables the creation of a dedicated, - ``http-dedicated-listener`` - enables or disables the creation of a dedicated,
internal HTTP listener through which the server receives HA messages from its internal HTTP listener through which the server receives HA messages from its
peers. The internal listener replaces the role of ``kea-ctrl-agent`` traffic, 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 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 relies on ``kea-ctrl-agent``. This parameter has been provided largely for
flexibility and testing; running HA+MT without dedicated listeners enabled 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 - ``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. 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 - ``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 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``, These parameters are grouped together under a map element, ``multi-threading``,
as illustrated below: as illustrated below: