From: Tomek Mrugalski <tomasz@isc.org>
Date: Wed, 22 Jun 2016 13:41:51 +0000 (+0200)
Subject: [github21] Documentation updated, install notes added.
X-Git-Tag: trac4283_base~10
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9c0311ca2cb9066fb0885f6565d949eb58db0380;p=thirdparty%2Fkea.git

[github21] Documentation updated, install notes added.
---

diff --git a/doc/guide/admin.xml b/doc/guide/admin.xml
index 4557e09daa..8fa45140eb 100644
--- a/doc/guide/admin.xml
+++ b/doc/guide/admin.xml
@@ -494,7 +494,7 @@ $ <userinput>kea-admin lease-init pgsql -u <replaceable>database-user</replaceab
     </section> <!-- end of PostgreSQL sections -->
 
     <section>
-      <title>CQL</title>
+      <title>CQL (Cassandra)</title>
 
       <para>
         The CQL database must be properly set up if you want Kea to store
diff --git a/doc/guide/install.xml b/doc/guide/install.xml
index b1f4772e80..41793080c8 100644
--- a/doc/guide/install.xml
+++ b/doc/guide/install.xml
@@ -501,6 +501,46 @@ Debian and Ubuntu:
           PostgreSQL database configuration.
         </para>
       </section>
+
+      <section>
+        <title>Building with CQL (Cassandra) support</title>
+        <para>
+          Install Cassandra according to the instructions for your system. The
+          Cassandra project webpage contains useful pointers: <ulink
+          url="http://cassandra.apache.org/download/" />.
+        </para>
+        <para>
+          Download and compile cpp-driver from DataStax. For details regarding
+          dependencies for building cpp-driver, see the project homepage
+          <ulink url="https://github.com/datastax/cpp-driver" />. As of June
+          2016, the following commands were used:
+          <screen>
+$ <userinput>git clone https://github.com/datastax/cpp-driver</userinput>
+$ <userinput>cd cpp-driver</userinput>
+$ <userinput>mkdir build</userinput>
+$ <userinput>cmake ..</userinput>
+$ <userinput>make</userinput>
+</screen>
+        </para>
+        <para>
+          As of June 2016, cpp-driver does not include cql_config script
+          yet. There is a work in progress to contribute such a script to
+          cpp-driver project. Until such contribution is accepted, there are
+          intermediate steps that need to be conducted. The cql_config
+          script and cql_config_defines.sh are temporarily stored in
+          tools/ directory of the Kea sources. Before using it, please
+          edit cql_config_defines.sh: change CPP_DRIVER_PATH to the directory,
+          where cpp-driver sources are located. If cpp-driver sources already
+          provide cql_config script please use that rather than the version
+          from Kea sources.
+        </para>
+        <para>
+          Build and install Kea as described in <xref linkend="installation"/>, with
+          the following modification. To enable the Cassandra (CQL) database code, at the
+          "configure" step (see <xref linkend="configure"/>), do:
+          <screen><userinput>./configure [other-options] --with-cql=<replaceable>path-to-cql_config</replaceable></userinput></screen>
+        </para>
+      </section>
    </section>
 
   </chapter>