Commit f86096d0 authored by Marcin Siodelski's avatar Marcin Siodelski

[5645] HA developer's guide moved to main devguide.

parent d1ed415c
......@@ -778,6 +778,7 @@ INPUT = ../src/bin/agent \
../src/bin/perfdhcp \
../src/bin/sockcreator \
../src/bin/lfc \
../src/hooks/dhcp/high_availability \
../src/hooks/dhcp/user_chk \
../src/hooks/dhcp/lease_cmds \
../src/hooks/dhcp/stat_cmds \
......
......@@ -52,6 +52,7 @@
* - @subpage agentHooks
* - @subpage hooksComponentDeveloperGuide
* - @subpage hooksmgMaintenanceGuide
* - @subpage libdhcp_ha
* - @subpage libdhcp_user_chk
* - @subpage libdhcp_lease_cmds
* - @subpage libdhcp_stat_cmds
......
This diff is collapsed.
# This is a doxygen configuration for generating XML output as well as HTML.
#
# Inherit everything from our default Doxyfile except GENERATE_XML, which
# will be reset to YES
@INCLUDE = Doxyfile
GENERATE_XML = YES
......@@ -16,6 +16,7 @@ BUILT_SOURCES = ha_messages.h ha_messages.cc
# Ensure that the message file is included in the distribution
EXTRA_DIST = ha_messages.mes
EXTRA_DIST += ha.dox
# Get rid of generated message files on a clean
CLEANFILES = *.gcno *.gcda ha_messages.h ha_messages.cc s-messages
......@@ -67,13 +68,3 @@ libdhcp_ha_la_LIBADD += $(top_builddir)/src/lib/log/libkea-log.la
libdhcp_ha_la_LIBADD += $(top_builddir)/src/lib/util/threads/libkea-threads.la
libdhcp_ha_la_LIBADD += $(top_builddir)/src/lib/util/libkea-util.la
libdhcp_ha_la_LIBADD += $(top_builddir)/src/lib/exceptions/libkea-exceptions.la
EXTRA_DIST += ha.dox Doxyfile Doxyfile-xml
devel:
mkdir -p html
(cat Doxyfile; echo PROJECT_NUMBER=$(PACKAGE_VERSION)) | doxygen - > html/doxygen.log 2> html/doxygen-error.log
echo `grep -i ": warning:" html/doxygen-error.log | wc -l` warnings/errors detected.
clean-local:
rm -rf html
......@@ -5,19 +5,13 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
/**
@mainpage Kea High Availability Hooks Library
@page libdhcp_ha Kea High Availability Hooks Library
Welcome to Kea High Availability Hooks Library. This documentation is
addressed at developers who are interested in internal operation of the
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="http://git.kea.isc.org/~tester/kea/doxygen/">Kea
Developer's Guide</a> and in particular its section about hooks: <a
href="http://git.kea.isc.org/~tester/kea/doxygen/df/d46/hooksdgDevelopersGuide.html">
Hooks Developer's Guide</a>.
@section haOverview Overview
The High Availability (HA) hooks library is inteded for DHCP deployments
......@@ -43,17 +37,16 @@ The HA feature design can be found at
High Availability is a very important requirement for various DHCP
deployments. It is a valid question why such a generic feature is
placed in a hook library rather implemented as an integral part of the
Kea DHCP servers. Besides business reasons to make the HA a premium Kea
feature, there are also some technical reasons. If the HA is implemented
in the loadable library, users who don't use HA or who don't want to
use this particular solution for HA will simply not load this library.
The server code without the HA implementation is lighter, easier
to understand and debug. High Availability is a pretty complex feature
and will certainly keep growing both in size and complexity. Keeping
it in a separate code base makes it easier to maintain and use. Also,
the HA hooks library requires Kea lease_cmds hook library to be loaded
on the participating servers. It would clearly be a bad design to
introduce the feature relying on the presence the loadable (lease_cmds)
Kea DHCP servers. If the HA is implemented in the loadable library,
users who don't use HA or who don't want to use this particular
solution for HA will simply not load this library. The server code
without the HA implementation is lighter, easier to understand and
debug. High Availability is a pretty complex feature and will certainly
keep growing both in size and complexity. Keeping it in a separate
code base makes it easier to maintain and use. Also, the HA hooks
library requires Kea lease_cmds hook library to be loaded on the
participating servers. It would clearly be a bad design to introduce
the feature relying on the presence the loadable (lease_cmds)
module in the main Kea code.
@section haNotableDifferences Notable Differences to ISC DHCP
......
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