diff --git a/doc/sphinx/arm/admin.rst b/doc/sphinx/arm/admin.rst index a0859ebd67..1be290f58d 100644 --- a/doc/sphinx/arm/admin.rst +++ b/doc/sphinx/arm/admin.rst @@ -37,8 +37,8 @@ version, it will fail; administrative action is required to upgrade the schema. .. _kea-admin: -The kea-admin Tool -================== +The ``kea-admin`` Tool +====================== To manage the databases, Kea provides the ``kea-admin`` tool. It can initialize a new backend, check its version number, perform a backend @@ -48,19 +48,19 @@ upgrade, and dump lease data to a text file. ``backend``. Additional, non-mandatory options may be specified. The currently supported commands are: -- ``db-init`` — Initializes a new database schema. This is useful +- ``db-init`` — initializes a new database schema. This is useful during a new Kea installation. The database is initialized to the latest version supported by the version of the software being installed. -- ``db-version`` — Reports the database backend version number. This +- ``db-version`` — reports the database backend version number. This is not necessarily equal to the Kea version number, as each backend has its own versioning scheme. -- ``db-upgrade`` — Conducts a database schema upgrade. This is +- ``db-upgrade`` — conducts a database schema upgrade. This is useful when upgrading Kea. -- ``lease-dump`` — Dumps the contents of the lease database (for MySQL, +- ``lease-dump`` — dumps the contents of the lease database (for MySQL, PostgreSQL, or CQL backends) to a CSV (comma-separated values) text file. The first line of the file contains the column names. This is meant to be used as a diagnostic tool, so it provides a portable, @@ -68,21 +68,21 @@ currently supported commands are: .. note:: - In versions of Kea earlier than 1.6.0, the `db-init`, `db-version`, and - `db-upgrade` commands were named `lease-init`, `lease-version`, and - `lease-upgrade`, respectively. + In versions of Kea earlier than 1.6.0, the ``db-init``, ``db-version``, and + ``db-upgrade`` commands were named ``lease-init``, ``lease-version``, and + ``lease-upgrade``, respectively. ``backend`` specifies the type of backend database. The currently supported types are: -- ``memfile`` — Lease information is stored on disk in a text file. +- ``memfile`` — lease information is stored on disk in a text file. -- ``mysql`` — Information is stored in a MySQL relational database. +- ``mysql`` — information is stored in a MySQL relational database. -- ``pgsql`` — Information is stored in a PostgreSQL relational +- ``pgsql`` — information is stored in a PostgreSQL relational database. -- ``cql`` — Information is stored in an Apache Cassandra database. +- ``cql`` — information is stored in an Apache Cassandra database. This backend is deprecated. Additional parameters may be needed, depending on the setup and @@ -195,9 +195,9 @@ To check the MySQL timezone: To configure the MySQL timezone for a specific server, please refer to the installed version documentation. -Usually the setting is configured in the [mysqld] section in /etc/mysql/my.cnf, -/etc/mysql/mysql.cnf, /etc/mysql/mysqld.cnf, or -/etc/mysql/mysql.conf.d/mysqld.cnf. +Usually the setting is configured in the [mysqld] section in ``/etc/mysql/my.cnf``, +``/etc/mysql/mysql.cnf``, ``/etc/mysql/mysqld.cnf``, or +``/etc/mysql/mysql.conf.d/mysqld.cnf``. .. code-block:: ini @@ -302,6 +302,7 @@ To create the database: (where ``path-to-kea`` is the location where Kea is installed.) .. warning:: + Dropping the database results in the unrecoverable loss of any data it contains. @@ -380,7 +381,7 @@ Improved Performance With MySQL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Changing the MySQL internal value ``innodb_flush_log_at_trx_commit`` from the default value -of ``1`` to ``2`` can result in a huge gain in Kea performance. In some deployments, the +of 1 to 2 can result in a huge gain in Kea performance. In some deployments, the gain was over 1000% (10 times faster when set to 2, compared to the default value of 1). It can be set per-session for testing: