From: Francis Dupont Date: Sat, 1 Jun 2019 11:26:24 +0000 (+0200) Subject: [538-kea-should-not-store-anything-in-var-kea-lsb-violation] Updated doc + some impro... X-Git-Tag: Kea-1.6.0-beta2~276 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=80bc902549ccda74838525873e4dbe38b1b2e09f;p=thirdparty%2Fkea.git [538-kea-should-not-store-anything-in-var-kea-lsb-violation] Updated doc + some improvements --- diff --git a/configure.ac b/configure.ac index 8557c60d74..6e678c9320 100644 --- a/configure.ac +++ b/configure.ac @@ -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 diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index 83b56a47ac..238c34a83a 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -96,7 +96,7 @@ 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: runstatedir: The value as passed into the @@ -155,7 +155,7 @@ "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. name: 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 "[kea-install-dir]/var/kea/kea-leases4.csv" + for this parameter is "[kea-install-dir]/var/lib/kea/kea-leases4.csv" . diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index 01c4fd2112..c9290b7bca 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -96,7 +96,7 @@ 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: runstatedir: The value as passed into the @@ -156,7 +156,7 @@ "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. name: 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 "[kea-install-dir]/var/kea/kea-leases6.csv" + for this parameter is "[kea-install-dir]/var/lib/kea/kea-leases6.csv" . @@ -4524,7 +4524,7 @@ autogenerated IDs are not stable across configuration changes. 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. In some uncommon deployments where no stable storage is @@ -4558,7 +4558,7 @@ autogenerated IDs are not stable across configuration changes. DHCPv6 data directory The Kea DHCPv6 server puts the server identifier file and the default memory lease file into its data directory. By default - this directory is prefix/var/kea + this directory is prefix/var/lib/kea but this location can be changed using the data-directory global parameter as in: diff --git a/doc/guide/hooks.xml b/doc/guide/hooks.xml index 0dd54288a9..3fcb2f5d91 100644 --- a/doc/guide/hooks.xml +++ b/doc/guide/hooks.xml @@ -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" } }, diff --git a/doc/guide/install.xml b/doc/guide/install.xml index 7d1208cdb7..0faa02a52e 100644 --- a/doc/guide/install.xml +++ b/doc/guide/install.xml @@ -79,8 +79,20 @@ - var/kea/ — - server identification, lease databases, and log files. + var/lib/kea/ — + server identification, and lease databases files. + + + + + var/log/ — + log files. + + + + + var/run/kea/ — + pid and logger lock files. @@ -178,7 +190,7 @@ Debian and Ubuntu: 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: + + + The in the installation + directories is particular: there are three cases: + + + You use autoconf 2.70 or greater which supports + this but this autoconf version has not been currently + released. + + + + You use autoconf 2.69 patched to add support of + this. In this case and the previous simply use when needed + the configure parameter. + + + + There is no support (the configure parameter is + not recognized and configure directly raises an error). + For autoconf 2.69 the + environment variable is supported so simply remove the + -- before + in the configure script call. + + + + + For instructions concerning the installation and configuration diff --git a/doc/guide/keactrl.xml b/doc/guide/keactrl.xml index c236ac73ac..2bce940ed6 100644 --- a/doc/guide/keactrl.xml +++ b/doc/guide/keactrl.xml @@ -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: $ keactrl start -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. During normal shutdowns these PID files are deleted. They may, however, be left over as remnants following a system crash. It is possible, diff --git a/doc/guide/quickstart.xml b/doc/guide/quickstart.xml index ca68b8d50a..e4523c547f 100644 --- a/doc/guide/quickstart.xml +++ b/doc/guide/quickstart.xml @@ -96,10 +96,10 @@ $ ./configure [your extra parameters] # keactrl status A server status of "inactive" may indicate a configuration error. Please check the log file (by default named - [kea-install-dir]/var/kea/kea-dhcp4.log, - [kea-install-dir]/var/kea/kea-dhcp6.log, - [kea-install-dir]/var/kea/kea-ddns.log or - [kea-install-dir]/var/kea/kea-ctrl-agent.log) + [kea-install-dir]/var/log/kea-dhcp4.log, + [kea-install-dir]/var/log/kea-dhcp6.log, + [kea-install-dir]/var/log/kea-ddns.log or + [kea-install-dir]/var/log/kea-ctrl-agent.log) for the details of the error.