From: Suzanne Goldlust Date: Mon, 7 Jan 2019 18:31:16 +0000 (-0500) Subject: Update admin.xml X-Git-Tag: 481-remote-subnet4-set-inconsistent-work-when-id-subnet-is-duplicated_base~44 X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=28baa6d7b02a41d34e84bbe1e1b941ac4b207b73;p=thirdparty%2Fkea.git Update admin.xml --- diff --git a/doc/guide/admin.xml b/doc/guide/admin.xml index 3890cc3549..f20fea0243 100644 --- a/doc/guide/admin.xml +++ b/doc/guide/admin.xml @@ -14,27 +14,27 @@ Databases and Database Version Numbers - Kea supports storing leases and host reservations (i.e. static + Kea supports the storage of 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. + the several supported backend databases. As future versions of Kea + are released, the structure of those backends will change. For example, Kea currently only stores lease information and host reservations. Future versions of Kea will store - additional data such as subnet definitions, so the database + additional data such as subnet definitions, so the backend structure will need to be updated to accommodate the extra information. A given version of Kea expects a particular structure in - the database and checks for this by examining the version of + the backend and checks for this by examining the version of database it is using. Separate version numbers are maintained for - backend databases, independent of the version of Kea itself. It - is possible that the backend database version will stay the same + backends, independent of the version of Kea itself. It + is possible that the backend version will stay the same through several Kea revisions; similarly, it is possible that the - version of the backend database may go up several revisions during a - Kea upgrade. Versions for each database are independent, so an - increment in the MySQL database version does not imply an increment + version of the backend may go up several revisions during a + Kea upgrade. Versions for each backend are independent, so an + increment in the MySQL backend version does not imply an increment in that of PostgreSQL. @@ -42,16 +42,16 @@ Backend versions are specified in a major.minor format. The minor number is increased when there are backward-compatible changes - introduced: for example, the addition of a new index. It is + introduced; for example, the addition of a new index. It is desirable but not mandatory to apply such a change; you - can run an older database version if you want to. (Although, in + can run an older backend version if you want to. (Although, in the example given, running without the new index may be at the expense of a performance penalty.) On the other hand, the major number is increased when an incompatible change is introduced: for example, an extra column is added to a table. If you try to - run Kea software on a database that is too old (as signified by + run Kea on a backend that is too old (as signified by a mismatched backend major version number), Kea will refuse to run; - administrative action will be required to upgrade the database. + administrative action will be required to upgrade the backend. @@ -61,8 +61,8 @@ To manage the databases, Kea provides the kea-admin tool. It is able to initialize - a new database, check its version number, perform a - database upgrade, and dump lease data to a text file. + a new backend, check its version number, perform a + backend upgrade, and dump lease data to a text file. @@ -85,7 +85,7 @@ lease-version — - Reports the lease database version number. This is + Reports the lease backend version number. This is not necessarily equal to the Kea version number as each backend has its own versioning scheme. @@ -94,7 +94,7 @@ lease-upgrade — - Conducts a lease database upgrade. This is useful when + Conducts a lease backend upgrade. This is useful when upgrading Kea. @@ -111,7 +111,7 @@ - backend specifies the backend type. The currently + backend specifies the type of backend database. The currently supported types are: @@ -139,7 +139,7 @@ cql — - Lease information is stored in a CQL database. + Lease information is stored in an Apache Cassandra database. @@ -153,7 +153,7 @@
- Supported Databases + Supported Backends The following table presents the capabilities of available backends. Please refer to the specific sections dedicated to each backend to @@ -193,7 +193,7 @@ CSV file SQL RMDB SQL RMDB - NoSQL database (CQL) + NoSQL database (Cassandra) @@ -414,8 +414,7 @@ $ kea-admin lease-upgrade mysql -u database-user PostgreSQL is able to store leases, host reservations, and options defined on a per-host basis. - A PostgreSQL database must be set up if you want Kea to store - lease and other information in PostgreSQL. This step can be + This step can be safely ignored if you are using other database backends. @@ -522,7 +521,7 @@ psql: FATAL: no pg_hba.conf entry for host "[local]", user "user-n the database and must have the appropriate entries added to PostgreSQL's pg_hba.conf file. This file is normally located in the primary data directory for your - PostgreSQL server. The precise path may vary, but the + PostgreSQL server. The precise path may vary depending on your operating system and version, but the default location for PostgreSQL 9.3 on Centos 6.5 is: /var/lib/pgsql/9.3/data/pg_hba.conf. @@ -544,7 +543,7 @@ host database-name user-name @@ -590,18 +589,18 @@ $ kea-admin lease-upgrade pgsql -u database-user
- CQL (Cassandra) + Cassandra - Cassandra, or Cassandra Query Language (CQL), is the newest backend + Cassandra (sometimes for historical reasons referred to in documentation and commands as CQL) is the newest backend added to Kea; initial development was contributed by Deutsche Telekom. The Cassandra backend is able to store leases, host reservations, and options defined on a per-host basis. - The CQL database must be properly set up if you want Kea to store - information in CQL. This section can be safely ignored if you choose to + Cassandra must be properly set up if you want Kea to store + information in it. This section can be safely ignored if you choose to store the data in other backends. @@ -609,8 +608,7 @@ $ kea-admin lease-upgrade pgsql -u database-userFirst-Time Creation of the Cassandra Database - If you are setting up the CQL database for the first time, you need to - create the keyspace area within CQL. This needs to be done manually; + If you are setting up the Cassandra database for the first time, you need to create the keyspace area within it. This needs to be done manually; kea-admin cannot do this for you. @@ -649,7 +647,7 @@ cql> CREATE KEYSPACE keyspace-name WITH replication = {'class' : ' At this point, you may elect to create the database tables. - (Alternatively, you can exit CQL and create the tables using the + (Alternatively, you can exit Cassandra and create the tables using the kea-admin tool, as explained below.) To do this: cqslh -k keyspace-name -f path-to-kea/share/kea/scripts/cql/dhcpdb_create.cql @@ -678,7 +676,7 @@ $ kea-admin lease-init cql -n database-name
- Upgrading a CQL Database from an Earlier Version of Kea + Upgrading a Cassandra Database from an Earlier Version of Kea Sometimes a new Kea version may use a newer database schema, so @@ -719,7 +717,7 @@ $ kea-admin lease-upgrade cql -n database-name and describe when such configuration may be required and how to configure Kea to - operate using a read-only host database. + operate in this way.
@@ -733,7 +731,7 @@ $ kea-admin lease-upgrade cql -n database-name