Skip to content

GitLab

Commit 80bc9025 authored by Francis Dupont's avatar Francis Dupont
Browse files

[538-kea-should-not-store-anything-in-var-kea-lsb-violation] Updated doc + some improvements

parent 0a11fe9e
Hide whitespace changes
Inline Side-by-side
Showing with 67 additions and 24 deletions
configure.ac
View file @ 80bc9025
......@@ -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
......
doc/guide/dhcp4-srv.xml
View file @ 80bc9025
......@@ -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
......@@ -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.
<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>
......
doc/guide/dhcp6-srv.xml
View file @ 80bc9025
......@@ -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
......@@ -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.
<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>
......
doc/guide/hooks.xml
View file @ 80bc9025
......@@ -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"
}
},
......
doc/guide/install.xml
View file @ 80bc9025
......@@ -79,8 +79,20 @@
</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
......
doc/guide/keactrl.xml
View file @ 80bc9025
......@@ -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,
......
doc/guide/quickstart.xml
View file @ 80bc9025
......@@ -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>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment