]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[538-kea-should-not-store-anything-in-var-kea-lsb-violation] Updated doc + some impro...
authorFrancis Dupont <fdupont@isc.org>
Sat, 1 Jun 2019 11:26:24 +0000 (13:26 +0200)
committerFrancis Dupont <fdupont@isc.org>
Tue, 18 Jun 2019 16:54:26 +0000 (12:54 -0400)
configure.ac
doc/guide/dhcp4-srv.xml
doc/guide/dhcp6-srv.xml
doc/guide/hooks.xml
doc/guide/install.xml
doc/guide/keactrl.xml
doc/guide/quickstart.xml

index 8557c60d74a0185f2e74c051bdc4b9ef8079c9d3..6e678c93208d2fbb1c1bb22ef6821ce725dd9c0c 100644 (file)
@@ -1528,10 +1528,12 @@ AM_COND_IF([HAVE_OPTRESET], [AC_DEFINE([HAVE_OPTRESET], [1], [Check for optreset
 AC_DEFINE([CONFIG_H_WAS_INCLUDED], [1], [config.h inclusion marker])
 
 # Autoconf 2.70 has runstatedir but is not yet released.
+m4_version_prereq([2.70], [], [dnl
+    AC_ARG_VAR(runstatedir, [$localstatedir/run for autoconf < 2.70])dnl
+    AC_SUBST(runstatedir)dnl
+])
 if test "x$runstatedir" = "x"; then
-    AC_ARG_VAR(runstatedir, [$localstatedir/run for autoconf < 2.70])
     runstatedir="$localstatedir/run"
-    AC_SUBST(runstatedir)
 fi
 
 AC_CONFIG_FILES([Makefile
index 83b56a47acda7287ba952c86eb1a6796764d0439..238c34a83adb17ceac53b18e50928abf83569dc7 100644 (file)
@@ -96,7 +96,7 @@
 
       <para>
         During startup, the server will attempt to create a PID file of the
-        form: [runstatedir]/[conf name].kea-dhcp4.pid where:
+        form: [runstatedir]/kea/[conf name].kea-dhcp4.pid where:
         <itemizedlist>
             <listitem>
             <simpara><command>runstatedir</command>: The value as passed into the
     "lease-database": {
         "type": "memfile",
         "persist": true,
-        "name": "/var/kea/dhcp4.leases"
+        "name": "/var/lib/kea/dhcp4.leases"
     },
 
 # Finally, we list the subnets from which we will be leasing addresses.
@@ -351,7 +351,7 @@ global and Dhcp4, hence we need two closing curly brackets to close them.
     <listitem>
       <simpara><command>name</command>: specifies an absolute location of the lease
       file in which new leases and lease updates will be recorded. The default value
-      for this parameter is <userinput>"[kea-install-dir]/var/kea/kea-leases4.csv"
+      for this parameter is <userinput>"[kea-install-dir]/var/lib/kea/kea-leases4.csv"
       </userinput>.</simpara>
     </listitem>
 
index 01c4fd2112e5a81f6854c0fcd3bc704c83a62afa..c9290b7bcab4b020a39a61458851bb78afb44186 100644 (file)
@@ -96,7 +96,7 @@
 
       <para>
         During startup, the server will attempt to create a PID file of the
-        form: [runstatedir]/[conf name].kea-dhcp6.pid where:
+        form: [runstatedir]/kea/[conf name].kea-dhcp6.pid where:
         <itemizedlist>
             <listitem>
             <simpara><command>runstatedir</command>: The value as passed into the
     "lease-database": {
         "type": "memfile",
         "persist": true,
-        "name": "/var/kea/dhcp6.leases"
+        "name": "/var/lib/kea/dhcp6.leases"
     },
 
 # Finally, we list the subnets from which we will be leasing addresses.
@@ -340,7 +340,7 @@ global and Dhcp6, hence we need two closing curly brackets to close them.
     <listitem>
       <simpara><command>name</command>: specifies an absolute location of the lease
       file in which new leases and lease updates will be recorded. The default value
-      for this parameter is <userinput>"[kea-install-dir]/var/kea/kea-leases6.csv"
+      for this parameter is <userinput>"[kea-install-dir]/var/lib/kea/kea-leases6.csv"
       </userinput>.</simpara>
     </listitem>
 
@@ -4524,7 +4524,7 @@ autogenerated IDs are not stable across configuration changes.
       </para>
 
       <para>The server stores the generated server identifier in the following
-      location: [kea-install-dir]/var/kea/kea-dhcp6-serverid.
+      location: [kea-install-dir]/var/lib/kea/kea-dhcp6-serverid.
       </para>
 
       <para>In some uncommon deployments where no stable storage is
@@ -4558,7 +4558,7 @@ autogenerated IDs are not stable across configuration changes.
       <title>DHCPv6 data directory</title>
       <para>The Kea DHCPv6 server puts the server identifier file and the
       default memory lease file into its data directory. By default
-      this directory is <filename><userinput>prefix</userinput>/var/kea</filename>
+      this directory is <filename><userinput>prefix</userinput>/var/lib/kea</filename>
       but this location can be changed using the
       <command>data-directory</command> global parameter as in:
 <screen>
index 0dd54288a94e3ae88736a4fbec0ccc92c7b3be85..3fcb2f5d911adb9d8c2b51bd1a9c8e9ed5a1cdba 100644 (file)
@@ -1039,7 +1039,7 @@ Examples:
         {
             "library": "/usr/local/lib/libdhcp_legal_log.so",
             "parameters": {
-                "path": "/var/kea/var",
+                "path": "/var/lib/kea/log",
                 "base-name": "kea-forensic4"
             }
         },
@@ -1056,7 +1056,7 @@ Examples:
         {
             "library": "/usr/local/lib/libdhcp_legal_log.so",
             "parameters": {
-                "path": "/var/kea/var",
+                "path": "/var/lib/kea/log",
                 "base-name": "kea-forensic6"
             }
         },
index 7d1208cdb767269eb6593f6fc98ea179d8d34a23..0faa02a52e299868e2afa88312bff1da434f2590 100644 (file)
           </listitem>
           <listitem>
             <simpara>
-              <filename>var/kea/</filename> —
-              server identification, lease databases, and log files.
+              <filename>var/lib/kea/</filename> —
+              server identification, and lease databases files.
+            </simpara>
+          </listitem>
+          <listitem>
+            <simpara>
+              <filename>var/log/</filename> —
+              log files.
+            </simpara>
+          </listitem>
+          <listitem>
+            <simpara>
+              <filename>var/run/kea/</filename> —
+              pid and logger lock files.
             </simpara>
           </listitem>
         </itemizedlist>
@@ -178,7 +190,7 @@ Debian and Ubuntu:
         <listitem>
         <para>
           The cpp-driver from DataStax is needed when using the --with-cql
-         configuration flag to build Kea with the Cassandra database backend.
+          configuration flag to build Kea with the Cassandra database backend.
           In this case, an instance of the Cassandra server running locally
           or on some other machine, reachable over the network from the
           machine running Kea, is required. Note that running the unit
@@ -408,6 +420,35 @@ Debian and Ubuntu:
           </varlistentry>
 
           </variablelist>
+          <note>
+            <para>
+              The <option>--runstatedir</option> in the installation
+              directories is particular: there are three cases:
+              <orderedlist>
+                 <listitem>
+                    <simpara>You use autoconf 2.70 or greater which supports
+                    this but this autoconf version has not been currently
+                    released.
+                    </simpara>
+                 </listitem>
+                 <listitem>
+                    <simpara>You use autoconf 2.69 patched to add support of
+                    this. In this case and the previous simply use when needed
+                    the <option>--runstatedir</option> configure parameter.
+                    </simpara>
+                 </listitem>
+                 <listitem>
+                    <simpara>There is no support (the configure parameter is
+                    not recognized and configure directly raises an error).
+                    For autoconf 2.69 the <option>runstatedir</option>
+                    environment variable is supported so simply remove the
+                    <command>--</command> before <option>runstatedir</option>
+                    in the configure script call.
+                    </simpara>
+                 </listitem>
+               </orderedlist>
+            </para>
+          </note>
           <note>
             <para>
               For instructions concerning the installation and configuration
index c236ac73acc735c3070f48ac9ae40c3419d618d6..2bce940ed66e5fda5019333c22347ca38d39621e 100644 (file)
@@ -210,11 +210,11 @@ INFO/keactrl: Starting kea-netconf -c /usr/local/etc/kea/kea-netconf.conf -d
       output will look similar to the following:
 <screen>
 <userinput>$ keactrl start</userinput>
-INFO/keactrl: kea-dhcp4 appears to be running, see: PID 10918, PID file: /usr/local/var/kea/kea.kea-dhcp4.pid.
-INFO/keactrl: kea-dhcp6 appears to be running, see: PID 10924, PID file: /usr/local/var/kea/kea.kea-dhcp6.pid.
-INFO/keactrl: kea-dhcp-ddns appears to be running, see: PID 10930, PID file: /usr/local/var/kea/kea.kea-dhcp-ddns.pid.
-INFO/keactrl: kea-ctrl-agent appears to be running, see: PID 10931, PID file: /usr/local/var/kea/kea.kea-ctrl-agent.pid.
-INFO/keactrl: kea-netconf appears to be running, see: PID 10123, PID file: /usr/local/var/kea/kea.kea-netconf.pid.
+INFO/keactrl: kea-dhcp4 appears to be running, see: PID 10918, PID file: /usr/local/var/run/kea/kea.kea-dhcp4.pid.
+INFO/keactrl: kea-dhcp6 appears to be running, see: PID 10924, PID file: /usr/local/var/run/kea/kea.kea-dhcp6.pid.
+INFO/keactrl: kea-dhcp-ddns appears to be running, see: PID 10930, PID file: /usr/local/var/run/kea/kea.kea-dhcp-ddns.pid.
+INFO/keactrl: kea-ctrl-agent appears to be running, see: PID 10931, PID file: /usr/local/var/run/kea/kea.kea-ctrl-agent.pid.
+INFO/keactrl: kea-netconf appears to be running, see: PID 10123, PID file: /usr/local/var/run/kea/kea.kea-netconf.pid.
 </screen>
       During normal shutdowns these PID files are deleted. They may, however,
       be left over as remnants following a system crash. It is possible,
index ca68b8d50a5e2e991e1c7de8f388e972ff53cb79..e4523c547f71c0ad7cd179b6d7e3beff9fc57434 100644 (file)
@@ -96,10 +96,10 @@ $ <userinput>./configure [your extra parameters]</userinput></screen>
           <screen># <userinput>keactrl status</userinput></screen>
           A server status of "inactive" may indicate a configuration
           error. Please check the log file (by default named
-          <filename>[kea-install-dir]/var/kea/kea-dhcp4.log</filename>,
-          <filename>[kea-install-dir]/var/kea/kea-dhcp6.log</filename>,
-          <filename>[kea-install-dir]/var/kea/kea-ddns.log</filename> or
-          <filename>[kea-install-dir]/var/kea/kea-ctrl-agent.log</filename>) 
+          <filename>[kea-install-dir]/var/log/kea-dhcp4.log</filename>,
+          <filename>[kea-install-dir]/var/log/kea-dhcp6.log</filename>,
+          <filename>[kea-install-dir]/var/log/kea-ddns.log</filename> or
+          <filename>[kea-install-dir]/var/log/kea-ctrl-agent.log</filename>) 
           for the details of the error.
           </para>
         </listitem>