From: Marcin Siodelski <marcin@isc.org>
Date: Mon, 10 Dec 2018 15:31:35 +0000 (+0100)
Subject: [#173,!154] Added a note suggesting to set reconnect for all used backends.
X-Git-Tag: 339-doxygen-errors_base~10^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=377f49e84ad6ebc91cbeac4116d24a15571c522d;p=thirdparty%2Fkea.git

[#173,!154] Added a note suggesting to set reconnect for all used backends.
---

diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index 6c08867d8d..7befc88735 100644
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -505,6 +505,19 @@ The default value for MySQL and Postgres is 0, which disables automatic recovery
 causes the server to exit immediately upon detecting the loss of connectivity.
 The default value for Cassandra is 2000 ms.
     </para>
+
+    <note>
+      <para>
+        Automatic reconnect to database backends is configured individually per backend.
+        This allows you to tailor the recovery parameters to the each backend you use.
+        We do suggest that you either enable it for all backends or no backends so you
+        have consistent behavior.  Losing connectivity to a backend for which reconnect
+        is disabled will result in the server shutting itself down. This includes the
+        cases when lease database backend and hosts database backend is connected to
+        the same database instance.
+      </para>
+    </note>
+
   <para>Finally, the credentials of the account under which the server will
   access the database should be set:
 <screen>
@@ -673,17 +686,17 @@ causes the server to exit immediately upon detecting the loss of connectivity.
 The default value for Cassandra is 2000 ms.
     </para>
 
-    <warning>
+    <note>
       <para>
-        Current Kea release has a flaw whereby the values of <command>reconnect-wait-time</command>
-        and <command>max-reconnect-tries</command> specified in the <command>lease-database</command>
-        override the setting of those parameters in the <command>hosts-database</command>. The
-        parameters specified within the <command>hosts-database</command> are only effective
-        when <command>memfile</command> is used as a lease database backend. This behavior will
-        be corrected in the future releases of Kea.
+        Automatic reconnect to database backends is configured individually per backend.
+        This allows you to tailor the recovery parameters to the each backend you use.
+        We do suggest that you either enable it for all backends or no backends so you
+        have consistent behavior.  Losing connectivity to a backend for which reconnect
+        is disabled will result in the server shutting itself down. This includes the
+        cases when lease database backend and hosts database backend is connected to
+        the same database instance.
       </para>
-    </warning>
-
+    </note>
   </para>
   <para>Finally, the credentials of the account under which the server will
   access the database should be set:
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index 63be6fbd9d..968eee6006 100644
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -502,6 +502,19 @@ The default value for MySQL and Postgres is 0, which disables automatic recovery
 causes the server to exit immediately upon detecting the loss of connectivity.
 The default value for Cassandra is 2000 ms.
   </para>
+
+  <note>
+    <para>
+      Automatic reconnect to database backends is configured individually per backend.
+      This allows you to tailor the recovery parameters to the each backend you use.
+      We do suggest that you either enable it for all backends or no backends so you
+      have consistent behavior.  Losing connectivity to a backend for which reconnect
+      is disabled will result in the server shutting itself down. This includes the
+      cases when lease database backend and hosts database backend is connected to
+      the same database instance.
+    </para>
+  </note>
+
   <para>
     Note that host parameter is used by MySQL and PostgreSQL
     backends. Cassandra has a concept of contact points that could be
@@ -610,16 +623,17 @@ causes the server to exit immediately upon detecting the loss of connectivity.
 The default value for Cassandra is 2000 ms.
   </para>
 
-  <warning>
-    <para>
-      Current Kea release has a flaw whereby the values of <command>reconnect-wait-time</command>
-      and <command>max-reconnect-tries</command> specified in the <command>lease-database</command>
-      override the setting of those parameters in the <command>hosts-database</command>. The
-      parameters specified within the <command>hosts-database</command> are only effective
-      when <command>memfile</command> is used as a lease database backend. This behavior will
-      be corrected in the future releases of Kea.
-    </para>
-  </warning>
+    <note>
+      <para>
+        Automatic reconnect to database backends is configured individually per backend.
+        This allows you to tailor the recovery parameters to the each backend you use.
+        We do suggest that you either enable it for all backends or no backends so you
+        have consistent behavior.  Losing connectivity to a backend for which reconnect
+        is disabled will result in the server shutting itself down. This includes the
+        cases when lease database backend and hosts database backend is connected to
+        the same database instance.
+      </para>
+    </note>
 
   <para>Finally, the credentials of the account under which the server will
   access the database should be set: