Commit e6bf8498 authored by Tomek Mrugalski's avatar Tomek Mrugalski 🛰

[5280] Doxygen for lease commands added.

parent ffaff5b5
// Copyright (C) 2017 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
@mainpage Kea Lease Commands Hooks Library
Welcome to Kea Lease Commands Hooks Library. This documentation is addressed at
developers who are interested in internal operation of the Lease Commands
library. This file provides information needed to understand and perhaps extend
this library.
This documentation is stand-alone: you should have read and understood <a
href="">Kea Developer's Guide</a> and in
particular its section about hooks.
@section lease_cmds Lease Commands Overview
Lease Commands (or lease_cmds) is a Hook library that can be loaded by Kea to
extend it with additional mechanisms.
The primary purpose of this library is to provide commands that manage leases.
As such, the whole library is structured around command handlers. When the
library is loaded it registers a number of handlers for new commands. When a
command is issued (be it directly via control channel or indirectly via REST
interface from control agent), the code receives a JSON command with
parameters. Those are parsed and then actual operation commences. This
operation always interacts with an instantiation of isc::dhcp::LeaseMgr
instance, which is Kea's way of storing leases. At time of writing this text
(Aug. 2017), Kea supports four types of lease managers: memfile, MySQL,
PostgreSQL or Cassandra. Those commands provide a unified interface for those
As with other hooks, also this one keeps its code in separate namespace, which
corresponds to the file name of the library: isc::lease_cmds.
@section lease_cmdsCode Lease Commands Code Overview
The library operation starts with Kea calling load() function (file It instantiates isc::lease_cmds::LeaseCmds object. Constructor
of that object registers all commands. For a list, see @ref
isc::lease_cmds::LeaseCmds class documentation. This class uses Pimpl design
pattern, thus the real implementation is hidden in
Almost every command has its own handler, except few that share the same handler
between v4 and v6 due to its similarity. For example
isc::lease_cmds::LeaseCmdsImpl::leaseAddHandler handles lease4-add and lease6-add
commands. Although the details differ between handlers, the general approach
is the same. First, it starts with parameters sanitization and then some
interaction with isc::dhcp::LeaseMgr is conducted.
For commands that do something with a specific lease (lease4-get, lease6-get,
lease4-del, lease6-del), there is a @ref isc::lease_cmds::Parameters class that
contains parsed elements.
For details see documentation and code of the following handlers:
- @ref isc::lease_cmds::LeaseCmdsImpl::leaseAddHandler (lease4-add, lease6-add)
- @ref isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler (lease4-get, lease6-get)
- @ref isc::lease_cmds::LeaseCmdsImpl::lease4DelHandler (lease4-del)
- @ref isc::lease_cmds::LeaseCmdsImpl::lease6DelHandler (lease6-del)
- @ref isc::lease_cmds::LeaseCmdsImpl::lease4UpdateHandler (lease4-update)
- @ref isc::lease_cmds::LeaseCmdsImpl::lease6UpdateHandler (lease6-update)
- @ref isc::lease_cmds::LeaseCmdsImpl::lease4WipeHandler (lease4-wipe)
- @ref isc::lease_cmds::LeaseCmdsImpl::lease6WipeHandler (lease6-wipe)
@section lease_cmdsDesigns Lease Commands Design choices
The lease manipulation commands were implemented to provide convenient interface
for sysadmins. The primary goal was to offer a way to interact with the live
lease database in unified way, regardless of the actual backend being used.
For some backends (MySQL, PostgreSQL and Cassandra) it is possible to interact
with the backend while Kea is running and possibly change its content. This
is both powerful and dangerous ability. In particular, only rudimentary
checks are enforced by the DB schemas (e.g. not possible to have two leases
for the same address). However, it does not prevent sysadmins from making
more obscure errors, like inserting leases for subnets that do not exist
or configing an address that is topologically outside of the subnet it was
supposed to belong to. This kind of checks is only possible by DHCP-aware
code, which this library provides.
Some of the queries may require a seemingly odd set of parameters. For example,
lease6-get query requires at least duid, subnet-id and iaid to retrieve a lease
by DUID. The need for a sysadmin to know and specify an iaid is troublesome.
However, the guiding principle here was to use whatever queries were already
exposed by lease manager and not introduce new indexes, unless absolutely
necessary. This ensures that there is no performance degradation when the
library is loaded. The only exception for that was lease4-wipe and lease6-wipe
commands that remove all leases from specifiec subnet. As there were no
queries that could retrieve or otherwise enumerate leases from specific subnet,
a new query type (and a new index) had to be developed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment