dhcp6-srv.xml 238 KB
Newer Older
1 2 3 4 5 6 7
<!--
 - Copyright (C) 2014-2018 Internet Systems Consortium, Inc. ("ISC")
 -
 - This Source Code Form is subject to the terms of the Mozilla Public
 - License, v. 2.0. If a copy of the MPL was not distributed with this
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->
8 9
<!-- Converted by db4-upgrade version 1.1 -->
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="dhcp6">
10 11
    <title>The DHCPv6 Server</title>

12
    <section xml:id="dhcp6-start-stop">
13 14 15
      <title>Starting and Stopping the DHCPv6 Server</title>

      <para>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
16 17 18 19
        It is recommended that the Kea DHCPv6 server be started and stopped
        using <command>keactrl</command> (described in <xref linkend="keactrl"/>).
        However, it is also possible to run the server directly: it accepts
        the following command-line switches:
20 21
      </para>

22 23
      <itemizedlist>
          <listitem>
24 25 26 27
            <simpara>
            <command>-c <replaceable>file</replaceable></command> -
            specifies the configuration file. This is the only mandatory
            switch.</simpara>
28 29
          </listitem>
          <listitem>
30
            <simpara>
31
            <command>-d</command> - specifies whether the server
32
            logging should be switched to verbose mode. In verbose mode,
33
            the logging severity and debuglevel specified in the configuration
34 35 36 37
            file are ignored and "debug" severity and the maximum debuglevel
            (99) are assumed. The flag is convenient, for temporarily
            switching the server into maximum verbosity, e.g. when
            debugging.</simpara>
38 39
          </listitem>
          <listitem>
40 41
            <simpara>
            <command>-p <replaceable>port</replaceable></command> -
42 43
            specifies UDP port on which the server will listen. This is only
            useful during testing, as a DHCPv6 server listening on
44
            ports other than the standard ones will not be able to
45
            handle regular DHCPv6 queries.</simpara>
46
          </listitem>
Francis Dupont's avatar
Francis Dupont committed
47
          <listitem>
48 49 50
            <simpara>
            <command>-t <replaceable>file</replaceable></command> -
            specifies the configuration file to be tested. Kea-dhcp6
Francis Dupont's avatar
Francis Dupont committed
51 52 53 54 55 56 57
            will attempt to load it, and will conduct sanity
            checks. Note that certain checks are possible only while
            running the actual server. The actual status is reported
            with exit code (0 = configuration looks ok, 1 = error
            encountered). Kea will print out log messages to standard
            output and error to standard error when testing
            configuration.</simpara>
58
          </listitem>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
59 60
          <listitem>
            <simpara>
61
              <command>-v</command> - prints out the Kea version and exits.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
62 63 64 65
            </simpara>
          </listitem>
          <listitem>
            <simpara>
66 67 68
              <command>-V</command> - prints out the Kea extended version with
              additional parameters and exits. The listing includes the versions
              of the libraries dynamically linked to Kea.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
69 70
            </simpara>
          </listitem>
71 72
          <listitem>
            <simpara>
73 74 75 76 77
              <command>-W</command> - prints out the Kea configuration report
              and exits. The report is a copy of the
              <filename>config.report</filename> file produced by
              <userinput>./configure</userinput>: it is embedded in the
              executable binary.
78 79
            </simpara>
          </listitem>
80 81
      </itemizedlist>

Francis Dupont's avatar
Francis Dupont committed
82
      <para>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
83 84 85 86 87 88
        The <filename>config.report</filename> may also be accessed more
        directly.  The following command may be used to extract this
        information.  The binary <userinput>path</userinput> may be found
        in the install directory or in the <filename>.libs</filename>
        subdirectory in the source tree. For example
        <filename>kea/src/bin/dhcp6/.libs/kea-dhcp6</filename>.
89

90 91 92 93 94
<screen>
strings <userinput>path</userinput>/kea-dhcp6 | sed -n 's/;;;; //p'
</screen>
      </para>

95
      <para>
96
        On start-up, the server will detect available network interfaces
97 98
        and will attempt to open UDP sockets on all interfaces
        mentioned in the configuration file.
99 100
        Since the DHCPv6 server opens privileged ports, it requires root
        access. Make sure you run this daemon as root.
101 102
      </para>

103 104
      <para>
        During startup the server will attempt to create a PID file of the
105
        form: localstatedir]/[conf name].kea-dhcp6.pid where:
106 107 108
        <itemizedlist>
            <listitem>
            <simpara><command>localstatedir</command>: The value as passed into the
Jeremy C. Reed's avatar
Jeremy C. Reed committed
109
            build configure script. It defaults to "/usr/local/var".  Note
110 111 112 113 114
            that this value may be overridden at run time by setting the environment
            variable KEA_PIDFILE_DIR.  This is intended primarily for testing purposes.
            </simpara>
            </listitem>
            <listitem>
115
            <simpara><command>conf name</command>: The configuration file name
116 117 118 119 120 121 122 123 124
            used to start the server, minus all preceding path and file extension.
            For example, given a pathname of "/usr/local/etc/kea/myconf.txt", the
            portion used would be "myconf".
            </simpara>
            </listitem>
        </itemizedlist>
        If the file already exists and contains the PID of a live process,
        the server will issue a DHCP6_ALREADY_RUNNING log message and exit. It
        is possible, though unlikely, that the file is a remnant of a system crash
125
        and the process to which the PID belongs is unrelated to Kea.  In such a
126 127
        case it would be necessary to manually delete the PID file.
      </para>
128 129 130 131 132 133 134

      <para>
        The server can be stopped using the <command>kill</command> command.
        When running in a console, the server can be shut down by
        pressing ctrl-c. It detects the key combination and shuts
        down gracefully.
      </para>
135 136
    </section>

137
    <section xml:id="dhcp6-configuration">
138
      <title>DHCPv6 Server Configuration</title>
139 140
<section>
  <title>Introduction</title>
141
      <para>
142
        This section explains how to configure the DHCPv6 server using the
143 144
        Kea configuration backend. (Kea configuration using any other
        backends is outside of scope of this document.) Before DHCPv6
145
        is started, its configuration file has to be created. The
146
        basic configuration is as follows:
147
<screen>
148
{
149
# DHCPv6 configuration starts on the next line
150 151 152
"Dhcp6": {

# First we set up global values
153
    "valid-lifetime": 4000,
154 155 156 157
    "renew-timer": 1000,
    "rebind-timer": 2000,
    "preferred-lifetime": 3000,

158 159 160 161 162
# Next we setup the interfaces to be used by the server.
    "interfaces-config": {
        "interfaces": [ "eth0" ]
    },

163
# And we specify the type of lease database
164 165
    "lease-database": {
        "type": "memfile",
166
        "persist": true,
167 168 169 170 171 172 173 174 175 176 177 178 179 180
        "name": "/var/kea/dhcp6.leases"
    },

# Finally, we list the subnets from which we will be leasing addresses.
    "subnet6": [
        {
            "subnet": "2001:db8:1::/64",
            "pools": [
                 {
                     "pool": "2001:db8:1::1-2001:db8:1::ffff"
                 }
             ]
        }
    ]
181
# DHCPv6 configuration ends with the next line
182 183 184 185 186 187
}

} </screen>
</para>

<para>The following paragraphs provide a brief overview of the parameters in
188
the above example together with
189 190 191 192 193 194 195 196 197 198
their format. Subsequent sections of this chapter go into much greater detail
for these and other parameters.</para>

<para>The lines starting with a hash (#) are comments and are ignored by
the server; they do not impact its
operation in any way.</para>

<para>The configuration starts in the first line with the initial
opening curly bracket (or brace). Each configuration consists of
one or more objects. In this specific example, we have only one
199
object, called Dhcp6. This is a simplified configuration, as usually
200
there will be additional objects, like <command>Logging</command> or
Francis Dupont's avatar
Francis Dupont committed
201
<command>DhcpDdns</command>, but we omit them now for clarity. The Dhcp6
202
configuration starts with the <command>"Dhcp6": {</command> line
203 204 205 206
and ends with the corresponding closing brace (in the above example,
the brace after the last comment).  Everything defined between those
lines is considered to be the Dhcp6 configuration.</para>

207
<para>In the general case, the order in which those parameters appear does not
208
matter. There are two caveats here though. The first one is to remember that
209 210 211
the configuration file must be well formed JSON. That means that parameters
for any given scope must be separated by a comma and there must not be a comma
after the last parameter. When reordering a configuration file, keep in mind that
212
moving a parameter to or from the last position in a given scope may also require
213 214
moving the comma. The second caveat is that it is uncommon — although
legal JSON — to
215 216 217 218 219 220
repeat the same parameter multiple times. If that happens, the last occurrence of a
given parameter in a given scope is used while all previous instances are
ignored. This is unlikely to cause any confusion as there are no real life
reasons to keep multiple copies of the same parameter in your configuration
file.</para>

221 222
<para>Moving onto the DHCPv6 configuration elements, the very first few elements
define some global parameters. <command>valid-lifetime</command>
223
defines for how long the addresses (leases) given out by the server are valid. If
224
nothing changes, a client that got an address is allowed to use it for 4000
225 226 227
seconds. (Note that integer numbers are specified as is, without any quotes
around them.) The address will become deprecated in 3000 seconds (clients are
allowed to keep old connections, but can't use this address for creating new
228 229 230
connections). <command>renew-timer</command> and
<command> rebind-timer</command> are values that define T1 and T2 timers that
govern when the client will begin the renewal and rebind procedures.</para>
231

232 233 234 235 236 237 238 239 240 241 242 243 244 245
<para>The <command>interfaces-config</command> map specifies the server
configuration concerning the network interfaces, on which the server should
listen to the DHCP messages. The <command>interfaces</command> parameter
specifies a list of network interfaces on which the server should listen.
Lists are opened and closed with square brackets, with elements separated
by commas. Had we wanted to listen on two interfaces, the
<command>interfaces-config</command> would look like this:
<screen>
"interfaces-config": {
    "interfaces": [ "eth0", "eth1" ]
},
</screen>
</para>

246
<para>The next couple of lines define the lease database, the place where the server
247 248
stores its lease information. This particular example tells the server to use
<command>memfile</command>, which is the simplest (and fastest) database
249
backend. It uses an in-memory database and stores leases on disk in a CSV
250
file. This is a very simple configuration. Usually the lease database configuration
251 252 253
is more extensive and contains additional parameters.  Note that
<command>lease-database</command>
is an object and opens up a new scope, using an opening brace.
254
Its parameters (just one in this example - <command>type</command>)
255
follow. Had there been more than one, they would be separated by commas. This
256 257
scope is closed with a closing brace. As more parameters for the Dhcp6 definition
follow, a trailing comma is present.</para>
258 259 260

<para>Finally, we need to define a list of IPv6 subnets. This is the
most important DHCPv6 configuration structure as the server uses that
261 262
information to process clients' requests. It defines all subnets from
which the server is expected to receive DHCP requests. The subnets are
263 264
specified with the <command>subnet6</command> parameter.  It is a list,
so it starts and ends with square brackets.  Each subnet definition in
265
the list has several attributes associated with it, so it is a structure
266 267
and is opened and closed with braces. At minimum, a subnet definition
has to have at least two parameters: <command>subnet</command> (that
268
defines the whole subnet) and <command>pools</command> (which is a list of
269 270 271 272 273 274 275
dynamically allocated pools that are governed by the DHCP server).</para>

<para>The example contains a single subnet. Had more than one been defined,
additional elements
in the <command>subnet6</command> parameter would be specified and
separated by commas. For example, to define two subnets, the following
syntax would be used:
276
<screen>
277 278
"subnet6": [
    {
279
        "pools": [ { "pool": "2001:db8:1::/112" } ],
280 281 282
        "subnet": "2001:db8:1::/64"
    },
    {
283
        "pools": [ { "pool": "2001:db8:2::1-2001:db8:2::ffff" } ],
284
        "subnet": "2001:db8:2::/64"
285 286
    }
]
287
</screen>
288
Note that indentation is optional and is used for aesthetic purposes only.
289
In some cases in may be preferable to use more compact notation.
290
</para>
291

292 293
<para>After all parameters are specified, we have two contexts open:
global and Dhcp6, hence we need two closing curly brackets to close them.
294 295
In a real life configuration file there most likely would be additional
components defined such as Logging or DhcpDdns, so the closing brace would
296 297 298 299 300 301
be followed by a comma and another object definition.</para>
</section>

<section>
  <title>Lease Storage</title>
  <para>All leases issued by the server are stored in the lease database.
302
  Currently there are four database backends available:  memfile (which is the
303
  default backend), MySQL, PostgreSQL and Cassandra.</para>
304
<section>
305
  <title>Memfile - Basic Storage for Leases</title>
306 307

  <para>The server is able to store lease data in different repositories. Larger
308
  deployments may elect to store leases in a database. <xref linkend="database-configuration6"/> describes this option. In typical
309 310
  smaller deployments though, the server will store lease information in a CSV file rather
  than a database. As well as requiring less administration, an
311 312 313 314
  advantage of using a file for storage is that it
  eliminates a dependency on third-party database software.</para>

  <para>The configuration of the file backend (Memfile) is controlled through
315 316 317
  the Dhcp6/lease-database parameters. The <command>type</command> parameter
  is mandatory and it specifies which storage for leases the server should use.
  The value of <userinput>"memfile"</userinput> indicates that the file should
318 319
  be used as the storage. The following list gives additional, optional,
  parameters that can be used to configure the Memfile backend.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346

  <itemizedlist>
    <listitem>
      <simpara><command>persist</command>: controls whether the new leases and
      updates to existing leases are written to the file. It is strongly
      recommended that the value of this parameter is set to
      <userinput>true</userinput> at all times, during the server's normal
      operation. Not writing leases to disk will mean that if a server is restarted
      (e.g. after a power failure), it will not know what addresses have been
      assigned.  As a result, it may hand out addresses to new clients that are
      already in use. The value of <userinput>false</userinput> is mostly useful
      for performance testing purposes. The default value of the
      <command>persist</command> parameter is <userinput>true</userinput>,
      which enables writing lease updates
      to the lease file.
      </simpara>
    </listitem>

    <listitem>
      <simpara><command>name</command>: specifies an absolute location of the lease
      file in which new leases and lease updates will be recorded. The default value
      for this parameter is <userinput>"[kea-install-dir]/var/kea/kea-leases6.csv"
      </userinput>.</simpara>
    </listitem>

    <listitem>
      <simpara><command>lfc-interval</command>: specifies the interval in seconds, at
347 348
      which the server will perform a lease file cleanup (LFC).  This
      removes redundant (historical) information from the lease file
349 350
      and effectively reduces the lease file size. The cleanup process is described
      in more detailed fashion further in this section. The default value of the
351 352
      <command>lfc-interval</command> is <userinput>3600</userinput>. A value of 0
      disables the LFC.</simpara>
353 354 355 356 357
    </listitem>

  </itemizedlist>
  </para>

358
  <para>An example configuration of the Memfile backend is presented below:
Jeremy C. Reed's avatar
Jeremy C. Reed committed
359

360
<screen>
361
"Dhcp6": {
362 363
    "lease-database": {
        <userinput>"type": "memfile"</userinput>,
364
        <userinput>"persist": true</userinput>,
365 366
        <userinput>"name": "/tmp/kea-leases6.csv"</userinput>,
        <userinput>"lfc-interval": 1800</userinput>
367 368 369
    }
}
</screen>
370 371 372 373 374

    This configuration selects the <filename>/tmp/kea-leases6.csv</filename> as
    the storage for lease information and enables persistence (writing lease updates
    to this file). It also configures the backend perform the periodic cleanup
    of the lease files, executed every 30 minutes.
375 376
  </para>

377
  <para>It is important to know how the lease file contents are organized
378
  to understand why the periodic lease file cleanup is needed. Every time
379 380
  the server updates a lease or creates a new lease for the client, the new
  lease information must be recorded in the lease file. For performance reasons,
381 382 383
  the server does not update the existing client's lease in the file, as it would
  potentially require rewriting the entire file. Instead, it simply appends the new lease
  information to the end of the file: the previous lease entries for the
384 385 386 387 388 389
  client are not removed. When the server loads leases from the lease file, e.g.
  at the server startup, it assumes that the latest lease entry for the client
  is the valid one. The previous entries are discarded. This means that the
  server can re-construct the accurate information about the leases even though
  there may be many lease entries for each client. However, storing many entries
  for each client results in bloated lease file and impairs the performance of
390
  the server's startup and reconfiguration as it needs to process a larger number
391 392 393
  of lease entries.
  </para>

394
  <para>Lease file cleanup (LFC) removes all previous entries for each client and
395 396
  leaves only the latest ones. The interval at which the cleanup is performed
  is configurable, and it should be selected according to the frequency of lease
397 398
  renewals initiated by the clients. The more frequent the renewals, the smaller
  the value of <command>lfc-interval</command> should be. Note however, that the
399 400 401 402
  LFC takes time and thus it is possible (although unlikely) that new cleanup
  is started while the previous cleanup instance is still running, if the
  <command>lfc-interval</command> is too short. The server would recover from
  this by skipping the new cleanup when it detects that the previous cleanup
403
  is still in progress. But it implies that the actual cleanups will be
404
  triggered more rarely than configured. Moreover, triggering a new cleanup
405
  adds an overhead to the server which will not be able to respond to new
406 407
  requests for a short period of time when the new cleanup process is spawned.
  Therefore, it is recommended that the <command>lfc-interval</command> value
408
  is selected in a way that would allow for the LFC to complete the cleanup before a
409 410 411
  new cleanup is triggered.
  </para>

412 413 414
  <para>Lease file cleanup is performed by a separate process (in background) to avoid
  a performance impact on the server process. In order to avoid the conflicts
  between two processes both using the same lease files, the LFC process
415 416 417
  operates on the copy of the original lease file, rather than on the lease
  file used by the server to record lease updates. There are also other files
  being created as a side effect of the lease file cleanup. The detailed
418 419
  description of the LFC is located in the Kea Administrator's Reference Manual:
  <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://jenkins.isc.org/job/Kea_doc/guide/kea-guide.html#kea-lfc">https://jenkins.isc.org/job/Kea_doc/guide/kea-guide.html#kea-lfc</uri>.
420
  </para>
421

422 423
</section>

424
<section xml:id="database-configuration6">
425
  <title>Lease Database Configuration</title>
426 427

  <note>
428
    <para>Lease database access information must be configured for the DHCPv6 server,
429 430 431 432 433
    even if it has already been configured for the DHCPv4 server.  The servers
    store their information independently, so each server can use a separate
    database or both servers can use the same database.</para>
  </note>

434 435
  <para>Lease database configuration is controlled through the
  Dhcp6/lease-database parameters. The type of the database must be set to
436
  "memfile", "mysql", "postgresql" or "cql", e.g.
437
<screen>
438
"Dhcp6": { "lease-database": { <userinput>"type": "mysql"</userinput>, ... }, ... }
439
</screen>
440
  Next, the name of the database is to hold the leases must be set: this is the
441
  name used when the database was created
442 443 444
  (see <xref linkend="mysql-database-create"/>,
  <xref linkend="pgsql-database-create"/>
  or <xref linkend="cql-database-create"/>).
445
<screen>
446
"Dhcp6": { "lease-database": { <userinput>"name": "<replaceable>database-name</replaceable>" </userinput>, ... }, ... }
447 448 449 450
</screen>
  For Cassandra:
<screen>
"Dhcp6": { "lease-database": { <userinput>"keyspace": "<replaceable>database-name</replaceable>" </userinput>, ... }, ... }
451
</screen>
452 453 454
  If the database is located on a different system to the DHCPv6 server, the
  database host name must also be specified. (It should be noted that this
  configuration may have a severe impact on server performance.):
455
<screen>
456 457 458 459
"Dhcp6": { "lease-database": { <userinput>"host": "<replaceable>remote-host-name</replaceable>"</userinput>, ... }, ... }
</screen>
  For Cassandra, multiple contact points can be provided:
<screen>
Razvan Becheriu's avatar
Razvan Becheriu committed
460
"Dhcp6": { "lease-database": { <userinput>"contact-points": "<replaceable>remote-host-name[, ...]</replaceable>" </userinput>, ... }, ... }
461
</screen>
462 463
  The usual state of affairs will be to have the database on the same machine as
  the DHCPv6 server.  In this case, set the value to the empty string:
464
<screen>
465
"Dhcp6": { "lease-database": { <userinput>"host" : ""</userinput>, ... }, ... }
466 467 468
</screen>
  For Cassandra:
<screen>
Razvan Becheriu's avatar
Razvan Becheriu committed
469
"Dhcp6": { "lease-database": { <userinput>"contact-points": ""</userinput>, ... }, ... }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
470
</screen>
471
  Should the database use a port different than default, it may be
Tomek Mrugalski's avatar
Tomek Mrugalski committed
472 473
  specified as well:
<screen>
474
"Dhcp6": { "lease-database": { <userinput>"port" : 12345</userinput>, ... }, ... }
475
</screen>
476 477 478
  Should the database be located on a different system, you may need to specify a longer interval
  for the connection timeout:
<screen>
479
"Dhcp6": { "lease-database": { <userinput>"connect-timeout" : <replaceable>timeout-in-seconds</replaceable></userinput>, ... }, ... }
480 481
</screen>
The default value of five seconds should be more than adequate for local connections.
482
If a timeout is given though, it should be an integer greater than zero.
483
  </para>
484 485 486 487 488 489 490 491 492 493 494 495
  <para>
The maxiumum number of times the server will automatically attempt to reconnect to
the lease database after connectivity has been lost may be specified:
<screen>
"Dhcp6": { "lease-database": { <userinput>"max-reconnect-tries" : <replaceable>number-of-tries</replaceable></userinput>, ... }, ... }
</screen>
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 default) disables automatic
recovery and the server will exit immediately upon detecting a loss of connectivity
(MySQL and Postgres only).
  </para>
  <para>
496
The number of milliseconds the server will wait in between attempts to reconnect to the
497 498
lease database after connectivity has been lost may also be specified:
<screen>
499
"Dhcp6": { "lease-database": { <userinput>"reconnect-wait-time" : <replaceable>number-of-milliseconds</replaceable></userinput>, ... }, ... }
500
</screen>
501 502 503
The default value for MySQL and Postgres is 0, which disables automatic recovery and
causes the server to exit immediately upon detecting the loss of connectivity.
The default value for Cassandra is 2000 ms.
504
  </para>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
505 506 507 508 509 510
  <para>
    Note that host parameter is used by MySQL and PostgreSQL
    backends. Cassandra has a concept of contact points that could be
    used to contact the cluster, instead of a single IP or
    hostname. It takes a list of comma separated IP addresses. This may be specified as:
<screen>
511
"Dhcp6": { "lease-database": { <userinput>"contact-points" : "192.0.2.1,192.0.2.2"</userinput>, ... }, ... }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
512 513 514
</screen>
  </para>

515 516
  <para>Finally, the credentials of the account under which the server will
  access the database should be set:
517
<screen>
518
"Dhcp6": { "lease-database": { <userinput>"user": "<replaceable>user-name</replaceable>"</userinput>,
519
                               <userinput>"password": "<replaceable>password</replaceable>"</userinput>,
520 521
                              ... },
           ... }
522
</screen>
523 524 525
  If there is no password to the account, set the password to the empty string
  "". (This is also the default.)</para>
</section>
526 527 528 529 530 531 532

<section xml:id="cassandra-database-configuration6">
    <title>Cassandra specific parameters</title>
<para>The parameters are the same for DHCPv4 and DHCPv6. See <xref
linkend="cassandra-database-configuration4"/> for details.</para>
</section>

533
</section>
534

535
<section xml:id="hosts6-storage">
536 537
  <title>Hosts Storage</title>
    <para>Kea is also able to store information about host reservations in the
538 539
    database. The hosts database configuration uses the same syntax as the lease
    database. In fact, a Kea server opens independent connections for each
540
    purpose, be it lease or hosts information. This arrangement gives the most
541
    flexibility. Kea can be used to keep leases and host reservations
542
    separately, but can also point to the same database. Currently the
543
    supported hosts database types are MySQL and PostgreSQL. The Cassandra
544
    backend does not support host reservations yet.</para>
545

546
    <para>Please note that usage of hosts storage is optional. A user can define
547
    all host reservations in the configuration file. That is the recommended way
548 549 550
    if the number of reservations is small. However, when the number of
    reservations grows it's more convenient to use host storage. Please note
    that both storage methods (configuration file and one of the supported databases)
551
    can be used together. If hosts are defined in both places, the definitions
552
    from the configuration file are checked first and external storage is checked
553
    later, if necessary.</para>
554

Francis Dupont's avatar
Francis Dupont committed
555 556 557 558 559 560 561
    <para>Version 1.4 extends the host storage to multiple storages. Operations
    are performed on host storages in the configuration order with a special
    case for addition: read-only storages must be configured after a
    required read-write storage, or host reservation addition will
    always fail.</para>

<section xml:id="hosts-databases-configuration6">
562
  <title>DHCPv6 Hosts Database Configuration</title>
563 564

  <para>Hosts database configuration is controlled through the Dhcp6/hosts-database
565
  parameters. If enabled, the type of the database must be set to "mysql" or
566
  "postgresql". Other hosts backends may be added in later version of Kea.
567 568 569
<screen>
"Dhcp6": { "hosts-database": { <userinput>"type": "mysql"</userinput>, ... }, ... }
</screen>
570 571 572
  Next, the name of the database to hold the reservations must be set: this is the
  name used when the database was created  (see <xref linkend="supported-databases"/>
  for instructions how to setup desired database type).
573 574 575
<screen>
"Dhcp6": { "hosts-database": { <userinput>"name": "<replaceable>database-name</replaceable>" </userinput>, ... }, ... }
</screen>
576
  If the database is located on a different system than the DHCPv6 server, the
577
  database host name must also be specified. (Again it should be noted that this
578 579 580 581 582 583 584 585
  configuration may have a severe impact on server performance):
<screen>
"Dhcp6": { "hosts-database": { <userinput>"host": <replaceable>remote-host-name</replaceable></userinput>, ... }, ... }
</screen>
  The usual state of affairs will be to have the database on the same machine as
  the DHCPv6 server.  In this case, set the value to the empty string:
<screen>
"Dhcp6": { "hosts-database": { <userinput>"host" : ""</userinput>, ... }, ... }
Tomek Mrugalski's avatar
Tomek Mrugalski committed
586 587
</screen>
<screen>
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
"Dhcp6": { "hosts-database": { <userinput>"port" : 12345</userinput>, ... }, ... }
</screen>
  </para>
  <para>
The maxiumum number of times the server will automatically attempt to reconnect to
the host database after connectivity has been lost may be specified:
<screen>
"Dhcp6": { "host-database": { <userinput>"max-reconnect-tries" : <replaceable>number-of-tries</replaceable></userinput>, ... }, ... }
</screen>
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 default) disables automatic
recovery and the server will exit immediately upon detecting a loss of connectivity
(MySQL and Postgres only).
  </para>
  <para>
603
The number of milliseconds the server will wait in between attempts to reconnect to the
604 605
host database after connectivity has been lost may also be specified:
<screen>
606
"Dhcp6": { "hosts-database": { <userinput>"reconnect-wait-time" : <replaceable>number-of-milliseconds</replaceable></userinput>, ... }, ... }
607
</screen>
608 609 610
The default value for MySQL and Postgres is 0, which disables automatic recovery and
causes the server to exit immediately upon detecting the loss of connectivity.
The default value for Cassandra is 2000 ms.
611 612 613 614 615 616 617 618 619 620 621
  </para>
  <para>Finally, the credentials of the account under which the server will
  access the database should be set:
<screen>
"Dhcp6": { "hosts-database": { <userinput>"user": "<replaceable>user-name</replaceable>"</userinput>,
                               <userinput>"password": "<replaceable>password</replaceable>"</userinput>,
                              ... },
           ... }
</screen>
  If there is no password to the account, set the password to the empty string
  "". (This is also the default.)</para>
622

Francis Dupont's avatar
Francis Dupont committed
623 624 625 626 627 628 629 630
  <para>The multiple storage extension uses a similar syntax: a configuration
  is placed into a "hosts-databases" list instead of into a "hosts-database"
  entry as in:
<screen>
"Dhcp6": { "hosts-databases": [ { <userinput>"type": "mysql"</userinput>, ... }, ... ], ... }
</screen>
  </para>

631 632 633
  <para>
    For additional Cassandra specific parameters, see <xref
    linkend="cassandra-database-configuration4" />.</para>
634

635
</section>
636

637
<section xml:id="read-only-database-configuration6">
638
<title>Using Read-Only Databases for Host Reservations</title>
639
<para>
640 641
In some deployments the database user whose name is specified in the database backend
configuration may not have write privileges to the database. This is often
642 643 644
required by the policy within a given network to secure the data from being
unintentionally modified. In many cases administrators have inventory databases
deployed, which contain substantially more information about the hosts than
645
static reservations assigned to them. The inventory database can be used to create
646 647 648
a view of a Kea hosts database and such view is often read only.
</para>
<para>
649 650 651 652 653 654 655
Kea host database backends operate with an implicit configuration to both
read from and write to the database. If the database user does not have
write access to the host database, the backend will fail to start and the
server will refuse to start (or reconfigure). However, if access to a read
only host database is required for retrieving reservations for clients
and/or assign specific addresses and options, it is possible to explicitly
configure Kea to start in "read-only" mode. This is controlled by the
656 657
<command>readonly</command> boolean parameter as follows:
<screen>
658
"Dhcp6": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
659 660 661 662 663 664 665 666 667
</screen>
Setting this parameter to <userinput>false</userinput> would configure the
database backend to operate in "read-write" mode, which is also a default
configuration if the parameter is not specified.
</para>
<note><para>The <command>readonly</command> parameter is currently only supported
for MySQL and PostgreSQL databases.</para></note>
</section>

668
</section>
669

670
<section xml:id="dhcp6-interface-selection">
671
  <title>Interface Selection</title>
672
  <para>The DHCPv6 server has to be configured to listen on specific network
673
  interfaces.  The simplest network interface configuration instructs the server to
674 675
  listen on all available interfaces:
  <screen>
676 677 678 679 680 681 682
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"*"</userinput> ]
    }
    ...
}
</screen>
683 684 685
  The asterisk plays the role of a wildcard and means "listen on all interfaces".
  However, it is usually a good idea to explicitly specify interface names:
  <screen>
686 687 688 689 690 691 692 693
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3"</userinput> ]
    },
    ...
}
  </screen>
</para>
694
  <para>It is possible to use wildcard interface name (asterisk) concurrently
695
  with the actual interface names:
696
  <screen>
697 698 699 700 701 702 703
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3", "*"</userinput> ]
    },
    ...
}
  </screen>
704 705 706
It is anticipated that this will form of usage only be used where it is desired to
temporarily override a list of interface names and listen on all interfaces.
  </para>
Francis Dupont's avatar
Francis Dupont committed
707 708 709 710

  <para>As for the DHCPv4 server binding to specific addresses and
  disabling re-detection of interfaces are supported. But
  <command>dhcp-socket-type</command> is not because DHCPv6 uses
711 712
  UDP/IPv6 sockets only. The following example shows how to disable the
  interface detection:
Francis Dupont's avatar
Francis Dupont committed
713 714
  </para>

715 716 717 718 719 720 721 722 723 724
  <screen>
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1", "eth3"</userinput> ],
        "re-detect": <userinput>false</userinput>
    },
    ...
}
  </screen>

725 726 727
  <para>The loopback interfaces (i.e. the "lo" or "lo0" interface)
  are not configured by default, unles explicitely mentioned in
  the configration. Note Kea requires a link-local address which does
728 729 730 731 732 733 734 735 736 737 738 739
  not exist on all systems, or a specified unicast address as in:
  </para>

  <screen>
"Dhcp6": {
    "interfaces-config": {
        "interfaces": [ <userinput>"lo/::1"</userinput> ]
    },
    ...
}
  </screen>

740
</section>
741

742
    <section xml:id="ipv6-subnet-id">
743 744
      <title>IPv6 Subnet Identifier</title>
      <para>
745
        The subnet identifier is a unique number associated with a particular subnet.
746 747
        In principle, it is used to associate clients' leases with their respective subnets.
        When a subnet identifier is not specified for a subnet being configured, it will
748 749 750 751 752
        be automatically assigned by the configuration mechanism. The identifiers
        are assigned from 1 and are monotonically increased for each subsequent
        subnet: 1, 2, 3 ....
      </para>
      <para>
753 754 755 756 757 758 759 760 761 762
        If there are multiple subnets configured with auto-generated identifiers and
        one of them is removed, the subnet identifiers may be renumbered. For example:
        if there are four subnets and the third is removed the last subnet will be assigned
        the identifier that the third subnet had before removal. As a result, the leases
        stored in the lease database for subnet 3 are now associated with
        subnet 4, something that may have unexpected consequences. It is planned
        to implement a mechanism to preserve auto-generated subnet ids in a
        future version of Kea.  However, the only remedy for this issue
        at present is to
        manually specify a unique identifier for each subnet.
763
      </para>
764 765 766
      <note>
        Subnet IDs must be greater than zero and less than 4294967295.
      </note>
767
      <para>
768 769
        The following configuration will assign the specified subnet
        identifier to the newly configured subnet:
770

771
        <screen>
772 773
"Dhcp6": {
    "subnet6": [
774 775 776 777 778
        {
            "subnet": "2001:db8:1::/64",
            <userinput>"id": 1024</userinput>,
            ...
        }
779 780 781
    ]
}
</screen>
782 783 784
        This identifier will not change for this subnet unless the "id" parameter is
        removed or set to 0. The value of 0 forces auto-generation of the subnet
        identifier.
785
      </para>
786 787
      <!-- @todo: describe whether database needs to be updated after changing
      id -->
788 789
    </section>

790
    <section xml:id="dhcp6-unicast">
791
      <title>Unicast Traffic Support</title>
792
      <para>
793
        When the DHCPv6 server starts, by default it listens to the DHCP traffic
794 795 796 797
        sent to multicast address ff02::1:2 on each interface that it is
        configured to listen on (see <xref linkend="dhcp6-interface-selection"/>).
        In some cases it is useful to configure a server to handle incoming
        traffic sent to the global unicast addresses as well. The most common
798 799 800
        reason for this is to have relays send their traffic to the server
        directly. To configure the server to listen on a specific unicast address,
        nn interface name can be
801
        optionally followed by a slash, followed by the global unicast address on which
802 803
        the server should listen. The server listens to this address in addition to normal
        link-local binding and listening on ff02::1:2 address. The sample configuration
804
        below shows how to listen on 2001:db8::1 (a global address)
805 806 807
        configured on the eth1 interface.
      </para>
      <para>
808 809
 <screen>
"Dhcp6": {
810 811 812
    "interfaces-config": {
        "interfaces": [ <userinput>"eth1/2001:db8::1"</userinput> ]
    },
813
    ...
814 815 816
    "option-data": [
        {
            "name": "unicast",
Francis Dupont's avatar
Francis Dupont committed
817
            "data": "2001:db8::1"
818 819
        } ],
    ...
820 821
}
 </screen>
822

823
        This configuration will cause the server to listen on
824
        eth1 on the link-local address, the multicast group (ff02::1:2) and 2001:db8::1.
825
      </para>
826 827 828
      <para>
        Usually unicast support is associated with a server unicast option
        which allows clients to send unicast messages to the server.
829 830
        The example above includes a server unicast option specification
        which will cause the client to send messages to the specified
Francis Dupont's avatar
Francis Dupont committed
831
        unicast address.
832
      </para>
833 834
      <para>
        It is possible to mix interface names, wildcards and interface name/addresses
835
        in the list of interfaces. It is not possible however to specify more than one
836 837 838 839
        unicast address on a given interface.
      </para>
      <para>
        Care should be taken to specify proper unicast addresses. The server will
840 841 842
        attempt to bind to the addresses specified without any additional checks.
        This approach has selected on purpose to allow the software to
        communicate over uncommon addresses if so desired.
843 844 845
      </para>
    </section>

846
    <section xml:id="dhcp6-address-config">
847 848
      <title>Subnet and Address Pool</title>
      <para>
849
        The main role of a DHCPv6 server is address assignment. For this,
850 851 852 853 854 855 856
        the server has to be configured with at least one subnet and one pool of dynamic
        addresses to be managed. For example, assume that the server
        is connected to a network segment that uses the 2001:db8:1::/64
        prefix. The Administrator of that network has decided that addresses from range
        2001:db8:1::1 to 2001:db8:1::ffff are going to be managed by the Dhcp6
        server. Such a configuration can be achieved in the following way:
        <screen>
857 858 859 860 861 862
"Dhcp6": {
    <userinput>"subnet6": [
       {
           "subnet": "2001:db8:1::/64",
           "pools": [
               {
863
                   "pool": "2001:db8:1::1-2001:db8:1::ffff"
864 865 866 867 868 869 870
               }
           ],
           ...
       }
    ]</userinput>
}</screen>

871 872 873 874
        Note that <command>subnet</command> is defined as a simple string, but
        the <command>pools</command> parameter is actually a list of pools: for
        this reason, the pool definition is enclosed in square brackets, even
        though only one range of addresses is specified.</para>
875 876

        <para>Each <command>pool</command> is a structure that contains the
877
        parameters that describe a single pool. Currently there is only one
878 879 880 881
        parameter, <command>pool</command>, which gives the range of addresses
        in the pool. Additional parameters will be added in future releases of
        Kea.</para>

882 883
        <para>It is possible to define more than one pool in a
        subnet: continuing the previous example, further assume that
884
        2001:db8:1:0:5::/80 should also be managed by the server. It could be written as
885 886 887 888 889
        2001:db8:1:0:5:: to 2001:db8:1::5:ffff:ffff:ffff, but typing so many 'f's
        is cumbersome. It can be expressed more simply as 2001:db8:1:0:5::/80. Both
        formats are supported by Dhcp6 and can be mixed in the pool list.
        For example, one could define the following pools:
        <screen>
890 891 892 893 894
"Dhcp6": {
    <userinput>"subnet6": [
    {
        "subnet": "2001:db8:1::/64",
        "pools": [
895 896
            { "pool": "2001:db8:1::1-2001:db8:1::ffff" },
            { "pool": "2001:db8:1:05::/80" }
897 898 899 900 901
        ]</userinput>,
        ...
    }
    ]
}</screen>
902 903 904 905
        White space in pool definitions is ignored, so spaces before and after the hyphen are optional.
        They can be used to improve readability.
      </para>
      <para>
906 907 908 909 910 911 912
        The number of pools is not limited, but for performance reasons it is recommended to
        use as few as possible.
      </para>
      <para>
         The server may be configured to serve more than one subnet. To add a second subnet,
         use a command similar to the following:
        <screen>
913 914 915 916 917
"Dhcp6": {
    <userinput>"subnet6": [
    {
        "subnet": "2001:db8:1::/64",
        "pools": [
918
            { "pool": "2001:db8:1::1-2001:db8:1::ffff" }
919 920 921 922 923
        ]
    },
    {
        "subnet": "2001:db8:2::/64",
        "pools": [
924
            { "pool": "2001:db8:2::/64" }
925 926 927 928 929 930
        ]
    },
</userinput>
        ...
    ]
}</screen>
931
        In this example, we allow the server to
932
        dynamically assign all addresses available in the whole subnet. Although
933
        rather wasteful, it is certainly a valid configuration to dedicate the
934
        whole /64 subnet for that purpose. Note that the Kea server does not preallocate
935
        the leases, so there is no danger in using gigantic address pools.
936 937 938
      </para>
      <para>
        When configuring a DHCPv6 server using prefix/length notation, please pay
939 940
        attention to the boundary values. When specifying that the server can use
        a given pool, it will also be able to allocate the first (typically network
941
        address) address from that pool. For example, for pool 2001:db8:2::/64 the
942 943
        2001:db8:2:: address may be assigned as well. If you want to avoid this,
        use the "min-max" notation.
944 945 946 947 948 949
      </para>
    </section>

    <section>
      <title>Subnet and Prefix Delegation Pools</title>
      <para>
950
        Subnets may also be configured to delegate prefixes, as defined in
951 952 953
        <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://tools.ietf.org/html/rfc8415">RFC 8415</link>,
        section 6.3.  A subnet may have one or more prefix delegation pools.
        Each pool has a prefixed address, which is specified as a prefix
954 955 956 957 958 959 960
        (<command>prefix</command>) and a prefix length
        (<command>prefix-len</command>), as well as a delegated prefix length
        (<command>delegated-len</command>). The delegated length must not be
        shorter (that is it must be numerically greater or equal) than the
        prefix length.  If both the delegated and prefix lengths are equal, the
        server will be able to delegate only one prefix. The delegated prefix
        does not have to match the subnet prefix.
961 962 963
      </para>
      <para> Below is a sample subnet configuration which enables prefix
      delegation for the subnet:
964
      <screen>
965 966 967 968 969 970
"Dhcp6": {
    "subnet6": [
        {
            "subnet": "2001:d8b:1::/64",
            <userinput>"pd-pools": [
                {
971
                    "prefix": "3000:1::",
972 973 974 975 976 977 978 979
                    "prefix-len": 64,
                    "delegated-len": 96
                }
            ]</userinput>
        }
    ],
    ...
}</screen>
980
      </para>
981 982