Commit 06b66be3 authored by Marcin Siodelski's avatar Marcin Siodelski

[master] Several fixes to the documentation following 1.5.0 sanity checks.

Okayed on jabber.
parent 718aee7a
...@@ -10,21 +10,21 @@ ...@@ -10,21 +10,21 @@
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="kea-config"> <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="kea-config">
<title>Kea Configuration</title> <title>Kea Configuration</title>
<para>Kea is using JSON structures to handle configuration. Previously <para>Kea is using JSON structures to represent servers' configurations.
we there was a concept of other configuration backends, but that never was The following sections describe how the configuration structures are
implemented and the idea was abandoned.</para> organized.
</para>
<section xml:id="json"> <section xml:id="json">
<title>JSON Configuration</title> <title>JSON Configuration</title>
<para>JSON is notation used throughout the Kea project. The most obvious <para>JSON is notation used throughout the Kea project. The most obvious
usage is for configuration file, but it is also used for sending commands usage is for the configuration file, but it is also used for sending commands
over Management API (see <xref linkend="ctrl-channel"/>) and for over Management API (see <xref linkend="ctrl-channel"/>) and for
communicating between DHCP servers and DDNS update daemon.</para> communicating between DHCP servers and DDNS update daemon.</para>
<para>Typical usage assumes that the servers are started from the command line <para>Typical usage assumes that the servers are started from the command line
(either directly or using a script, e.g. <filename>keactrl</filename>). (either directly or using a script, e.g. <filename>keactrl</filename>).
The JSON backend uses certain signals to influence Kea. The The configuration file is specified upon startup using the -c parameter.</para>
configuration file is specified upon startup using the -c parameter.</para>
<section xml:id="json-format"> <section xml:id="json-format">
<title>JSON Syntax</title> <title>JSON Syntax</title>
......
...@@ -139,11 +139,9 @@ strings <userinput>path</userinput>/kea-dhcp4 | sed -n 's/;;;; //p' ...@@ -139,11 +139,9 @@ strings <userinput>path</userinput>/kea-dhcp4 | sed -n 's/;;;; //p'
<section> <section>
<title>Introduction</title> <title>Introduction</title>
<para> <para>
This section explains how to configure the DHCPv4 server using the This section explains how to configure the DHCPv4 server using a
Kea configuration backend. (Kea configuration using any other configuration file. Before DHCPv4 is started, its configuration
backends is outside of scope of this document.) Before DHCPv4 file has to be created. The basic configuration is as follows:
is started, its configuration file has to be created. The
basic configuration is as follows:
<screen> <screen>
{ {
# DHCPv4 configuration starts in this line # DHCPv4 configuration starts in this line
...@@ -310,9 +308,9 @@ In some cases in may be preferable to use more compact notation. ...@@ -310,9 +308,9 @@ In some cases in may be preferable to use more compact notation.
<para>After all the parameters have been specified, we have two contexts open: <para>After all the parameters have been specified, we have two contexts open:
global and Dhcp4, hence we need two closing curly brackets to close them. global and Dhcp4, hence we need two closing curly brackets to close them.
In a real life configuration file there most likely would be additional In a real life configuration file there most likely would be an additional
components defined such as Logging or DhcpDdns, so the closing brace would component defined such as Logging, so the closing brace would be followed
be followed by a comma and another object definition.</para> by a comma and another object definition.</para>
</section> </section>
<section> <section>
......
...@@ -139,11 +139,9 @@ strings <userinput>path</userinput>/kea-dhcp6 | sed -n 's/;;;; //p' ...@@ -139,11 +139,9 @@ strings <userinput>path</userinput>/kea-dhcp6 | sed -n 's/;;;; //p'
<section> <section>
<title>Introduction</title> <title>Introduction</title>
<para> <para>
This section explains how to configure the DHCPv6 server using the This section explains how to configure the DHCPv6 server using a
Kea configuration backend. (Kea configuration using any other configuration file. Before DHCPv6 is started, its configuration
backends is outside of scope of this document.) Before DHCPv6 file has to be created. The basic configuration is as follows:
is started, its configuration file has to be created. The
basic configuration is as follows:
<screen> <screen>
{ {
# DHCPv6 configuration starts on the next line # DHCPv6 configuration starts on the next line
...@@ -303,8 +301,8 @@ In some cases in may be preferable to use more compact notation. ...@@ -303,8 +301,8 @@ In some cases in may be preferable to use more compact notation.
<para>After all parameters are specified, we have two contexts open: <para>After all parameters are specified, we have two contexts open:
global and Dhcp6, hence we need two closing curly brackets to close them. global and Dhcp6, hence we need two closing curly brackets to close them.
In a real life configuration file there most likely would be additional In a real life configuration file there most likely would be additional
components defined such as Logging or DhcpDdns, so the closing brace would components defined such as Logging, so the closing brace would be followed
be followed by a comma and another object definition.</para> by a comma and another object definition.</para>
</section> </section>
<section> <section>
......
...@@ -596,7 +596,7 @@ Debian and Ubuntu: ...@@ -596,7 +596,7 @@ Debian and Ubuntu:
(and thus in the shell path) you do not need to supply its path. (and thus in the shell path) you do not need to supply its path.
If it does not work (e.g. no pkg-config, package not available in If it does not work (e.g. no pkg-config, package not available in
pkg-config with the cassandra name), you can still use pkg-config with the cassandra name), you can still use
the <command>cql_config</command> script in tools/ as describe below. the <command>cql_config</command> script in tools/ as described below.
</para> </para>
<para> <para>
Download and compile cpp-driver from DataStax. For details regarding Download and compile cpp-driver from DataStax. For details regarding
...@@ -615,14 +615,16 @@ $ <userinput>make</userinput> ...@@ -615,14 +615,16 @@ $ <userinput>make</userinput>
<para> <para>
As of June 2016, cpp-driver does not include cql_config script As of June 2016, cpp-driver does not include cql_config script
yet. Work is in progress to contribute such a script to the cpp-driver yet. Work is in progress to contribute such a script to the cpp-driver
project but, until that is complete, intermediate steps that need to project but, until that is complete, intermediate steps need to
be conducted. A cql_config script is present in the tools/ directory be conducted. A cql_config script is present in the tools/ directory
of the Kea sources. Before using it, please create a of the Kea sources. Before using it, please create a
cql_config_defines.sh in the same directory (there is an example in cql_config_defines.sh in the same directory (there is an example in
cql_config_define.sh.sample available, you may copy it over to cql_config_define.sh.sample available, you may copy it over to
cql_config_defines.sh and edit path specified in it) and change the cql_config_defines.sh and edit path specified in it) and change the
environment variable CPP_DRIVER_PATH to point to the directory, where environment variable CPP_DRIVER_PATH to point to the directory, where
cpp-driver sources are located. cpp-driver sources are located. Make sure that appropriate access
rights are set on this file. It should be executable by the system
user building Kea.
</para> </para>
<para> <para>
Build and install Kea as described in <xref linkend="installation"/>, with Build and install Kea as described in <xref linkend="installation"/>, with
......
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