[5357] Config examples improved.

diff --git a/doc/examples/kea4/shared-network.json b/doc/examples/kea4/shared-network.json
index cdcc84415ed9d69b19a0f1fcfeda0248aa0818a4..e355fe2b40b93459438a5d41a171bd3f35458c32 100644 (file)
--- a/doc/examples/kea4/shared-network.json
+++ b/doc/examples/kea4/shared-network.json
@@ -11,7 +11,7 @@
         // As with any other configuration, you need to tell Kea the interface
         // names, so it would listen to incoming traffic.
         "interfaces-config": {
-            "interfaces": [ "eth0" ]
+            "interfaces": [ "ethX" ]
         },
 
         // You also need to tell where to store lease information.
@@ -21,9 +21,9 @@
             "lfc-interval": 3600
         },
 
-        // Here the shared networks definition starts. shared-networks can
+        // The shared networks definition starts here. shared-networks can
         // contain a list of shared networks. There are many parameters
-        // that can be specfied here, so this example may be overwhelming
+        // that can be specified here, so this example may be overwhelming
         // at first, but the only mandatory parameter for each shared
         // network is name. It must be unique. Typically, each shared
         // subnet also needs to have at least two subnets to be functional,
@@ -103,7 +103,7 @@
             "valid-lifetime": 200
         } ], // end of shared-networks
 
-        // It is likely that in your network you'll have a mix or regular,
+        // It is likely that in your network you'll have a mix of regular,
         // "plain" subnets and shared networks. It is perfectly valid to mix
         // them in the same config file.
         //

diff --git a/doc/examples/kea6/shared-network.json b/doc/examples/kea6/shared-network.json
index 4b0f552da594a33c933383ae377cbf83d7211e29..99b60a8bc3ee44c200ec35c3f59316f20218350a 100644 (file)
--- a/doc/examples/kea6/shared-network.json
+++ b/doc/examples/kea6/shared-network.json
@@ -1,64 +1,100 @@
+// This is an example configuration file for DHCPv6 server in Kea.
+// It demonstrates an advanced feature called shared network. Typically, for
+// each physical link there is one IPv6 subnet that the server is expected
+// to manage. However, in some cases there is a need to configure more subnets
+// in the same physical location. This may sound odd, as IPv6 is not expected
+// to run out of addresses. However, due to vast address space some deployments
+// experiment with various addressing schemes and later find out that the
+// initial proposal was not best and way to migrate to something else.
 {
     "Dhcp6": {
-// Kea is told to listen on ethX interface only.
+        // Kea is told to listen on ethX interface only.
         "interfaces-config": {
-            "interfaces": [ "eth0" ]
+            "interfaces": [ "ethX" ]
         },
 
-// We need to specify the the database used to store leases. As of
-// September 2016, four database backends are supported: MySQL,
-// PostgreSQL, Cassandra, and the in-memory database, Memfile.
-// We'll use memfile  because it doesn't require any prior set up.
+        // You also need to tell where to store lease information.
+        // memfile is the backend that is easiest to set up.
         "lease-database": {
             "type": "memfile",
             "lfc-interval": 3600
         },
 
+        // It is likely that in your network you'll have a mix of regular,
+        // "plain" subnets and shared networks. It is perfectly valid to mix
+        // them in the same config file.
+        //
+        // This is regular subnet. It's not part of any shared-network.
         "subnet6": [
             {
                 "pools": [ { "pool": "2001:db8:2::/80" } ],
                 "subnet": "2001:db8:2::/64",
-                "interface": "eth0",
-                "id": 100
+                "interface": "ethX"
             }
         ],
 
-        "shared-networks": [ 
+        // Hhe shared networks definition starts here. shared-networks can
+        // contain a list of shared networks. There are many parameters
+        // that can be specified here, so this example may be overwhelming
+        // at first, but the only mandatory parameter for each shared
+        // network is name. It must be unique. Typically, each shared
+        // subnet also needs to have at least two subnets to be functional,
+        // but if you really want to, you can define a degraded shared
+        // network that has 1 or even 0 subnets. This may come in handy
+        // when migrating between regular subnets and shared networks
+        // or when debugging a problem. It is not recommended to use
+        // 1 subnet per shared network, as there is extra processing
+        // overhead for shared networks.
+        "shared-networks": [
         {
             "interface": "eth1",
+
+            // Similar to regular subnets, it is forbidden to define both
+            // interface and interface-id at the same time. That's because
+            // interface parameter expresses physical network interface
+            // for links available locally and interface-id identifies
+            // values inserted by relays, which are only used for
+            // remote traffic. A shared network cannot be both direct
+            // and relayed.
+            //"interface-id": "content of the option",
+
+            // Other parameters defined here will be inherited by the
+            // subnets.
             "name": "frog",
             "option-data": [ ],
             "preferred-lifetime": 200,
             "rapid-commit": true,
             "rebind-timer": 150,
             "relay": {
-                "ip-address": "::"
+                "ip-address": "2001:db8::1"
             },
             "renew-timer": 100,
             "reservation-mode": "all",
+
+            // List of subnets belonging to this particular shared-network
+            // start here.
             "subnet6": [
+
+                // This is the first subnet.
                 {
-                    "id": 1,
-                    "option-data": [ ],
-                    "pd-pools": [ ],
-                    "pools": [ ],
                     "preferred-lifetime": 30,
                     "rapid-commit": false,
                     "rebind-timer": 20,
+                    // It is possible to override some values here.
                     "relay": {
-                        "ip-address": "2001:db8:1::1"
+                        "ip-address": "2001:db8:1::123"
                     },
                     "renew-timer": 10,
                     "reservation-mode": "all",
                     "subnet": "2001:db8:1::/64",
+                    "pools": [ { "pool": "2001:db8:1:abcd::/64" } ],
                     "valid-lifetime": 40
                 },
+
+                // This is the second subnet.
                 {
-                    "id": 2,
-                    "option-data": [ ],
-                    "pd-pools": [ ],
-                    "pools": [ ],
                     "preferred-lifetime": 30,
+                    "pools": [ { "pool": "3000:db8::/64" } ],
                     "rapid-commit": false,
                     "rebind-timer": 20,
                     "relay": {