From b9e8499456a82f2c1931e093ebd83de900392636 Mon Sep 17 00:00:00 2001 From: Thomas Markwalder Date: Fri, 20 Sep 2019 10:03:24 -0400 Subject: [PATCH] [#917,!518] Added note in ARM about manually admining cb data doc/sphinx/arm/config-backend.rst --- doc/sphinx/arm/config-backend.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/sphinx/arm/config-backend.rst b/doc/sphinx/arm/config-backend.rst index b03a4d201c..1ce448afeb 100644 --- a/doc/sphinx/arm/config-backend.rst +++ b/doc/sphinx/arm/config-backend.rst @@ -86,6 +86,24 @@ CB in the Kea 1.6.0 release: .. +.. note:: + Kea CB stores data in a MySQL schema that is public. It's possible to + insert configuration data into the MySQL tables manually, or automatically + using SQL scripts, but this requires a reasonably good knowledge of SQL and the + schema. The supported method for managing the data is through our cb-cmds + hook library which provides management commands for config backends. + It simplifies many typical operations, such as listing, adding, retrieving, + and deleting of global parameters, shared networks, subnets, pools, options, + and option definitions. In addition, it provides essential business logic + that ensures logical integrity of the data. For a complete list, see commands + starting with "remote-" in Appendix A of the Kea Administrator Reference Manual. + The cb_cmds hooks library is available to subscribers only. If you are not a + subscriber and would like to subscribe, please contact info@isc.org and + our sales team will assist you. + + The schema creation script can be found here `dhcpdb_create.mysql ` and + we have some related design documents in gitlab `CB Design `. + .. note:: We strongly recommend against duplication of the configuration information -- 2.47.2