mirror of
https://gitlab.isc.org/isc-projects/kea
synced 2025-08-22 09:57:41 +00:00
189 lines
5.0 KiB
ReStructuredText
189 lines
5.0 KiB
ReStructuredText
.. _quickstart:
|
|
|
|
***********
|
|
Quick Start
|
|
***********
|
|
|
|
This section describes the basic steps needed to get Kea up and running.
|
|
For further details, full customizations, and troubleshooting, see the
|
|
respective chapters elsewhere in this Kea Administrator Reference Manual (ARM).
|
|
|
|
.. _quick-start-tarball:
|
|
|
|
Quick Start Guide for using tarball
|
|
============================================
|
|
|
|
1. Install required run-time and build dependencies. See
|
|
:ref:`build-requirements` for details.
|
|
|
|
2. Download the Kea source tarball from the `ISC.org downloads
|
|
page <https://www.isc.org/download/>`__ or the `ISC downloads.isc.org
|
|
<https://downloads.isc.org/isc/kea/>`__.
|
|
|
|
3. Extract the tarball. For example:
|
|
|
|
.. parsed-literal::
|
|
|
|
$ tar xvzf kea-|release|.tar.gz
|
|
|
|
4. Go into the source directory and run the configure script:
|
|
|
|
.. parsed-literal::
|
|
|
|
$ cd kea-|release|
|
|
$ ./configure [your extra parameters]
|
|
|
|
5. Build it:
|
|
|
|
.. code-block:: console
|
|
|
|
$ make
|
|
|
|
6. Install it (by default it will be placed in ``/usr/local/``, so it
|
|
is likely that you will need root privileges for this step):
|
|
|
|
.. code-block:: console
|
|
|
|
$ make install
|
|
|
|
.. _quick-start-repo:
|
|
|
|
Quick Start Guide using native packages
|
|
=======================================
|
|
|
|
Starting with Kea 1.6.0, ISC now provides native RPM, deb and APK
|
|
packages, which make Kea installation much easier. Unless you want
|
|
to tweak specific compilation options, it is usually easier to install
|
|
Kea using native packages.
|
|
|
|
1. Go to `Kea on cloudsmith.io <https://cloudsmith.io/~isc/repos/>`__
|
|
and choose Kea version and enter repository.
|
|
|
|
2. Use ``Set Me Up`` and follow instructions to add repository
|
|
on your system.
|
|
|
|
3. Update system repositories. For example:
|
|
|
|
.. code-block:: console
|
|
|
|
$ apt-get update
|
|
|
|
4. Kea is splitted into various packages check entire list on `cloudsmith.io
|
|
<https://cloudsmith.io/~isc/repos/>`__ or in the system. For example:
|
|
|
|
.. code-block:: console
|
|
|
|
$ apt-cache search isc-kea
|
|
|
|
5. Install specified packages:
|
|
|
|
.. code-block:: console
|
|
|
|
$ apt-get install isc-kea-dhcp6-server
|
|
|
|
or all packages:
|
|
|
|
.. code-block:: console
|
|
|
|
$ sudo apt-get install isc-kea*
|
|
|
|
or all packages with specifying version number:
|
|
|
|
.. code-block:: console
|
|
|
|
$ sudo apt-get install isc-kea*=1.6.2-isc0043420200221140216
|
|
|
|
6. All installed packages should be now available directly, for example:
|
|
|
|
.. code-block:: console
|
|
|
|
# kea-dhcp6 -c /path/to/your/kea6/config/file.json
|
|
|
|
or using systemd:
|
|
|
|
.. code-block:: console
|
|
|
|
# systemctl restart isc-kea-dhcp6-server
|
|
|
|
``keactrl`` is not available in packages.
|
|
|
|
.. _quick-start-services:
|
|
|
|
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.
|
|
|
|
2. In order to start the DHCPv4 server in the background, run the
|
|
following command (as root):
|
|
|
|
.. code-block:: console
|
|
|
|
# keactrl start -s dhcp4
|
|
|
|
Or run the following command to start the DHCPv6 server instead:
|
|
|
|
.. code-block:: console
|
|
|
|
# keactrl start -s dhcp6
|
|
|
|
Note that it is also possible to start all servers simultaneously:
|
|
|
|
.. code-block:: console
|
|
|
|
# keactrl start
|
|
|
|
3. Verify that the Kea server(s) is/are running:
|
|
|
|
.. code-block:: console
|
|
|
|
# keactrl status
|
|
|
|
A server status of "inactive" may indicate a configuration error.
|
|
Please check the log file (by default named
|
|
``[kea-install-dir]/var/log/kea-dhcp4.log``,
|
|
``[kea-install-dir]/var/log/kea-dhcp6.log``,
|
|
``[kea-install-dir]/var/log/kea-ddns.log`` or
|
|
``[kea-install-dir]/var/log/kea-ctrl-agent.log``) for the details of
|
|
the error.
|
|
|
|
4. If the server has been started successfully, test that it is
|
|
responding to DHCP queries and that the client receives a
|
|
configuration from the server; for example, use the `ISC DHCP
|
|
client <https://www.isc.org/download/>`__.
|
|
|
|
5. Stop running the server(s):
|
|
|
|
.. code-block:: console
|
|
|
|
# keactrl stop
|
|
|
|
For instructions specific to your system, please read the
|
|
`system-specific notes <https://kb.isc.org/docs/installing-kea>`__,
|
|
available in the Kea section of `ISC's
|
|
Knowledgebase <https://kb.isc.org/docs>`__.
|
|
|
|
The details of ``keactrl`` script usage can be found in
|
|
:ref:`keactrl`.
|
|
|
|
.. _quick-start-direct-run:
|
|
|
|
Running the Kea Servers Directly
|
|
================================
|
|
|
|
The Kea servers can be started directly, without the need to use
|
|
``keactrl`` or ``systemctl``. To start the DHCPv4 server run the following command:
|
|
|
|
.. code-block:: console
|
|
|
|
# kea-dhcp4 -c /path/to/your/kea4/config/file.json
|
|
|
|
Similarly, to start the DHCPv6 server run the following command:
|
|
|
|
.. code-block:: console
|
|
|
|
# kea-dhcp6 -c /path/to/your/kea6/config/file.json
|