[#2220] Add ChangeLog entry and documentation

diff --git a/ChangeLog b/ChangeLog
index 5ce3468cefb9a81aa9667379cd910a21e0eacb9c..abea64924c6fb84b8ed2a9c4c10e0d5e12fcda46 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -11,7 +11,7 @@
 
 Kea 2.3.1 (development) released on September 28, 2022
 
-2065.  [func]          djt
+2066.  [func]          djt
        A compatibility config option called ignore-rai-link-selection
        has been added to the DHCPv4 config allow operators to ignore
        Link Selection suboption data in Relay Agent information options.
@@ -19,6 +19,23 @@ Kea 2.3.1 (development) released on September 28, 2022
        use data provided in the suboption for subnet selection.
        (Gitlab #2543)
 
+2065.  [func]          djt
+       Kea's official APK, Deb, and RPM packages have been restructured
+       and made to follow a consistent packaging standard. Some of the
+       package names have been modified, and some packages have been
+       consolidated into larger packages as a result of these changes.
+       Kea now runs under a service user on RPM systems. Upgrading Kea
+       on Debian and Ubuntu systems should be done with ``apt
+       dist-upgrade`` when upgrading to this release or later, as some
+       packages need to be removed before being reinstalled. Depending
+       on how Kea was installed, upgrading to this release or later on
+       Debian or Ubuntu systems could cause the DHCPv6 and/or the DDNS
+       server, as well as the open-source hooks to be removed. In order
+       to ensure they are properly installed, either install the
+       ``isc-kea`` metapackage, or install the packages explicitly by
+       name. Further details can be found in the Gitlab issue.
+       (Gitlab #2220)
+
 2064.  [build]         mgodzina
        The library version numbers have been bumped for the Kea 2.3.1
        development release.

diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst
index 54828129914e900214e2c78f945f7b907829f223..e6e90c9d57e1b8bc111e0837e34c37a97583b54d 100644 (file)
--- a/doc/sphinx/arm/install.rst
+++ b/doc/sphinx/arm/install.rst
@@ -18,6 +18,46 @@ go to https://cloudsmith.io/~isc/repos, choose the repository of
 interest, and then click the ``Set Me Up`` button for detailed
 instructions.
 
+Installation From Cloudsmith Packages
+-------------------------------------
+ISC provides Kea packages for Alpine, CentOS, Debian, Fedora, RHEL, and Ubuntu.
+The recommended method for installing Kea on any of these systems from the
+Cloudsmith repository for Kea release 2.3.2 is to install the ``isc-kea``
+metapackage. This metapackage is included on all supported distros and will
+install all of the services offered by the Kea software suite.
+
+If you would only like to install specific components offered by Kea, this
+can be accomplished by installing any of the following packages:
+
+- ``isc-kea-dhcp4`` — Kea DHCPv4 server package
+
+- ``isc-kea-dhcp6`` — Kea DHCPv6 server package
+
+- ``isc-kea-dhcp-ddns`` — Kea DHCP DDNS server
+
+- ``isc-kea-ctrl-agent`` — Kea Control Agent for remote configuration
+
+- ``isc-kea-admin`` — Kea Database administration tools
+
+- ``isc-kea-hooks`` — Kea open-source DHCP hooks
+
+Kea Premium hook packages are not included in the ``isc-kea-hooks`` package.
+If you have access to the premium hooks, the packages will have the
+``isc-kea-premium-`` prefix.
+
+Once installed, the services can be managed through your distribution's
+service manager. The services will be named: ``kea-dhcp4``, ``kea-dhcp6``,
+``kea-dhcp-ddns``, and ``kea-ctrl-agent``.
+
+.. note::
+   The real service names on Debian and Ubuntu follow the names of the older
+   packages in order to maintain compatibility in pre-existing scripts. A
+   systemd service alias is used to allow users to refer to them with shorter
+   names. In order to call ``systemctl enable`` on these services, you must
+   use the real service names, which are: ``isc-kea-dhcp4-server``,
+   ``isc-kea-dhcp6-server``, ``isc-kea-dhcp-ddns-server``, and
+   ``isc-kea-ctrl-agent``.
+
 .. _install-hierarchy:
 
 Installation Hierarchy

diff --git a/doc/sphinx/arm/keactrl.rst b/doc/sphinx/arm/keactrl.rst
index f2b382eb406ae4ad40a10d724136c2e1de8dc695..b455d417541701083fbc7477043774925da23a3b 100644 (file)
--- a/doc/sphinx/arm/keactrl.rst
+++ b/doc/sphinx/arm/keactrl.rst
@@ -348,10 +348,10 @@ Briefly, here are example commands to check status, start, stop, and restart var
 
 .. code-block:: console
 
-   # systemctl status isc-kea-ctrl-agent
-   # systemctl start isc-kea-dhcp4-server
-   # systemctl stop isc-kea-dhcp6-server
-   # systemctl restart isc-kea-dhcp-ddns-server
+   # systemctl status kea-ctrl-agent
+   # systemctl start kea-dhcp4
+   # systemctl stop kea-dhcp6
+   # systemctl restart kea-dhcp-ddns
 
 Note that the service names may be slightly different between Linux distributions; in general,
 we have followed the naming conventions in third-party packages. In particular,

diff --git a/doc/sphinx/arm/quickstart.rst b/doc/sphinx/arm/quickstart.rst
index 7433535204048ef8d8782cee9fde46a4b0691909..d1ef363122a0f5b58384d4a55c0757fdeab4b048 100644 (file)
--- a/doc/sphinx/arm/quickstart.rst
+++ b/doc/sphinx/arm/quickstart.rst
@@ -79,7 +79,7 @@ easier to install Kea using native packages.
 
     .. code-block:: console
 
-        $ sudo apt-get install isc-kea-dhcp6-server
+        $ sudo apt-get install isc-kea-dhcp6
 
    or all packages:
 
@@ -103,7 +103,7 @@ easier to install Kea using native packages.
 
     .. code-block:: console
 
-       # systemctl restart isc-kea-dhcp6-server
+       # systemctl restart kea-dhcp6
 
    ``keactrl`` is not available in packages as similar functionality is provided
    by the native systemctl scripts.