mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-03 07:25:18 +00:00
Code Issues Releases Wiki Activity

[#3881] Starting reorg of CB docs

Browse Source
This commit is contained in:
Ben Scott
2025-05-08 17:15:42 +00:00
committed by Marcin Siodelski
parent 6936322e64
commit 6b64fc0fd4
1 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/sphinx/arm/config-backend.rst
View File

@@ -9,18 +9,7 @@ Applicability
------------- -------------
Kea Configuration Backend (CB or config backend) gives Kea servers the ability Kea Configuration Backend (CB or config backend) gives Kea servers the ability
to manage and fetch their configuration from one or more databases. In to manage and fetch their configuration from one or more databases.
this documentation, the term "Configuration Backend" may also refer to
the particular Kea module providing support to manage and fetch the
configuration information from the particular database type. For
example, the MySQL Configuration Backend is the logic implemented within
:ischooklib:`libdhcp_mysql.so`, which provides a complete set of functions to
manage and fetch the configuration information from the MySQL database.
The PostgreSQL Configuration Backend is the logic implemented within
:ischooklib:`libdhcp_pgsql.so`, which provides a complete set of functions to
manage and fetch the configuration information from the PostgreSQL database.
From here on, the term "database" is used to refer to either a MySQL or
PostgreSQL database.
In small deployments, e.g. those comprising a single DHCP server In small deployments, e.g. those comprising a single DHCP server
instance with limited and infrequently changing number of subnets, it instance with limited and infrequently changing number of subnets, it
@@ -163,6 +152,19 @@ in two independent configuration sources.
CB Components CB Components
------------- -------------
In
this documentation, the term "Configuration Backend" may also refer to
the particular Kea module providing support to manage and fetch the
configuration information from the particular database type. For
example, the MySQL Configuration Backend is the logic implemented within
:ischooklib:`libdhcp_mysql.so`, which provides a complete set of functions to
manage and fetch the configuration information from the MySQL database.
The PostgreSQL Configuration Backend is the logic implemented within
:ischooklib:`libdhcp_pgsql.so`, which provides a complete set of functions to
manage and fetch the configuration information from the PostgreSQL database.
From here on, the term "database" is used to refer to either a MySQL or
PostgreSQL database.
To use a MySQL configuration backend, :ischooklib:`libdhcp_mysql.so` must To use a MySQL configuration backend, :ischooklib:`libdhcp_mysql.so` must
be compiled and the DHCP servers must be configured to load it. It is compiled be compiled and the DHCP servers must be configured to load it. It is compiled
when the ``-D mysql=enabled`` configuration switch is used during the Kea build. when the ``-D mysql=enabled`` configuration switch is used during the Kea build.