Merge pull request #2396 from tempesta-tech/rb-2038-deb-packeges

rework the preparation of release packages.

Author: krizhanovsky

pkg/README.md

@@ -1,61 +1,34 @@
 ## Packaging Tempesta
 
-TempestaFW packaging is plain and simple. First of all it is build as DKMS
-module rather than a binary Linux kernel module. This approach allows:
-
-- Build single package for all supported CPUs. Since user will build the module
-on the target server, build system will be aware of all supported x86
-extensions, such as AVX2.
-
-- Have a weak dependency between kernel image and the module. End user can
-use the module with the custom kernel.
-
-
-### Dependencies between Tempesta and Kernel
-
-TempestaFW requires patched kernel, and it has minimum required version. Thus
-variable `BUILD_EXCLUSIVE_KERNEL` in `pkg/debian/tempesta-fw-dkms.dkms` gives
-regexp to match supported versions.
-
-Every time a new module is added or removed in Tempesta sources, `BUILT_MODULE_*`
-modules list must be udated.
-
-
-### Workflow
-
-To simplify the build, TempestaFW is built as native Debian module using
-`git-buildpackage` tool set. The tool set does not honor builds from any
-branches except `master` or builds with dirty index, so warning will appear
-and build will fail. But the tool set does not track ignored files, so unneeded
-files may appear in package. Clone the repo to a new directory or remove
-untracked files with:
-```sh
-git clean -fd
+TempestaFW packaging is plain and simple. It is build as a binary Linux package.
+
+### Structure
+```text
+├── debian
+│   ├── changelog
+│   ├── compat
+│   ├── control
+│   ├── copyright
+│   ├── dirs
+│   ├── rules
+│   ├── tempesta-fw.service
 ```
 
-Packaging require to hame `debian` directory in repo root, create symlink:
-```sh
-ln -s pkg/debian debian
-```
-
-Update packet changelog with `dch` command. See manpages for more info.
-Although `git-buildpackage` has a pretty `gbp dch` tool, which can update
-changelog using git history, it is not suitable in our case, git history doesn't
-hold information valuable for end user.
-
-Finally, build the package using command:
-```sh
-gbp buildpackage --git-tag -us -uc
-```
-`--git-tag` option will add git tag, formatted as `debian/0.1-2`, where `0.1-2`
-- debian version, stated in the log. Push the tag to upstream to indicate
-exact commit used for packaging.
-
-`-us -uc` options are similar to `dpkg-buildpackage`. If stated, source package
-and `.changes` files will remain unsigned.
-
-
-### TODO
-
-Add dependencies into `debian/control` to allow dependency tracking via package
-manager.
+- changelog - contains a log of changes made to the package in each version. 
+It follows a specific format and is important for users to understand what 
+has been added, changed, or fixed in each release. It is also used by package 
+management tools to display version history.
+- compat - specifies the debhelper compatibility level that should be used when 
+building the package. It indicates which features of debhelper are available 
+for use in the rules file.
+- control - contains essential metadata about the package, such as its name, 
+version, architecture, description, maintainer information and dependencies. 
+Must contain the necessary kernel patch in dependencies. 
+For example: `linux-headers-5.10.35.tfw-39c65d3, linux-image-5.10.35.tfw-39c65d3`.
+- copyright - provides information about the licensing of the package and its components.
+- dirs - lists of directories that need to be created during the installation process. 
+- rules - is a makefile that defines how the package is built and installed. 
+It contains instructions on how to install files and other tasks necessary to 
+create a Debian package.
+- tempesta-fw.service - defines a systemd service unit for TempestaFW. It specifies
+ virtual variables in the system.

pkg/debian/.gitignore

@@ -1,4 +1,4 @@
-tempesta-fw-dkms/
+tempesta-fw/
 debhelper-build-stamp
 files
 *.debhelper.log

pkg/debian/README.source

@@ -1,4 +1,4 @@
-tempesta-fw-dkms (0.8.0) focal; urgency=medium
+tempesta-fw (0.8.0) focal; urgency=medium
 
   * Add `Expect: 100-continue` support
   * Add `cache_use_stale` directive
@@ -55,7 +55,7 @@ tempesta-fw-dkms (0.8.0) focal; urgency=medium
 
  -- Tempesta Technologies, Inc. <info@tempesta-tech.com>  Thu, 13 Mar 2025 16:13:47 +0400
 
-tempesta-fw-dkms (0.7.1) focal; urgency=medium
+tempesta-fw (0.7.1) focal; urgency=medium
 
   * Frang: Changed default settings to more strict
   * Implement `max_concurrent_streams` limitation
@@ -73,7 +73,7 @@ tempesta-fw-dkms (0.7.1) focal; urgency=medium
   * Fix incorrect server connection reference counter
   * Hide "Te" header from HTTP/1.x backend when proxying response over HTTP/2.
 
-tempesta-fw-dkms (0.7.0) focal; urgency=medium
+tempesta-fw (0.7.0) focal; urgency=medium
 
   * Fix corrupted header location on H2 sticky cookie redirect
   * Fix crash during tempesta reconfiguration
@@ -119,7 +119,7 @@ tempesta-fw-dkms (0.7.0) focal; urgency=medium
 
  -- Tempesta Technologies, Inc. <info@tempesta-tech.com>  Wed, 3 Mar 2022 20:13:43 +0500
 
-tempesta-fw-dkms (0.6.8) focal; urgency=medium
+tempesta-fw (0.6.8) focal; urgency=medium
 
   * Fix parsing of an empty extension if it comes last in ClientHello.
   * Fix cached data corruption during encryption.
@@ -131,7 +131,7 @@ tempesta-fw-dkms (0.6.8) focal; urgency=medium
 
  -- Tempesta Technologies, Inc. <info@tempesta-tech.com>  Wed, 3 Mar 2022 20:13:43 +0500
 
-tempesta-fw-dkms (0.5.0) stretch; urgency=medium
+tempesta-fw (0.5.0) stretch; urgency=medium
 
   * Add HTTP health monitoring
   * Performance optiomistation and fixes for the On-the-fly reconfiguration
@@ -145,7 +145,7 @@ tempesta-fw-dkms (0.5.0) stretch; urgency=medium
 
  -- Tempesta Technologies, Inc. <info@tempesta-tech.com>  Wed, 21 Mar 2018 14:48:56 +0500
 
-tempesta-fw-dkms (0.5.0pre8) stretch; urgency=medium
+tempesta-fw (0.5.0pre8) stretch; urgency=medium
 
   * Update supported Linux kernel to 4.9.35
   * Fix memory leaks under high load
@@ -155,7 +155,7 @@ tempesta-fw-dkms (0.5.0pre8) stretch; urgency=medium
 
  -- Tempeststa Technologies, Inc. <info@tempesta-tech.com>  Tue, 23 Jan 2018 08:58:30 +0500
 
-tempesta-fw-dkms (0.5.0) stretch; urgency=medium
+tempesta-fw (0.5.0) stretch; urgency=medium
 
   * Initial release
 

pkg/debian/changelog

@@ -1,21 +1,22 @@
-Source: tempesta-fw-dkms
+Source: tempesta-fw
 Section: web
 Priority: optional
 Maintainer: Tempeststa Technologies, Inc. <info@tempesta-tech.com>
-Build-Depends: debhelper (>= 9.20160709~), dkms
-Standards-Version: 3.9.8
+Build-Depends: debhelper (>= 9)
+Standards-Version: 4.5.0
 Homepage: http://tempesta-tech.com
 Vcs-Git: https://github.com/tempesta-tech/tempesta.git
 Vcs-Browser: https://github.com/tempesta-tech/tempesta.git
 
-Package: tempesta-fw-dkms
+Package: tempesta-fw
 Architecture: amd64
-Depends: dkms (>= 1.95),
- libboost-dev,
+Depends: libboost-dev,
  libboost-program-options-dev,
  kdump-tools,
  libfmt-dev,
  libspdlog-dev,
+ linux-headers-5.10.35.tfw-39c65d3,
+ linux-image-5.10.35.tfw-39c65d3,
  ${misc:Depends}
 Description: Open-source high-speed application delivery controller.
  Tempesta FW is an open-source application delivery controller (ADC) built

pkg/debian/control

@@ -4,11 +4,11 @@ Source: http://tempesta-tech.com
 
 Files: *
 Copyright: 2014      NatSys Lab
-           2015-2018 Tempesta Technologies, Inc.
+           2015-2025 Tempesta Technologies, Inc.
 License: GPL-2.0+
 
 Files: debian/*
-Copyright: 2017 Tempeststa Technologies, Inc. <info@tempesta-tech.com>
+Copyright: 2017-2025 Tempeststa Technologies, Inc. <info@tempesta-tech.com>
 License: GPL-2.0+
 
 License: GPL-2.0+

pkg/debian/copyright

@@ -4,26 +4,21 @@
 # Uncomment this to turn on verbose mode.
 export DH_VERBOSE=1
 
-NAME=tempesta-fw
-DEB_NAME=$(NAME)-dkms
-VERSION=$(shell dpkg-parsechangelog |grep ^Version:|cut -d ' ' -f 2)
+DEB_NAME=tempesta-fw
 
 %:
-	dh $@ --with dkms --with systemd
+	dh $@ --with systemd
 
 override_dh_auto_install:
-	dh_install fw usr/src/$(NAME)-$(VERSION)
-	dh_install db usr/src/$(NAME)-$(VERSION)
-	dh_install tls usr/src/$(NAME)-$(VERSION)
-	dh_install lib usr/src/$(NAME)-$(VERSION)
-	dh_install Makefile usr/src/$(NAME)-$(VERSION)
+	dh_install fw usr/src/tempesta
+	dh_install db usr/src/tempesta
+	dh_install tls usr/src/tempesta
+	dh_install lib usr/src/tempesta
+	dh_install Makefile usr/src/tempesta
 	dh_install etc/* /etc/tempesta
 	dh_install scripts /lib/tempesta
 	dh_install utils /lib/tempesta
-	find "debian/$(DEB_NAME)/usr/src/$(NAME)-$(VERSION)" -name '.git*' -exec rm {} \;
-
-override_dh_dkms:
-	dh_dkms -V $(VERSION)
+	find "debian/$(DEB_NAME)/usr/src/tempesta" -name '.git*' -exec rm {} \;
 
 override_dh_installinit:
 	dh_installinit --no-start --no-restart-on-upgrade --noscripts --name=tempesta-fw

pkg/debian/rules

@@ -5,10 +5,10 @@ After=network.target
 
 [Service]
 Type=oneshot
-Environment="TFW_PATH=/lib/modules/%v/updates/dkms"
-Environment="TDB_PATH=/lib/modules/%v/updates/dkms"
-Environment="TLS_PATH=/lib/modules/%v/updates/dkms"
-Environment="LIB_PATH=/lib/modules/%v/updates/dkms"
+Environment="TFW_PATH=/usr/src/tempesta/fw"
+Environment="TDB_PATH=/usr/src/tempesta/db/core"
+Environment="TLS_PATH=/usr/src/tempesta/tls"
+Environment="LIB_PATH=/usr/src/tempesta/lib"
 Environment=TFW_CFG_PATH=/etc/tempesta/tempesta_fw.conf
 Environment="TFW_SYSTEMD=1"
 RemainAfterExit=yes