From: Marcin Siodelski <marcin@isc.org>
Date: Mon, 27 May 2019 08:44:09 +0000 (+0200)
Subject: [#71,!314] Addressed review comments.
X-Git-Tag: Kea-1.6.0-beta~52
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=e7709ddb7ed8e0ef3618aca12ee604fe4cb5b105;p=thirdparty%2Fkea.git

[#71,!314] Addressed review comments.
---

diff --git a/doc/api/remote-subnet4-set.json b/doc/api/remote-subnet4-set.json
index efa7587b73..b4b409ce77 100644
--- a/doc/api/remote-subnet4-set.json
+++ b/doc/api/remote-subnet4-set.json
@@ -11,7 +11,7 @@
             {
                 \"id\": <subnet identifier>,
                 \"subnet\": <subnet prefix>,
-                \"shared-network-name\": <shared network name> | null
+                \"shared-network-name\": <shared network name> | null,
                 <the rest of the subnet specification here>
             }
         ],
@@ -24,5 +24,9 @@
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv4 subnet successfully set.\",
+    \"arguments\": {
+        \"id\": <subnet identifier>,
+        \"subnet\": <subnet prefix>
+    }
 }"
 }
diff --git a/doc/api/remote-subnet6-set.json b/doc/api/remote-subnet6-set.json
index faf8a1686d..f0545b95b8 100644
--- a/doc/api/remote-subnet6-set.json
+++ b/doc/api/remote-subnet6-set.json
@@ -11,7 +11,7 @@
             {
                 \"id\": <subnet identifier>,
                 \"subnet\": <subnet prefix>,
-                \"shared-network-name\": <shared network name> | null
+                \"shared-network-name\": <shared network name> | null,
                 <the rest of the subnet specification here>
             }
         ],
@@ -24,5 +24,9 @@
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv6 subnet successfully set.\",
+    \"arguments\": {
+        \"id\": <subnet identifier>,
+        \"subnet\": <subnet prefix>
+    }
 }"
 }
diff --git a/doc/examples/kea4/config-backend.json b/doc/examples/kea4/config-backend.json
index e695716785..637ad8433e 100644
--- a/doc/examples/kea4/config-backend.json
+++ b/doc/examples/kea4/config-backend.json
@@ -54,14 +54,12 @@
         //,{
             // "library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so"
         //}
-    ]
-},
+    ],
 
-// The following configures logging. It assumes that messages with at
-// least informational level (info, warn, error and fatal) should be
-// logged to stdout. Alternatively, you can specify stderr here, a filename
-// or 'syslog', which will store output messages via syslog.
-"Logging": {
+    // The following configures logging. It assumes that messages with at
+    // least informational level (info, warn, error and fatal) should be
+    // logged to stdout. Alternatively, you can specify stderr here, a filename
+    // or 'syslog', which will store output messages via syslog.
     "loggers": [
         {
             "name": "kea-dhcp4",
diff --git a/doc/examples/kea6/config-backend.json b/doc/examples/kea6/config-backend.json
index 73d1dd5245..8956462d3f 100644
--- a/doc/examples/kea6/config-backend.json
+++ b/doc/examples/kea6/config-backend.json
@@ -54,14 +54,12 @@
         //,{
             // "library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so"
         //}
-    ]
-},
+    ],
 
-// The following configures logging. It assumes that messages with at
-// least informational level (info, warn, error and fatal) should be
-// logged to stdout. Alternatively, you can specify stderr here, a filename
-// or 'syslog', which will store output messages via syslog.
-"Logging": {
+    // The following configures logging. It assumes that messages with at
+    // least informational level (info, warn, error and fatal) should be
+    // logged to stdout. Alternatively, you can specify stderr here, a filename
+    // or 'syslog', which will store output messages via syslog.
     "loggers": [
         {
             "name": "kea-dhcp6",
@@ -75,4 +73,5 @@
         }
     ]
 }
+
 }
diff --git a/doc/guide/config-backend.xml b/doc/guide/config-backend.xml
index e28fa6f093..038f66890f 100644
--- a/doc/guide/config-backend.xml
+++ b/doc/guide/config-backend.xml
@@ -114,6 +114,32 @@
         database. This limitation will be removed in Kea 1.6.0 final release.
       </simpara></listitem>
     </itemizedlist>
+
+    <note>
+      <para>
+        We strongly recommend to not duplicate the configuration information
+        in the file and the database. For example, when specifying subnets
+        for the DHCP server, please store them in the configuration backend
+        or in the configuration file, not in both places. Storing some subnets
+        in the database and other in the file may put you at risk of potential
+        configuration conflicts. Note that the configuration from the database
+        takes precedence over the configuration from the file, thus it is possible
+        that parts of the configuration specified in the file may be overriden.
+      </para>
+    </note>
+
+    <note>
+      <para>
+        It is recommended that <command>subnet_cmds</command> hooks library is
+        not used to manage the subnets when the configuration backend is used
+        as a source of information about the subnets. The
+        <command>subnet_cmds</command> hooks library modifies the local subnets
+        configuration (in the server's memory), not in the database. Use
+        the <command>cb_cmds</command> hooks library to manage the subnets
+        information in the database instead.
+      </para>
+    </note>
+
   </section>
 
   <section xml:id="cb-components">
diff --git a/doc/guide/hooks-cb-cmds.xml b/doc/guide/hooks-cb-cmds.xml
index b29c701c31..a20d1b9add 100644
--- a/doc/guide/hooks-cb-cmds.xml
+++ b/doc/guide/hooks-cb-cmds.xml
@@ -351,7 +351,9 @@
           </screen>
             deletes the "level3" IPv6 shared network. The subnets are preserved
             but they are disassociated from the deleted shared network and become
-            global.
+            global. This behavior corresponds to the behavior of the
+            <command>network[46]-del</command> commands with respect to the
+            <command>subnets-action</command>.
           </para>
         </section>
 
@@ -597,6 +599,7 @@
           </para>
           <para>
             The following command retrieves the IPv6 "DNS Servers" (code 23) option:
+            <screen>
 {
     "command": remote-option6-global-get",
     "arguments": {
@@ -611,6 +614,7 @@
         }
     }
 }
+            </screen>
           </para>
         </section>