mirror of
https://gitlab.isc.org/isc-projects/kea
synced 2025-08-30 13:37:55 +00:00
Updating links for conversion from docbook to sphinx; editing for clarity, grammar
This commit is contained in:
committed by
Michal Nowikowski
parent
30eaa6f2a6
commit
f1d2bcddd2
@@ -154,7 +154,7 @@ files will be assigned appropriate default values. When downgrading, any
|
|||||||
data present in the files but not in the server's schema will be
|
data present in the files but not in the server's schema will be
|
||||||
dropped. If you wish to convert the files manually prior to starting the
|
dropped. If you wish to convert the files manually prior to starting the
|
||||||
servers, you may do so by running the LFC process yourself. See
|
servers, you may do so by running the LFC process yourself. See
|
||||||
:ref:`The LFC Process <kea-lfc>` for more information.
|
:ref:`kea-lfc` for more information.
|
||||||
|
|
||||||
.. _mysql-database:
|
.. _mysql-database:
|
||||||
|
|
||||||
@@ -253,7 +253,7 @@ To check the current version of the database, use the following command:
|
|||||||
|
|
||||||
$ kea-admin lease-version mysql -u database-user -p database-password -n database-name
|
$ kea-admin lease-version mysql -u database-user -p database-password -n database-name
|
||||||
|
|
||||||
(See :ref:`Databases and Database Version Numbers <kea-database-version>`
|
(See :ref:`kea-database-version`
|
||||||
for a discussion about versioning.) If the version does not match the
|
for a discussion about versioning.) If the version does not match the
|
||||||
minimum required for the new version of Kea (as described in the release
|
minimum required for the new version of Kea (as described in the release
|
||||||
notes), the database needs to be upgraded.
|
notes), the database needs to be upgraded.
|
||||||
@@ -405,8 +405,7 @@ Upgrading a PostgreSQL Database from an Earlier Version of Kea
|
|||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The PostgreSQL database schema can be upgraded using the same tool and
|
The PostgreSQL database schema can be upgraded using the same tool and
|
||||||
commands as described in :ref:`Upgrading a MySQL Database from an Earlier
|
commands as described in :ref:`mysql-upgrade`, with the exception that the "pgsql"
|
||||||
Version of Kea <mysql-upgrade>`, with the exception that the "pgsql"
|
|
||||||
database backend type must be used in the commands.
|
database backend type must be used in the commands.
|
||||||
|
|
||||||
Use the following command to check the current schema version:
|
Use the following command to check the current schema version:
|
||||||
@@ -506,7 +505,7 @@ To check the current version of the database, use the following command:
|
|||||||
|
|
||||||
$ kea-admin lease-version cql -n database-name
|
$ kea-admin lease-version cql -n database-name
|
||||||
|
|
||||||
(See :ref:`Databases and Database Version Numbers <kea-database-version>`
|
(See :ref:`kea-database-version`
|
||||||
for a discussion about versioning.) If the version does not match the
|
for a discussion about versioning.) If the version does not match the
|
||||||
minimum required for the new version of Kea (as described in the release
|
minimum required for the new version of Kea (as described in the release
|
||||||
notes), the database needs to be upgraded.
|
notes), the database needs to be upgraded.
|
||||||
@@ -525,10 +524,10 @@ Using Read-Only Databases with Host Reservations
|
|||||||
|
|
||||||
If a read-only database is used for storing host reservations, Kea must
|
If a read-only database is used for storing host reservations, Kea must
|
||||||
be explicitly configured to operate on the database in read-only mode.
|
be explicitly configured to operate on the database in read-only mode.
|
||||||
Sections :ref:`Using Read-Only Databases for Host Reservations (DHCPv4) <read-only-database-configuration4>` and
|
Sections :ref:`read-only-database-configuration4` and
|
||||||
:ref:`Using Read-Only Databases for Host Reservations (DHCPv6) <read-only-database-configuration6>` describe when such
|
:ref:`read-only-database-configuration6` describe when such
|
||||||
a configuration may be required, and how to configure Kea to operate in
|
a configuration may be required, and how to configure Kea to operate in
|
||||||
this way.
|
this way for both DHCPv4 and DHCPv6.
|
||||||
|
|
||||||
Limitations Related to the Use of SQL Databases
|
Limitations Related to the Use of SQL Databases
|
||||||
-----------------------------------------------
|
-----------------------------------------------
|
||||||
|
@@ -17,7 +17,7 @@ whether the command should be handled by the CA or forwarded is made by
|
|||||||
checking the value of the "service" parameter, which may be included in
|
checking the value of the "service" parameter, which may be included in
|
||||||
the command from the controlling client. The details of the supported
|
the command from the controlling client. The details of the supported
|
||||||
commands, as well as their structures, are provided in
|
commands, as well as their structures, are provided in
|
||||||
:ref:`Management API <ctrl-channel>`.
|
:ref:`ctrl-channel`.
|
||||||
|
|
||||||
The CA can use hook libraries to provide support for additional commands
|
The CA can use hook libraries to provide support for additional commands
|
||||||
or custom behavior of existing commands. Such hook libraries must
|
or custom behavior of existing commands. Such hook libraries must
|
||||||
@@ -89,7 +89,7 @@ provided above, the RESTful service will be available under the URL of
|
|||||||
``http://10.20.30.40:8080/``. If these parameters are not specified, the
|
``http://10.20.30.40:8080/``. If these parameters are not specified, the
|
||||||
default URL is http://127.0.0.1:8000/
|
default URL is http://127.0.0.1:8000/
|
||||||
|
|
||||||
As mentioned in :ref:`Overview <agent-overview>`, the CA can forward
|
As mentioned in :ref:`agent-overview`, the CA can forward
|
||||||
received commands to the Kea servers for processing. For example,
|
received commands to the Kea servers for processing. For example,
|
||||||
``config-get`` is sent to retrieve the configuration of one of the Kea
|
``config-get`` is sent to retrieve the configuration of one of the Kea
|
||||||
services. When the CA receives this command, including a ``service``
|
services. When the CA receives this command, including a ``service``
|
||||||
@@ -97,7 +97,7 @@ parameter indicating that the client wishes to retrieve the
|
|||||||
configuration of the DHCPv4 server, the CA forwards the command to that
|
configuration of the DHCPv4 server, the CA forwards the command to that
|
||||||
server and passes the received response back to the client. More about
|
server and passes the received response back to the client. More about
|
||||||
the ``service`` parameter and the general structure of commands can be
|
the ``service`` parameter and the general structure of commands can be
|
||||||
found in :ref:`Management API <ctrl-channel>`.
|
found in :ref:`ctrl-channel`.
|
||||||
|
|
||||||
The CA uses UNIX domain sockets to forward control commands and receive
|
The CA uses UNIX domain sockets to forward control commands and receive
|
||||||
responses from other Kea services. The ``dhcp4``, ``dhcp6``, and ``d2``
|
responses from other Kea services. The ``dhcp4``, ``dhcp6``, and ``d2``
|
||||||
@@ -107,8 +107,8 @@ configuration above, the CA will connect to the DHCPv4 server via
|
|||||||
Obviously, the DHCPv4 server must be configured to listen to connections
|
Obviously, the DHCPv4 server must be configured to listen to connections
|
||||||
via this same socket. In other words, the command socket configuration
|
via this same socket. In other words, the command socket configuration
|
||||||
for the DHCPv4 server and the CA (for this server) must match. Consult
|
for the DHCPv4 server and the CA (for this server) must match. Consult
|
||||||
:ref:`Management API for the DHCPv4 Server <dhcp4-ctrl-channel>`, :ref:`Management API for the DHCPv6 Server <dhcp6-ctrl-channel>` and
|
:ref:`dhcp4-ctrl-channel`, :ref:`dhcp6-ctrl-channel` and
|
||||||
:ref:`Management API for the D2 Server <d2-ctrl-channel>` to learn how the socket configuration is
|
:ref:`d2-ctrl-channel` to learn how the socket configuration is
|
||||||
specified for the DHCPv4, DHCPv6, and D2 services.
|
specified for the DHCPv4, DHCPv6, and D2 services.
|
||||||
|
|
||||||
**Warning**
|
**Warning**
|
||||||
@@ -138,7 +138,7 @@ The ``hooks-libraries`` list contains the list of hooks libraries that
|
|||||||
should be loaded by the CA, along with their configuration information
|
should be loaded by the CA, along with their configuration information
|
||||||
specified with ``parameters``.
|
specified with ``parameters``.
|
||||||
|
|
||||||
Please consult :ref:`Logging <logging>` for the details how to configure
|
Please consult :ref:`logging` for the details how to configure
|
||||||
logging. The CA's root logger's name is ``kea-ctrl-agent``, as given in
|
logging. The CA's root logger's name is ``kea-ctrl-agent``, as given in
|
||||||
the example above.
|
the example above.
|
||||||
|
|
||||||
@@ -263,7 +263,7 @@ file it should use. For example:
|
|||||||
|
|
||||||
$ ./kea-ctrl-agent -c /usr/local/etc/kea/kea-ctrl-agent.conf
|
$ ./kea-ctrl-agent -c /usr/local/etc/kea/kea-ctrl-agent.conf
|
||||||
|
|
||||||
It can be started by keactrl as well (see :ref:`Managing Kea with keactrl <keactrl>`).
|
It can be started by keactrl as well (see :ref:`keactrl`).
|
||||||
|
|
||||||
.. _agent-clients:
|
.. _agent-clients:
|
||||||
|
|
||||||
@@ -271,4 +271,4 @@ Connecting to the Control Agent
|
|||||||
===============================
|
===============================
|
||||||
|
|
||||||
For an example of a tool that can take advantage of the RESTful API, see
|
For an example of a tool that can take advantage of the RESTful API, see
|
||||||
:ref:`The Kea Shell <kea-shell>`.
|
:ref:`kea-shell`.
|
||||||
|
@@ -15,7 +15,7 @@ JSON Configuration
|
|||||||
|
|
||||||
JSON is the notation used throughout the Kea project. The most obvious
|
JSON is the notation used throughout the Kea project. The most obvious
|
||||||
usage is for the configuration file, but JSON is also used for sending
|
usage is for the configuration file, but JSON is also used for sending
|
||||||
commands over the Management API (see :ref:`Management API <ctrl-channel>`) and for
|
commands over the Management API (see :ref:`ctrl-channel`) and for
|
||||||
communicating between DHCP servers and the DDNS update daemon.
|
communicating between DHCP servers and the DDNS update daemon.
|
||||||
|
|
||||||
Typical usage assumes that the servers are started from the command
|
Typical usage assumes that the servers are started from the command
|
||||||
|
File diff suppressed because it is too large
Load Diff
@@ -44,7 +44,7 @@ Build Requirements
|
|||||||
=====================
|
=====================
|
||||||
|
|
||||||
In addition to the run-time requirements (listed in
|
In addition to the run-time requirements (listed in
|
||||||
:ref:`Required Software at Run-Time <required-software>`), building Kea from source code requires
|
:ref:`required-software`), building Kea from source code requires
|
||||||
various development include headers and program development tools.
|
various development include headers and program development tools.
|
||||||
|
|
||||||
**Note**
|
**Note**
|
||||||
@@ -217,7 +217,7 @@ options. Some commonly used options are:
|
|||||||
found, it searches for OpenSSL. Normally this is not necessary.
|
found, it searches for OpenSSL. Normally this is not necessary.
|
||||||
|
|
||||||
--enable-shell
|
--enable-shell
|
||||||
Build the optional ``kea-shell`` tool (more in :ref:`The Kea Shell" <kea-shell>`).
|
Build the optional ``kea-shell`` tool (more in :ref:`kea-shell`).
|
||||||
The default is to not build it.
|
The default is to not build it.
|
||||||
|
|
||||||
--enable-perfdhcp
|
--enable-perfdhcp
|
||||||
@@ -229,8 +229,7 @@ options. Some commonly used options are:
|
|||||||
**Note**
|
**Note**
|
||||||
|
|
||||||
For instructions concerning the installation and configuration of
|
For instructions concerning the installation and configuration of
|
||||||
database backends for Kea, see :ref:`DHCP Database Installation and
|
database backends for Kea, see :ref:`dhcp-install-configure`.
|
||||||
Configuration <dhcp-install-configure>`.
|
|
||||||
|
|
||||||
There are also many additional options that are typically not necessary for
|
There are also many additional options that are typically not necessary for
|
||||||
regular users. However, they may be useful for package maintainers,
|
regular users. However, they may be useful for package maintainers,
|
||||||
@@ -387,9 +386,9 @@ Building with MySQL Support
|
|||||||
Install MySQL according to the instructions for your system. The client
|
Install MySQL according to the instructions for your system. The client
|
||||||
development libraries must be installed.
|
development libraries must be installed.
|
||||||
|
|
||||||
Build and install Kea as described in :ref:`Installation <installation>`,
|
Build and install Kea as described in :ref:`installation`,
|
||||||
with the following modification. To enable the MySQL database code, at
|
with the following modification. To enable the MySQL database code, at
|
||||||
the "configure" step (see :ref:`Configure Before the Build <configure>`),
|
the "configure" step (see :ref:`configure`),
|
||||||
the --with-mysql switch should be specified:
|
the --with-mysql switch should be specified:
|
||||||
|
|
||||||
::
|
::
|
||||||
@@ -404,7 +403,7 @@ switch, i.e.
|
|||||||
|
|
||||||
./configure [other-options] --with-mysql=path-to-mysql_config
|
./configure [other-options] --with-mysql=path-to-mysql_config
|
||||||
|
|
||||||
See :ref:`First-Time Creation of the MySQL Database <mysql-database-create>` for details regarding MySQL
|
See :ref:`mysql-database-create` for details regarding MySQL
|
||||||
database configuration.
|
database configuration.
|
||||||
|
|
||||||
Building with PostgreSQL support
|
Building with PostgreSQL support
|
||||||
@@ -414,10 +413,9 @@ Install PostgreSQL according to the instructions for your system. The
|
|||||||
client development libraries must be installed. Client development
|
client development libraries must be installed. Client development
|
||||||
libraries are often packaged as "libpq".
|
libraries are often packaged as "libpq".
|
||||||
|
|
||||||
Build and install Kea as described in :ref:`Installation <installation>`,
|
Build and install Kea as described in :ref:`installation`,
|
||||||
with the following modification. To enable the PostgreSQL database code,
|
with the following modification. To enable the PostgreSQL database code,
|
||||||
at the "configure" step (see :ref:`Configure Before the
|
at the "configure" step (see :ref:`configure`), the --with-pgsql switch should be specified:
|
||||||
Build <configure>`), the --with-pgsql switch should be specified:
|
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
@@ -431,7 +429,7 @@ the switch, i.e.
|
|||||||
|
|
||||||
./configure [other-options] --with-pgsql=path-to-pg_config
|
./configure [other-options] --with-pgsql=path-to-pg_config
|
||||||
|
|
||||||
See :ref:`First-Time Creation of the PostgreSQL Database <pgsql-database-create>` for details regarding PostgreSQL
|
See :ref:`pgsql-database-create` for details regarding PostgreSQL
|
||||||
database configuration.
|
database configuration.
|
||||||
|
|
||||||
Building with CQL (Cassandra) Support
|
Building with CQL (Cassandra) Support
|
||||||
@@ -443,9 +441,8 @@ https://cassandra.apache.org.
|
|||||||
|
|
||||||
If you have a cpp-driver package available as binary or as source,
|
If you have a cpp-driver package available as binary or as source,
|
||||||
simply install or build and install the package. Then build and install
|
simply install or build and install the package. Then build and install
|
||||||
Kea as described in :ref:`Installation <installation>`. To enable the
|
Kea as described in :ref:`installation`. To enable the
|
||||||
Cassandra (CQL) database code, at the "configure" step (see :ref:`Configure
|
Cassandra (CQL) database code, at the "configure" step (see :ref:`configure`), enter:
|
||||||
Before the Build <configure>`), enter:
|
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
@@ -483,10 +480,9 @@ point to the directory where the cpp-driver sources are located. Make
|
|||||||
sure that appropriate access rights are set on this file. It should be
|
sure that appropriate access rights are set on this file. It should be
|
||||||
executable by the system user building Kea.
|
executable by the system user building Kea.
|
||||||
|
|
||||||
Build and install Kea as described in :ref:`Installation <installation>`,
|
Build and install Kea as described in :ref:`installation`,
|
||||||
with the following modification. To enable the Cassandra (CQL) database
|
with the following modification. To enable the Cassandra (CQL) database
|
||||||
code, at the "configure" step (see :ref:`Configure Before the
|
code, at the "configure" step (see :ref:`configure`), enter:
|
||||||
Build <configure>`), enter:
|
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
|
@@ -34,7 +34,7 @@ Required Software at Run-Time
|
|||||||
Running Kea uses various extra software packages which may not be
|
Running Kea uses various extra software packages which may not be
|
||||||
provided in the default installation of some operating systems, nor in
|
provided in the default installation of some operating systems, nor in
|
||||||
the standard package collections. You may need to install this required
|
the standard package collections. You may need to install this required
|
||||||
software separately. (For the build requirements, also see :ref:`Build Requirements <build-requirements>`.)
|
software separately. (For the build requirements, also see :ref:`build-requirements`.)
|
||||||
|
|
||||||
- Kea supports two cryptographic libraries: Botan and OpenSSL. Only one
|
- Kea supports two cryptographic libraries: Botan and OpenSSL. Only one
|
||||||
of them is required to be installed during compilation. Kea uses the
|
of them is required to be installed during compilation. Kea uses the
|
||||||
@@ -74,7 +74,7 @@ software separately. (For the build requirements, also see :ref:`Build Requireme
|
|||||||
kea-netconf agent. This Kea module is built optionally and requires
|
kea-netconf agent. This Kea module is built optionally and requires
|
||||||
Sysrepo software when used. Building Kea with NETCONF support
|
Sysrepo software when used. Building Kea with NETCONF support
|
||||||
requires many dependencies to be installed, which are described in
|
requires many dependencies to be installed, which are described in
|
||||||
more detail in :ref: `Installing NETCONF <netconf-install>`.
|
more detail in :ref: `netconf-install`.
|
||||||
|
|
||||||
.. _kea_software:
|
.. _kea_software:
|
||||||
|
|
||||||
|
@@ -120,7 +120,7 @@ specified with the ``dhcp4_srv``, ``dhcp6_srv``, ``dhcp_ddns_srv``,
|
|||||||
The ``kea_verbose`` parameter specifies the verbosity of the servers
|
The ``kea_verbose`` parameter specifies the verbosity of the servers
|
||||||
being started. When ``kea_verbose`` is set to "yes" the logging level of
|
being started. When ``kea_verbose`` is set to "yes" the logging level of
|
||||||
the server is set to DEBUG. Modification of the logging severity in a
|
the server is set to DEBUG. Modification of the logging severity in a
|
||||||
configuration file, as described in :ref:`Logging <logging>`, will have no
|
configuration file, as described in :ref:`logging`, will have no
|
||||||
effect as long as the ``kea_verbose`` is set to "yes." Setting it to
|
effect as long as the ``kea_verbose`` is set to "yes." Setting it to
|
||||||
"no" will cause the server to use the logging levels specified in the
|
"no" will cause the server to use the logging levels specified in the
|
||||||
Kea configuration file. If no logging configuration is specified, the
|
Kea configuration file. If no logging configuration is specified, the
|
||||||
|
@@ -14,7 +14,7 @@ Quick Start Guide for DHCPv4 and DHCPv6 Services
|
|||||||
================================================
|
================================================
|
||||||
|
|
||||||
1. Install required run-time and build dependencies. See
|
1. Install required run-time and build dependencies. See
|
||||||
:ref:`Build Requirements <build-requirements>` for details.
|
:ref:`build-requirements` for details.
|
||||||
|
|
||||||
2. Download the Kea source tarball from the :ref:`ISC.org downloads
|
2. Download the Kea source tarball from the :ref:`ISC.org downloads
|
||||||
page <https://www.isc.org/download/>` or the :ref:`ISC FTP
|
page <https://www.isc.org/download/>` or the :ref:`ISC FTP
|
||||||
@@ -102,7 +102,7 @@ available in the :ref:`Kea section of ISC's
|
|||||||
Knowledgebase <https://kb.isc.org/docs>`.
|
Knowledgebase <https://kb.isc.org/docs>`.
|
||||||
|
|
||||||
The details of ``keactrl`` script usage can be found in
|
The details of ``keactrl`` script usage can be found in
|
||||||
:ref:`Managing Kea with keactrl <#keactrl>`.
|
:ref:`keactrl`.
|
||||||
|
|
||||||
.. _quick-start-direct-run:
|
.. _quick-start-direct-run:
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user