path: root/gnu/packages/high-availability.scm

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2018 Christopher Baines <mail@cbaines.net>
;;; Copyright © 2020 Brice Waegeneire <brice@waegenei.re>
;;; Copyright © 2020, 2022 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2022, 2024 Sharlatan Hellseher <sharlatanus@gmail.com>
;;; Copyright © 2023 Benjamin <benjamin@uvy.fr>
;;; Copyright © 2024 jgart <jgart@dismail.de>
;;; Copyright © 2024 Jordan Moore <lockbox@struct.foo>
;;; Copyright © 2025 Artur Wroblewski <wrobell@riseup.net>
;;;
;;; This file is part of GNU Guix.
;;;
;;; This program is free software: you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published by
;;; the Free Software Foundation, either version 3 of the License, or
;;; (at your option) any later version.
;;;
;;; This program is distributed in the hope that it will be useful,
;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; This module provides package definitions related for High Availability (HA)
;; software, which come as foundation to create clusterization and load
;; balancing of services.

;;; Code:

(define-module (gnu packages high-availability)
  #:use-module (gnu packages autotools)
  #:use-module (gnu packages base)
  #:use-module (gnu packages bash)
  #:use-module (gnu packages check)
  #:use-module (gnu packages cluster)
  #:use-module (gnu packages compression)
  #:use-module (gnu packages crypto)
  #:use-module (gnu packages documentation)
  #:use-module (gnu packages elixir)
  #:use-module (gnu packages erlang)
  #:use-module (gnu packages gcc)
  #:use-module (gnu packages gettext)
  #:use-module (gnu packages glib)
  #:use-module (gnu packages golang-build)
  #:use-module (gnu packages golang-check)
  #:use-module (gnu packages golang-compression)
  #:use-module (gnu packages golang-crypto)
  #:use-module (gnu packages golang-web)
  #:use-module (gnu packages golang-xyz)
  #:use-module (gnu packages hardware)
  #:use-module (gnu packages libevent)
  #:use-module (gnu packages linux)
  #:use-module (gnu packages lua)
  #:use-module (gnu packages networking)
  #:use-module (gnu packages nss)
  #:use-module (gnu packages pcre)
  #:use-module (gnu packages pkg-config)
  #:use-module (gnu packages python)
  #:use-module (gnu packages rsync)
  #:use-module (gnu packages sqlite)
  #:use-module (gnu packages tls)
  #:use-module (gnu packages valgrind)
  #:use-module (gnu packages version-control)
  #:use-module (gnu packages xml)
  #:use-module (gnu packages)
  #:use-module (guix build-system gnu)
  #:use-module (guix build-system go)
  #:use-module (guix download)
  #:use-module (guix gexp)
  #:use-module (guix git-download)
  #:use-module (guix packages)
  #:use-module (guix utils)
  #:use-module ((guix licenses)
                #:prefix license:))

(define-public cowsql
  ;; Use the latest commit which includs
  ;; <https://github.com/cowsql/cowsql/pull/37>, revert back to vertion tags
  ;; when released.
  (let ((commit "cb624d3263ca22b42ecfa8a1dd8a0c8d990db7b6")
        (revision "0"))
    (package
      (name "cowsql")
      (version (git-version "1.15.8" revision commit))
      (source
       (origin
         (method git-fetch)
         (uri (git-reference
                (url "https://github.com/cowsql/cowsql")
                (commit commit)))
         (file-name (git-file-name name version))
         (sha256
          (base32 "0b4ymmsp9y9zzwanp739bc6p5qzl1h6ny2g50blhda99xcnlaf77"))))
      (build-system gnu-build-system)
      (arguments
       (list
        #:phases
        #~(modify-phases %standard-phases
            (replace 'bootstrap
              (lambda _
                (invoke "autoreconf" "-vfi"))))))
      (native-inputs
       (list autoconf
             automake
             libtool
             pkg-config))
      (inputs
       (list cowsql-raft
             libuv
             sqlite))
      (home-page "https://github.com/cowsql/cowsql")
      (synopsis "Embeddable, replicated and fault tolerant SQL engine")
      (description
       "cowsql (/ˈkaʊ,siːkwəl/ listen) is a C library that implements an
embeddable and replicated SQL database engine with high availability and
automatic failover.

cowsql extends SQLite with a network protocol that can connect together
various instances of your application and have them act as a highly-available
cluster, with no dependency on external databases.")
      (license license:gpl3+))))

(define-public cowsql-raft
  (package
    (name "cowsql-raft")
    (version "0.22.1")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
              (url "https://github.com/cowsql/raft")
              (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1cs70jlc2hg3hrcwpc4h54l4zpwm287mlamdm7gxhpdw7c0kyv38"))))
    (build-system gnu-build-system)
    (arguments
     (list
      #:phases
      #~(modify-phases %standard-phases
          (replace 'bootstrap
            (lambda _
              (invoke "autoreconf" "-vfi"))))))
    (native-inputs
     (list autoconf
           automake
           libtool
           pkg-config))
    (inputs
     (list libuv
           lz4))
    (home-page "https://github.com/cowsql/raft")
    (synopsis "Asynchronous C implementation of the Raft consensus protocol")
    (description
     "This package implements a Raft algorithm logic (no I/O and no system
calls).  On top of that, various drivers are provided that implement actual
network communication and persistent data storage.

The core part of the library is designed to work well with asynchronous or
non-blocking I/O engines (such as libuv and io_uring), although it can be used
in threaded or blocking contexts as well.")
    (license license:lgpl3)))

(define-public haproxy
  (package
    (name "haproxy")
    (version "3.1.1")
    (source
     (origin
       (method url-fetch)
       (uri (string-append "https://www.haproxy.org/download/"
                           (version-major+minor version)
                           "/src/haproxy-" version ".tar.gz"))
       (sha256
        (base32 "0wyjyzazlwpi3hm4ri699lhyzbb703i5fp240bk7icm4kd1ms6wc"))))
    (build-system gnu-build-system)
    (arguments
     (list
      #:tests? #f  ; there are only regression tests, using varnishtest
      #:make-flags
      #~(list "LUA_LIB_NAME=lua"
              "TARGET=linux-glibc"
              "USE_LUA=1"
              "USE_OPENSSL=1"
              "USE_PCRE2=1"
              "USE_PCRE2_JIT=1"
              "USE_PROMEX=1"
              "USE_ZLIB=1"
              (string-append "CC=" #$(cc-for-target))
              (string-append "DOCDIR=" #$output "/share/" #$name)
              (string-append "LUA_INC=" #$(this-package-input "lua") "/include")
              (string-append "LUA_LIB=" #$(this-package-input "lua") "/lib")
              (string-append "PREFIX=" #$output))
      #:phases
      #~(modify-phases %standard-phases
          (delete 'configure))))
    (inputs
     (list libxcrypt lua openssl pcre2 zlib))
    (home-page "https://www.haproxy.org/")
    (synopsis "Reliable, high performance TCP/HTTP load balancer")
    (description "HAProxy offers @acronym{HA, high availability}, load
balancing, and proxying for TCP and HTTP-based applications.  It is particularly
suited to Web sites crawling under very high loads while needing persistence or
Layer 7 processing.  Supporting tens of thousands of connections is clearly
realistic with today's hardware.")
    (license (list license:gpl2+
                   license:lgpl2.1
                   license:lgpl2.1+))))

(define-public libqb
  (package
    (name "libqb")
    (version "2.0.8")
    (source (origin
              (method url-fetch)
              (uri (string-append
                    "https://github.com/ClusterLabs/libqb/releases/download/v"
                    version "/libqb-" version ".tar.xz"))
              (sha256
               (base32
                "1rifa94zrdr7d5gsy4yvkgqfx8f4yx4xr96hqvs05b5q43y329dl"))))
    (build-system gnu-build-system)
    (native-inputs (list pkg-config))
    (inputs (list libxml2))
    (home-page "https://clusterlabs.github.io/libqb/")
    (synopsis
     "Library providing high-performance logging, tracing, IPC, and polling")
    (description
     "Libqb is a library with the primary purpose of providing
high-performance, reusable features for client-server architecture, such as
logging, tracing, @acronym{IPC, inter-process communication} and polling.  Libqb
is not intended to be an all-encompassing library, but instead provide focused
APIs that are highly tuned for maximum performance for client-server
applications.")
    (license license:lgpl2.1)))

(define-public kronosnet
  (package
    (name "kronosnet")
    (version "1.30")
    (source (origin
              (method git-fetch)
              (uri (git-reference
                    (url "https://github.com/kronosnet/kronosnet")
                    (commit (string-append "v" version))))
              (file-name (git-file-name name version))
              (sha256
               (base32
                "1vpar3q49fb0s7g76kq39g4gzql38pcji6w71yf7c6n9k8vllcc9"))))
    (build-system gnu-build-system)
    (arguments
     ;; XXX: Multiple tests failed. Tests
     ;; require very complex environment and for some of them root privileges to
     ;; set network configuration. It has it's own CI based on Jenkis
     ;; https://ci.kronosnet.org/.
     (list #:tests? #f
           #:configure-flags #~'("--disable-static")
           #:phases #~(modify-phases %standard-phases
                        (add-before 'bootstrap 'fix-version-gen
                          (lambda _
                            (call-with-output-file ".tarball-version"
                              (lambda (port)
                                (display #$version port))))))))
    (native-inputs (list autoconf
                         automake
                         doxygen
                         libtool
                         net-tools
                         pkg-config))
    (inputs (list lksctp-tools
                  libnl
                  libqb
                  libxml2
                  lz4
                  lzo
                  nss
                  nspr
                  openssl
                  xz
                  zlib
                  `(,zstd "lib")))
    (home-page "https://kronosnet.org/")
    (synopsis "Network abstraction layer designed for High Availability")
    (description
     "Kronosnet, often referred to as @code{knet}, is a network
 abstraction layer designed for High Availability use cases, where redundancy,
 security, fault tolerance and fast fail-over are the core requirements of
 your application.

 Kronosnet is the new underlying network protocol for Linux HA components
 (Corosync), that features ability to use multiple links between nodes,
 active/active and active/passive link failover policies, automatic link
 recovery, FIPS compliant encryption (nss and/or openssl), automatic PMTUd and
 in general better performances compared to the old network protocol.")
    (license (list license:gpl2+ license:lgpl2.1+))))

(define-public nats-server
  (package
    (name "nats-server")
    (version "2.10.26")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/nats-io/nats-server")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "0mpmbsq14l1fbyz9wrfks8acbdikpwi25whlxz5w9wn8w7bd5rwc"))))
    (build-system go-build-system)
    (arguments
     (list
      #:install-source? #f
      #:import-path "github.com/nats-io/nats-server"
      ;; The test logic is taken from project's GitHub Actions workflow file
      ;; <.github/workflows/tests.yaml>.
      #:test-flags
      #~(list "-count=1" "-vet=off" "-failfast"
              "-skip" (string-join
                       (list "TestHTTPHost"
                             "TestSysLogger"
                             "TestLogMaxArchives")
                       "|") )
      #:test-subdirs
      #~(list "conf/..." "internal/..." "logger/..." "test/...")))
    (inputs
     (list go-github-com-klauspost-compress
           go-github-com-minio-highwayhash
           go-github-com-nats-io-jwt-v2
           go-github-com-nats-io-nats-go
           go-github-com-nats-io-nkeys
           go-github-com-nats-io-nuid
           go-go-uber-org-automaxprocs
           go-golang-org-x-crypto
           go-golang-org-x-sys
           go-golang-org-x-time))
    (home-page "https://github.com/nats-io/nats-server")
    (synopsis "High performance message broker")
    (description
     "NATS is a simple, secure and performant communications system for digital
systems, services and devices.  NATS is part of the Cloud Native Computing
Foundation (CNCF).  NATS has over 40 client language implementations, and its
server can run on-premise, in the cloud, at the edge, and even on a Raspberry
Pi.  NATS can secure and simplify design and operation of modern distributed
systems.")
    (license license:asl2.0)))

(define-public nsq
  (package
    (name "nsq")
    (version "1.3.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/nsqio/nsq")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32 "1227ricbng8r5svnpr6hkmwjafa74jdp3ivijrk55qhw43rjk05a"))))
    (build-system go-build-system)
    (arguments
     (list
      #:import-path "github.com/nsqio/nsq"
      #:install-source? #f
      #:phases
      #~(modify-phases %standard-phases
          (replace 'build
            (lambda* (#:key import-path #:allow-other-keys)
              (with-directory-excursion (string-append "src/" import-path)
                (invoke "make"))))
          (replace 'check
            (lambda* (#:key tests? import-path #:allow-other-keys)
              (when tests?
                (setenv "HOME" "/tmp")
                (with-directory-excursion (string-append "src/" import-path)
                ;; go test: -race is only supported on linux/amd64,
                ;; linux/ppc64le, linux/arm64
                  (invoke #$@(if (not target-x86-32?)
                                 (list "go" "test" "-v" "-race" "./...")
                                 (list "go" "test" "-v" "./...")))))))
          (replace 'install
            (lambda* (#:key import-path #:allow-other-keys)
              (with-directory-excursion (string-append "src/" import-path)
                (invoke "make" (string-append "PREFIX=" #$output)
                        "install")))))))
    (native-inputs
     (list go-github-com-bitly-go-hostpool
           go-github-com-bitly-timer-metrics
           go-github-com-blang-semver
           go-github-com-bmizerany-perks-quantile
           go-github-com-burntsushi-toml
           go-github-com-davecgh-go-spew
           go-github-com-golang-snappy
           go-github-com-julienschmidt-httprouter
           go-github-com-mreiferson-go-options
           go-github-com-mreiferson-go-svc
           go-github-com-nsqio-go-diskqueue
           go-github-com-nsqio-go-nsq
           python-wrapper))
    (home-page "https://nsq.io")
    (synopsis "Realtime distributed messaging platform")
    (description
     "NSQ is a realtime distributed messaging platform designed to operate at
scale, handling billions of messages per day.

Key features:
@itemize
@item support distributed topologies without @acronym{SPOF, Single Point of
Failure}
@item scale horizontally (no brokers, seamlessly add more nodes to the
cluster)
@item low-latency push based message delivery (performance)
@item combine load-balanced and multicast style message routing
@item excel at both streaming (high-throughput) and job oriented
(low-throughput) workloads
@item primarily in-memory (beyond a high-water mark messages are transparently
kept on disk)
@item runtime discovery service for consumers to find producers (nsqlookupd)
@item transport layer security (TLS)
@item data format agnostic
@item few dependencies (easy to deploy) and a sane, bounded, default
configuration
@item simple TCP protocol supporting client libraries in any language
@item HTTP interface for stats, admin actions, and producers (no client
library needed to publish)
@item integrate with @acronym{StatsD, Stats aggregation Daemon} for realtime
instrumentation
@item robust cluster administration interface (nsqadmin)
@end itemize")
    (license license:expat)))

(define-public corosync
  (package
    (name "corosync")
    (version "3.1.9")
    (source (origin
              (method git-fetch)
              (uri (git-reference
                    (url "https://github.com/corosync/corosync")
                    (commit (string-append "v" version))))
              (file-name (git-file-name name version))
              (sha256
               (base32
                "1l6vgn61q3qv439lrdb9nnbkx5yvda6hy9da0jf3bggjdwqq9g3a"))))
    (build-system gnu-build-system)
    (arguments
     (list #:configure-flags #~'("--disable-static")
           #:phases #~(modify-phases %standard-phases
                        (add-before 'bootstrap 'fix-version-gen
                          (lambda _
                            (call-with-output-file ".tarball-version"
                              (lambda (port)
                                (display #$version port))))))))
    (native-inputs (list autoconf automake libtool pkg-config))
    (inputs (list kronosnet libqb))
    (home-page "https://corosync.github.io/corosync/")
    (synopsis
     "Group communication system for implementing High Availability in applications")
    (description
     "The Corosync Cluster Engine is a Group Communication System with additional
features for implementing high availability within applications.  The project
provides four C Application Programming Interface features:

@itemize

@item A closed process group communication model with extended virtual synchrony
guarantees for creating replicated state machines.

@item A simple availability manager that restarts the application process when
it has failed.

@item A configuration and statistics in-memory database that provide the ability
to set, retrieve, and receive change notifications of information.

@item A quorum system that notifies applications when quorum is achieved or
lost.

@end itemize")
    (license (list license:bsd-0 license:gpl3+))))

(define-public pacemaker
  (package
    (name "pacemaker")
    (version "2.1.9")
    (source (origin
              (method git-fetch)
              (uri (git-reference
                    (url "https://github.com/ClusterLabs/pacemaker")
                    (commit (string-append "Pacemaker-" version))))
              (file-name (git-file-name name version))
              (sha256
               (base32
                "154wnh7yrblq3jlcyqy19yvncjcy5sh73nphakhm0kq8qq64m208"))))
    (build-system gnu-build-system)
    (arguments
     (list #:configure-flags #~(list "--with-corosync" "--disable-static"
                                     (string-append "--with-initdir="
                                                    #$output "/etc/init.d")
                                     (string-append "--with-ocfdir="
                                                    #$output "/lib"))))
    (native-inputs (list autoconf
                         automake
                         cmocka
                         gettext-minimal
                         libtool
                         pkg-config
                         rsync
                         util-linux
                         valgrind/pinned))
    (inputs (list dbus
                  corosync
                  glib
                  gnutls
                  libqb
                  libxml2
                  libxslt
                  python
                  `(,util-linux "lib")))
    (home-page "https://www.clusterlabs.org/pacemaker/")
    (synopsis "Scalable High-Availability cluster resource manager")
    (description
     "Pacemaker is a high-availability cluster resource manager.

It achieves maximum availability for your cluster services (a.k.a. resources) by
detecting and recovering from node- and resource-level failures by making use of
the messaging and membership capabilities provided by Corosync.

It can do this for clusters of practically any size and comes with a powerful
dependency model that allows the administrator to accurately express the
relationships (both ordering and location) between the cluster resources.

Virtually anything that can be scripted can be managed as part of a Pacemaker cluster.")
    (license (list license:cc-by4.0 license:gpl2+ license:lgpl2.1+))))

(define-public rabbitmq
  (package
    (name "rabbitmq")
    (version "4.1.2")
    (source
     (origin
       (method url-fetch)
       (uri (string-append
             "https://github.com/rabbitmq/rabbitmq-server/releases/download/v"
             version "/rabbitmq-server-" version ".tar.xz"))
       (file-name (string-append name "-" version ".tar.xz"))
       (sha256
        (base32 "1dl2x5v4bj6sl51gw50aj9nch9sy03qhrfjap3k9x9jpkhm6g946"))
       (patches (search-patches "rabbitmq-defaults.patch"))))
    (build-system gnu-build-system)
    (arguments
     (list
      ;; Using parallel build leads to random build crashes.
      #:parallel-build? #f
      ;; The release page advises to use .tar.xz archive, but this file does not
      ;; contain files required to run RabbitMQ  tests (i.e.
      ;; deps/rabbitmq_ct_helpers is missing). If we change to the .tar.gz
      ;; archive, then we can run the tests, but that can take even few hours if
      ;; a machine is slow. We might need to pick a subset of the tests. See
      ;; RabbitMQ Arch Linux package for a candidate of a subset of tests.
      #:tests? #f
      #:make-flags
      #~(list (string-append "RMQ_ROOTDIR="
                             #$output)
              (string-append "RABBITMQ_VERSION="
                             #$version))
      #:phases
      #~(modify-phases %standard-phases
          ;; erlang.mk contains the entries
          ;;
          ;; ELIXIR_BIN ?= $(shell readlink -f `which elixir`)
          ;; ELIXIR_LIBS ?= $(abspath $(dir $(ELIXIR_BIN))/../lib)
          ;;
          ;; but fails to find elixir.app when building plugins.
          ;;
          ;; Despite the failures, the build is reported successful while some
          ;; plugins are not built. For example, running rabbitmqctl
          ;; command-line utility gives error
          ;;
          ;; undefined function Elixir.RabbitMQCtl':main/1
          ;;
          ;; After changing `dir` to `dirname`, all plugins build successfully
          ;; and it is possible to use the command-line utilities.
          (add-after 'unpack 'extract-rabbitmq-sources
            (lambda _
              (substitute* "erlang.mk"
                (("dir \\$\\(ELIXIR_BIN\\)")
                 "shell dirname \\$\\(ELIXIR_BIN\\)"))))
          (add-after 'install 'wrap-rabbitmq
            (lambda* (#:key outputs inputs #:allow-other-keys)
              (let ((sbindir (string-append #$output "/lib/rabbitmq_server-"
                                            #$version "/sbin"))
                    (rabbitmq-programs (list "rabbitmqctl"
                                             "rabbitmq-diagnostics"
                                             "rabbitmq-plugins"
                                             "rabbitmq-queues"
                                             "rabbitmq-server"
                                             "rabbitmq-streams"
                                             "rabbitmq-upgrade")))
                ;; Starting RabbitMQ server requires: getconf, df, erl.
                (wrap-program (string-append sbindir "/rabbitmq-server")
                  `("PATH" ":" prefix
                    (,(dirname (search-input-file inputs "bin/getconf"))
                     ,(dirname (search-input-file inputs "bin/df"))
                     ,(dirname (search-input-file inputs "bin/erl")))))
                ;; Each of the RabbitMQ programs requires Erlang cookie
                ;; stored in RabbitMQ'S user home directory.
                (for-each (lambda (prog)
                            (wrap-program (string-append sbindir "/" prog)
                              `("PATH" suffix
                                (,(string-append #$erlang "/bin")))
                              `("HOME" =
                                ("/var/lib/rabbitmq")))) rabbitmq-programs))))
          (delete 'configure)
          (add-after 'install 'patch-scripts
            (lambda* (#:key inputs outputs #:allow-other-keys)
              (substitute* (string-append #$output "/lib/rabbitmq_server-"
                                          #$version "/sbin/rabbitmq-env")
                (("basename")
                 (which "basename"))
                (("dirname")
                 (which "dirname"))
                (("readlink")
                 (which "readlink")))))
          (add-after 'install 'install-bin
            (lambda* (#:key inputs outputs #:allow-other-keys)
              (let ((target (string-append #$output "/sbin"))
                    (sbindir (string-append #$output "/lib/rabbitmq_server-"
                                            #$version "/sbin"))
                    (rabbitmq-programs (list "rabbitmqctl"
                                             "rabbitmq-diagnostics"
                                             "rabbitmq-plugins"
                                             "rabbitmq-queues"
                                             "rabbitmq-server"
                                             "rabbitmq-streams"
                                             "rabbitmq-upgrade")))
                (mkdir-p target)
                (for-each (lambda (prog)
                            (symlink (string-append sbindir "/" prog)
                                     (string-append target "/" prog)))
                          rabbitmq-programs)))))))
    (inputs (list bash-minimal))
    (native-inputs (list erlang elixir python-wrapper which p7zip))
    (synopsis
     "Messaging and streaming broker supporting multiple open protocols")
    (description
     "RabbitMQ is a messaging and streaming broker that supports multiple
messaging protocols, including AMQP 1.0 and MQTT 5.0.  It offers features
such as message routing, filtering, streaming, federation, and clustering.
It is designed for reliability and flexibility.")
    (home-page "https://www.rabbitmq.com/")
    (license license:asl2.0)))