[3769] Updated Kea Admin guide with PID file info

    Added discussion of PID files to start up section for
    each of the servers.

diff --git a/doc/guide/ddns.xml b/doc/guide/ddns.xml
index 9b0159b98a8051105be38460e35dc00d3c26ff81..95d1582026a0cfe42f01038545dd204733b24e30 100644 (file)
--- a/doc/guide/ddns.xml
+++ b/doc/guide/ddns.xml
@@ -128,6 +128,35 @@ strings <userinput>path</userinput>/kea-dhcp-ddns | sed -n 's/;;;; //p'
       Upon start up the module will load its configuration and begin listening
       for NCRs based on that configuration.
       </para>
+
+      <para>
+        During startup the server will attempt to create a PID file of the
+        form: [localstatedir]/[conf name].kea-dhcp-ddns.pid
+        where:
+        <itemizedlist>
+            <listitem>
+            <simpara><command>localstatedir</command>: The value as passed into the
+            build configure script. It defaults defaults to "/usr/local/var".  Note
+            that this value may be overridden at run time by setting the environment
+            variable KEA_PIDFILE_DIR.  This is intended primarily for testing purposes.
+            </simpara>
+            </listitem>
+            <listitem>
+            <simpara><command>conf name</command>: The confguration file name
+            used to start the server, minus all preceding path and file extension.
+            For example, given a pathname of "/usr/local/etc/kea/myconf.txt", the
+            portion used would be "myconf".
+            </simpara>
+            </listitem>
+        </itemizedlist>
+        If the file already exists and contains the PID of a live process,
+        the server will issue a DHCP_DDNS_ALREADY_RUNNING log message and exit. It
+        is possible, though unlikely, that the file is a remnant of a system crash
+        and the process to which the PID belongs is unrelated to Kea.  In such a 
+        case it would be necessary to manually delete the PID file.
+      </para>
+
+
     </section> <!-- end start-stop -->
     <section id="d2-configuration">
       <title>Configuring the DHCP-DDNS Server</title>

diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index ab353edd636d4464eaebb9869a32e9aee4e27bbb..583faf653a85584d6da0343961aeb4cd46d53ef0 100644 (file)
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -106,6 +106,33 @@ strings <userinput>path</userinput>/kea-dhcp4 | sed -n 's/;;;; //p'
         access. Make sure you run this daemon as root.
       </para>
 
+      <para>
+        During startup the server will attempt to create a PID file of the
+        form: [localstatedir]/[conf name].kea-dhcp4.pid
+        where:
+        <itemizedlist>
+            <listitem>
+            <simpara><command>localstatedir</command>: The value as passed into the
+            build configure script. It defaults defaults to "/usr/local/var".  Note
+            that this value may be overridden at run time by setting the environment
+            variable KEA_PIDFILE_DIR.  This is intended primarily for testing purposes.
+            </simpara>
+            </listitem>
+            <listitem>
+            <simpara><command>conf name</command>: The confguration file name
+            used to start the server, minus all preceding path and file extension.
+            For example, given a pathname of "/usr/local/etc/kea/myconf.txt", the
+            portion used would be "myconf".
+            </simpara>
+            </listitem>
+        </itemizedlist>
+        If the file already exists and contains the PID of a live process,
+        the server will issue a DHCP4_ALREADY_RUNNING log message and exit. It
+        is possible, though unlikely, that the file is a remnant of a system crash
+        and the process to which the PID belongs is unrelated to Kea.  In such a 
+        case it would be necessary to manually delete the PID file.
+      </para>
+
     </section>
 
     <section id="dhcp4-configuration">

diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index 89aa13533677a797b73ea3af04dad5c25b3eed1b..a35ab85b2dcd4c42e5ffa1f4d817352bedf5466a 100644 (file)
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -104,6 +104,32 @@ strings <userinput>path</userinput>/kea-dhcp6 | sed -n 's/;;;; //p'
         access. Make sure you run this daemon as root.
       </para>
 
+      <para>
+        During startup the server will attempt to create a PID file of the
+        form: [localstatedir]/[conf name].kea-dhcp6.pid
+        where:
+        <itemizedlist>
+            <listitem>
+            <simpara><command>localstatedir</command>: The value as passed into the
+            build configure script. It defaults defaults to "/usr/local/var".  Note
+            that this value may be overridden at run time by setting the environment
+            variable KEA_PIDFILE_DIR.  This is intended primarily for testing purposes.
+            </simpara>
+            </listitem>
+            <listitem>
+            <simpara><command>conf name</command>: The confguration file name
+            used to start the server, minus all preceding path and file extension.
+            For example, given a pathname of "/usr/local/etc/kea/myconf.txt", the
+            portion used would be "myconf".
+            </simpara>
+            </listitem>
+        </itemizedlist>
+        If the file already exists and contains the PID of a live process,
+        the server will issue a DHCP6_ALREADY_RUNNING log message and exit. It
+        is possible, though unlikely, that the file is a remnant of a system crash
+        and the process to which the PID belongs is unrelated to Kea.  In such a 
+        case it would be necessary to manually delete the PID file.
+      </para>
     </section>
 
     <section id="dhcp6-configuration">