Introduce pyroscope packaging via nfpm

Signed-off-by: Wilfried Roset <[email protected]>

Author: wilfriedroset

Makefile

@@ -421,3 +421,6 @@ docs/%:
 .PHONY: run
 run: ## Run the pyroscope binary (pass parameters with 'make run PARAMS=-myparam')
 	./pyroscope $(PARAMS)
+
+packages: build
+	@tools/packaging/nfpm.sh

tools/packaging/nfpm.jsonnet

@@ -0,0 +1,52 @@
+local overrides = {
+  profilecli: {
+    description:
+      |||
+        profilecli is the command-line interface to pyroscope.
+      |||,
+  },
+
+  pyroscope: {
+    description: |||
+      Grafana Pyroscope is an open source software project for aggregating continuous
+      profiling data. Continuous profiling is an observability signal that allows you
+      to understand your workload's resources (CPU, memory, etc...) usage down to the
+      line number.
+    |||,
+    contents+: [
+      {
+        src: './tools/packaging/pyroscope.service',
+        dst: '/etc/systemd/system/pyroscope.service',
+      },
+      {
+        src: './cmd/pyroscope/pyroscope.yaml',
+        dst: '/etc/pyroscope/config.yml',
+        type: 'config|noreplace',
+      },
+    ],
+    scripts: {
+      postinstall: './tools/packaging/postinstall.sh',
+    },
+  },
+};
+
+local name = std.extVar('name');
+local arch = std.extVar('arch');
+local suffix = std.extVar('suffix');
+
+{
+  name: name,
+  arch: arch,
+  platform: 'linux',
+  version: '${DRONE_TAG}',
+  section: 'default',
+  provides: [name],
+  maintainer: 'Grafana Labs <[email protected]>',
+  vendor: 'Grafana Labs Inc',
+  homepage: 'https://grafana.com/pyroscope',
+  license: 'AGPL-3.0',
+  contents: [{
+    src: './dist/%s_linux_%s%s/%s' % [name, arch, suffix, name],
+    dst: '/usr/bin/%s' % name,
+  }],
+} + overrides[name]

tools/packaging/nfpm.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+if [[ -z "${NFPM_SIGNING_KEY_FILE}" ]]; then
+  echo "NFPM_SIGNING_KEY_FILE is not set"
+  exit 1
+fi
+if [[ -z "${NFPM_PASSPHRASE}" ]]; then
+  echo "NFPM_PASSPHRASE is not set"
+  exit 1
+fi
+
+rm -rf dist/tmp && mkdir -p dist/tmp/packages
+
+for name in pyroscope profilecli; do
+  for arch in amd64 arm64; do
+    config_path="dist/tmp/config-${name}-${arch}.json"
+    suffix=""
+    if [ $arch = "amd64" ]; then
+      suffix="_v1"
+    fi
+    jsonnet -V "name=${name}" -V "arch=${arch}" -V "suffix=${suffix}" "tools/packaging/nfpm.jsonnet" >"${config_path}"
+    nfpm package -f "${config_path}" -p rpm -t dist/
+    nfpm package -f "${config_path}" -p deb -t dist/
+  done
+done
+
+rm -rf dist/tmp

tools/packaging/postinstall.sh

@@ -0,0 +1,62 @@
+#!/bin/sh
+
+# Based on https://nfpm.goreleaser.com/tips/
+
+if ! command -V systemctl >/dev/null 2>&1; then
+  echo "Could not find systemd. Skipping system installation." && exit 0
+else
+    systemd_version=$(systemctl --version | awk '/systemd /{print $2}')
+fi
+
+cleanInstall() {
+    printf "\033[32m Post Install of a clean install\033[0m\n"
+
+    # Create the user
+    if ! id pyroscope > /dev/null 2>&1 ; then
+        adduser --system --shell /bin/false "pyroscope"
+    fi
+
+    # rhel/centos7 cannot use ExecStartPre=+ to specify the pre start should be run as root
+    # even if you want your service to run as non root.
+    if [ "${systemd_version}" -lt 231 ]; then
+        printf "\033[31m systemd version %s is less then 231, fixing the service file \033[0m\n" "${systemd_version}"
+        sed -i "s/=+/=/g" /etc/systemd/system/pyroscope.service
+    fi
+    printf "\033[32m Reload the service unit from disk\033[0m\n"
+    systemctl daemon-reload ||:
+    printf "\033[32m Unmask the service\033[0m\n"
+    systemctl unmask pyroscope ||:
+    printf "\033[32m Set the preset flag for the service unit\033[0m\n"
+    systemctl preset pyroscope ||:
+    printf "\033[32m Set the enabled flag for the service unit\033[0m\n"
+    systemctl enable pyroscope ||:
+    systemctl restart pyroscope ||:
+}
+
+upgrade() {
+    :
+    # printf "\033[32m Post Install of an upgrade\033[0m\n"
+}
+
+action="$1"
+if  [ "$1" = "configure" ] && [ -z "$2" ]; then
+  # Alpine linux does not pass args, and deb passes $1=configure
+  action="install"
+elif [ "$1" = "configure" ] && [ -n "$2" ]; then
+    # deb passes $1=configure $2=<current version>
+    action="upgrade"
+fi
+
+case "${action}" in
+  "1" | "install")
+    cleanInstall
+    ;;
+  "2" | "upgrade")
+    upgrade
+    ;;
+  *)
+    # $1 == version being installed
+    printf "\033[32m Alpine\033[0m"
+    cleanInstall
+    ;;
+esac

tools/packaging/pyroscope.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=Pyroscope service
+After=network.target
+
+[Service]
+Type=simple
+User=pyroscope
+ExecStart=/usr/bin/pyroscope -config.file /etc/pyroscope/config.yml
+# Give a reasonable amount of time for the server to start up/shut down
+TimeoutSec = 120
+Restart = on-failure
+RestartSec = 2
+
+[Install]
+WantedBy=multi-user.target