Commit cc3cfee4 authored by Suzanne Goldlust's avatar Suzanne Goldlust Committed by Michal Nowikowski
Browse files

Various Sphinx edits

parent b5b87d18
......@@ -111,7 +111,7 @@ for the DHCPv4 server and the CA (for this server) must match. Consult
:ref:`d2-ctrl-channel` to learn how the socket configuration is
specified for the DHCPv4, DHCPv6, and D2 services.
.. warning::
.. warning::
"dhcp4-server", "dhcp6-server", and "d2-server" were renamed to
"dhcp4", "dhcp6", and "d2" respectively in Kea 1.2. If you are
......@@ -240,7 +240,7 @@ server enables authentication of the clients using certificates.
..
.. note::
.. note::
Note that the configuration snippet provided above is for testing
purposes only. It should be modified according to the security
......
......@@ -28,7 +28,7 @@ network grows, the usefulness of the CB becomes obvious.
A good example of a use case for the CB is a pair of Kea DHCP servers which can be configured
to support High Availability as described in
:ref:`ha: High Availability <high-availability-library>`. The configurations of both servers
:ref:`high-availability-library`. The configurations of both servers
are almost exactly the same. They may differ by the server identifier
and designation of the server as a primary or standby (or secondary).
They may also differ by the interfaces configuration. Typically, the
......@@ -70,7 +70,7 @@ comes with a number of limitations as a result of the overall
complexity of this feature and the development time constraints. This
feature will evolve over time and the new capabilities will be added in
subsequent releases. In this section we present the capabilities and limitations of the
CB in the current Kea 1.6.0 release:
CB in the Kea 1.6.0 release:
- Kea CB is supported for the MySQL database only.
......@@ -120,13 +120,13 @@ Configuration Backend for MySQL must be compiled and loaded by the DHCP
servers. This hooks library is compiled when the ``--with-mysql``
configuration switch is used during the Kea build. The MySQL C client
libraries must be installed, as explained in
:ref:`DHCP Database Installation and Configuration <dhcp-install-configure>`.
:ref:`dhcp-install-configure`.
.. note::
Any existing MySQL schema must be upgraded to the latest schema
required by the particular Kea version using the ``kea-admin`` tool,
as described in `The kea-admin Tool <kea-admin>`.
as described in :ref:`kea-admin`.
The ``cb_cmds`` premium hooks library, which is available to ISC's paid support
customers, provides a complete set of commands to manage the
......@@ -136,9 +136,9 @@ possible to manage the configuration information without the ``cb_cmds``
hooks library with commonly available tools, such as MySQL Workbench or
the command-line MySQL client, by directly working with the database.
Refer to :ref:`cb_cmds: Configuration Backend Commands <cb-cmds-library>` for the details regarding the
Refer to :ref:`cb-cmds-library` for the details regarding the
``cb_cmds`` hooks library.
The DHCPv4 and DHCPv6 server-specific configurations of the CB, as well as
the list of supported configuration parameters, can be found in
:ref:`Configuration Backend in DHCPv4 <dhcp4-cb>` and :ref:`Configuration Backend in DHCPv6 <dhcp6-cb>` respectively.
:ref:`dhcp4-cb` and :ref:`dhcp6-cb` respectively.
......@@ -3063,14 +3063,14 @@ are enabled. To set its value simply set it to the desired string:
When generating a name, kea-dhcp4 will construct the name in the format:
[generated-prefix]-[address-text].[qualifying-suffix].
[**generated-prefix**]-[**address-text**].[**qualifying-suffix**].
where address-text is simply the lease IP address converted to a
where **address-text** is simply the lease IP address converted to a
hyphenated string. For example, if the lease address is 172.16.1.10, the
qualifying suffix "example.com", and the default value is used for
``generated-prefix``, the generated FQDN is:
myhost-172-16-1-10.example.com.
**myhost-172-16-1-10.example.com.**
.. _host-name-sanitization:
......
......@@ -26,8 +26,7 @@ Command Line Options
# keactrl <command> [-c keactrl-config-file] [-s server[,server,...]]
``<command>`` is one of the commands described in
`Commands <#keactrl-commands>`__.
``<command>`` is one of the commands described in :ref:`keactrl-commands`.
The optional ``-c keactrl-config-file`` switch allows specification of
an alternate ``keactrl`` configuration file. (``--ctrl-config`` is a
......@@ -69,7 +68,6 @@ The contents of ``keactrl.conf`` are:
kea_ctrl_agent_config_file=@sysconfdir@/@PACKAGE@/kea-ctrl-agent.conf
kea_netconf_config_file=@sysconfdir@/@PACKAGE@/kea-netconf.conf
# Location of Kea binaries.
exec_prefix=@exec_prefix@
dhcp4_srv=@sbindir@/kea-dhcp4
......@@ -243,7 +241,7 @@ take effect. This limitation will be removed in a future release.
..
.. note::
.. note::
NETCONF is an optional feature that is disabled by default and can be
enabled during compilation. If Kea was compiled without NETCONF
......@@ -252,7 +250,7 @@ take effect. This limitation will be removed in a future release.
the keactrl.conf file, but NETCONF status will not be shown and other
commands will ignore it.
.. note::
.. note::
Currently ``keactrl`` does not report configuration failures when the
server is started or reconfigured. To check if the server's
......
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