Browse Source

[4489] Minor edits to documentation

Stephen Morris 8 years ago
parent
commit
134a55c708
3 changed files with 22 additions and 22 deletions
  1. 1 1
      doc/guide/admin.xml
  2. 10 10
      doc/guide/dhcp4-srv.xml
  3. 11 11
      doc/guide/dhcp6-srv.xml

+ 1 - 1
doc/guide/admin.xml

@@ -714,7 +714,7 @@ $ <userinput>kea-admin lease-upgrade cql -n <replaceable>database-name</replacea
       the read only mode.
       the read only mode.
       Sections <xref linkend="read-only-database-configuration4"/> and
       Sections <xref linkend="read-only-database-configuration4"/> and
       <xref linkend="read-only-database-configuration6"/> describe when
       <xref linkend="read-only-database-configuration6"/> describe when
-      such configuration may be desired and how to configure Kea to
+      such configuration may be reqired and how to configure Kea to
       operate using read only host database.
       operate using read only host database.
       </para>
       </para>
     </section>
     </section>

+ 10 - 10
doc/guide/dhcp4-srv.xml

@@ -541,10 +541,10 @@ If a timeout is given though, it should be an integer greater than zero.
 </section>
 </section>
 
 
 <section id="read-only-database-configuration4">
 <section id="read-only-database-configuration4">
-<title>Using Read Only Databases for Host Reservations</title>
+<title>Using Read-Only Databases for Host Reservations</title>
 <para>
 <para>
-In some deployments the database user, which name is specified in the database backend
+In some deployments the database user whose name is specified in the database backend
-configuration, may not have write privileges to the database. This is often
+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
 required by the policy within a given network to secure the data from being
 unintentionally modified. In many cases administrators have inventory databases
 unintentionally modified. In many cases administrators have inventory databases
 deployed, which contain substantially more information about the hosts than
 deployed, which contain substantially more information about the hosts than
@@ -552,13 +552,13 @@ static reservations assigned to them. The inventory database can be used to crea
 a view of a Kea hosts database and such view is often read only.
 a view of a Kea hosts database and such view is often read only.
 </para>
 </para>
 <para>
 <para>
-Kea host database backends operate with implicit configuration to both read
+Kea host database backends operate with an implicit configuration to both
-from and write to the database. If the host database is read only for the
+read from and write to the database. If the database user does not have
-particular user, the backend will fail to start and consequently the server
+write access to the host database, the backend will fail to start and the
-will refuse to start/reconfigure. If the administrator intends to use the
+server will refuse to start (or reconfigure). However, if access to a read
-read only host database for retrieving reservations for clients, to assign
+only host database is required for retrieving reservations for clients
-specific addresses and options, it is possible to explicitly configure
+and/or assign specific addresses and options, it is possible to explicitly
-Kea to start in "read-only" mode. This is controlled by the
+configure Kea to start in "read-only" mode. This is controlled by the
 <command>readonly</command> boolean parameter as follows:
 <command>readonly</command> boolean parameter as follows:
 <screen>
 <screen>
 "Dhcp4": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
 "Dhcp4": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }

+ 11 - 11
doc/guide/dhcp6-srv.xml

@@ -542,10 +542,10 @@ If a timeout is given though, it should be an integer greater than zero.
 </section>
 </section>
 
 
 <section id="read-only-database-configuration6">
 <section id="read-only-database-configuration6">
-<title>Using Read Only Databases for Host Reservations</title>
+<title>Using Read-Only Databases for Host Reservations</title>
 <para>
 <para>
-In some deployments the database user, which name is specified in the database backend
+In some deployments the database user whose name is specified in the database backend
-configuration, may not have write privileges to the database. This is often
+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
 required by the policy within a given network to secure the data from being
 unintentionally modified. In many cases administrators have inventory databases
 unintentionally modified. In many cases administrators have inventory databases
 deployed, which contain substantially more information about the hosts than
 deployed, which contain substantially more information about the hosts than
@@ -553,16 +553,16 @@ static reservations assigned to them. The inventory database can be used to crea
 a view of a Kea hosts database and such view is often read only.
 a view of a Kea hosts database and such view is often read only.
 </para>
 </para>
 <para>
 <para>
-Kea host database backends operate with implicit configuration to both read from
+Kea host database backends operate with an implicit configuration to both
-and write to the database. If the host database is read only for the
+read from and write to the database. If the database user does not have
-particular user, the backend will fail to start and consequently the server
+write access to the host database, the backend will fail to start and the
-will refuse to start/reconfigure. If the administrator intends to use the
+server will refuse to start (or reconfigure). However, if access to a read
-read only host database for retrieving reservations for clients, to assign
+only host database is required for retrieving reservations for clients
-specific addresses and options, it is possible to explicitly configure
+and/or assign specific addresses and options, it is possible to explicitly
-Kea to start in "read-only" mode. This is controlled by the
+configure Kea to start in "read-only" mode. This is controlled by the
 <command>readonly</command> boolean parameter as follows:
 <command>readonly</command> boolean parameter as follows:
 <screen>
 <screen>
-"Dhcp4": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
+"Dhcp6": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
 </screen>
 </screen>
 Setting this parameter to <userinput>false</userinput> would configure the
 Setting this parameter to <userinput>false</userinput> would configure the
 database backend to operate in "read-write" mode, which is also a default
 database backend to operate in "read-write" mode, which is also a default