mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-30 21:45:37 +00:00
Code Issues Releases Wiki Activity

[#1299] document host reservations

Browse Source
This commit is contained in:
Andrei Pavel
2020-10-06 18:24:39 +03:00
parent 0465ea02b6
commit 06e9ca33ed
5 changed files with 159 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
ChangeLog
View File

@@ -1,3 +1,10 @@
1818. [doc] andrei
Add to the reservation documentation:
* instructions on how to choose "reservation-mode"
* priority of "reservation-mode" specified at all levels
* priority of file reservations vs database reservations
(Gitlab #1299)
1817. [func] fdupont 1817. [func] fdupont
Redact control agent logs to hide basic HTTP authentication Redact control agent logs to hide basic HTTP authentication
passwords from the configuration files. Note that when HTTP passwords from the configuration files. Note that when HTTP

78
doc/sphinx/arm/dhcp4-srv.rst
View File

@@ -732,6 +732,11 @@ entry, as in:
For additional Cassandra-specific parameters, see For additional Cassandra-specific parameters, see
:ref:`cassandra-database-configuration4`. :ref:`cassandra-database-configuration4`.
If the same host is configured both in-file and in-database, Kea won't warn of
the duplicate like it would if you specified them both in the same data source.
Instead the host configured in-file will have priority over the one configured
in-database.
.. _read-only-database-configuration4: .. _read-only-database-configuration4:
Using Read-Only Databases for Host Reservations with DHCPv4 Using Read-Only Databases for Host Reservations with DHCPv4
@@ -3941,7 +3946,7 @@ DHCPv4 message such as siaddr, sname, or file.
.. note:: .. note::
Kea requires that reserved address must be within the subnet. Kea requires that the reserved address must be within the subnet.
Kea 1.7.10 is the last release that does not enforce this. Kea 1.7.10 is the last release that does not enforce this.
The following example shows how to reserve addresses for specific hosts The following example shows how to reserve addresses for specific hosts
@@ -4441,8 +4446,75 @@ allocating or renewing a lease for the client. Allowed values are:
defined will be completely ignored. As the checks are skipped, the defined will be completely ignored. As the checks are skipped, the
server may operate faster in this mode. server may operate faster in this mode.
The parameter can be specified at global, subnet, and shared-network The ``reservation-mode`` parameter can be specified at:
levels.
- global level: ``.Dhcp4["reservation-mode"]`` (lowest priority: gets overridden
by all others)
- subnet level: ``.Dhcp4.subnet4[]["reservation-mode"]`` (low priority)
- shared-network level: ``.Dhcp4["shared-networks"][]["reservation-mode"]``
(high priority)
- shared-network subnet-level:
``.Dhcp4["shared-networks"][].subnet4[]["reservation-mode"]`` (highest
priority: overrides all others)
For deciding what ``"reservation-mode"`` to choose, you may refer to the
following decision diagram:
::
O
|
v
+-----------------------------+------------------------------+
| Is per-host configuration needed, such as |
| reserving specific addresses, |
| assigning specific options or |
| assigning packets to specific classes on per-device basis? |
+-+-----------------+----------------------------------------+
| |
no| yes|
| | +--------------------------------------+
| | | For all given hosts, |
+--> "disabled" +-->+ can the reserved resources |
| be used in all configured subnets? |
+--------+---------------------------+-+
| |
+----------------------------+ |no |yes
| Is | | |
| at least one reservation +<--+ "global" <--+
| used to reserve addresses? |
+-+------------------------+-+
| |
no| yes| +---------------------------+
| | | Is high leases-per-second |
+--> "out-of-pool" +-->+ performance or efficient |
^ | resource usage |
| | (CPU ticks, RAM usage, |
| | database roundtrips) |
| | important to your setup? |
| +-+----------------+--------+
| | |
| yes| no|
| | |
| +-------------+ |
| | |
| | +----------------------+ |
| | | Can it be guaranteed | |
| +-->+ that the reserved | |
| | addresses | |
| | aren't part of the | |
| | pools configured | |
| | in the respective | |
| | subnet? | |
| +-+------------------+-+ |
| | | |
| yes| no| |
| | | V
+----------------+ +--> "all"
An example configuration that disables reservation looks as follows: An example configuration that disables reservation looks as follows:

78
doc/sphinx/arm/dhcp6-srv.rst
View File

@@ -613,7 +613,7 @@ specified:
:: ::
"Dhcp6": { "host-database": { "max-reconnect-tries" : number-of-tries, ... }, ... } "Dhcp6": { "hosts-database": { "max-reconnect-tries" : number-of-tries, ... }, ... }
If the server is unable to reconnect to the database after making the If the server is unable to reconnect to the database after making the
maximum number of attempts, the server will exit. A value of zero (the maximum number of attempts, the server will exit. A value of zero (the
@@ -670,6 +670,11 @@ entry, as in:
For additional Cassandra-specific parameters, see For additional Cassandra-specific parameters, see
:ref:`cassandra-database-configuration4`. :ref:`cassandra-database-configuration4`.
If the same host is configured both in-file and in-database, Kea won't warn of
the duplicate like it would if you specified them both in the same data source.
Instead the host configured in-file will have priority over the one configured
in-database.
.. _read-only-database-configuration6: .. _read-only-database-configuration6:
Using Read-Only Databases for Host Reservations with DHCPv6 Using Read-Only Databases for Host Reservations with DHCPv6
@@ -3840,8 +3845,75 @@ allocating or renewing a lease for the client. Allowed values are:
defined will be completely ignored. As the checks are skipped, the defined will be completely ignored. As the checks are skipped, the
server may operate faster in this mode. server may operate faster in this mode.
The parameter can be specified at global, subnet, and shared-network The ``reservation-mode`` parameter can be specified at:
levels.
- global level: ``.Dhcp6["reservation-mode"]`` (lowest priority: gets overridden
by all others)
- subnet level: ``.Dhcp6.subnet6[]["reservation-mode"]`` (low priority)
- shared-network level: ``.Dhcp6["shared-networks"][]["reservation-mode"]``
(high priority)
- shared-network subnet-level:
``.Dhcp6["shared-networks"][].subnet6[]["reservation-mode"]`` (highest
priority: overrides all others)
For deciding what ``"reservation-mode"`` to choose, you may refer to the
following decision diagram:
::
O
|
v
+-----------------------------+------------------------------+
| Is per-host configuration needed, such as |
| reserving specific addresses, |
| assigning specific options or |
| assigning packets to specific classes on per-device basis? |
+-+-----------------+----------------------------------------+
| |
no| yes|
| | +--------------------------------------+
| | | For all given hosts, |
+--> "disabled" +-->+ can the reserved resources |
| be used in all configured subnets? |
+--------+---------------------------+-+
| |
+----------------------------+ |no |yes
| Is | | |
| at least one reservation +<--+ "global" <--+
| used to reserve addresses |
| or prefixes? |
+-+------------------------+-+
| |
no| yes| +---------------------------+
| | | Is high leases-per-second |
+--> "out-of-pool" +-->+ performance or efficient |
^ | resource usage |
| | (CPU ticks, RAM usage, |
| | database roundtrips) |
| | important to your setup? |
| +-+----------------+--------+
| | |
| yes| no|
| | |
| +-------------+ |
| | |
| | +----------------------+ |
| | | Can it be guaranteed | |
| +-->+ that the reserved | |
| | addresses/prefixes | |
| | aren't part of the | |
| | pools configured | |
| | in the respective | |
| | subnet? | |
| +-+------------------+-+ |
| | | |
| yes| no| |
| | | V
+----------------+ +--> "all"
An example configuration that disables reservation looks as follows: An example configuration that disables reservation looks as follows:

2
src/lib/database/dbaccess_parser.h
View File

@@ -20,7 +20,7 @@ namespace db {
/// @brief Parse Database Parameters /// @brief Parse Database Parameters
/// ///
/// This class is the parser for the database configuration. This is a /// This class is the parser for the database configuration. This is a
/// map under the top-level "lease-database", "host-database" and /// map under the top-level "lease-database", "hosts-database" and
/// "config-database" elements, and comprises a map of strings. /// "config-database" elements, and comprises a map of strings.
class DbAccessParser: public isc::data::SimpleParser { class DbAccessParser: public isc::data::SimpleParser {
public: public:

2
src/share/api/reservation-get.json
View File

@@ -40,7 +40,7 @@
" \"next-server\": <string (IPv4 address)>,", " \"next-server\": <string (IPv4 address)>,",
" \"option-data-list\": [ <comma-separated structures defining options> ],", " \"option-data-list\": [ <comma-separated structures defining options> ],",
" \"prefixes\": [ <comma-separated IPv6 prefixes> ],", " \"prefixes\": [ <comma-separated IPv6 prefixes> ],",
" \"reservation-client-classes\": [ <comma-separated strings> ],", " \"client-classes\": [ <comma-separated strings> ],",
" \"server-hostname\": <string>,", " \"server-hostname\": <string>,",
" \"subnet-id\": <integer>,", " \"subnet-id\": <integer>,",
" \"user-context\": <any valid JSON>", " \"user-context\": <any valid JSON>",