]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3290] docs - ha-scopes warning
authorMarcin Godzina <mgodzina@isc.org>
Thu, 23 May 2024 11:19:52 +0000 (11:19 +0000)
committerMarcin Godzina <mgodzina@isc.org>
Thu, 23 May 2024 11:19:52 +0000 (11:19 +0000)
doc/sphinx/arm/hooks-ha.rst

index 0f8c35cb58f8caeb152c5daa4e1984980cf86bc9..154d688413b7f933288f11d947ec470b416fdaf4 100644 (file)
@@ -1920,9 +1920,23 @@ The ``ha-scopes`` Command
 -------------------------
 
 This command allows an administrator to modify the HA scopes being served.
+It can be useful when recovering from a failure or when performing maintenance.
 Consult :ref:`ha-load-balancing-config` and :ref:`ha-hot-standby-config` to
-learn which scopes are available for the different HA modes of operation. The
-:isccmd:`ha-scopes` command has the following structure (in a DHCPv4 example):
+learn which scopes are available for the different HA modes of operation.
+
+.. warning::
+
+   The :isccmd:`ha-scopes` command can put Kea servers into conflicting states,
+   which can lead to unexpected behavior. Changing scopes does not automatically
+   change the state of the server or its relationship with a partner.
+   
+   For example, when we add primary scopes to the standby server it will start
+   responding to DHCP traffic for those scopes. This can lead to a situation where
+   both servers are responding to the same traffic, which can lead to IP address
+   collisions.
+
+The :isccmd:`ha-scopes` command has the following structure;
+using an example in DHCPv4.:
 
 ::