From: Shawn Routhier Date: Thu, 12 Mar 2015 04:09:00 +0000 (-0700) Subject: [3720] Add documentation about LFC to Kea administrator reference manual X-Git-Tag: trac3764_base~6^2~3 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4fc285bebde682576fbb86f5586a0e6f570cbe42;p=thirdparty%2Fkea.git [3720] Add documentation about LFC to Kea administrator reference manual --- diff --git a/doc/guide/Makefile.am b/doc/guide/Makefile.am index ffda1d5245..8076fb673a 100644 --- a/doc/guide/Makefile.am +++ b/doc/guide/Makefile.am @@ -7,7 +7,7 @@ dist_html_DATA = $(HTMLDOCS) kea-guide.css DOCBOOK = kea-guide.xml intro.xml quickstart.xml install.xml admin.xml config.xml DOCBOOK += keactrl.xml dhcp4-srv.xml dhcp6-srv.xml logging.xml ddns.xml hooks.xml -DOCBOOK += libdhcp.xml +DOCBOOK += libdhcp.xml lfc.xml EXTRA_DIST = $(DOCBOOK) DISTCLEANFILES = $(HTMLDOCS) $(DOCS) kea-messages.xml diff --git a/doc/guide/intro.xml b/doc/guide/intro.xml index c5a17d7e47..a48d608c62 100644 --- a/doc/guide/intro.xml +++ b/doc/guide/intro.xml @@ -146,6 +146,17 @@ + + + kea-lfc — + This process removes redundant information from the files used + to provide persistent storage for the memfile data base backend. + The service is written to run as a stand alone process. While it + can be started externally it should be started by the Kea DHCP + servers. + + + perfdhcp — diff --git a/doc/guide/kea-guide.xml b/doc/guide/kea-guide.xml index 0b0c868d9b..0095931a6c 100644 --- a/doc/guide/kea-guide.xml +++ b/doc/guide/kea-guide.xml @@ -69,6 +69,8 @@ + + diff --git a/doc/guide/lfc.xml b/doc/guide/lfc.xml new file mode 100644 index 0000000000..a3c11aa06b --- /dev/null +++ b/doc/guide/lfc.xml @@ -0,0 +1,99 @@ + + +]> + + + The LFC process + +
+ Overview + kea-lfc is a service process that removes + redundant infomation from the files used to provide persistent storage + for the memfile data base backend. This service is written to run as a + stand alone process. + + While kea-lfc can be started externally it should + be started by the Kea DHCP servers. + + The process operates on a set of files, using them for input and output + of the lease entries and to indicate where it is in the process in case of an + interruption. Currently the caller must supply names for all of the files, in + the future this requirement may be relaxed with the process getting the names + from either the config file or from defaults. + +
+ +
+ Command Line Options + kea-lfc is run as follows: + +kea-lfc [-4 | -6] -c config-file -p pid-file -x previous-file -i copy-file -o output-file -f finish-file + + + + The argument -4 or -6 selects the protocol + version of the lease files. + + + The -c argument specifies the configuration file. This is + required, but not currently used by the process. + + + The -p argument specifies the PID file. When the + kea-lfc process starts it attempts to determine if another + instance of the process is already running by examining the pid file. If one + is running it aborts the new process. If one isn't running it writes its + pid into the pid file. + + + The other filenames specify where the kea-lfc process + should look for input, write its output and use for bookkeeping. + + + + previous — + When kea-lfc starts this + is the result of any previous run of kea-lfc. + When kea-lfc finishes it is the result of this run. + If kea-lfc is interrupted before compelting + this file may not exist. + + + + input — + Before the DHCP server invokes kea-lfc it will + copy the current lease file here and then call kea-lfc + with this file. + + + + output — + The temporary file kea-lfc should use to write the leases. + Upon completion of writing this this file it will be moved to the finish file + (see below). + + + + finish — + Another temporary file kea-lfc uses for bookkeeping. When + kea-lfc completes writing the outputfile it moves it to this + file name. After kea-lfc finishes deleting the other files + (previous and input) it moves this file to previous lease file. By moving the + files in this fashion the kea-lfc and the DHCP server + processes can determine the correct file to use even if one of the + processes was interrupted before completing its task. + + + + + + There are several additional arguments mostly for debugging purposes. + -d Sets the logging level to debug. -v and + -V print out version stamps with -V providing + a longer form. -h prints out the usage string. + + +
+ diff --git a/src/bin/lfc/kea-lfc.xml b/src/bin/lfc/kea-lfc.xml index 119efca163..2bdd33af50 100644 --- a/src/bin/lfc/kea-lfc.xml +++ b/src/bin/lfc/kea-lfc.xml @@ -62,7 +62,7 @@ DESCRIPTION The kea-lfc service process removes redundant - information for the files used to provide persistent storage for + information from the files used to provide persistent storage for the memfile data base backend. The service is written to run as a stand alone process. While it can be started externally it should be started by the Kea DHCP servers as desired and required.