Build packages for Debian

Author: valeriansaliou

.github/workflows/build.yml

@@ -59,6 +59,24 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+  build-packages:
+    needs: build-releases
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Build packages
+        run: ./scripts/build_packages.sh
+
+      - name: Push packages to Packagecloud
+        uses: faucetsdn/action-packagecloud-upload-debian-packages@v1
+        with:
+          path: ./packages
+          repo: ${{ secrets.PACKAGECLOUD_REPO }}
+          token: ${{ secrets.PACKAGECLOUD_TOKEN }}
+
   build-docker:
     runs-on: ubuntu-latest
 

PACKAGING.md

@@ -9,7 +9,7 @@ We consider here the packaging flow of Vigil version `1.0.0` for Linux.
     1. Bump version in `Cargo.toml` to `1.0.0`
     2. Execute `cargo update` to bump `Cargo.lock`
 
-2. **How to build Vigil, package it and release it on Crates, GitHub and Docker Hub (multiple architectures):**
+2. **How to build Vigil, package it and release it on Crates, GitHub, Docker Hub and Packagecloud (multiple architectures):**
     1. Tag the latest Git commit corresponding to the release with tag `v1.0.0`, and push the tag
     2. Wait for all release jobs to complete on the [actions](https://github.com/valeriansaliou/vigil/actions) page on GitHub
     3. Download all release archives, and sign them locally using: `./scripts/sign_binaries.sh --version=1.0.0`

README.md

@@ -94,6 +94,44 @@ Vigil is built in Rust. To install it, either download a version from the [Vigil
 
 👉 _Each release binary comes with an `.asc` signature file, which can be verified using [@valeriansaliou](https://github.com/valeriansaliou) GPG public key: [:key:valeriansaliou.gpg.pub.asc](https://valeriansaliou.name/files/keys/valeriansaliou.gpg.pub.asc)._
 
+**Install from packages:**
+
+Vigil provides [pre-built packages](https://packagecloud.io/valeriansaliou/vigil) for Debian-based systems (Debian, Ubuntu, etc.).
+
+**Important: Vigil only provides 64 bits packages targeting Debian 10, 11 & 12 for now (codenames: `buster`, `bullseye` & `bookworm`). You will still be able to use them on other Debian versions, as well as Ubuntu.**
+
+First, add the Vigil APT repository (eg. for Debian `bookworm`):
+
+```bash
+echo "deb https://packagecloud.io/valeriansaliou/vigil/debian/ bookworm main" > /etc/apt/sources.list.d/valeriansaliou_vigil.list
+```
+
+```bash
+curl --silent -L https://packagecloud.io/valeriansaliou/vigil/gpgkey | apt-key add -
+```
+
+```bash
+apt-get update
+```
+
+Then, install the Vigil package:
+
+```bash
+apt-get install vigil
+```
+
+Then, edit the pre-filled Vigil configuration file:
+
+```bash
+nano /etc/vigil.cfg
+```
+
+Finally, restart Vigil:
+
+```
+service vigil restart
+```
+
 **Install from Cargo:**
 
 If you prefer managing `vigil` via Rust's Cargo, install it directly via `cargo install`:

debian/changelog

@@ -0,0 +1,5 @@
+vigil (0.0.0-1) UNRELEASED; urgency=medium
+
+  * Initial release.
+
+ -- Valerian Saliou <[email protected]>  Tue, 31 Aug 2023 12:00:00 +0000

debian/compat

@@ -0,0 +1 @@
+10

debian/control

@@ -0,0 +1,13 @@
+Source: vigil
+Section: net
+Priority: ext
+Maintainer: Valerian Saliou <[email protected]>
+Standards-Version: 3.9.4
+Build-Depends: wget, ca-certificates
+Homepage: https://github.com/valeriansaliou/vigil
+
+Package: vigil
+Architecture: any
+Depends: adduser
+Provides: vigil
+Description: Microservices Status Page. Monitors a distributed infrastructure and sends alerts.

debian/copyright

@@ -0,0 +1,13 @@
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: vigil
+Upstream-Contact: Valerian Saliou <[email protected]>
+Source: https://github.com/valeriansaliou/vigil
+
+Files: *
+Copyright: 2023 Valerian Saliou
+License: MPL-2
+
+License: MPL-2
+ This Source Code Form is subject to the terms of the Mozilla Public License,
+ v. 2.0. If a copy of the MPL was not distributed with this file,
+ You can obtain one at http://mozilla.org/MPL/2.0/.

debian/rules

@@ -0,0 +1,30 @@
+#!/usr/bin/make -f
+
+DISTRIBUTION = $(shell lsb_release -sr)
+VERSION = 1.26.0
+PACKAGEVERSION = $(VERSION)-0~$(DISTRIBUTION)0
+URL = https://github.com/valeriansaliou/vigil/releases/download/v$(VERSION)/
+
+%:
+		dh $@ --with systemd
+
+override_dh_auto_clean:
+override_dh_auto_test:
+override_dh_auto_build:
+override_dh_auto_install:
+		$(eval ENV_ARCH := $(shell dpkg --print-architecture))
+		$(eval ENV_ISA := $(shell if [ "$(ENV_ARCH)" = "amd64" ]; then echo "x86_64"; else echo "$(ENV_ARCH)"; fi))
+		$(eval ENV_TARBALL := v$(VERSION)-$(ENV_ISA).tar.gz)
+
+		echo "Architecture: $(ENV_ARCH)"
+		echo "Instruction Set: $(ENV_ISA)"
+		echo "Target: $(URL)$(ENV_TARBALL)"
+
+		wget -N --progress=dot:mega $(URL)$(ENV_TARBALL)
+		tar -xf $(ENV_TARBALL)
+		strip vigil/vigil
+		mv vigil/config.cfg vigil/vigil.cfg
+		sed -i 's/path = ".\/res\/assets\/"/path = "\/etc\/vigil\/assets\/"/g' vigil/vigil.cfg
+
+override_dh_gencontrol:
+		dh_gencontrol -- -v$(PACKAGEVERSION)

debian/source/format

@@ -0,0 +1 @@
+3.0 (quilt)

debian/vigil.install

@@ -0,0 +1,3 @@
+vigil/vigil usr/bin/
+vigil/vigil.cfg etc/
+res/assets/ etc/

debian/vigil.postinst

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+set -e
+
+case "$1" in
+    configure)
+        adduser --system --disabled-password --disabled-login --home /var/empty \
+                --no-create-home --quiet --group vigil
+        ;;
+esac
+
+#DEBHELPER#
+
+exit 0

debian/vigil.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=Microservices Status Page
+After=network.target
+
+[Service]
+Type=simple
+User=vigil
+Group=vigil
+ExecStartPre=/sbin/setcap 'cap_net_raw+ep' /bin/vigil
+ExecStart=/usr/bin/vigil -c /etc/vigil.cfg
+Restart=on-failure
+PermissionsStartOnly=true
+
+[Install]
+WantedBy=multi-user.target

scripts/build_packages.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+##
+#  Vigil
+#
+#  Microservices Status Page
+#  Copyright: 2023, Valerian Saliou <[email protected]>
+#  License: Mozilla Public License v2.0 (MPL v2.0)
+##
+
+# Define build pipeline
+function build_for_target {
+    OS="$2" DIST="$3" ARCH="$1" ./packpack/packpack
+    release_result=$?
+
+    if [ $release_result -eq 0 ]; then
+        mkdir -p "./packages/$2_$3/"
+        mv ./build/*$4 "./packages/$2_$3/"
+
+        echo "Result: Packaged architecture: $1 for OS: $2:$3 (*$4)"
+    fi
+
+    return $release_result
+}
+
+# Run release tasks
+ABSPATH=$(cd "$(dirname "$0")"; pwd)
+BASE_DIR="$ABSPATH/../"
+
+rc=0
+
+pushd "$BASE_DIR" > /dev/null
+    echo "Executing packages build steps for Vigil..."
+
+    # Initialize `packpack`
+    rm -rf ./packpack && \
+        git clone https://github.com/packpack/packpack.git packpack
+    rc=$?
+
+    # Proceed build for each target?
+    if [ $rc -eq 0 ]; then
+        build_for_target "x86_64" "debian" "buster" ".deb" && \
+            build_for_target "x86_64" "debian" "bullseye" ".deb" && \
+            build_for_target "x86_64" "debian" "bookworm" ".deb"
+        rc=$?
+    fi
+
+    # Cleanup environment
+    rm -rf ./build ./packpack
+
+    if [ $rc -eq 0 ]; then
+        echo "Success: Done executing packages build steps for Vigil"
+    else
+        echo "Error: Failed executing packages build steps for Vigil"
+    fi
+popd > /dev/null
+
+exit $rc