diff options
author | Andrei Pavel <andrei@isc.org> | 2020-11-20 15:54:00 +0100 |
---|---|---|
committer | Andrei Pavel <andrei@isc.org> | 2020-11-23 12:40:41 +0100 |
commit | 279dcd3225fe9e7676c72e960c87f3afd3af5e08 (patch) | |
tree | 4fe327c5f11d45b7757c6d20bdc9329a36dec223 | |
parent | [#1554] regenerate parsers (diff) | |
download | kea-279dcd3225fe9e7676c72e960c87f3afd3af5e08.tar.xz kea-279dcd3225fe9e7676c72e960c87f3afd3af5e08.zip |
[#1554] tidy up documentation
-rw-r--r-- | doc/sphinx/arm/admin.rst | 9 | ||||
-rw-r--r-- | doc/sphinx/arm/dhcp4-srv.rst | 2 | ||||
-rw-r--r-- | doc/sphinx/arm/dhcp6-srv.rst | 6 | ||||
-rw-r--r-- | doc/sphinx/arm/hooks-bootp.rst | 2 | ||||
-rw-r--r-- | doc/sphinx/arm/hooks-radius.rst | 2 | ||||
-rw-r--r-- | doc/sphinx/arm/install.rst | 39 | ||||
-rw-r--r-- | doc/sphinx/arm/quickstart.rst | 20 | ||||
-rw-r--r-- | doc/sphinx/arm/stats.rst | 4 | ||||
-rw-r--r-- | doc/sphinx/index.rst | 2 |
9 files changed, 43 insertions, 43 deletions
diff --git a/doc/sphinx/arm/admin.rst b/doc/sphinx/arm/admin.rst index be05782435..93d871cfb1 100644 --- a/doc/sphinx/arm/admin.rst +++ b/doc/sphinx/arm/admin.rst @@ -197,7 +197,7 @@ To create the database: mysql> CREATE DATABASE database_name; - (database_name is the name chosen for the database.) + (``database_name`` is the name chosen for the database.) 3. Create the user under which Kea will access the database (and give it a password), then grant it access to the database tables: @@ -242,8 +242,9 @@ To create the database: mysql: [Warning] Using a password on the command line interface can be insecure. ERROR/kea-admin: Create failed, the user, keatest, has insufficient privileges. - The simplest way around this is to set the global MySQL variable, log_bin_trust_function_creators, to 1 - via the MySQL client. Note this must be done as a user with SUPER privileges: + The simplest way around this is to set the global MySQL variable, + ``log_bin_trust_function_creators``, to 1 via the MySQL client. + Note this must be done as a user with SUPER privileges: .. code-block:: mysql @@ -541,7 +542,7 @@ manually; it cannot be performed by ``kea-admin``. To create the database: -1. Export CQLSH_HOST environment variable: +1. Export ``CQLSH_HOST`` environment variable: .. code-block:: console diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index 00a18b514d..e1421215a3 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -63,7 +63,7 @@ form: [runstatedir]/kea/[conf name].kea-dhcp4.pid where: - ``runstatedir``: The value as passed into the build configure script; it defaults to "/usr/local/var/run". Note that this value may be overridden at runtime by setting the environment variable - KEA_PIDFILE_DIR, although this is intended primarily for testing + ``KEA_PIDFILE_DIR``, although this is intended primarily for testing purposes. - ``conf name``: The configuration file name used to start the server, diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index 965876a8ac..6bc528af1b 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -63,7 +63,7 @@ form: [**runstatedir**]/kea/[**conf name**].kea-dhcp6.pid where: - ``runstatedir``: The value as passed into the build configure script; it defaults to "/usr/local/var/run". Note that this value may be overridden at runtime by setting the environment variable - KEA_PIDFILE_DIR, although this is intended primarily for testing + ``KEA_PIDFILE_DIR``, although this is intended primarily for testing purposes. - ``conf name``: The configuration file name used to start the server, @@ -5334,7 +5334,7 @@ specified in the configuration. .. _data-directory: -DHCPv6 data directory +DHCPv6 Data Directory ===================== The Kea DHCPv6 server puts the server identifier file and the default @@ -6652,7 +6652,7 @@ treated as “not implemented yet”, rather than actual limitations. .. _dhcp6-srv-examples: -Kea DHCPv6 server examples +Kea DHCPv6 Server Examples ========================== A collection of simple-to-use examples for the DHCPv6 component of Kea diff --git a/doc/sphinx/arm/hooks-bootp.rst b/doc/sphinx/arm/hooks-bootp.rst index c70fd1ae3b..23d180f663 100644 --- a/doc/sphinx/arm/hooks-bootp.rst +++ b/doc/sphinx/arm/hooks-bootp.rst @@ -1,6 +1,6 @@ .. _hooks-bootp: -BOOTP support +BOOTP Support ============= .. note:: diff --git a/doc/sphinx/arm/hooks-radius.rst b/doc/sphinx/arm/hooks-radius.rst index 25951fca28..fc826acd02 100644 --- a/doc/sphinx/arm/hooks-radius.rst +++ b/doc/sphinx/arm/hooks-radius.rst @@ -131,7 +131,7 @@ Choice 1: get from github .. code-block:: console - $ git clone https://github.com/isc-projects/kea + $ git clone https://github.com/isc-projects/kea.git Choice 2: get a tarball and extract it diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst index acc55995fd..f0932bf898 100644 --- a/doc/sphinx/arm/install.rst +++ b/doc/sphinx/arm/install.rst @@ -34,27 +34,24 @@ The following is the directory layout of the complete Kea installation. - ``lib/kea/hooks`` — additional hooks libraries. -- ``sbin/`` — server software and commands used by the system - administrator. +- ``sbin/`` — server software and commands used by the system administrator. -- ``share/kea/`` — configuration specifications and examples. +- ``share/doc/kea/`` — this guide, other supplementary documentation and examples. -- ``share/doc/kea/`` — this guide, other supplementary documentation, - and examples. +- ``share/kea/`` — API command examples and database schema scripts. - ``share/man/`` — manual pages (online documentation). -- ``var/lib/kea/`` — server identification, and lease databases - files. +- ``var/lib/kea/`` — server identification and lease database files. - ``var/log/`` - log files. -- ``var/run/kea`` - pid and logger lock files. +- ``var/run/kea`` - PID file and logger lock file. .. _build-requirements: Build Requirements -===================== +================== In addition to the run-time requirements (listed in :ref:`required-software`), building Kea from source code requires @@ -106,13 +103,12 @@ the system: running Kea, is required. Note that running the unit tests requires a local Cassandra server. -- The FreeRADIUS client library is required to connect to a RADIUS - server. (This is specified using the --with-freeradius configuration - switch.) +- The FreeRADIUS client library is required to connect to a RADIUS server. + This is specified using the --with-freeradius configuration switch. -- Sysrepo (version 0.7.6 or later) and libyang (version 0.16-r2 or - later) are needed to connect to a Sysrepo database. (This is - specified using the --with-sysrepo switch when running "configure".) +- Sysrepo (version 0.7.6 or later up to and including 0.7.9) and + libyang (version 0.16-r2 or 0.16-r3) are needed to connect to a Sysrepo database. + This is specified using the --with-sysrepo switch when running "configure". - googletest (version 1.8 or later) is required when using the --with-gtest configuration option to build the unit tests. @@ -144,7 +140,7 @@ Download Tar File ----------------- The Kea release tarballs may be downloaded from: -https://downloads.isc.org/isc/kea/ . +https://downloads.isc.org/isc/kea/. Retrieve From Git ----------------- @@ -521,7 +517,7 @@ commands were used: .. code-block:: console - $ git clone https://github.com/datastax/cpp-driver + $ git clone https://github.com/datastax/cpp-driver.git $ cd cpp-driver $ mkdir build $ cd build @@ -552,8 +548,8 @@ code, at the "configure" step (see :ref:`configure`), enter: .. include:: hammer.rst -Running Kea from non-root account on Linux -========================================== +Running Kea From a Non-root Account on Linux +============================================ Both Kea DHCPv4 and DHCPv6 servers perform operations that in general require root access privileges. In particular, DHCPv4 opens raw sockets and both DHCPv4 and DHCPv6 open UDP sockets on @@ -566,8 +562,9 @@ First, a regular user account must be created: useradd admin -Then, change the binaries ownership and group to new user. Note that the specific path may be different. Please -refer to the ``--prefix`` parameter passed to the configure script.: +Then, change the binaries ownership and group to new user. Note that +the specific path may be different. Please refer to the ``--prefix`` +parameter passed to the configure script.: .. code-block:: console diff --git a/doc/sphinx/arm/quickstart.rst b/doc/sphinx/arm/quickstart.rst index cf57ef967c..043886ebc1 100644 --- a/doc/sphinx/arm/quickstart.rst +++ b/doc/sphinx/arm/quickstart.rst @@ -10,8 +10,8 @@ respective chapters elsewhere in this Kea Administrator Reference Manual (ARM). .. _quick-start-tarball: -Quick Start Guide for using tarball -============================================ +Quick Start Guide using tarball +=============================== 1. Install required run-time and build dependencies. See :ref:`build-requirements` for details. @@ -48,7 +48,7 @@ Quick Start Guide for using tarball .. _quick-start-repo: -Quick Start Guide using native packages +Quick Start Guide using Native Packages ======================================= Starting with Kea 1.6.0, ISC now provides native RPM, deb and APK @@ -68,8 +68,9 @@ Kea using native packages. $ apt-get update -4. Kea is split into various packages. You may check the entire list on `cloudsmith.io - <https://cloudsmith.io/~isc/repos/>`__ or using apt/yum/dnf. For example: +4. Kea is split into various packages. You may check the entire list on + `cloudsmith.io <https://cloudsmith.io/~isc/repos/>`__ or using apt/yum/dnf. + For example: .. code-block:: console @@ -91,7 +92,7 @@ Kea using native packages. .. code-block:: console - $ sudo apt-get install isc-kea*=1.6.2-isc0043420200221140216 + $ sudo apt-get install isc-kea*=1.8.1-isc0000920201106154401 6. All installed packages should be now available directly, for example: @@ -105,7 +106,8 @@ Kea using native packages. # systemctl restart isc-kea-dhcp6-server - ``keactrl`` is not available in packages as similar functionality is provided by the native systemctl scripts. + ``keactrl`` is not available in packages as similar functionality is provided + by the native systemctl scripts. .. _quick-start-services: @@ -114,8 +116,8 @@ Quick Start Guide for DHCPv4 and DHCPv6 Services 1. Edit the Kea configuration files which by default are installed in the ``[kea-install-dir]/etc/kea/`` directory. These are: ``kea-dhcp4.conf``, ``kea-dhcp6.conf``, ``kea-dhcp-ddns.conf`` and - ``kea-ctrl-agent.conf``, for DHCPv4 server, DHCPv6 server, D2, and - Control Agent, respectively. + ``kea-ctrl-agent.conf``, ``keactrl.conf`` for DHCPv4 server, DHCPv6 server, + D2, Control Agent and keactrl script respectively. 2. In order to start the DHCPv4 server in the background, run the following command (as root): diff --git a/doc/sphinx/arm/stats.rst b/doc/sphinx/arm/stats.rst index 4cb50b51ea..b5dc144325 100644 --- a/doc/sphinx/arm/stats.rst +++ b/doc/sphinx/arm/stats.rst @@ -381,8 +381,8 @@ a status code of 1 (error) and the text field contains the error description. .. _time-series: -Time series -==================== +Time Series +=========== Previously, by default, each statistic held only a single data point. When Kea attempted to record a new value, the existing previous value was overwritten. diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 401579be8f..c2a5f1af3f 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -55,7 +55,7 @@ Kea, can be found in ISC's `Knowledgebase <https://kb.isc.org/docs/kea-administr -Indices and tables +Indices and Tables ================== * :ref:`genindex` |