]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2472] updated documentation
authorRazvan Becheriu <razvan@isc.org>
Thu, 24 Nov 2022 16:20:55 +0000 (18:20 +0200)
committerRazvan Becheriu <razvan@isc.org>
Thu, 24 Nov 2022 16:38:43 +0000 (18:38 +0200)
doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json
doc/examples/kea4/ha-load-balancing-server2-mt.json
doc/examples/template-ha-mt-tls/info.md
doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf
doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf
doc/sphinx/arm/hooks-flex-id.rst

index 91dde37eb8a9a4e59aece439d74b59b6898d8959..ff094a3387f50c9335c456c01182ef3386cc748d 100644 (file)
                         // 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,
index 5a985e6694cdbf1da0101361cd2a8578158d6447..5f01cf4caf24eaf15c646339f1b622482f654fa7 100644 (file)
                         // 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,
index dbd22818f8276b0b47d09627699d11ebb95166f2..02e9f60e311c099da17acee6c2af1cab6c6d4f4f 100644 (file)
@@ -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.
 
index 6b38a2c063b43a75ec051690a4ef847ca71c8f54..c586f803775bf7eab4e7efde4e5f1def659b9c06 100644 (file)
                         // 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,
index ed65d7a3f0efb2cd618a29019107fd8a41f5b3d8..893bb9a7001c4d25aba663d720b672a025f8bc0e 100644 (file)
                         // 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,
index 8a19a4119d9947132b3a2e543c06a11543634eae..ca407e8ac0d7b33a3127d149d6efc64574a8149f 100644 (file)
@@ -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.