From: Marcin Siodelski Date: Thu, 28 Jul 2016 16:33:27 +0000 (+0200) Subject: [4489] Updated documentation for "readonly" database parameter. X-Git-Tag: trac4631_base~9^2~13 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fe0424b0321a31aa64e4e1a6d600ae71980ddd8e;p=thirdparty%2Fkea.git [4489] Updated documentation for "readonly" database parameter. --- diff --git a/doc/guide/admin.xml b/doc/guide/admin.xml index 7628279c21..ccfe991d77 100644 --- a/doc/guide/admin.xml +++ b/doc/guide/admin.xml @@ -11,11 +11,13 @@ Databases and Database Version Numbers - Kea stores leases in one of several supported databases. - As future versions of Kea are released, the structure of those - databases will change. For example, Kea currently only stores - lease information: in the future, additional data - such as host - reservation details - will also be stored. + Kea supports storing leases and host reservations (i.e. static + assignments of addresses, prefixes and options) in one of + the several supported databases. As future versions of Kea + are released, the structure of those databases will change. + For example, Kea currently only stores lease information + and host reservations: in the future, additional + data - such as subnet definitions - will also be stored. @@ -705,6 +707,18 @@ $ kea-admin lease-upgrade cql -n database-name +
+ Using read only databases with host reservations + If read only database is used for storing host reservations, + Kea must be explicitly configured to operate on the database in + the read only mode. + Sections and + describe when + such configuration may be desired and how to configure Kea to + operate using read only host database. + +
+
Limitations related to the use of the SQL databases @@ -721,6 +735,7 @@ $ kea-admin lease-upgrade cql -n database-name
+ diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index 352f50f667..63a99d818f 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -539,6 +539,38 @@ If a timeout is given though, it should be an integer greater than zero. If there is no password to the account, set the password to the empty string "". (This is also the default.) + +
+Using Read Only Databases for Host Reservations + +In some deployments the database user, which name is specified in the database backend +configuration, may not have write privileges to the database. This is often +required by the policy within a given network to secure the data from being +unintentionally modified. In many cases administrators have inventory databases +deployed, which contain substantially more information about the hosts than +static reservations assigned to them. Such database can be used to create +a view of a Kea hosts database and such view is often read only. + + +Kea host database backends operate with implicit configuration to both read +and write from the database. If the host database is read only for the +particular user, the backend will fail to start and consequently the server +will refuse to start/reconfigure. If the administrator intends to use the +read only host database for retrieving reservations for clients, to assign +specific addresses and options, it is possible to explicitly configure +Kea to start in "read-only" mode. This is controlled by the +readonly boolean parameter as follows: + +"Dhcp4": { "hosts-database": { "readonly": true, ... }, ... } + +Setting this parameter to false would configure the +database backend to operate in "read-write" mode, which is also a default +configuration if the parameter is not specified. + +The readonly parameter is currently only supported +for MySQL and PostgreSQL databases. +
+
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index 5b1d5c5858..a12666e381 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -477,6 +477,7 @@ If a timeout is given though, it should be an integer greater than zero. If there is no password to the account, set the password to the empty string "". (This is also the default.)
+
@@ -539,8 +540,40 @@ If a timeout is given though, it should be an integer greater than zero. If there is no password to the account, set the password to the empty string "". (This is also the default.)
+ +
+Using Read Only Databases for Host Reservations + +In some deployments the database user, which name is specified in the database backend +configuration, may not have write privileges to the database. This is often +required by the policy within a given network to secure the data from being +unintentionally modified. In many cases administrators have inventory databases +deployed, which contain substantially more information about the hosts than +static reservations assigned to them. Such database can be used to create +a view of a Kea hosts database and such view is often read only. + + +Kea host database backends operate with implicit configuration to both read +and write from the database. If the host database is read only for the +particular user, the backend will fail to start and consequently the server +will refuse to start/reconfigure. If the administrator intends to use the +read only host database for retrieving reservations for clients, to assign +specific addresses and options, it is possible to explicitly configure +Kea to start in "read-only" mode. This is controlled by the +readonly boolean parameter as follows: + +"Dhcp4": { "hosts-database": { "readonly": true, ... }, ... } + +Setting this parameter to false would configure the +database backend to operate in "read-write" mode, which is also a default +configuration if the parameter is not specified. + +The readonly parameter is currently only supported +for MySQL and PostgreSQL databases. +
+ ---> +
Interface selection