From: Tomek Mrugalski Date: Thu, 18 Jul 2019 11:13:59 +0000 (+0200) Subject: [#644,!370] Manual apply of 80bc902549ccda74838525873e4dbe38b1b2e09f X-Git-Tag: Kea-1.6.1~10^2~70 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=31012b882f76ad280663107f93398ecc4b84379c;p=thirdparty%2Fkea.git [#644,!370] Manual apply of 80bc902549ccda74838525873e4dbe38b1b2e09f --- diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index 949b1e71e2..771911bafa 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -58,7 +58,7 @@ configuration file. Since the DHCPv4 server opens privileged ports, it requires root access. This daemon must be run as root. 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 build configure script; it defaults to "/usr/local/var/run". Note that this value may be @@ -113,7 +113,7 @@ be created. The basic configuration is as follows: "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. @@ -300,7 +300,7 @@ can be used to configure the memfile backend. - ``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"``. + this parameter is ``"[kea-install-dir]/var/lib/kea/kea-leases4.csv"``. - ``lfc-interval``: specifies the interval, in seconds, at which the server will perform a lease file cleanup (LFC). This removes diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index 1a2cb2f7d2..81dc1e5125 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -58,7 +58,7 @@ configuration file. Since the DHCPv6 server opens privileged ports, it requires root access. This daemon must be run as root. 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 build configure script; it defaults to "/usr/local/var/run". Note that this value may be @@ -114,7 +114,7 @@ be created. The basic configuration is as follows: "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. @@ -286,7 +286,7 @@ can be used to configure the memfile backend. - ``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"``. + this parameter is ``"[kea-install-dir]/var/lib/kea/kea-leases6.csv"``. - ``lfc-interval``: specifies the interval, in seconds, at which the server will perform a lease file cleanup (LFC). This removes @@ -4320,7 +4320,7 @@ which will result in the following server identifier: |type |htype| identifier | 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 available, the server should be configured not to try to store the server identifier. @@ -4355,7 +4355,7 @@ 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`` but this location can be changed using the +``prefix/var/lib/kea`` but this location can be changed using the ``data-directory`` global parameter as in: :: diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst index 52256d3fab..4b3b45e07e 100644 --- a/doc/sphinx/arm/hooks.rst +++ b/doc/sphinx/arm/hooks.rst @@ -721,7 +721,7 @@ done with the following Kea4 configuration: { "library": "/usr/local/lib/libdhcp_legal_log.so", "parameters": { - "path": "/var/kea/var", + "path": "/var/lib/kea/log", "base-name": "kea-forensic4" } }, @@ -738,7 +738,7 @@ To configure it for kea-dhcp6, the commands are: { "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/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst index 11e38491eb..6558710838 100644 --- a/doc/sphinx/arm/install.rst +++ b/doc/sphinx/arm/install.rst @@ -38,7 +38,12 @@ The following is the directory layout of the complete Kea installation. - ``share/man/`` — manual pages (online documentation). -- ``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. .. _build-requirements: @@ -226,6 +231,22 @@ options. Some commonly used options are: Build the optional ``perfdhcp`` DHCP benchmarking tool. The default is to not build it. +.. note:: + + The ``--runstatedir`` 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 released yet. + + - You use autoconf 2.69 patched to add support of this. In this case and the + previous simply use when needed the``--runstatedir`` configure parameter. + + - There is no support (the configure parameter is not recognized and configure + directly raises an error). For autoconf 2.69 the ``runstatedir`` environment + variable is supported so simply remove the ``--`` before ``runstatedir`` + in the configure script call, e.g.: ``./configure runstatedir=/opt/run ...`` + .. .. note:: diff --git a/doc/sphinx/arm/keactrl.rst b/doc/sphinx/arm/keactrl.rst index 4b92201feb..d972882660 100644 --- a/doc/sphinx/arm/keactrl.rst +++ b/doc/sphinx/arm/keactrl.rst @@ -170,11 +170,11 @@ look similar to the following: .. code-block:: console $ 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/sphinx/arm/quickstart.rst b/doc/sphinx/arm/quickstart.rst index 336509938a..f68d4a22be 100644 --- a/doc/sphinx/arm/quickstart.rst +++ b/doc/sphinx/arm/quickstart.rst @@ -79,10 +79,10 @@ Quick Start Guide for DHCPv4 and DHCPv6 Services 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``) for the details of + ``[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. 10. If the server has been started successfully, test that it is