mirror of
https://gitlab.isc.org/isc-projects/kea
synced 2025-08-30 21:45:37 +00:00
Second update to documentation files
This commit is contained in:
@@ -173,7 +173,7 @@ The ``hooks-libraries`` list contains the list of hooks libraries that
|
||||
should be loaded by the CA, along with their configuration information
|
||||
specified with ``parameters``.
|
||||
|
||||
Please consult :ref:`logging` for the details how to configure
|
||||
Please consult :ref:`logging` for the details on how to configure
|
||||
logging. The CA's root logger's name is ``kea-ctrl-agent``, as given in
|
||||
the example above.
|
||||
|
||||
|
@@ -203,10 +203,10 @@ is specified in the Kea configuration file, using the
|
||||
All Kea instances presenting the same server tag to the configuration database
|
||||
are given the same configuration. It is the administrator's choice whether
|
||||
multiple Kea instances use the same server tag or each Kea instance is using
|
||||
a different sever tag. Also, there is no requirement that the instances
|
||||
a different server tag. Also, there is no requirement that the instances
|
||||
running on the same physical or virtual machine use the same server tag. It is
|
||||
even possible to configure the Kea server without assigning it a server tag.
|
||||
In such case the server will be given the configuration specified for "all"
|
||||
In such a case the server will be given the configuration specified for "all"
|
||||
servers.
|
||||
|
||||
In order to differentiate the configurations between the Kea servers, a
|
||||
@@ -239,7 +239,7 @@ the subnet within the network. Some commands provided by the
|
||||
information by subnet identifier (or prefix) and explicitly prohibit
|
||||
using the server tag to access the subnet. This is because, in a
|
||||
general case, the subnet definition is associated with multiple servers
|
||||
rather than single server. In fact, it may even be associated
|
||||
rather than a single server. In fact, it may even be associated
|
||||
with no servers (unassigned). Still, the unassigned subnet has an
|
||||
identifier and prefix which can be used to access the subnet.
|
||||
|
||||
@@ -293,5 +293,5 @@ belong to "all" servers.
|
||||
use this configuration. The server fetching the subnets will be
|
||||
aware that the subnets are associated with the shared network but
|
||||
the shared network will not be found by this server as it doesn't
|
||||
belong to it. In such case, both the shared network and the subnets
|
||||
belong to it. In such a case, both the shared network and the subnets
|
||||
should be assigned to the same set of servers.
|
||||
|
@@ -52,7 +52,7 @@ Kea components use an extended JSON with additional features allowed:
|
||||
ignored.
|
||||
|
||||
- Multiline comments: any text between /\* and \*/ is ignored. This
|
||||
commenting can span multiple lines.
|
||||
comment can span multiple lines.
|
||||
|
||||
- File inclusion: JSON files can include other JSON files by using a
|
||||
statement of the form \<?include "file.json"?\>.
|
||||
@@ -180,7 +180,7 @@ syntax and its top-level element is a map (i.e. the data must be enclosed in
|
||||
curly brackets). However, some hook libraries may expect specific formatting;
|
||||
please consult the specific hook library documentation for details.
|
||||
|
||||
In a sense the user context mechanism has superseeded the JSON comment
|
||||
In a sense the user context mechanism has superseded the JSON comment
|
||||
capabilities. ISC would like to encourage people to use user-context in favor of
|
||||
the older mechanisms and we hope to deprecate JSON comments one day in the
|
||||
future. To promote this way of storing comments, Kea code is able to understand
|
||||
|
@@ -319,7 +319,7 @@ can be used to configure the memfile backend.
|
||||
LFC.
|
||||
|
||||
- ``max-row-errors``: when the server loads a lease file, it is processed
|
||||
row by row, each row contaning a single lease. If a row is flawed and
|
||||
row by row, each row containing a single lease. If a row is flawed and
|
||||
cannot be processed correctly the server will log it, discard the row,
|
||||
and go on to the next row. This parameter can be used to set a limit on
|
||||
the number of such discards that may occur after which the server will
|
||||
@@ -909,7 +909,7 @@ to the broadcast address, all sockets on this link will receive this
|
||||
message and multiple responses will be sent to the client. Therefore,
|
||||
the configuration with multiple IPv4 addresses assigned to the interface
|
||||
should not be used when the directly connected clients are operating on
|
||||
that link. To use a single address on such interface, the
|
||||
that link. To use a single address on such an interface, the
|
||||
"interface-name/address" notation should be used.
|
||||
|
||||
.. note::
|
||||
@@ -964,7 +964,7 @@ disabled by setting the ``re-detect`` value to ``false``, for instance:
|
||||
Note that interfaces are not re-detected during ``config-test``.
|
||||
|
||||
Usually loopback interfaces (e.g. the "lo" or "lo0" interface) may not
|
||||
be configured, but if a loopback interface is explicitely configured and
|
||||
be configured, but if a loopback interface is explicitly configured and
|
||||
IP/UDP sockets are specified, the loopback interface is accepted.
|
||||
|
||||
For example, it can be used to run Kea in a FreeBSD jail having only a
|
||||
@@ -4443,7 +4443,7 @@ reserved class has been also assigned.
|
||||
.. note::
|
||||
Client classes specified within the Kea configuration file may
|
||||
depend on the classes specified within the global host reservations.
|
||||
In such case the ``only-if-required`` parameter is not needed.
|
||||
In such a case the ``only-if-required`` parameter is not needed.
|
||||
Refer to the :ref:`pool-selection-with-class-reservations4` and
|
||||
:ref:`subnet-selection-with-class-reservations4`
|
||||
for the specific use cases.
|
||||
@@ -4978,7 +4978,7 @@ Subnet Selection with Client Class Reservations
|
||||
|
||||
There is one specific use case when subnet selection may be influenced by
|
||||
client classes specified within host reservations. This is the case when the
|
||||
client belongs to a shared network. In such case it is possible to use
|
||||
client belongs to a shared network. In such a case it is possible to use
|
||||
classification to select a subnet within this shared network. Consider the
|
||||
following example:
|
||||
|
||||
|
@@ -294,7 +294,7 @@ can be used to configure the memfile backend.
|
||||
disables the LFC.
|
||||
|
||||
- ``max-row-errors``: when the server loads a lease file, it is processed
|
||||
row by row, each row contaning a single lease. If a row is flawed and
|
||||
row by row, each row containing a single lease. If a row is flawed and
|
||||
cannot be processed correctly the server will log it, discard the row,
|
||||
and go on to the next row. This parameter can be used to set a limit on
|
||||
the number of such discards that may occur after which the server will
|
||||
@@ -3887,7 +3887,7 @@ reserved class has been also assigned.
|
||||
.. note::
|
||||
Client classes specified within the Kea configuration file may
|
||||
depend on the classes specified within the global host reservations.
|
||||
In such case the ``only-if-required`` parameter is not needed.
|
||||
In such a case the ``only-if-required`` parameter is not needed.
|
||||
Refer to the :ref:`pool-selection-with-class-reservations6` and
|
||||
:ref:`subnet-selection-with-class-reservations6`
|
||||
for the specific use cases.
|
||||
@@ -4419,7 +4419,7 @@ Subnet Selection with Client Class Reservations
|
||||
|
||||
There is one specific use case when subnet selection may be influenced by
|
||||
client classes specified within host reservations. This is the case when the
|
||||
client belongs to a shared network. In such case it is possible to use
|
||||
client belongs to a shared network. In such a case it is possible to use
|
||||
classification to select a subnet within this shared network. Consider the
|
||||
following example:
|
||||
|
||||
|
@@ -1376,7 +1376,7 @@ successful upgrade of one of the servers to the version supporting
|
||||
the maintenance mechanism it is possible to benefit from this
|
||||
mechanism during the upgrade of the second server.
|
||||
|
||||
In such case, shut down the server running the old version. Next,
|
||||
In such a case, shut down the server running the old version. Next,
|
||||
send the ``ha-maintenance-start`` to the server that has been
|
||||
upgraded and supports the maintenance mechanism. This server should
|
||||
immediately transition to the partner-down state as it cannot
|
||||
@@ -1678,7 +1678,7 @@ The ``last-scopes`` and ``last-state`` contain the information about the
|
||||
HA scopes served by the partner and its state. Note that this information
|
||||
is gathered during the heartbeat command exchange, so it may not be
|
||||
accurate if the communication problem occur between the partners and this
|
||||
status information is not refreshed. In such case, it may be useful to
|
||||
status information is not refreshed. In such a case, it may be useful to
|
||||
send the ``status-get`` command to the partner server directly to check
|
||||
its current state. The ``age`` parameter specifies the number of seconds
|
||||
since the information from the partner was gathered (the age of this
|
||||
|
@@ -127,7 +127,7 @@ default settings will be used.
|
||||
.. note::
|
||||
|
||||
The verbosity for the server is set when it is started. Once started,
|
||||
the verbosity can be only changed by stopping the server and starting
|
||||
the verbosity can only be changed by stopping the server and starting
|
||||
it again with the new value of the ``kea_verbose`` parameter.
|
||||
|
||||
.. _keactrl-commands:
|
||||
|
@@ -48,7 +48,7 @@ single statistic or all statistics. See the section :ref:`command-stats`
|
||||
for a list of statistics-oriented commands.
|
||||
|
||||
Statistics can be used by external tools to monitor Kea. One example of such a tool is Stork.
|
||||
See :ref:`stork` for details how to use it to retrieve statistics periodically (and use
|
||||
See :ref:`stork` for details on how to use it to retrieve statistics periodically (and use
|
||||
other data sources) to get better insight into Kea health and operational status.
|
||||
|
||||
.. _stats-lifecycle:
|
||||
|
Reference in New Issue
Block a user