From 06b66be37f2140eb3338fa62ccc76b1cc427049c Mon Sep 17 00:00:00 2001 From: Marcin Siodelski Date: Thu, 13 Dec 2018 15:58:54 +0100 Subject: [PATCH] [master] Several fixes to the documentation following 1.5.0 sanity checks. Okayed on jabber. --- doc/guide/config.xml | 12 ++++++------ doc/guide/dhcp4-srv.xml | 14 ++++++-------- doc/guide/dhcp6-srv.xml | 12 +++++------- doc/guide/install.xml | 8 +++++--- 4 files changed, 22 insertions(+), 24 deletions(-) diff --git a/doc/guide/config.xml b/doc/guide/config.xml index 4613d8360c..a6c8d92aae 100644 --- a/doc/guide/config.xml +++ b/doc/guide/config.xml @@ -10,21 +10,21 @@ Kea Configuration - Kea is using JSON structures to handle configuration. Previously - we there was a concept of other configuration backends, but that never was - implemented and the idea was abandoned. + Kea is using JSON structures to represent servers' configurations. + The following sections describe how the configuration structures are + organized. +
JSON Configuration 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 ) and for communicating between DHCP servers and DDNS update daemon. Typical usage assumes that the servers are started from the command line (either directly or using a script, e.g. keactrl). - The JSON backend uses certain signals to influence Kea. The - configuration file is specified upon startup using the -c parameter. + The configuration file is specified upon startup using the -c parameter.
JSON Syntax diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index 485a60fe06..88b4ca6916 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -139,11 +139,9 @@ strings path/kea-dhcp4 | sed -n 's/;;;; //p'
Introduction - This section explains how to configure the DHCPv4 server using the - Kea configuration backend. (Kea configuration using any other - backends is outside of scope of this document.) Before DHCPv4 - is started, its configuration file has to be created. The - basic configuration is as follows: + This section explains how to configure the DHCPv4 server using a + configuration file. Before DHCPv4 is started, its configuration + file has to be created. The basic configuration is as follows: { # DHCPv4 configuration starts in this line @@ -310,9 +308,9 @@ In some cases in may be preferable to use more compact notation. 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. -In a real life configuration file there most likely would be additional -components defined such as Logging or DhcpDdns, so the closing brace would -be followed by a comma and another object definition. +In a real life configuration file there most likely would be an additional +component defined such as Logging, so the closing brace would be followed +by a comma and another object definition.
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index 2b202657ce..4262ca7676 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -139,11 +139,9 @@ strings path/kea-dhcp6 | sed -n 's/;;;; //p'
Introduction - This section explains how to configure the DHCPv6 server using the - Kea configuration backend. (Kea configuration using any other - backends is outside of scope of this document.) Before DHCPv6 - is started, its configuration file has to be created. The - basic configuration is as follows: + This section explains how to configure the DHCPv6 server using a + configuration file. Before DHCPv6 is started, its configuration + file has to be created. The basic configuration is as follows: { # DHCPv6 configuration starts on the next line @@ -303,8 +301,8 @@ In some cases in may be preferable to use more compact notation. After all parameters are specified, we have two contexts open: 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 -components defined such as Logging or DhcpDdns, so the closing brace would -be followed by a comma and another object definition. +components defined such as Logging, so the closing brace would be followed +by a comma and another object definition.
diff --git a/doc/guide/install.xml b/doc/guide/install.xml index 88de6fb96f..531af5c240 100644 --- a/doc/guide/install.xml +++ b/doc/guide/install.xml @@ -596,7 +596,7 @@ Debian and Ubuntu: (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 pkg-config with the cassandra name), you can still use - the cql_config script in tools/ as describe below. + the cql_config script in tools/ as described below. Download and compile cpp-driver from DataStax. For details regarding @@ -615,14 +615,16 @@ $ make 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 - 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 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_define.sh.sample available, you may copy it over to cql_config_defines.sh and edit path specified in it) and change the 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. Build and install Kea as described in , with -- 2.47.2