Commit 49a49e36 authored by Shawn Routhier's avatar Shawn Routhier
Browse files

[trac3620] Fix some typos in the docs

parent f71e34d4
......@@ -6,8 +6,8 @@
<chapter id="kea-config">
<title>Kea configuration</title>
<para>Depending on configuration backend chosen (see <xref
linkend="dhcp-config-backend"/>), configuration mechanisms are different. The
<para>Depending on the configuration backend chosen (see <xref
linkend="dhcp-config-backend"/>), the configuration mechanisms are different. The
following sections describe details of the different configuration backends. Note
that only one configuration backend can be used and its selection is
made when the configure script is run.</para>
......@@ -27,7 +27,7 @@
It assumes that the servers are started from the command line
(either directly or using a script, e.g. <filename>keactrl</filename>).
The JSON backend uses certain signals to influence Kea. The
configuration file is specified upon startup using -c parameter.</para>
configuration file is specified upon startup using the -c parameter.</para>
<section id="json-format">
<title>JSON syntax</title>
......@@ -106,7 +106,7 @@
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 (the global map that holds Dhcp6, Logging and possibly
the 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.</para>
</section>
......@@ -114,11 +114,11 @@
<section>
<title>Simplified Notation</title>
<para>It is sometimes convenient to refer to specific element in the
<para>It is sometimes convenient to refer to a specific element in the
configuration hierarchy. Each hierarchy level is separated by a slash.
If there is an array, a specific instance within that array is referred by
If there is an array, a specific instance within that array is referenced 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
valid-lifetime in the Dhcp6 component can be referred to as
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.</para>
......
......@@ -11,12 +11,12 @@
the DDNS protocol (defined in RFC 2136) on behalf of the DHCPv4 and DHCPv6
servers (kea-dhcp4 and kea-dhcp6 respectively). The DHCP servers construct
DDNS update requests, known as NameChangeRequests (NCRs), based upon DHCP
lease change events and then post these to D2. D2 attempts to match
lease change events and then posts these to D2. D2 attempts to match
each such request to the appropriate DNS server(s) and carry out the
necessary conversation with those servers to update the DNS data.
</para>
<para>
In order to match a request to appropriate DNS servers, D2 must have a
In order to match a request to the appropriate DNS servers, D2 must have a
catalog of servers from which to select. In fact, D2 has two such catalogs,
one for forward DNS and one for reverse DNS; these catalogs are referred
to as DDNS Domain Lists. Each list consists of one or more named DDNS
......@@ -55,7 +55,7 @@
<command>kea-dhcp-ddns</command> is the Kea DHCP-DDNS server
and, due to the nature of DDNS, it is run alongside either the
DHCPv4 or DHCPv6 components (or both). Like other parts of
Kea, is a separate binary that can be run on its own or through
Kea, it is a separate binary that can be run on its own or through
<command>keactrl</command> (see <xref linkend="keactrl"/>). In
normal operation, controlling <command>kea-dhcp-ddns</command>
with <command>keactrl</command> is recommended. However, it is also
......@@ -74,7 +74,7 @@
<simpara>
<command>-d</command> - specifies whether the server
logging should be switched to debug/verbose mode. In verbose mode,
the logging severity and debuglevel specified in a configuration
the logging severity and debuglevel specified in the configuration
file are ignored and "debug" severity and the maximum debuglevel
(99) are assumed. The flag is convenient, for temporarily
switching the server into maximum verbosity, e.g. when
......@@ -319,7 +319,7 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
"DhcpDdns": {
"tsig_keys": [
<userinput> {
"name": "key.four.example.com",
"name": "key.four.example.com.",
"algorithm": "HMAC-SHA224",
"secret": "bZEG7Ow8OgAUPfLWV3aAUQ=="
}</userinput>
......@@ -365,7 +365,7 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
by zone and a DDNS Domain only defines a single zone.
</para>
<para>
The section describes how to add Forward DDNS Domains. Repeat these
This section describes how to add Forward DDNS Domains. Repeat these
steps for each Forward DDNS Domain desired. Each Forward DDNS Domain
has the following parameters:
<itemizedlist>
......@@ -407,7 +407,7 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
"forward_ddns": {
"ddns_domains": [
<userinput>{
"name": "other.example.com",
"name": "other.example.com.",
"key_name": "",
"dns_servers": [
]
......@@ -426,7 +426,7 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
<section id="add-forward-dns-servers">
<title>Adding Forward DNS Servers</title>
<para>
The section describes how to add DNS servers to a Forward DDNS Domain.
This section describes how to add DNS servers to a Forward DDNS Domain.
Repeat them for as many servers as desired for a each domain.
</para>
<para>
......@@ -457,7 +457,7 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
</listitem>
</itemizedlist>
To create a new forward DNS Server, one must add a new server
element to the domain and fill its parameters. If for
element to the domain and fill in its parameters. If for
example the service is running at "172.88.99.10", then set it as
follows:
<screen>
......@@ -465,7 +465,7 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
"forward_ddns": {
"ddns_domains": [
{
"name": "other.example.com",
"name": "other.example.com.",
"key_name": "",
"dns_servers": [
<userinput>{
......@@ -524,7 +524,7 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
single zone.
</para>
<para>
The section describes how to add Reverse DDNS Domains. Repeat these
This section describes how to add Reverse DDNS Domains. Repeat these
steps for each Reverse DDNS Domain desired. Each Reverse DDNS Domain
has the following parameters:
<itemizedlist>
......@@ -592,8 +592,8 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
<section id="add-reverse-dns-servers">
<title>Adding Reverse DNS Servers</title>
<para>
The section describes how to add DNS servers to a Reverse DDNS Domain.
Repeat them for as many servers as desired for a each domain.
This section describes how to add DNS servers to a Reverse DDNS Domain.
Repeat them for as many servers as desired for each domain.
</para>
<para>
Reverse DNS Server entries represents a actual DNS servers which
......@@ -622,7 +622,7 @@ corresponding values in the DHCP servers' "dhcp-ddns" configuration section.
</listitem>
</itemizedlist>
To create a new reverse DNS Server, one must first add a new server
element to the domain and fill its parameters. If for
element to the domain and fill in its parameters. If for
example the service is running at "172.88.99.10", then set it as
follows:
<screen>
......
This diff is collapsed.
This diff is collapsed.
......@@ -310,7 +310,7 @@ Debian and Ubuntu:
<para>
For additional instructions concerning the building and installation of
Kea for various databases, see <xref linkend="dhcp-install-configure"/>.
For additional instructions concerning configuration backends, see
For additional instructions concerning the configuration backends, see
<xref linkend="dhcp-config-backend" />.
</para>
</note>
......@@ -389,7 +389,7 @@ Debian and Ubuntu:
<section id="dhcp-config-backend">
<title>Selecting the Configuration Backend</title>
<para>Kea 0.9 introduces configuration backends that are
switchable during compilation phase. The backend is chosen using
switchable during the compilation phase. The backend is chosen using
the --with-kea-config switch when running the configure script. It
currently supports two values: BUNDY and JSON. JSON is the default.
</para>
......@@ -415,8 +415,8 @@ Debian and Ubuntu:
<varlistentry>
<term>JSON</term>
<listitem>
<simpara>JSON is a new default configuration backend
that causes Kea to read JSON configuration file from
<simpara>JSON is the new default configuration backend
that causes Kea to read JSON configuration files from
disk. It does not require any framework and thus is
considered more lightweight. It will allow dynamic
on-line reconfiguration, but will lack remote capabilities
......
......@@ -107,7 +107,7 @@ kea_verbose=no
<para>
By default, Kea servers managed by <command>keactrl</command> are
located in <filename>[kea-install-dir]/sbin</filename>. This
should work for most of the installations. If the default
should work for most installations. If the default
location needs to be altered for any reason, the paths
specified with the <parameter>dhcp4_srv</parameter>,
<parameter>dhcp6_srv</parameter> and <parameter>dhcp_ddns_srv</parameter>
......
......@@ -264,7 +264,7 @@
Each logger can have zero or more
<option>output_options</option>. These specify where log
messages are sent to. These are explained in detail below.
messages are sent. These are explained in detail below.
</para>
......@@ -583,7 +583,7 @@ file be created.</para>
<varlistentry>
<term>KEA_LOCKFILE_DIR</term>
<listitem><para>
Specifies a directory where logging system should create its
Specifies a directory where the logging system should create its
lock file. If not specified, it is
<replaceable>prefix</replaceable>/var/run/kea, where
<replaceable>prefix</replaceable> defaults to /usr/local.
......
......@@ -61,7 +61,7 @@ $ <userinput>./configure [your extra parameters]</userinput></screen>
</listitem>
<listitem>
<para>Edit configuration file which is by default installed in
<para>Edit the configuration file which by default is 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>
......
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