[master] Merge branch 'trac3519'

doc/guide/dhcp4-srv.xml

@@ -77,7 +77,7 @@
     </section>
 
     <section id="dhcp4-configuration">
-      <title>Configuring the DHCPv4 Server</title>
+      <title>DHCPv4 Server Configuration</title>
 <section>
   <title>Introduction</title>
       <para>

doc/guide/quickstart.xml

@@ -14,7 +14,7 @@
     </para>
 
     <section id="quick-start">
-      <title>Quick start guide for DHCPv4 and DHCPv6 services</title>
+      <title>Quick start guide for DHCPv4 and DHCPv6 services.</title>
 
       <orderedlist>
 
@@ -25,19 +25,22 @@
           </simpara>
         </listitem>
 
-        <!-- We may need to replace it with the link to a downloadable tarball
-        once we have it. -->
         <listitem>
-          <simpara>
-            Checkout the latest Kea revision from the Git repository:
-            <screen>$ <userinput>git clone git://git.kea.isc.org/kea</userinput> </screen>
-          </simpara>
+          <para>
+            Download Kea source tarball from <ulink url="https://www.isc.org/downloads/">ISC.org downloads page</ulink> or <ulink url="http://ftp.isc.org/isc/kea/">ISC ftp server</ulink>.
+          </para>
+        </listitem>
+
+        <listitem>
+          <para>
+            Extract the tarball. For example:
+            <screen>$ <userinput>tar xvf kea-0.9-beta1.tar.gz</userinput></screen>
+          </para>
         </listitem>
 
         <listitem>
           <para>Go into the source directory and run the configure script:
-            <screen>$ <userinput>cd kea</userinput>
-$ <userinput>autoreconf --install</userinput>
+            <screen>$ <userinput>cd kea-0.9-beta1</userinput>
 $ <userinput>./configure [your extra parameters]</userinput></screen>
           </para>
         </listitem>
@@ -50,66 +53,69 @@ $ <userinput>./configure [your extra parameters]</userinput></screen>
 
         <listitem>
           <para>Install it (by default the installation prefix is <filename>/usr/local/</filename>,
-          so you need root privileges for that step):
-            <screen>$ <userinput>make install</userinput></screen>
+          so you likely need root privileges for that step):
+            <screen># <userinput>make install</userinput></screen>
           </para>
         </listitem>
 
         <listitem>
-          <para>If you wish to run a DHCP server for IPv4, you need to set up and start
-          the kea-dhcp4 server:</para>
-          <orderedlist>
-          <listitem>
-          <para>Edit your configuration file for DHCPv4. <xref linkend="dhcp4-configuration"/>
-          describes the configuration choices available; example DHCPv4 configuration can be found in
-          doc/examples/kea4.</para>
-	</listitem>
+          <para>Edit configuration file which is by default installed in
+          <filename>[kea-install-dir]/etc/kea/kea.conf</filename> and contains
+          configuration for all Kea services. Configuration choices for DHCPv4
+          and DHCPv6 services are described in <xref linkend="dhcp4-configuration"/> and <xref linkend="dhcp6-configuration"/>, respectively.</para>
+        </listitem>
 
         <listitem>
-          <para>Start Kea DHCPv4 server (as root):
-            <screen># <userinput>kea-dhcp4 -c /path/to/your/kea4/config/file.json</userinput></screen>
+          <para>In order to start the DHCPv4 server in background, run the
+          following command (as root):
+          <screen># <userinput>keactrl start -s dhcp4</userinput></screen>
+          Or run the following command to start DHCPv6 server instead:
+          <screen># <userinput>keactrl start -s dhcp6</userinput></screen>
+          Note that it is also possible to start both servers simultaneously:
+          <screen>$ <userinput>keactrl start</userinput></screen>
           </para>
         </listitem>
 
         <listitem>
-         <para>Test it; for example, use the
-         <ulink url="http://www.isc.org/downloads/DHCP/">ISC DHCP client</ulink>
-         to send DHCPv4 queries to the server and verify that the client receives a
-         configuration from the server:
-            <screen>$ <userinput>dhclient -4 eth0</userinput></screen>
-         </para>
-        </listitem>
-        </orderedlist>
+          <para>Verify that Kea server(s) are running:
+          <screen># <userinput>keactrl status</userinput></screen>
+          If the server status is "inactive" may indicate a configuration
+          error. Please check a log file (by default located in
+          <filename>[kea-install-dir]/var/kea/kea.log</filename>) for the
+          details of the error.
+          </para>
         </listitem>
 
         <listitem>
-          <para>If you wish to run a DHCP server for IPv6, you need to set up and start
-          the kea-dhcp6 server:</para>
-          <orderedlist>
-        <listitem>
-          <para>Edit your configuration file for DHCPv6. <xref linkend="dhcp6-configuration"/>
-          describes the configuration choices, and some example DHCPv6 configuration can be found in
-          doc/examples/kea6.</para>
-	</listitem>
-
-        <listitem>
-          <para>Start Kea DHCPv6 server (as root):
-            <screen># <userinput>kea-dhcp6 -c /path/to/your/kea6/config/file.json</userinput></screen>
+          <para>
+            If the server has been started sucessfully, test that it is
+            responding to DHCP queries and that the client
+            receives a configuration from the server; for example, use
+            the <ulink url="http://www.isc.org/downloads/DHCP/">ISC DHCP client</ulink>.
           </para>
         </listitem>
 
         <listitem>
-         <para>Test it; for example, use the
-         <ulink url="http://www.isc.org/downloads/DHCP/">ISC DHCP client</ulink>
-         to send DHCPv6 queries to the server and verify that the client receives a
-         configuration from the server:
-            <screen>$ <userinput>dhclient -6 eth0</userinput></screen>
-         </para>
-        </listitem>
-        </orderedlist>
+          <para>
+            Stop running server(s):
+            <screen># <userinput>keactrl stop</userinput></screen>
+          </para>
         </listitem>
       </orderedlist>
 
+      <para>The details of <command>keactrl</command> script usage can be found
+      in <xref linkend="keactrl"/>.</para>
+    </section>
+
+    <section id="quick-start-direct-run">
+      <title>Running Kea servers directly</title>
+      <para>Kea servers can be started directly (without a need to use
+      <command>keactrl</command>). To start DHCPv4 server run the following
+      commmand:
+      <screen># <userinput>kea-dhcp4 -c /path/to/your/kea4/config/file.json</userinput></screen>
+      And, to start the DHCPv6 server run the following command:
+      <screen># <userinput>kea-dhcp6 -c /path/to/your/kea6/config/file.json</userinput></screen>
+    </para>
     </section>
 
   </chapter>