From: Stephen Morris Date: Wed, 18 Jun 2014 11:02:24 +0000 (+0100) Subject: [3418] Small alterations to configuration section made as part of review X-Git-Tag: trac3473_base~12^2~3 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=738e8b2479719f8570cffb198bd2f98801be9672;p=thirdparty%2Fkea.git [3418] Small alterations to configuration section made as part of review --- diff --git a/doc/guide/config.xml b/doc/guide/config.xml index 2fc939c334..d9bad8debd 100644 --- a/doc/guide/config.xml +++ b/doc/guide/config.xml @@ -8,45 +8,45 @@ Depending on configuration backend chosen (see ), configuration mechanisms are different. The - following sections describe details of specific configuration backends. Note + following sections describe details of the differeent configuration backends. Note that only one configuration backend can be used and its selection is - determined during compilation time. + made when the configure script is run.
- Bundy configuration backend - This legacy configuration backend allows Kea to use former BIND10 + BIND 10 configuration backend + This legacy configuration backend allows Kea to use the former BIND10 framework. That framework and this Kea configuration backend is no longer - supported by ISC. It is currently developed as part of Bundy project (see - Bundy homepage). See Bundy project + supported by ISC. It is currently developed as part of the Bundy project (see + Bundy homepage). See the Bundy project documentation regarding configuration.
JSON configuration backend JSON is the default configuration backend and the only one supported - as of 0.9 release. It assumes that the servers are started from command line - (either directly or using a script, see TODO for details). JSON backend uses - certain signals to influence certain behaviors. The configuration file is + as of the 0.9 release. It assumes that the servers are started from the command line + (either directly or using a script, see TODO for details). The JSON backend uses + certain signals to influence Kea. The configuration file is specified upon startup using -c parameter.
JSON syntax Configuration files for DHCPv4, DHCPv6 and DDNS modules are defined - in extended JSON format. The basic JSON is defined in RFC 4627. Kea components - use extended JSON, which extends basic format by allowing bash-style - comments in the file. Comment lines must have hash (#) in the first - column. + use a slightly modified JSON, in that they allowing bash-style + comments in the file: lines with the hash (#) character in the first column + are comment lines and are ignored. - Configuration file consists of a single object (often colloquially - called a map) started with a curly bracket. It consists "Dhcp4", "Dhcp6", + The configuration file consists of a single object (often colloquially + called a map) started with a curly bracket. It comprises the "Dhcp4", "Dhcp6", "DhcpDdns" and/or "Logging" objects. It is possible to define additional - elements, but they will be ignored. That principle was chosen to ease - configuration management. For example, it is possible to define Dhcp4, - Dhcp6 and Logging elements in one configuration file that can be used to - start both DHCPv4 and DHCPv6 components. When starting, DHCPv4 component - will use Dhcp4 object to configure itself and Logging to configure logging - parameters, while ignoring Dhcp6 object. + elements, but they will be ignored. (That principle was chosen to ease + configuration management.) For example, it is possible to define Dhcp4, + Dhcp6 and Logging elements in a single configuration file that can be used to + start both the DHCPv4 and DHCPv6 components. When starting, the DHCPv4 component + will use Dhcp4 object to configure itself and the Logging object to configure logging + parameters; it will ignore the Dhcp6 object. For example, a very simple configuration for both DHCPv4 and DHCPv6 could look like this: @@ -84,7 +84,7 @@ # DHCPv6 specific configuration ends here. # Logger parameters (that could be shared among several components) start here. -# That section can be used by both DHCPv4 and DHCPv6 servers. +# This section is used by both the DHCPv4 and DHCPv6 servers. "Logging": { "loggers": [{ "name": "*", @@ -102,26 +102,25 @@ More examples are available in the Kea source code in the doc/examples directory. - To avoid repetition of mostly similar structures, specific - examples will showcase only subset of parameters appropriate for a given - context. For example, when discussing IPv6 subnets configuration in + To avoid repetition of mostly similar structures, examples in the + rest of this guide will showcase only the subset of parameters appropriate for a given + context. For example, when discussing the IPv6 subnets configuration in DHCPv6, only subnet6 parameters will be mentioned. It is implied that - remaining elements (global that holds Dhcp6, Logging and possibly - DhcpDdns) are present, but are omitted for clarity. Usually, locations - where extra parameters may appear are denoted with ellipsis (triple - dot). + remaining elements (the global map that holds Dhcp6, Logging and possibly + DhcpDdns) are present, but they are omitted for clarity. Usually, locations + where extra parameters may appear are denoted with an ellipsis.
- Simplified notation + Simplified Notation It is sometimes convenient to refer to specific element in the configuration hierarchy. Each hierarchy level is separated by a slash. - If there is an array, specific instance within that array is referred by - a number in square brackets. For example, in the above configuration the + If there is an array, a specific instance within that array is referred by + a number in square brackets (with numbering starting at zero). For example, in the above configuration the valid-lifetime in Dhcp6 component can be referred to as - Dhcp6/valid-lifetime, first interface for the DHCPv4 server as - Dhcp4/interfaces[0] and the pool in the first IPv6 defined in DHCPv6 + Dhcp6/valid-lifetime, the first interface for the DHCPv4 server as + Dhcp4/interfaces[0] and the pool in the first subnet defined in the DHCPv6 configuration as Dhcp6/subnet6[0]/pool.