From a77985eaa94d6b7df431e13efde29bd6351f1efb Mon Sep 17 00:00:00 2001 From: Tomek Mrugalski Date: Thu, 23 Sep 2021 14:02:36 +0200 Subject: [PATCH] [#2050] Removed class assignments, updated kea-dhcp4-2 --- .../template-power-user-home/kea-dhcp4-1.conf | 3 +- .../template-power-user-home/kea-dhcp4-2.conf | 167 +++++++++++------- 2 files changed, 101 insertions(+), 69 deletions(-) diff --git a/doc/examples/template-power-user-home/kea-dhcp4-1.conf b/doc/examples/template-power-user-home/kea-dhcp4-1.conf index 246d5a9f02..ef53570f42 100644 --- a/doc/examples/template-power-user-home/kea-dhcp4-1.conf +++ b/doc/examples/template-power-user-home/kea-dhcp4-1.conf @@ -152,8 +152,7 @@ // Specify a dynamic address pool. "pools": [ { - "pool": "192.168.1.100-192.168.1.199", - "client-class": "HA_server1" + "pool": "192.168.1.100-192.168.1.199" } ], diff --git a/doc/examples/template-power-user-home/kea-dhcp4-2.conf b/doc/examples/template-power-user-home/kea-dhcp4-2.conf index bf432cfd04..eeabb5bf52 100644 --- a/doc/examples/template-power-user-home/kea-dhcp4-2.conf +++ b/doc/examples/template-power-user-home/kea-dhcp4-2.conf @@ -1,16 +1,22 @@ -// This is an example configuration of the Kea DHCPv4 server. It uses High -// Availability hooks library and Lease Commands hooks library to enable -// High Availability function for the DHCP server. Note that almost exactly -// the same configuration must be used on the second server (partner). -// The only difference is that "this-server-name" must be set to "server2" -// on this other server. Also, the interface configuration depends on the -// network settings of the particular machine. +// This is an example configuration of the Kea DHCPv4 server 1: // -// The servers using this configuration work in load balancing mode. +// - uses High Availability hooks library and Lease Commands hooks library +// to enable High Availability function for the DHCP server. This config +// file is for the primary (the active) server. +// - uses memfile, which stores lease data in a local CSV file +// - it assumes a single /24 addressing over a link that is directly reachable +// (no DHCP relays) +// - there is a handful of IP reservations +// +// It is expected to run with a standby (the passive) server, which has a very similar +// configuration. The only difference is that "this-server-name" must be set to "server2" on the +// other server. Also, the interface configuration depends on the network settings of the +// particular machine. + { -// DHCPv4 configuration starts here. "Dhcp4": { + // Add names of your network interfaces to listen on. "interfaces-config": { // The DHCPv4 server listens on this interface. When changing this to @@ -36,9 +42,28 @@ // Storage" for details. "lease-database": { // Memfile is the simplest and easiest backend to use. It's an in-memory + // database with data being written to a CSV file. It is very similar to + // what ISC DHCP does. "type": "memfile" }, + // Let's configure some global parameters. The home network is not very dynamic + // and there's no shortage of addresses, so no need to recycle aggresively. + "valid-lifetime": 43200, // leases will be valid for 12h + "renew-timer": 21600, // clients should renew every 6h + "rebind-timer": 32400, // clients should start looking for other servers after 9h + + // Kea will clean up its database of expired leases once per hour. However, it + // will keep the leases in expired state for 2 days. This greatly increases the + // chances for returning devices to get the same address again. To guarantee that, + // use host reservation. + "expired-leases-processing": { + "reclaim-timer-wait-time": 3600, + "hold-reclaimed-time": 172800, + "max-reclaim-leases": 0, + "max-reclaim-time": 0 + }, + // HA requires two hooks libraries to be loaded: libdhcp_lease_cmds.so and // libdhcp_ha.so. The former handles incoming lease updates from the HA peers. // The latter implements high availability feature for Kea. @@ -54,14 +79,13 @@ // The HA hooks library should be loaded. "library": "/usr/lib/x86_64-linux-gnu/kea/hooks/libdhcp_ha.so", "parameters": { - // High Availability configuration is specified for the HA hook library. // Each server should have the same HA configuration, except for the // "this-server-name" parameter. "high-availability": [ { // This parameter points to this server instance. The respective // HA peers must have this parameter set to their own names. "this-server-name": "server2", - // The HA mode is set to load-balancing. In this mode, the active + // The HA mode is set to host-standby. In this mode, the active // servers share the traffic (50/50). "mode": "hot-standby", // Heartbeat is to be sent every 10 seconds if no other control @@ -69,6 +93,8 @@ "heartbeat-delay": 10000, // Maximum time for partner's response to a heartbeat, after which // failure detection is started. This is specified in milliseconds. + // If we don't hear from the partner in 60 seconds, it's time to + // start worrying. "max-response-delay": 60000, // The following parameters control how the server detects the // partner's failure. The ACK delay sets the threshold for the @@ -80,35 +106,35 @@ "max-unacked-clients": 5, // This specifies the maximum timeout (in milliseconds) for the server // to complete sync. If you have a large deployment (high tens or - // hundreds of thausands of clients), you may need to increase it + // hundreds of thousands of clients), you may need to increase it // further. The default value is 60000ms (60 seconds). "sync-timeout": 60000, "peers": [ - // This is the configuration of this server instance. - { - "name": "server1", - // This specifies the URL of our server instance. The - // Control Agent must run along with our DHCPv4 server - // instance and the "http-host" and "http-port" must be - // set to the corresponding values. - "url": "http://192.168.1.2:8000/", - // This server is primary. The other one must be - // secondary. - "role": "primary" - }, - // This is the configuration of our HA peer. - { - "name": "server2", - // Specifies the URL on which the partner's control - // channel can be reached. The Control Agent is required - // to run on the partner's machine with "http-host" and - // "http-port" values set to the corresponding values. - "url": "http://192.168.1.3:8000/", - // The partner is a secondary. Our is primary. - "role": "standby" - } - ] - } ] + // This is the configuration of this server instance. + { + "name": "server1", + // This specifies the URL of our server instance. The + // Control Agent must run along with our DHCPv4 server + // instance and the "http-host" and "http-port" must be + // set to the corresponding values. + "url": "http://192.168.1.2:8000/", + // This server is primary. The other one must be + // secondary. + "role": "primary" + }, + // This is the configuration of our HA peer. + { + "name": "server2", + // Specifies the URL on which the partner's control + // channel can be reached. The Control Agent is required + // to run on the partner's machine with "http-host" and + // "http-port" values set to the corresponding values. + "url": "http://192.168.1.3:8000/", + // The partner is a secondary. Our is primary. + "role": "standby" + } + ] + } ] } } ], @@ -123,26 +149,22 @@ // is reachable directly via the ethX interface. "interface": "enp0s8", - // Specify four address pools. + // Specify a dynamic address pool. "pools": [ { - "pool": "192.168.1.100-192.168.1.149", - "client-class": "HA_server1" - }, - { - "pool": "192.168.1.150-192.168.1.200", - "client-class": "HA_server2" + "pool": "192.168.1.100-192.168.1.199" } ], - // These are options that are subnet specific. In most cases, - // you need to define at least routers option, as without this - // option your clients will not be able to reach their default - // gateway and will not have Internet connectivity. + // These are options that are subnet specific. In most cases, you need to define at + // least routers option, as without this option your clients will not be able to reach + // their default gateway and will not have Internet connectivity. If you have many + // subnets and they share the same options (e.g. DNS servers typically is the same + // everywhere), you may define options in the global scope, so you don't repeat them + // for every network. "option-data": [ { - // For each IPv4 subnet you most likely need to specify at - // least one router. + // For each IPv4 subnet you typically need to specify at least one router. "name": "routers", "data": "192.168.1.1" }, @@ -154,6 +176,25 @@ "name": "domain-name-servers", "data": "1.1.1.1,9.9.9.9" } + ], + + // Some devices should get a static address. Since the .100 - .199 range is dynamic, + // let's use the lower address space for this. There are many ways how reservation + // can be defined, but using MAC address (hw-address) is by far the most popular one. + // You can use client-id, duid and even custom defined flex-id that may use whatever + // parts of the packet you want to use as identifiers. Also, there are many more things + // you can specify in addition to just an IP address: extra options, next-server, hostname, + // assign device to client classes etc. See the Kea ARM, Section 8.3 for details. + // The reservations are subnet specific. + "reservations": [ + { + "hw-address": "1a:1b:1c:1d:1e:1f", + "ip-address": "192.168.1.10" + }, + { + "client-id": "01:11:22:33:44:55:66", + "ip-address": "192.168.1.11" + } ] } ], @@ -161,28 +202,20 @@ // Logging configuration starts here. "loggers": [ { - // This section affects kea-dhcp4, which is the base logger for DHCPv4 - // component. It tells DHCPv4 server to write all log messages (on - // severity INFO or more) to a file. + // This section affects kea-dhcp4, which is the base logger for DHCPv4 component. It tells + // DHCPv4 server to write all log messages (on severity INFO or higher) to a file. The file + // will be rotated once it grows to 2MB and up to 4 files will be kept. The debuglevel + // (range 0 to 99) is used only when logging on DEBUG level. "name": "kea-dhcp4", "output_options": [ { - "output": "/var/log/kea-dhcp4.log" - - } - ], - "severity": "INFO" - }, - { - // This section specifies configuration of the HA hooks library specific - // logger. - "name": "kea-dhcp4.ha-hooks", - "output_options": [ - { - "output": "stdout" + "output": "/var/log/kea-dhcp4.log", + "maxsize": 2048000, + "maxver": 4 } ], - "severity": "INFO" + "severity": "INFO", + "debuglevel": 0 } ] } -- 2.47.2