[#1405] added parser for the reservation-modes map

5 files changed, 113 insertions, 20 deletions

diff --git a/doc/examples/kea6/all-keys-netconf.json b/doc/examples/kea6/all-keys-netconf.json
index eb16357c2e..7585399fb6 100644
--- a/doc/examples/kea6/all-keys-netconf.json
+++ b/doc/examples/kea6/all-keys-netconf.json
@@ -528,7 +528,16 @@
 
                 // Enumeration specifying server's mode of operation when it
                 // fetches host reservations.
-                "reservation-mode": "all",
+                // It is deprecated by the "reservation-modes" map.
+                // "reservation-mode": "all",
+
+                // Reservation modes specifying server's mode of operation when it
+                // fetches host reservations.
+                "reservation-modes": {
+                    "global": False,
+                    "in-subnet": True,
+                    "out-of-pool": True
+                },
 
                 // List of client classes which must be evaluated when this shared
                 // network is selected for client assignments.
@@ -676,7 +685,16 @@
 
                         // Enumeration specifying server's mode of operation when it
                         // fetches host reservations.
-                        "reservation-mode": "all",
+                        // It is deprecated by the "reservation-modes" map.
+                        // "reservation-mode": "all",
+
+                        // Reservation modes specifying server's mode of operation when it
+                        // fetches host reservations.
+                        "reservation-modes": {
+                            "global": False,
+                            "in-subnet": True,
+                            "out-of-pool": True
+                        },
 
                         // Subnet level compute T1 and T2 timers.
                         "calculate-tee-times": true,
@@ -763,8 +781,7 @@
 
         // Configuration control (currently not used, i.e. this syntax
         // is already defined but corresponding feature is not implemented).
-        "config-control":
-        {
+        "config-control": {
             // Only configuration databases entry is defined.
             "config-databases": [
                 {
@@ -784,8 +801,7 @@
         "server-tag": "my DHCPv6 server",
 
         // DHCP queue control parameters.
-        "dhcp-queue-control":
-        {
+        "dhcp-queue-control": {
             // Enable queue is mandatory.
             "enable-queue": true,
 
@@ -794,7 +810,16 @@
         },
 
         // Fetches host reservations.
-        "reservation-mode": "all",
+        // It is deprecated by the "reservation-modes" map.
+        // "reservation-mode": "all",
+
+        // Reservation modes specifying server's mode of operation when it
+        // fetches host reservations.
+        "reservation-modes": {
+            "global": False,
+            "in-subnet": True,
+            "out-of-pool": True
+        },
 
         // Data directory.
         "data-directory": "/tmp",
diff --git a/doc/examples/kea6/all-keys.json b/doc/examples/kea6/all-keys.json
index ab84a84351..9482db7521 100644
--- a/doc/examples/kea6/all-keys.json
+++ b/doc/examples/kea6/all-keys.json
@@ -653,7 +653,16 @@
 
                 // Enumeration specifying server's mode of operation when it
                 // fetches host reservations.
-                "reservation-mode": "all",
+                // It is deprecated by the "reservation-modes" map.
+                // "reservation-mode": "all",
+
+                // Reservation modes specifying server's mode of operation when it
+                // fetches host reservations.
+                "reservation-modes": {
+                    "global": False,
+                    "in-subnet": True,
+                    "out-of-pool": True
+                },
 
                 // List of client classes which must be evaluated when this shared
                 // network is selected for client assignments.
@@ -839,7 +848,16 @@
 
                         // Enumeration specifying server's mode of operation when it
                         // fetches host reservations.
-                        "reservation-mode": "all",
+                        // It is deprecated by the "reservation-modes" map.
+                        // "reservation-mode": "all",
+
+                        // Reservation modes specifying server's mode of operation when it
+                        // fetches host reservations.
+                        "reservation-modes": {
+                            "global": False,
+                            "in-subnet": True,
+                            "out-of-pool": True
+                        },
 
                         // Subnet level compute T1 and T2 timers.
                         "calculate-tee-times": true,
@@ -932,8 +950,7 @@
 
         // Configuration control (currently not used, i.e. this syntax
         // is already defined but corresponding feature is not implemented).
-        "config-control":
-        {
+        "config-control": {
             // Only configuration databases entry is defined.
             "config-databases": [
                 {
@@ -953,8 +970,7 @@
         "server-tag": "my DHCPv6 server",
 
         // DHCP queue control parameters.
-        "dhcp-queue-control":
-        {
+        "dhcp-queue-control": {
             // Enable queue is mandatory.
             "enable-queue": true,
 
@@ -966,7 +982,16 @@
         },
 
         // Fetches host reservations.
-        "reservation-mode": "all",
+        // It is deprecated by the "reservation-modes" map.
+        // "reservation-mode": "all",
+
+        // Reservation modes specifying server's mode of operation when it
+        // fetches host reservations.
+        "reservation-modes": {
+            "global": False,
+            "in-subnet": True,
+            "out-of-pool": True
+        },
 
         // Data directory.
         "data-directory": "/tmp",
diff --git a/doc/examples/kea6/global-reservations.json b/doc/examples/kea6/global-reservations.json
index b5674178c1..53e253a8d9 100644
--- a/doc/examples/kea6/global-reservations.json
+++ b/doc/examples/kea6/global-reservations.json
@@ -36,11 +36,20 @@
 // costly database lookup to do so. It is therefore useful from a performance
 // perspective to use only the reservation types that are actually used in a
 // given network.
-    "host-reservation-identifiers": [ "duid", "hw-address", "flex-id" ],
+  "host-reservation-identifiers": [ "duid", "hw-address", "flex-id" ],
 
 // This directive tells Kea that reservations are global. Note that this
 // can also be specified at shared network and/or subnet level.
-    "reservation-mode": "global",
+// It is deprecated by the "reservation-modes" map.
+// "reservation-mode": "global",
+
+// Since Kea 1.9.1, a more flexible option of configuring the way Kea uses host
+// reservations is available through the 'reservation-modes' map.
+  "reservation-modes": {
+      "global": True,
+      "in-subnet": False,
+      "out-of-pool": False
+  },
 
 // Define several global host reservations.
     "reservations": [
diff --git a/doc/examples/kea6/reservations.json b/doc/examples/kea6/reservations.json
index dad59d4f1e..5005b5100e 100644
--- a/doc/examples/kea6/reservations.json
+++ b/doc/examples/kea6/reservations.json
@@ -48,7 +48,16 @@
       // out of the dynamic pool and change reservation-mode to "out-of-pool".
       // Kea will then be able to skip querying for host reservations when
       // assigning leases from dynamic pool.
-      "reservation-mode": "all",
+      // It is deprecated by the "reservation-modes" map.
+      // "reservation-mode": "all",
+
+      // Reservation modes specifying server's mode of operation when it
+      // fetches host reservations.
+      "reservation-modes": {
+          "global": False,
+          "in-subnet": True,
+          "out-of-pool": True
+      },
 
       "pools": [ { "pool": "2001:db8:1::/120" } ],
 
diff --git a/doc/examples/kea6/shared-network.json b/doc/examples/kea6/shared-network.json
index a8a537e36f..49f1c998ea 100644
--- a/doc/examples/kea6/shared-network.json
+++ b/doc/examples/kea6/shared-network.json
@@ -69,7 +69,16 @@
                 "ip-address": "2001:db8::1"
             },
             "renew-timer": 100,
-            "reservation-mode": "all",
+            // It is deprecated by the "reservation-modes" map.
+            // "reservation-mode": "all",
+
+            // Reservation modes specifying server's mode of operation when it
+            // fetches host reservations.
+            "reservation-modes": {
+                "global": False,
+                "in-subnet": True,
+                "out-of-pool": True
+            },
 
             // List of subnets belonging to this particular shared-network
             // start here.
@@ -85,7 +94,15 @@
                         "ip-address": "2001:db8:1::123"
                     },
                     "renew-timer": 10,
-                    "reservation-mode": "all",
+                    // It is deprecated by the "reservation-modes" map.
+                    // "reservation-mode": "all",
+                    // Reservation modes specifying server's mode of operation when it
+                    // fetches host reservations.
+                    "reservation-modes": {
+                        "global": False,
+                        "in-subnet": True,
+                        "out-of-pool": True
+                    },
                     "subnet": "2001:db8:1::/64",
                     "pools": [ { "pool": "2001:db8:1:abcd::/64" } ],
                     "valid-lifetime": 40
@@ -101,7 +118,15 @@
                         "ip-address": "3000::1"
                     },
                     "renew-timer": 10,
-                    "reservation-mode": "all",
+                    // It is deprecated by the "reservation-modes" map.
+                    // "reservation-mode": "all",
+                    // Reservation modes specifying server's mode of operation when it
+                    // fetches host reservations.
+                    "reservation-modes": {
+                        "global": False,
+                        "in-subnet": True,
+                        "out-of-pool": True
+                    },
                     "subnet": "3000::/16",
                     "valid-lifetime": 40
                 }