[c2ab6f4] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY kea-download-http "https://downloads.isc.org/isc/kea/&kea-dhcp-version;/kea-&kea-dhcp-version;.tar.gz">
|
---|
| 8 | <!ENTITY kea-download-ftp "ftp://ftp.isc.org/isc/kea/&kea-dhcp-version;/kea-&kea-dhcp-version;.tar.gz">
|
---|
[3b98d805] | 9 | <!ENTITY kea-md5sum "e01bdc8d68cfaca1cae17b20b26e09b6">
|
---|
| 10 | <!ENTITY kea-size "9.9 MB">
|
---|
[0dcde6e] | 11 | <!ENTITY kea-buildsize "1.1 GB">
|
---|
| 12 | <!ENTITY kea-time "14 SBU"><!-- Thats unexpectedly long -->
|
---|
[3b98d805] | 13 | <!ENTITY kea-arm-vers "&kea-dhcp-version;">
|
---|
[c2ab6f4] | 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="kea" xreflabel="KEA-&kea-dhcp-version;">
|
---|
| 17 | <?dbhtml filename="kea.html"?>
|
---|
| 18 |
|
---|
| 19 |
|
---|
| 20 | <title>Kea &kea-dhcp-version;</title>
|
---|
| 21 |
|
---|
| 22 | <indexterm zone="kea">
|
---|
| 23 | <primary sortas="a-KEA">Kea</primary>
|
---|
| 24 | </indexterm>
|
---|
| 25 |
|
---|
| 26 | <sect2 role="package">
|
---|
| 27 | <title>Introduction to ISC Kea</title>
|
---|
| 28 |
|
---|
| 29 | <para>
|
---|
[ead10d5] | 30 | The <application>ISC Kea</application> package contains the
|
---|
[c2ab6f4] | 31 | server programs for DHCP. It is the successor of the
|
---|
[194d47b] | 32 | old ISC DHCP server which is end-of-life since December 2022.
|
---|
[c2ab6f4] | 33 | </para>
|
---|
| 34 |
|
---|
| 35 | &lfs113_checked;
|
---|
| 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&kea-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&kea-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &kea-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &kea-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &kea-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &kea-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect3">Kea Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 74 | <para role="required">
|
---|
[0d3cd5d] | 75 | <xref linkend="boost"/>,
|
---|
[c2ab6f4] | 76 | <xref linkend="log4cplus"/>
|
---|
| 77 | </para>
|
---|
[ead10d5] | 78 |
|
---|
[4df5695d] | 79 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[0d3cd5d] | 80 | <para role="optional">
|
---|
[4df5695d] | 81 | <xref linkend="mitkrb"/>, for documentation
|
---|
[0d3cd5d] | 82 | <xref linkend="doxygen"/>,
|
---|
| 83 | <xref linkend="graphviz"/>,
|
---|
| 84 | <xref linkend="sphinx_rtd_theme"/>
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | <bridgehead renderas="sect4">Optional database backends</bridgehead>
|
---|
| 88 | <para role="optional">
|
---|
| 89 | <xref linkend="mariadb"/> or <ulink url="https://www.mysql.com/">MySQL</ulink>,
|
---|
| 90 | <xref linkend="postgresql"/>
|
---|
| 91 | </para>
|
---|
[4df5695d] | 92 | <!--
|
---|
| 93 | <para condition="html" role="usernotes">Editor Notes:
|
---|
[c2ab6f4] | 94 | <ulink url="&blfs-wiki;/kea"/>
|
---|
| 95 | </para>
|
---|
[4df5695d] | 96 | -->
|
---|
[c2ab6f4] | 97 | </sect2>
|
---|
| 98 |
|
---|
| 99 | <sect2 role="kernel" id="kea-dhcp-kernel">
|
---|
| 100 | <title>Kernel Configuration</title>
|
---|
| 101 |
|
---|
| 102 | <para>
|
---|
| 103 | You must have Packet Socket support. IPv6 support is optional.
|
---|
| 104 | </para>
|
---|
| 105 |
|
---|
[0add366] | 106 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 107 | href="kea-kernel.xml"/>
|
---|
| 108 |
|
---|
[c2ab6f4] | 109 | <indexterm zone="kea kea-dhcp-kernel">
|
---|
| 110 | <primary sortas="k-KEA">Kea</primary>
|
---|
| 111 | </indexterm>
|
---|
| 112 |
|
---|
| 113 | </sect2>
|
---|
| 114 |
|
---|
| 115 | <sect2 role="installation">
|
---|
| 116 | <title>Installation of ISC Kea DHCP</title>
|
---|
| 117 |
|
---|
| 118 | <para>
|
---|
| 119 | Install <application>ISC Kea DHCP</application> by running
|
---|
| 120 | the following commands:
|
---|
| 121 | </para>
|
---|
| 122 |
|
---|
| 123 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 124 | --sysconfdir=/etc \
|
---|
| 125 | --docdir=/usr/share/doc/kea-&kea-dhcp-version; \
|
---|
| 126 | --localstatedir=/var \
|
---|
| 127 | --enable-shell \
|
---|
[0dcde6e] | 128 | --with-openssl \
|
---|
| 129 | --disable-static &&
|
---|
[c2ab6f4] | 130 | make</userinput></screen>
|
---|
| 131 |
|
---|
| 132 | <para>
|
---|
| 133 | To test the results, issue: <command>make check</command>.
|
---|
| 134 | </para>
|
---|
| 135 |
|
---|
| 136 | <para>
|
---|
| 137 | To install the <application>ISC Kea DHCP</application> suite,
|
---|
| 138 | issue the following commands as the
|
---|
| 139 | <systemitem class="username">root</systemitem> user:
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
[4d418ccd] | 142 | <screen role="root"><userinput>make -j1 install</userinput></screen>
|
---|
[c2ab6f4] | 143 |
|
---|
| 144 | </sect2>
|
---|
| 145 |
|
---|
[4d418ccd] | 146 | <sect2 role="commands">
|
---|
| 147 | <title>Command Explanations</title>
|
---|
| 148 |
|
---|
| 149 | <para>
|
---|
[0d3cd5d] | 150 | <parameter>--with-pgsql</parameter> or <parameter>--with-mysql</parameter>:
|
---|
| 151 | <application>ISC Kea</application> can store the leases on a
|
---|
| 152 | database. This might be useful in large environments running
|
---|
| 153 | a cluster of DHCP servers. Using the <emphasis>memfile</emphasis>
|
---|
| 154 | backend (which is a CSV file stored locally) is possible anyhow.
|
---|
| 155 | </para>
|
---|
| 156 |
|
---|
[baf6d5a0] | 157 | <para>
|
---|
| 158 | <parameter>--enable-generate-docs</parameter>:
|
---|
| 159 | If documentation is to be rebuilt, add that option. Several
|
---|
| 160 | dependencies must be installed for generating the documentation.
|
---|
| 161 | </para>
|
---|
| 162 |
|
---|
[0d3cd5d] | 163 | <para>
|
---|
| 164 | <parameter>make -j1 install</parameter>: ISC does not recommend
|
---|
| 165 | any form of parallel or job server options when doing the install.
|
---|
[4d418ccd] | 166 | </para>
|
---|
| 167 |
|
---|
| 168 | </sect2>
|
---|
[ead10d5] | 169 |
|
---|
[c2ab6f4] | 170 | <sect2 role="configuration">
|
---|
| 171 | <title>Configuring ISC Kea DHCP</title>
|
---|
| 172 |
|
---|
[0c76f3cf] | 173 | <para>The support of IPv4, IPv6 and DDNS has been split into
|
---|
[0d3cd5d] | 174 | separate servers which runs independently from each other. Each
|
---|
| 175 | of them has its own configuration file. Additional configuration
|
---|
| 176 | files come from the keactrl agent which is uses to control the
|
---|
| 177 | servers in an easy way.</para>
|
---|
| 178 |
|
---|
[ead10d5] | 179 | <para>Consult the
|
---|
| 180 | <ulink url="https://kea.readthedocs.io/en/kea-&kea-arm-vers;/">Kea Administrator Reference Manual</ulink>
|
---|
[12c88b0] | 181 | for detailed information about the configuration of <application>ISC Kea</application>
|
---|
[ead10d5] | 182 | as it is a quite capable system. The configuration shown a bare
|
---|
| 183 | minimum to get a DHCP server running but it already includes
|
---|
| 184 | configuration for DDNS (Dynamic DNS). That setup might be working
|
---|
| 185 | for small networks with a few clients and low traffic. For greater
|
---|
| 186 | installations with thousands of clients, <application>ISC Kea</application>
|
---|
[0d3cd5d] | 187 | can be configured to use databases (mariadb or postgresql) to store
|
---|
[ead10d5] | 188 | the leases and build a cluster with multiple nodes. It can
|
---|
[0d3cd5d] | 189 | be integrated to <ulink url="https://www.isc.org/categories/stork/">ISC Stork</ulink>
|
---|
[ead10d5] | 190 | which is a management dashboard to <application>ISC Kea</application>.</para>
|
---|
| 191 |
|
---|
[0dcde6e] | 192 | <para>
|
---|
| 193 | If you want to start the DHCP Server at boot, install the
|
---|
| 194 | <phrase revision="sysv"><filename>/etc/rc.d/init.d/kea-dhcpd</filename>
|
---|
| 195 | init script</phrase>
|
---|
| 196 | <phrase revision="systemd"><filename>kea-dhcpd.service</filename>
|
---|
| 197 | unit</phrase> included in the
|
---|
| 198 | <xref linkend="bootscripts" revision="sysv"/>
|
---|
| 199 | <xref linkend="systemd-units" revision="systemd"/>
|
---|
| 200 | package:
|
---|
| 201 | </para>
|
---|
| 202 |
|
---|
| 203 | <screen role="root"><userinput>make install-kea-dhcpd</userinput></screen>
|
---|
| 204 |
|
---|
[c2ab6f4] | 205 | <sect3 id="kea-dhcp-config">
|
---|
| 206 | <title>Config Files</title>
|
---|
| 207 |
|
---|
| 208 | <para>
|
---|
| 209 | <filename>/etc/kea/keactrl.conf</filename>,
|
---|
| 210 | <filename>/etc/kea/kea-ctrl-agent.conf</filename>,
|
---|
| 211 | <filename>/etc/kea/kea-dhcp4.conf</filename>,
|
---|
| 212 | <filename>/etc/kea/kea-dhcp6.conf</filename> and
|
---|
| 213 | <filename>/etc/kea/kea-dhcp-ddns.conf</filename>
|
---|
| 214 | </para>
|
---|
[4d418ccd] | 215 |
|
---|
[c2ab6f4] | 216 | <indexterm zone="kea keactrl-config">
|
---|
| 217 | <primary sortas="e-etc-kea-keactrl.conf">/etc/kea/keactrl.conf</primary>
|
---|
| 218 | </indexterm>
|
---|
[0dcde6e] | 219 |
|
---|
[c2ab6f4] | 220 | <indexterm zone="kea kea-ctrl-agent-config">
|
---|
| 221 | <primary sortas="e-etc-kea-kea-ctrl-agent.conf">/etc/kea/kea-ctrl-agent.conf</primary>
|
---|
| 222 | </indexterm>
|
---|
[0dcde6e] | 223 |
|
---|
[c2ab6f4] | 224 | <indexterm zone="kea kea-dhcp4-config">
|
---|
| 225 | <primary sortas="e-etc-kea-dhcp4.conf">/etc/kea/kea-dhcp4.conf</primary>
|
---|
| 226 | </indexterm>
|
---|
[4d418ccd] | 227 | <!--
|
---|
[c2ab6f4] | 228 | <indexterm zone="kea kea-dhcp6-config">
|
---|
| 229 | <primary sortas="e-etc-kea-dhcp6.conf">/etc/kea/kea-dhcp6.conf</primary>
|
---|
| 230 | </indexterm>
|
---|
[ead10d5] | 231 | -->
|
---|
[c2ab6f4] | 232 | <indexterm zone="kea kea-dhcp-ddns-config">
|
---|
| 233 | <primary sortas="e-etc-kea-dhcp-ddns.conf">/etc/kea/kea-dhcp-ddns.conf</primary>
|
---|
| 234 | </indexterm>
|
---|
| 235 | </sect3>
|
---|
| 236 |
|
---|
| 237 | <sect3 id="keactrl-config">
|
---|
| 238 | <title>Kea Control Configuration</title>
|
---|
[4d418ccd] | 239 |
|
---|
[c2ab6f4] | 240 | <para><command>keactrl</command> is used to control the
|
---|
[d908ba4] | 241 | independent servers (IPv4, IPv6, DDNS). Its configuration file
|
---|
[c2ab6f4] | 242 | <filename>/etc/kea/keactrl.conf</filename> is installed by
|
---|
| 243 | default and includes many path settings which are defined
|
---|
| 244 | due to the <command>configure</command> at build time. It also
|
---|
| 245 | includes settings to specify which of the servers should be
|
---|
| 246 | started.</para>
|
---|
| 247 |
|
---|
| 248 | <itemizedlist>
|
---|
[0dcde6e] | 249 | <listitem>
|
---|
| 250 | <para>Control Agent</para>
|
---|
| 251 | <para>The Control Agent is a daemon which allows the
|
---|
| 252 | (re)configuration of the Kea DHCP service via REST API.
|
---|
| 253 | Set <literal>ctrl_agent=yes</literal> to start the
|
---|
| 254 | control agent (service providing a REST API), set
|
---|
| 255 | <literal>ctrl_agent=no</literal> in case the control agent
|
---|
| 256 | is not needed.</para>
|
---|
| 257 | </listitem>
|
---|
[c2ab6f4] | 258 | <listitem>
|
---|
| 259 | <para>IPv4 DHCP server</para>
|
---|
[4d418ccd] | 260 | <para>This daemon handles requests for IPv4 addresses.
|
---|
[ead10d5] | 261 | Set <literal>dhcp4=yes</literal> to start it, set
|
---|
[c2ab6f4] | 262 | <literal>dhcp4=no</literal> in case DHCP service for IPv4
|
---|
| 263 | is not wanted.</para>
|
---|
| 264 | </listitem>
|
---|
| 265 | <listitem>
|
---|
| 266 | <para>IPv6 DHCP server</para>
|
---|
[4d418ccd] | 267 | <para>This daemon handles requests for IPv6 addresses.
|
---|
[ead10d5] | 268 | Set <literal>dhcp6=yes</literal> to start it, set
|
---|
[c2ab6f4] | 269 | <literal>dhcp6=no</literal> in case DHCP service for IPv6
|
---|
| 270 | is not wanted.</para>
|
---|
| 271 | </listitem>
|
---|
| 272 | <listitem>
|
---|
| 273 | <para>Dynamic DNS</para>
|
---|
[4d418ccd] | 274 | <para>This daemon is used to update a DNS server dynamically
|
---|
[6886d51] | 275 | when Kea assigns an IP address to a device.
|
---|
[ead10d5] | 276 | Set <literal>dhcp_ddns=yes</literal> to enable it, set
|
---|
[c2ab6f4] | 277 | <literal>dhcp_ddns=no</literal> in case dynamic DNS updates
|
---|
| 278 | are not wanted.</para>
|
---|
| 279 | </listitem>
|
---|
| 280 | </itemizedlist>
|
---|
| 281 |
|
---|
| 282 | <para>The Netconf service is not installed because required
|
---|
| 283 | dependencies are not covered by the current BLFS book.</para>
|
---|
[4d418ccd] | 284 |
|
---|
| 285 | <para>With the following command, Kea will be configured to
|
---|
[ead10d5] | 286 | start the dhcp service for IPv4 and the
|
---|
[4d418ccd] | 287 | dynamic DNS update, while the control agent and
|
---|
| 288 | the dhcp service for IPv6 remains down. Tweak the command to
|
---|
| 289 | match your needs on started services and execute as the
|
---|
| 290 | <systemitem class="username">root</systemitem> user:</para>
|
---|
| 291 |
|
---|
| 292 | <screen><userinput role="root">sed -e "s/^dhcp4=.*/dhcp4=yes/" \
|
---|
| 293 | -e "s/^dhcp6=.*/dhcp6=no/" \
|
---|
| 294 | -e "s/^dhcp_ddns=.*/dhcp_ddns=yes/" \
|
---|
| 295 | -e "s/^ctrl_agent=.*/ctrl_agent=no/" \
|
---|
| 296 | -i /etc/kea/keactrl.conf
|
---|
| 297 | </userinput></screen>
|
---|
| 298 |
|
---|
[c2ab6f4] | 299 | </sect3>
|
---|
| 300 |
|
---|
[0dcde6e] | 301 | <sect3 id="kea-ctrl-agent-config">
|
---|
| 302 | <title>Control Agent Configuration</title>
|
---|
[ead10d5] | 303 |
|
---|
| 304 | <para>
|
---|
[0dcde6e] | 305 | The provided configuration could be used without changes
|
---|
[ccbeb94] | 306 | but in BLFS objects like sockets are stored in
|
---|
[0dcde6e] | 307 | <filename class="directory">/run</filename>
|
---|
| 308 | rather than in
|
---|
| 309 | <filename class="directory">/tmp</filename>.
|
---|
[ead10d5] | 310 | </para>
|
---|
| 311 |
|
---|
[4df5695d] | 312 | <screen role="nodump"><userinput>cat > /etc/kea/kea-ctrl-agent.conf << "EOF"
|
---|
[0dcde6e] | 313 | <literal>// Begin /etc/kea/kea-ctrl-agent.conf
|
---|
| 314 | {
|
---|
| 315 | // This is a basic configuration for the Kea Control Agent.
|
---|
| 316 | // RESTful interface to be available at http://127.0.0.1:8000/
|
---|
| 317 | "Control-agent": {
|
---|
| 318 | "http-host": "127.0.0.1",
|
---|
| 319 | "http-port": 8000,
|
---|
| 320 | "control-sockets": {
|
---|
| 321 | "dhcp4": {
|
---|
| 322 | "socket-type": "unix",
|
---|
| 323 | "socket-name": "/run/kea4-ctrl-socket"
|
---|
| 324 | },
|
---|
| 325 | "dhcp6": {
|
---|
| 326 | "socket-type": "unix",
|
---|
| 327 | "socket-name": "/run/kea6-ctrl-socket"
|
---|
| 328 | },
|
---|
| 329 | "d2": {
|
---|
| 330 | "socket-type": "unix",
|
---|
| 331 | "socket-name": "/run/kea-ddns-ctrl-socket"
|
---|
| 332 | }
|
---|
| 333 | },
|
---|
| 334 |
|
---|
| 335 | "loggers": [
|
---|
| 336 | {
|
---|
| 337 | "name": "kea-ctrl-agent",
|
---|
| 338 | "output_options": [
|
---|
| 339 | {
|
---|
| 340 | "output": "/var/log/kea-ctrl-agent.log"
|
---|
| 341 | "pattern": "%D{%Y-%m-%d %H:%M:%S.%q} %-5p %m\n"
|
---|
| 342 | }
|
---|
| 343 | ],
|
---|
| 344 | "severity": "INFO",
|
---|
| 345 | "debuglevel": 0
|
---|
| 346 | }
|
---|
| 347 | ]
|
---|
| 348 | }
|
---|
| 349 | }
|
---|
| 350 | // End /etc/kea/kea-ctrl-agent.conf</literal>
|
---|
| 351 | EOF</userinput></screen>
|
---|
| 352 |
|
---|
| 353 | </sect3>
|
---|
| 354 |
|
---|
| 355 | <sect3 id="kea-dhcp4-config">
|
---|
| 356 | <title>IPv4 DHCP Server Configuration</title>
|
---|
[c2ab6f4] | 357 |
|
---|
| 358 | <para>
|
---|
[5571805] | 359 | A sample configuration file is created in <filename>/etc/kea/kea-dhcp4.conf</filename>.
|
---|
[c2ab6f4] | 360 | Adjust the file to suit your needs or overwrite it by using
|
---|
| 361 | the following sample as the <systemitem class="username">root</systemitem>
|
---|
| 362 | user:
|
---|
| 363 | </para>
|
---|
| 364 |
|
---|
[4df5695d] | 365 | <screen role="nodump"><userinput>cat > /etc/kea/kea-dhcp4.conf << "EOF"
|
---|
[5571805] | 366 | <literal>// Begin /etc/kea/kea-dhcp4.conf
|
---|
[4d418ccd] | 367 | {
|
---|
[0d3cd5d] | 368 | "Dhcp4": {
|
---|
[ead10d5] | 369 | // Add names of your network interfaces to listen on.
|
---|
[c2ab6f4] | 370 | "interfaces-config": {
|
---|
[0d3cd5d] | 371 | "interfaces": [ "eth0", "eth2" ]
|
---|
[c2ab6f4] | 372 | },
|
---|
[ead10d5] | 373 |
|
---|
[c2ab6f4] | 374 | "control-socket": {
|
---|
[0d3cd5d] | 375 | "socket-type": "unix",
|
---|
[0dcde6e] | 376 | "socket-name": "/run/kea4-ctrl-socket"
|
---|
[c2ab6f4] | 377 | },
|
---|
[ead10d5] | 378 |
|
---|
[c2ab6f4] | 379 | "lease-database": {
|
---|
[0d3cd5d] | 380 | "type": "memfile",
|
---|
| 381 | "lfc-interval": 3600
|
---|
[c2ab6f4] | 382 | },
|
---|
[ead10d5] | 383 |
|
---|
| 384 | "expired-leases-processing": {
|
---|
[0d3cd5d] | 385 | "reclaim-timer-wait-time": 10,
|
---|
| 386 | "flush-reclaimed-timer-wait-time": 25,
|
---|
| 387 | "hold-reclaimed-time": 3600,
|
---|
| 388 | "max-reclaim-leases": 100,
|
---|
| 389 | "max-reclaim-time": 250,
|
---|
| 390 | "unwarned-reclaim-cycles": 5
|
---|
[ead10d5] | 391 | },
|
---|
| 392 |
|
---|
[c2ab6f4] | 393 | "renew-timer": 900,
|
---|
| 394 | "rebind-timer": 1800,
|
---|
| 395 | "valid-lifetime": 3600,
|
---|
[ead10d5] | 396 |
|
---|
| 397 | // Enable DDNS - Kea will dynamically update the DNS
|
---|
| 398 | "ddns-send-updates" : true,
|
---|
| 399 | "ddns-qualifying-suffix": "your.domain.tld",
|
---|
| 400 | "dhcp-ddns" : {
|
---|
[0d3cd5d] | 401 | "enable-updates": true
|
---|
[ead10d5] | 402 | },
|
---|
| 403 |
|
---|
[c2ab6f4] | 404 | "subnet4": [
|
---|
[0d3cd5d] | 405 | {
|
---|
| 406 | "subnet": "192.168.56.0/24",
|
---|
| 407 | "pools": [ { "pool": "192.168.56.16 - 192.168.56.254" } ],
|
---|
| 408 | "option-data": [
|
---|
| 409 | {
|
---|
| 410 | "name": "domain-name",
|
---|
| 411 | "data": "your.domain.tld"
|
---|
| 412 | },
|
---|
| 413 | {
|
---|
| 414 | "name": "domain-name-servers",
|
---|
| 415 | "data": "192.168.56.2, 192.168.3.7"
|
---|
| 416 | },
|
---|
| 417 | {
|
---|
| 418 | "name": "domain-search",
|
---|
| 419 | "data": "your.domain.tld"
|
---|
| 420 | },
|
---|
| 421 | {
|
---|
| 422 | "name": "routers",
|
---|
| 423 | "data": "192.168.56.2"
|
---|
| 424 | }
|
---|
| 425 | ]
|
---|
| 426 | }
|
---|
[ead10d5] | 427 | ],
|
---|
| 428 |
|
---|
| 429 | "loggers": [
|
---|
[0d3cd5d] | 430 | {
|
---|
| 431 | "name": "kea-dhcp4",
|
---|
| 432 | "output_options": [
|
---|
| 433 | {
|
---|
| 434 | "output": "/var/log/kea-dhcp4.log",
|
---|
| 435 | "pattern": "%D{%Y-%m-%d %H:%M:%S.%q} %-5p %m\n"
|
---|
| 436 | }
|
---|
| 437 | ],
|
---|
| 438 | "severity": "INFO",
|
---|
| 439 | "debuglevel": 0
|
---|
| 440 | }
|
---|
[c2ab6f4] | 441 | ]
|
---|
[0d3cd5d] | 442 | }
|
---|
[4d418ccd] | 443 | }
|
---|
[5571805] | 444 | // End /etc/kea/kea-dhcp4.conf</literal>
|
---|
[c2ab6f4] | 445 | EOF</userinput></screen>
|
---|
| 446 |
|
---|
[0d3cd5d] | 447 | <para>
|
---|
| 448 | The configuration for IPv6 is similar to the configuration
|
---|
| 449 | of IPv4. The configuration file is
|
---|
[5571805] | 450 | <filename>/etc/kea/kea-dhcp6.conf</filename>.
|
---|
[0d3cd5d] | 451 | </para>
|
---|
[c2ab6f4] | 452 |
|
---|
[ead10d5] | 453 | </sect3>
|
---|
| 454 |
|
---|
| 455 | <sect3 id="kea-dhcp-ddns-config">
|
---|
| 456 | <title>Dynamic DNS Configuration</title>
|
---|
| 457 |
|
---|
[c2ab6f4] | 458 | <para>
|
---|
[0dcde6e] | 459 | If there is a <xref linkend="bind"/> server running,
|
---|
| 460 | <application>ISC Kea</application> can update the DNS when
|
---|
| 461 | it gives an IP address to a client. A sample configuration
|
---|
| 462 | file is created in <filename>/etc/kea/kea-dhcp-ddns.conf</filename>.
|
---|
[ead10d5] | 463 | Adjust the file to suit your needs or overwrite it by using
|
---|
| 464 | the following sample as the <systemitem class="username">root</systemitem>
|
---|
| 465 | user:
|
---|
[c2ab6f4] | 466 | </para>
|
---|
| 467 |
|
---|
[ead10d5] | 468 | <screen role="nodump" ><userinput>cat > /etc/kea/kea-dhcp-ddns.conf << "EOF"
|
---|
| 469 | <literal>// Begin /etc/kea/kea-dhcp-ddns.conf
|
---|
| 470 | {
|
---|
[0d3cd5d] | 471 | "DhcpDdns": {
|
---|
[ead10d5] | 472 | "ip-address": "127.0.0.1",
|
---|
| 473 | "port": 53001,
|
---|
| 474 | "control-socket": {
|
---|
[0d3cd5d] | 475 | "socket-type": "unix",
|
---|
[0dcde6e] | 476 | "socket-name": "/run/kea-ddns-ctrl-socket"
|
---|
[ead10d5] | 477 | },
|
---|
| 478 |
|
---|
| 479 | "tsig-keys": [
|
---|
[0d3cd5d] | 480 | {
|
---|
| 481 | "name" : "rndc-key",
|
---|
| 482 | "algorithm" : "hmac-sha256",
|
---|
| 483 | "secret" : "1FU5hD7faYaajQCjSdA54JkTPQxbbPrRnzOKqHcD9cM="
|
---|
| 484 | }
|
---|
[ead10d5] | 485 | ],
|
---|
| 486 |
|
---|
| 487 | "forward-ddns" : {
|
---|
[0d3cd5d] | 488 | "ddns-domains" : [
|
---|
| 489 | {
|
---|
| 490 | "name" : "your.domain.tld.",
|
---|
[da1d238] | 491 | "key-name": "rndc-key",
|
---|
[0d3cd5d] | 492 | "dns-servers" : [
|
---|
[ead10d5] | 493 | {
|
---|
[0d3cd5d] | 494 | "ip-address" : "127.0.0.1",
|
---|
| 495 | "port" : 53
|
---|
[ead10d5] | 496 | }
|
---|
[0d3cd5d] | 497 | ]
|
---|
| 498 | }
|
---|
| 499 | ]
|
---|
[ead10d5] | 500 | },
|
---|
| 501 |
|
---|
| 502 | "reverse-ddns" : {
|
---|
[0d3cd5d] | 503 | "ddns-domains" : [
|
---|
| 504 | {
|
---|
| 505 | "name" : "56.168.192.in-addr.arpa.",
|
---|
[da1d238] | 506 | "key-name": "rndc-key",
|
---|
[0d3cd5d] | 507 | "dns-servers" : [
|
---|
[ead10d5] | 508 | {
|
---|
[0d3cd5d] | 509 | "ip-address" : "127.0.0.1",
|
---|
| 510 | "port" : 53
|
---|
[ead10d5] | 511 | }
|
---|
[0d3cd5d] | 512 | ]
|
---|
| 513 | }
|
---|
| 514 | ]
|
---|
[ead10d5] | 515 | },
|
---|
[c2ab6f4] | 516 |
|
---|
[ead10d5] | 517 | "loggers": [
|
---|
[0d3cd5d] | 518 | {
|
---|
| 519 | "name": "kea-dhcp-ddns",
|
---|
| 520 | "output_options": [
|
---|
| 521 | {
|
---|
[057e7a1] | 522 | "output": "/var/log/kea-ddns.log",
|
---|
[0d3cd5d] | 523 | "pattern": "%D{%Y-%m-%d %H:%M:%S.%q} %-5p %m\n"
|
---|
| 524 | }
|
---|
| 525 | ],
|
---|
| 526 | "severity": "INFO",
|
---|
| 527 | "debuglevel": 0
|
---|
| 528 | }
|
---|
[ead10d5] | 529 | ]
|
---|
[0d3cd5d] | 530 | }
|
---|
[ead10d5] | 531 | }
|
---|
| 532 | // End /etc/kea/kea-dhcp-ddns.conf</literal>
|
---|
| 533 | EOF</userinput></screen>
|
---|
[0d3cd5d] | 534 |
|
---|
| 535 | <note>
|
---|
| 536 | <para>
|
---|
| 537 | The value of <literal>secret</literal> is just an example.
|
---|
| 538 | Generate the key for your installation by using the
|
---|
| 539 | <command>rndc-confgen -a</command> command or the
|
---|
| 540 | <command>tsig-keygen</command> command which both are
|
---|
| 541 | provided by <xref linkend="bind"/>.
|
---|
| 542 | </para>
|
---|
[0dcde6e] | 543 | <para>
|
---|
| 544 | In this sample config it is assumed that the DNS server
|
---|
| 545 | runs on the same machine as Kea does (accessable via
|
---|
| 546 | <literal>127.0.0.1</literal>) and that this machine has
|
---|
| 547 | the IP <literal>192.168.56.2</literal>.
|
---|
| 548 | </para>
|
---|
[0d3cd5d] | 549 | </note>
|
---|
| 550 |
|
---|
[c2ab6f4] | 551 | </sect3>
|
---|
| 552 |
|
---|
| 553 | </sect2>
|
---|
| 554 |
|
---|
| 555 | <sect2 role="content">
|
---|
| 556 | <title>Contents</title>
|
---|
| 557 |
|
---|
| 558 | <segmentedlist>
|
---|
| 559 | <segtitle>Installed Programs</segtitle>
|
---|
| 560 | <segtitle>Installed Libraries</segtitle>
|
---|
| 561 | <segtitle>Installed Directories</segtitle>
|
---|
| 562 |
|
---|
| 563 | <seglistitem>
|
---|
| 564 | <seg>
|
---|
| 565 | keactrl, kea-admin, kea-ctrl-agent, kea-dhcp4, kea-dhcp6,
|
---|
| 566 | kea-dhcp-ddns, kea-lfc, kea-shell
|
---|
| 567 | </seg>
|
---|
| 568 | <seg>
|
---|
| 569 | libkea-*
|
---|
| 570 | </seg>
|
---|
| 571 | <seg>
|
---|
| 572 | /etc/kea,
|
---|
| 573 | /usr/include/kea,
|
---|
| 574 | /var/lib/kea
|
---|
| 575 | </seg>
|
---|
| 576 | </seglistitem>
|
---|
| 577 | </segmentedlist>
|
---|
| 578 |
|
---|
| 579 | <variablelist>
|
---|
| 580 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 581 | <?dbfo list-presentation="list"?>
|
---|
| 582 | <?dbhtml list-presentation="table"?>
|
---|
| 583 |
|
---|
| 584 | <varlistentry id="keactrl">
|
---|
| 585 | <term><command>keactrl</command></term>
|
---|
| 586 | <listitem>
|
---|
| 587 | <para>
|
---|
[ccbeb94] | 588 | Tool to control (start/stop) the server processes.
|
---|
[c2ab6f4] | 589 | </para>
|
---|
| 590 | <indexterm zone="kea keactrl">
|
---|
| 591 | <primary sortas="b-keactrl">keactrl</primary>
|
---|
| 592 | </indexterm>
|
---|
| 593 | </listitem>
|
---|
| 594 | </varlistentry>
|
---|
[ccbeb94] | 595 | <varlistentry id="kea-admin">
|
---|
| 596 | <term><command>kea-admin</command></term>
|
---|
| 597 | <listitem>
|
---|
| 598 | <para>
|
---|
| 599 | kea-admin is a shell script which offers database maintenance.
|
---|
| 600 | </para>
|
---|
| 601 | <indexterm zone="kea kea-admin">
|
---|
| 602 | <primary sortas="b-kea-admin">kea-admin</primary>
|
---|
| 603 | </indexterm>
|
---|
| 604 | </listitem>
|
---|
| 605 | </varlistentry>
|
---|
| 606 | <varlistentry id="kea-ctrl-agent">
|
---|
| 607 | <term><command>kea-ctrl-agent</command></term>
|
---|
| 608 | <listitem>
|
---|
| 609 | <para>
|
---|
| 610 | Daemon which exposes a RESTful control interface for
|
---|
| 611 | managing Kea servers.
|
---|
| 612 | </para>
|
---|
| 613 | <indexterm zone="kea kea-ctrl-agent">
|
---|
| 614 | <primary sortas="b-kea-ctrl-agent">kea-ctrl-agent</primary>
|
---|
| 615 | </indexterm>
|
---|
| 616 | </listitem>
|
---|
| 617 | </varlistentry>
|
---|
| 618 | <varlistentry id="kea-dhcp4">
|
---|
| 619 | <term><command>kea-dhcp4</command></term>
|
---|
| 620 | <listitem>
|
---|
| 621 | <para>
|
---|
| 622 | The server daemon providing IPv4 addresses.
|
---|
| 623 | </para>
|
---|
| 624 | <indexterm zone="kea kea-dhcp4">
|
---|
| 625 | <primary sortas="b-kea-dhcp4">kea-dhcp4</primary>
|
---|
| 626 | </indexterm>
|
---|
| 627 | </listitem>
|
---|
| 628 | </varlistentry>
|
---|
| 629 | <varlistentry id="kea-dhcp6">
|
---|
| 630 | <term><command>kea-dhcp6</command></term>
|
---|
| 631 | <listitem>
|
---|
| 632 | <para>
|
---|
| 633 | The server daemon providing IPv6 addresses.
|
---|
| 634 | </para>
|
---|
| 635 | <indexterm zone="kea kea-dhcp6">
|
---|
| 636 | <primary sortas="b-kea-dhcp6">kea-dhcp6</primary>
|
---|
| 637 | </indexterm>
|
---|
| 638 | </listitem>
|
---|
| 639 | </varlistentry>
|
---|
| 640 | <varlistentry id="kea-dhcp-ddns">
|
---|
| 641 | <term><command>kea-dhcp-ddns</command></term>
|
---|
| 642 | <listitem>
|
---|
| 643 | <para>
|
---|
| 644 | The server daemon performing the dynamic DNS updates.
|
---|
| 645 | </para>
|
---|
| 646 | <indexterm zone="kea kea-dhcp-ddns">
|
---|
| 647 | <primary sortas="b-kea-dhcp-ddns">kea-dhcp-ddns</primary>
|
---|
| 648 | </indexterm>
|
---|
| 649 | </listitem>
|
---|
| 650 | </varlistentry>
|
---|
| 651 | <varlistentry id="kea-lfc">
|
---|
| 652 | <term><command>kea-lfc</command></term>
|
---|
| 653 | <listitem>
|
---|
| 654 | <para>
|
---|
| 655 | The kea-lfc service process removes redundant information
|
---|
| 656 | from the files used to provide persistent storage for the
|
---|
| 657 | memfile database backend. It is run by the Kea DHCP server.
|
---|
| 658 | </para>
|
---|
| 659 | <indexterm zone="kea kea-lfc">
|
---|
| 660 | <primary sortas="b-kea-lfc">kea-lfc</primary>
|
---|
| 661 | </indexterm>
|
---|
| 662 | </listitem>
|
---|
| 663 | </varlistentry>
|
---|
[0dcde6e] | 664 | <varlistentry id="keashell">
|
---|
| 665 | <term><command>keashell</command></term>
|
---|
| 666 | <listitem>
|
---|
| 667 | <para>
|
---|
| 668 | RESTful client to the <application>ISC Kea</application>
|
---|
| 669 | services.
|
---|
| 670 | </para>
|
---|
| 671 | <indexterm zone="kea keashell">
|
---|
| 672 | <primary sortas="b-keashell">keashell</primary>
|
---|
| 673 | </indexterm>
|
---|
| 674 | </listitem>
|
---|
| 675 | </varlistentry>
|
---|
[c2ab6f4] | 676 |
|
---|
| 677 | </variablelist>
|
---|
| 678 |
|
---|
| 679 | </sect2>
|
---|
| 680 |
|
---|
| 681 | </sect1>
|
---|