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:
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
To create the database:
-1. Export CQLSH_HOST environment variable:
+1. Export ``CQLSH_HOST`` environment variable:
.. code-block:: console
- ``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,
- ``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,
.. _data-directory:
-DHCPv6 data directory
+DHCPv6 Data Directory
=====================
The Kea DHCPv6 server puts the server identifier file and the default
.. _dhcp6-srv-examples:
-Kea DHCPv6 server examples
+Kea DHCPv6 Server Examples
==========================
A collection of simple-to-use examples for the DHCPv6 component of Kea
.. _hooks-bootp:
-BOOTP support
+BOOTP Support
=============
.. note::
.. 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
- ``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
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.
-----------------
The Kea release tarballs may be downloaded from:
-https://downloads.isc.org/isc/kea/ .
+https://downloads.isc.org/isc/kea/.
Retrieve From Git
-----------------
.. 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
.. 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
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
.. _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.
.. _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
$ 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
.. 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:
# 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:
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):
.. _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.
-Indices and tables
+Indices and Tables
==================
* :ref:`genindex`
projects / thirdparty / kea.git / commitdiff
