summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRazvan Becheriu <razvan@isc.org>2021-03-18 21:17:42 +0100
committerRazvan Becheriu <razvan@isc.org>2021-03-29 20:11:29 +0200
commita730cfea4e35b6522a9cb148a37d3b9508840fa9 (patch)
tree8005c9d0a3ea97c57a0983f22fc04e988cb24e41 /doc
parent[#1621] add disable-dhcp-on-db-loss parameter to configure network state effect (diff)
downloadkea-a730cfea4e35b6522a9cb148a37d3b9508840fa9.tar.xz
kea-a730cfea4e35b6522a9cb148a37d3b9508840fa9.zip
[#1621] updated parsers
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/kea4/backends.json2
-rw-r--r--doc/examples/kea6/backends.json2
-rw-r--r--doc/sphinx/arm/database-connectivity.rst12
3 files changed, 11 insertions, 5 deletions
diff --git a/doc/examples/kea4/backends.json b/doc/examples/kea4/backends.json
index 6368c962a5..b91e2b49a0 100644
--- a/doc/examples/kea4/backends.json
+++ b/doc/examples/kea4/backends.json
@@ -42,6 +42,7 @@
// "password": "secret1",
// "reconnect-wait-time": 3000, // expressed in ms
// "max-reconnect-tries": 3,
+// "disable-dhcp-on-db-loss": true,
// "connect-timeout": 3
// },
@@ -61,6 +62,7 @@
// "password": "secret1",
// "reconnect-wait-time": 3000, // expressed in ms
// "max-reconnect-tries": 3,
+// "disable-dhcp-on-db-loss": true,
// "connect-timeout": 3
// },
diff --git a/doc/examples/kea6/backends.json b/doc/examples/kea6/backends.json
index 4d54df56ab..60104f5b31 100644
--- a/doc/examples/kea6/backends.json
+++ b/doc/examples/kea6/backends.json
@@ -42,6 +42,7 @@
// "password": "secret1",
// "reconnect-wait-time": 3000, // expressed in ms
// "max-reconnect-tries": 3,
+// "disable-dhcp-on-db-loss": true,
// "connect-timeout": 3
// },
@@ -61,6 +62,7 @@
// "password": "secret1",
// "reconnect-wait-time": 3000, // expressed in ms
// "max-reconnect-tries": 3,
+// "disable-dhcp-on-db-loss": true,
// "connect-timeout": 3
// },
diff --git a/doc/sphinx/arm/database-connectivity.rst b/doc/sphinx/arm/database-connectivity.rst
index 856f3819a6..a077b9bd66 100644
--- a/doc/sphinx/arm/database-connectivity.rst
+++ b/doc/sphinx/arm/database-connectivity.rst
@@ -6,7 +6,8 @@ Database Connectivity
Kea servers (kea-dhcp4 and kea-dhcp6) can be configured to use a variety of
database backends for leases, hosts, and configuration. All of them may be
configured to support automatic recovery when connectivity is lost (see
-``max-reconnect-tries`` and ``reconnect-wait-time``).
+``max-reconnect-tries``, ``reconnect-wait-time`` and
+``disable-dhcp-on-db-loss``).
It is important to understand how and when automatic recovery comes into play.
Automatic recovery, when configured, only operates after a successful startup
@@ -28,7 +29,8 @@ allows the configuration to be corrected via command, if required.
During normal operations, if connectivity to any of the backends is lost and
automatic recovery for that backend is enabled, the server disconnects from the
respective backend and then attempts to reconnect. During the recovery process,
-the server ceases to serve clients but continues to respond to commands. If
-connectivity to all backends is restored, the server returns to normal
-operations. If connectivity cannot be restored after ``max-reconnect-tries``,
-the server issues a fatal error and exits.
+the server ceases to serve clients according to the ``disable-dhcp-on-db-loss``
+configured option, but continues to respond to commands. If connectivity to all
+backends is restored, the server returns to normal operations. If connectivity
+cannot be restored after ``max-reconnect-tries``, the server issues a fatal
+error and exits.