diff options
author | Razvan Becheriu <razvan@isc.org> | 2022-11-24 17:20:55 +0100 |
---|---|---|
committer | Razvan Becheriu <razvan@isc.org> | 2022-11-24 17:38:43 +0100 |
commit | 9b89f0f139aad30a4dff30334d8a13e86caeeb21 (patch) | |
tree | 34782c64f9e87a72f76537e6c8027d2bbdeef442 /doc | |
parent | [#2472] updated documentation for ignore-iaid parameter in flex_id hooks library (diff) | |
download | kea-9b89f0f139aad30a4dff30334d8a13e86caeeb21.tar.xz kea-9b89f0f139aad30a4dff30334d8a13e86caeeb21.zip |
[#2472] updated documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json | 2 | ||||
-rw-r--r-- | doc/examples/kea4/ha-load-balancing-server2-mt.json | 2 | ||||
-rw-r--r-- | doc/examples/template-ha-mt-tls/info.md | 2 | ||||
-rw-r--r-- | doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf | 2 | ||||
-rw-r--r-- | doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf | 2 | ||||
-rw-r--r-- | doc/sphinx/arm/hooks-flex-id.rst | 18 |
6 files changed, 15 insertions, 13 deletions
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 91dde37eb8..ff094a3387 100644 --- a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json +++ b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json @@ -143,7 +143,7 @@ // When running in MT mode, the dedicated listener is used to handle // lease updates. "http-dedicated-listener": true, - // The number of threads used to handle incomming requests. + // The number of threads used to handle incoming requests. // A value of 0 instructs the server to use the same number of // threads that the Kea core is using for DHCP multi-threading. "http-listener-threads": 0, diff --git a/doc/examples/kea4/ha-load-balancing-server2-mt.json b/doc/examples/kea4/ha-load-balancing-server2-mt.json index 5a985e6694..5f01cf4caf 100644 --- a/doc/examples/kea4/ha-load-balancing-server2-mt.json +++ b/doc/examples/kea4/ha-load-balancing-server2-mt.json @@ -142,7 +142,7 @@ // When running in MT mode, the dedicated listener is used to handle // lease updates. "http-dedicated-listener": true, - // The number of threads used to handle incomming requests. + // The number of threads used to handle incoming requests. // A value of 0 instructs the server to use the same number of // threads that the Kea core is using for DHCP multi-threading. "http-listener-threads": 0, diff --git a/doc/examples/template-ha-mt-tls/info.md b/doc/examples/template-ha-mt-tls/info.md index dbd22818f8..02e9f60e31 100644 --- a/doc/examples/template-ha-mt-tls/info.md +++ b/doc/examples/template-ha-mt-tls/info.md @@ -35,7 +35,7 @@ Deployment Considerations The setup is not expected to scale automatically. This example uses 4 threads for processing DHCP traffic, 4 threads for listening and handling HA peer HTTP requests and 4 threads for sending lease updates to the HA peer. The thread queue used to -store incomming DHCP requests is set to 64, but specific values for better +store incoming DHCP requests is set to 64, but specific values for better performance must be determined on the deployment setup by doing proper testing and benchmarks. 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 6b38a2c063..c586f80377 100644 --- a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf +++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf @@ -141,7 +141,7 @@ // When running in MT mode, the dedicated listener is used to handle // lease updates. "http-dedicated-listener": true, - // The number of threads used to handle incomming requests. + // The number of threads used to handle incoming requests. // A value of 0 instructs the server to use the same number of // threads that the Kea core is using for DHCP multi-threading. "http-listener-threads": 0, 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 ed65d7a3f0..893bb9a700 100644 --- a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf +++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf @@ -141,7 +141,7 @@ // When running in MT mode, the dedicated listener is used to handle // lease updates. "http-dedicated-listener": true, - // The number of threads used to handle incomming requests. + // The number of threads used to handle incoming requests. // A value of 0 instructs the server to use the same number of // threads that the Kea core is using for DHCP multi-threading. "http-listener-threads": 0, diff --git a/doc/sphinx/arm/hooks-flex-id.rst b/doc/sphinx/arm/hooks-flex-id.rst index 8a19a4119d..ca407e8ac0 100644 --- a/doc/sphinx/arm/hooks-flex-id.rst +++ b/doc/sphinx/arm/hooks-flex-id.rst @@ -225,16 +225,18 @@ In DHCPv6, the corresponding query looks something like this: } } -When ``ignore-iaid`` is set to ``true`` (default setting is false), the +When ``ignore-iaid`` is set to ``true`` (default value is ``false``), the ``flex-id`` hooks library will make the Kea DHCPv6 server ignore IAID value -from incomming IPv6 packets. This parameter is ignored by the Kea DHCPv4 server. +from incoming IPv6 packets. This parameter is ignored by the Kea DHCPv4 server. .. note:: This functionality breaks RFC compliance and should be enabled only if - required. It will effectively make the Kea DHCPv6 server accept packets - which contain at most one IANA and one IAPD options. - When enabled, a warning message is issued at configure time. - If the incomming packet contains more than one IANA or IAPD option, the - packet will be dropped and a debug log message will indicate this event in - the hooks library logs. + required. When enabled, a warning message is issued at configure time. + If the incoming packet contains more than one IANA, the IAID value will not + be changed on any of the IANAs. Similarly if the incoming packet contains + more than one IAPD, the IAID value will not be changed on any of the IAPDs. + If the packet contains only one IANA the IAID value will be changed to 0 and + stored as such in the lease storage. Similarly if the packet contains only + one IAPD the IAID value will be changed to 0 and stored as such in the lease + storage. |