-html
\ No newline at end of file
+html
This is used by developers and is not used directly in official builds.
To build doxygen documetation run:
-make devel
\ No newline at end of file
+make devel
The idea is to install Kea on a Raspberry Pi 4 Model B running Raspbian
operation system (e.g. the
-<a href="https://www.raspberrypi.org/downloads/raspbian/">
+<a href="https://www.raspberrypi.org/software/operating-systems/">
Raspbian Buster with desktop and recommended software</a> distribution)
without having to compile Kea on the Raspberry Pi box itself as it
takes some hours so using a standard Linux box with a x86_64 processor.
$ make devel
@endcode
-*/
\ No newline at end of file
+*/
# Certificate Authority. Client certificate must be signed by the CA.
SSLCACertificateFile "/path/to/ca.crt"
-</VirtualHost>
\ No newline at end of file
+</VirtualHost>
// Type: string
{
"code": 59,
- "data": "https://how-to-boot.net/pxe/os.img",
+ "data": "https://boot.example.org/pxe/os.img",
"name": "bootfile-url"
},
/_build
/api.rst
/kea-messages.rst
-
-------------
A DDNS protocol exchange can be conducted with or without TSIG (defined
-in `RFC 2845 <https://tools.ietf/org/html/rfc2845>`__). This
+in `RFC 2845 <https://tools.ietf.org/html/rfc2845>`__). This
configuration section allows the administrator to define the set of TSIG
keys that may be used in such exchanges.
recommendations and are very dependent on the particular hardware that was used
for testing. We strongly advise that administrators run their own performance tests.
-A full report of Kea 1.7 performance results can be found `here <https://jenkins.isc.org/job/kea-1.7/job/performance/KeaPerformanceReport/>`_.
+A full report of performance results for the latest stable Kea can be found
+`here <https://jenkins.isc.org/job/kea-dev/job/performance/KeaPerformanceReport/>`_.
This includes hardware and test scenario descriptions, as well as
current results.
recommendations and are very dependent on the particular hardware that was used
for testing. We strongly advise that administrators run their own performance tests.
-A full report of Kea 1.7 performance results can be found `here <https://jenkins.isc.org/job/kea-1.7/job/performance/KeaPerformanceReport/>`_.
+A full report of performance results for the latest stable Kea can be found
+`here <https://jenkins.isc.org/job/kea-dev/job/performance/KeaPerformanceReport/>`_.
This includes hardware and test scenario descriptions, as well as
current results.
"result": 0,
"text": "NCR generated for: 2001:db8:1::1, hostname: example.com."
}
-
it is an address so is displayed in hexadecimal.
- ``%m``
- The log message itself. Keg log messages all begin with a message
- identifier followed by arbitrary log text. Every message in Kea has
- a unique identifier, which can be used as an index to the
- `Kea Messages Manual <https://jenkins.isc.org/job/Kea_doc/messages/kea-messages.html>`__,
- where more information can be obtained. In our example log above, the
- identifier is ``DHCPSRV_TIMERMGR_START_TIMER``. The log text is typically
- a brief description detailing the condition that caused the message to be
- logged. In our example, the information logged,
- ``starting timer: reclaim-expired-leases``, explains that the timer for
- the expired lease reclamation cycle has been started.
+ The log message itself. Kea log messages all begin with a message identifier
+ followed by arbitrary log text. Every message in Kea has a unique
+ identifier, which can be used as an index to the :ref:`kea-messages`, where
+ more information can be obtained. In our example log above, the identifier
+ is ``DHCPSRV_TIMERMGR_START_TIMER``. The log text is typically a brief
+ description detailing the condition that caused the message to be logged. In
+ our example, the information logged,
+ ``starting timer: reclaim-expired-leases``, explains that the timer for the
+ expired lease reclamation cycle has been started.
.. Warning::
def generate_rst(messages):
- rst = '''
+ rst = '''.. _kea-messages:
+
###################
Kea Messages Manual
###################
DHCPv4 Packet Processing
^^^^^^^^^^^^^^^^^^^^^^^^
-Next is the DHCPv4 packet processing, where we determine what sort of DHCP message this is, Discover, Request, Release, Decline or Inform. This diagram shows the general, high level flow for processing an inbound client DHCP packet (e.g. Discover, Request, Release, etc) from receipt to the server's response..
+Next is the DHCPv4 packet processing, where we determine what sort of DHCP message this is, Discover, Request, Release, Decline or Inform. This diagram shows the general, high level flow for processing an inbound client DHCP packet (e.g. Discover, Request, Release, etc) from receipt to the server's response..
.. figure:: uml/packet4.*
DHCP Request Processing
^^^^^^^^^^^^^^^^^^^^^^^
-The following diagrams focus on DHCPREQUEST processing. This chart gives an overview of the process, beginning with subnet selection, proceeding to checking for Host Reservations and evaluating client classes. Finally, before acknowledging the lease, the options are evaluated and added to the message.
+The following diagrams focus on DHCPREQUEST processing. This chart gives an overview of the process, beginning with subnet selection, proceeding to checking for Host Reservations and evaluating client classes. Finally, before acknowledging the lease, the options are evaluated and added to the message.
.. figure:: uml/request4.*
DHCPREQUEST processing
-.
+.
.. _uml_select4:
DHCPv4 Special Case of Double-booting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-After the subnet selection and before the lease allocation the DHCPv4 server handles the special case of clients restarting with an image provided by PXE boot or bootp. Note that the Lease Request box is expanded below.
+After the subnet selection and before the lease allocation the DHCPv4 server handles the special case of clients restarting with an image provided by PXE boot or bootp. Note that the Lease Request box is expanded below.
.. figure:: uml/assign-lease4.*
DHCPv4 Allocate Lease
^^^^^^^^^^^^^^^^^^^^^
-This diagram provides the details of the processing the client request, showing renewing an existing lease, assigning a reserved lease and allocating an unreserved lease. The next diagram after this one shows the algorithm in more detail.
+This diagram provides the details of the processing the client request, showing renewing an existing lease, assigning a reserved lease and allocating an unreserved lease. The next diagram after this one shows the algorithm in more detail.
.. figure:: uml/request4-lease.*
Allocate a lease for DHCPREQUEST
-
+
This diagram shows the algorithm used to validate a requested lease or select a new address to offer. The far right side of the diagram shows how a new address is selected when a new lease is required and the client has neither a requested address nor a reservation. Note that when a new lease is required and Kea iterates over pools and subnets, it starts with the subnet selected above in the subnet selection process.
.. figure:: uml/requestLease4.*
.. note::
- To find a free lease the allocation engine begins with evaluating the most recently used subnet.
+ To find a free lease the allocation engine begins with evaluating the most recently used subnet.
The current subnet depends on the history of prior queries.
.. figure:: uml/appendRequestedVendorOptions.*
appendRequestedVendorOptions (append vendor requested options) algorithm
-
/// \page LoggingApi Logging API
/// \section LoggingApiOverview Overview
/// Kea logging uses the concepts of the widely-used Java logging
-/// package log4j (http://logging.apache.log/log4j), albeit implemented
+/// package log4j (https://logging.apache.org/log4j/), albeit implemented
/// in C++ using an open-source port. Features of the system are:
///
/// - Within the code objects - known as loggers - can be created and
projects / thirdparty / kea.git / commitdiff
