GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee
;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2020, 2022 Marius Bakke <marius@gnu.org> ;;; ;;; This file is part of GNU Guix. ;;; ;;; GNU Guix 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. ;;; ;;; GNU Guix 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 GNU Guix. If not, see <http://www.gnu.org/licenses/>. (define-module (gnu services ganeti) #:use-module (gnu packages virtualization) #:use-module (gnu services) #:use-module (gnu services mcron) #:use-module (gnu services shepherd) #:use-module (guix gexp) #:use-module (guix records) #:use-module (srfi srfi-1) #:use-module (ice-9 match) #:export (ganeti-noded-configuration ganeti-noded-configuration? ganeti-noded-configuration-ganeti ganeti-noded-configuration-port ganeti-noded-configuration-address ganeti-noded-configuration-interface ganeti-noded-configuration-max-clients ganeti-noded-configuration-ssl? ganeti-noded-configuration-ssl-key ganeti-noded-configuration-ssl-cert ganeti-noded-configuration-debug? ganeti-noded-service-type ganeti-confd-configuration ganeti-confd-configuration? ganeti-confd-configuration-ganeti ganeti-confd-configuration-port ganeti-confd-configuration-address ganeti-confd-configuration-debug ganeti-confd-service-type ganeti-wconfd-configuration ganeti-wconfd-configuration? ganeti-wconfd-configuration-ganeti ganeti-wconfd-configuration-no-voting? ganeti-wconfd-configuration-debug? ganeti-wconfd-service-type ganeti-luxid-configuration ganeti-luxid-configuration? ganeti-luxid-configuration-ganeti ganeti-luxid-configuration-no-voting? ganeti-luxid-configuration-debug? ganeti-luxid-service-type ganeti-rapi-configuration ganeti-rapi-configuration? ganeti-rapi-configuration-ganeti ganeti-rapi-configuration-require-authentication? ganeti-rapi-configuration-port ganeti-rapi-configuration-address ganeti-rapi-configuration-interface ganeti-rapi-configuration-max-clients ganeti-rapi-configuration-ssl? ganeti-rapi-configuration-ssl-key ganeti-rapi-configuration-ssl-cert ganeti-rapi-configuration-debug? ganeti-rapi-service-type ganeti-kvmd-configuration ganeti-kvmd-configuration? ganeti-kvmd-configuration-ganeti ganeti-kvmd-configuration-debug? ganeti-kvmd-service-type ganeti-mond-configuration ganeti-mond-configuration? ganeti-mond-configuration-ganeti ganeti-mond-configuration-port ganeti-mond-configuration-address ganeti-mond-configuration-debug? ganeti-mond-service-type ganeti-metad-configuration ganeti-metad-configuration? ganeti-metad-configuration-ganeti ganeti-metad-configuration-port ganeti-metad-configuration-address ganeti-metad-configuration-debug? ganeti-metad-service-type ganeti-watcher-configuration ganeti-watcher-configuration? ganeti-watcher-configuration-ganeti ganeti-watcher-configuration-schedule ganeti-watcher-configuration-rapi-ip ganeti-watcher-configuration-job-age ganeti-watcher-configuration-verify-disks? ganeti-watcher-configuration-debug? ganeti-watcher-service-type ganeti-cleaner-configuration ganeti-cleaner-configuration? ganeti-cleaner-configuration-ganeti ganeti-cleaner-configuration-master-schedule ganeti-cleaner-configuration-node-schedule ganeti-cleaner-service-type ganeti-os ganeti-os? ganeti-os-name ganeti-os-extension ganeti-os-variants ganeti-os-variant ganeti-os-variant? ganeti-os-variant-name ganeti-os-variant-configuration %debootstrap-interfaces-hook %debootstrap-grub-hook %default-debootstrap-hooks %default-debootstrap-extra-pkgs debootstrap-configuration debootstrap-configuration? debootstrap-configuration-hooks debootstrap-configuration-proxy debootstrap-configuration-mirror debootstrap-configuration-arch debootstrap-configuration-suite debootstrap-configuration-extra-pkgs debootstrap-configuration-components debootstrap-configuration-generate-cache? debootstrap-configuration-clean-cache debootstrap-configuration-partition-style debootstrap-configuration-partition-alignment debootstrap-variant debootstrap-os %default-debootstrap-variants guix-variant guix-os %default-guix-variants %default-ganeti-os ganeti-configuration ganeti-configuration? ganeti-configuration-noded-configuration ganeti-configuration-confd-configuration ganeti-configuration-wconfd-configuration ganeti-configuration-luxid-configuration ganeti-configuration-rapi-configuration ganeti-configuration-kvmd-configuration ganeti-configuration-mond-configuration ganeti-configuration-metad-configuration ganeti-configuration-watcher-configuration ganeti-configuration-cleaner-configuration ganeti-configuration-file-storage-paths ganeti-configuration-os ganeti-service-type)) ;;; ;;; Service definitions for running a Ganeti cluster. ;;; ;;; Planned improvements: run daemons (except ganeti-noded) under unprivileged ;;; user accounts and/or containers. The account names must match the ones ;;; given to Ganetis configure script. metad needs "setcap" or root in order ;;; to bind on port 80. ;; Set PATH so the various daemons are able to find the 'ip' executable, LVM, ;; Ceph, Gluster, etc, without having to add absolute references to everything. (define %default-ganeti-environment-variables (list (string-append "PATH=" (string-join '("/run/privileged/bin" "/run/current-system/profile/sbin" "/run/current-system/profile/bin") ":")))) (define-record-type* <ganeti-noded-configuration> ganeti-noded-configuration make-ganeti-noded-configuration ganeti-noded-configuration? (ganeti ganeti-noded-configuration-ganeti ;file-like (default ganeti)) (port ganeti-noded-configuration-port ;integer (default 1811)) (address ganeti-noded-configuration-address ;string (default "0.0.0.0")) (interface ganeti-noded-configuration-interface ;string | #f (default #f)) (max-clients ganeti-noded-configuration-max-clients ;integer (default 20)) (ssl? ganeti-noded-configuration-ssl? ;Boolean (default #t)) (ssl-key ganeti-noded-configuration-ssl-key ;string (default "/var/lib/ganeti/server.pem")) (ssl-cert ganeti-noded-configuration-ssl-cert ;string (default "/var/lib/ganeti/server.pem")) (debug? ganeti-noded-configuration-debug? ;Boolean (default #f))) (define ganeti-noded-service (match-lambda (($ <ganeti-noded-configuration> ganeti port address interface max-clients ssl? ssl-key ssl-cert debug?) (list (shepherd-service (documentation "Run the Ganeti node daemon.") (provision '(ganeti-noded)) (requirement '(user-processes networking)) ;; If the daemon stops, it is probably for a good reason; ;; otherwise ganeti-watcher will restart it for us anyway. (respawn? #f) (start #~(make-forkexec-constructor (list #$(file-append ganeti "/sbin/ganeti-noded") #$(string-append "--port=" (number->string port)) #$(string-append "--bind=" address) #$@(if interface #~((string-append "--interface=" #$interface)) #~()) #$(string-append "--max-clients=" (number->string max-clients)) #$@(if ssl? #~((string-append "--ssl-key=" #$ssl-key) (string-append "--ssl-cert=" #$ssl-cert)) #~("--no-ssl")) #$@(if debug? #~("--debug") #~())) #:environment-variables '#$%default-ganeti-environment-variables #:pid-file "/var/run/ganeti/ganeti-noded.pid")) (stop #~(make-kill-destructor))))))) (define ganeti-noded-service-type (service-type (name 'ganeti-noded) (extensions (list (service-extension shepherd-root-service-type ganeti-noded-service))) (default-value (ganeti-noded-configuration)) (description "@command{ganeti-noded} is the daemon which is responsible for the node functions in the Ganeti system."))) (define-record-type* <ganeti-confd-configuration> ganeti-confd-configuration make-ganeti-confd-configuration ganeti-confd-configuration? (ganeti ganeti-confd-configuration-ganeti ;file-like (default ganeti)) (port ganeti-confd-configuration-port ;integer (default 1814)) (address ganeti-confd-configuration-address ;string (default "0.0.0.0")) (debug? ganeti-confd-configuration-debug? ;Boolean (default #f))) (define ganeti-confd-service (match-lambda (($ <ganeti-confd-configuration> ganeti port address debug?) (list (shepherd-service (documentation "Run the Ganeti confd daemon.") (provision '(ganeti-confd)) (requirement '(user-processes networking)) (respawn? #f) (start #~(make-forkexec-constructor (list #$(file-append ganeti "/sbin/ganeti-confd") #$(string-append "--port=" (number->string port)) #$(string-append "--bind=" address) #$@(if debug? #~("--debug") #~())) #:environment-variables '#$%default-ganeti-environment-variables #:pid-file "/var/run/ganeti/ganeti-confd.pid")) (stop #~(make-kill-destructor))))))) (define ganeti-confd-service-type (service-type (name 'ganeti-confd) (extensions (list (service-extension shepherd-root-service-type ganeti-confd-service))) (default-value (ganeti-confd-configuration)) (description "@command{ganeti-confd} is a daemon used to answer queries related to the configuration of a Ganeti cluster."))) (define-record-type* <ganeti-wconfd-configuration> ganeti-wconfd-configuration make-ganeti-wconfd-configuration ganeti-wconfd-configuration? (ganeti ganeti-wconfd-configuration-ganeti ;file-like (default ganeti)) (no-voting? ganeti-wconfd-configuration-no-voting? ;Boolean (default #f)) (debug? ganeti-wconfd-configuration-debug? ;Boolean (default #f))) ;; If this file exists, the wconfd daemon will be forcefully started even on ;; non-master nodes. It is used to accommodate a master-failover scenario. (define %wconfd-force-node-hint "/var/lib/ganeti/guix_wconfd_force_node_hint") (define (wconfd-wrapper ganeti args) ;; Wrapper for the wconfd daemon that looks for the force-node hint. (program-file "wconfd-wrapper" #~(begin (let ((wconfd #$(file-append ganeti "/sbin/ganeti-wconfd")) (force-node? (file-exists? #$%wconfd-force-node-hint))) (if force-node? (execl wconfd wconfd "--force-node" "--no-voting" "--yes-do-it" #$@args) (execl wconfd wconfd #$@args)))))) (define shepherd-wconfd-force-start-action ;; Shepherd action to create the force-node hint and start wconfd. (shepherd-action (name 'force-start) (documentation "Forcefully start wconfd even on non-master nodes (dangerous!).") (procedure #~(lambda _ (format #t "Forcefully starting the wconfd daemon...~%") (action 'ganeti-wconfd 'enable) (dynamic-wind (lambda () (false-if-exception (call-with-output-file #$%wconfd-force-node-hint (lambda (port) (const #t))))) (lambda () (action 'ganeti-wconfd 'restart)) (lambda () (delete-file #$%wconfd-force-node-hint))) #t)))) (define ganeti-wconfd-service (match-lambda (($ <ganeti-wconfd-configuration> ganeti no-voting? debug?) (list (shepherd-service (documentation "Run the Ganeti wconfd daemon.") (provision '(ganeti-wconfd)) (requirement '(user-processes)) ;; Shepherd action to support a master-failover scenario. It is ;; automatically invoked during 'gnt-cluster master-failover' (see ;; related Ganeti patch) and not intended for interactive use. (actions (list shepherd-wconfd-force-start-action)) ;; wconfd will disable itself when not running on the master ;; node. Don't attempt to restart it. (respawn? #f) (start #~(make-forkexec-constructor (list #$(wconfd-wrapper ganeti (append (if no-voting? '("--no-voting" "--yes-do-it") '()) (if debug? '("--debug") '())))) #:environment-variables '#$%default-ganeti-environment-variables #:pid-file "/var/run/ganeti/ganeti-wconfd.pid")) (stop #~(make-kill-destructor))))))) (define ganeti-wconfd-service-type (service-type (name 'ganeti-wconfd) (extensions (list (service-extension shepherd-root-service-type ganeti-wconfd-service))) (default-value (ganeti-wconfd-configuration)) (description "@command{ganeti-wconfd} is the daemon that has authoritative knowledge about the configuration and is the only entity that can accept changes to it. All jobs that need to modify the configuration will do so by sending appropriate requests to this daemon."))) (define-record-type* <ganeti-luxid-configuration> ganeti-luxid-configuration make-ganeti-luxid-configuration ganeti-luxid-configuration? (ganeti ganeti-luxid-configuration-ganeti ;file-like (default ganeti)) (no-voting? ganeti-luxid-configuration-no-voting? ;Boolean (default #f)) (debug? ganeti-luxid-configuration-debug? ;Boolean (default #f))) (define ganeti-luxid-service (match-lambda (($ <ganeti-luxid-configuration> ganeti no-voting? debug?) (list (shepherd-service (documentation "Run the Ganeti LUXI daemon.") (provision '(ganeti-luxid)) (requirement '(user-processes)) ;; This service will automatically disable itself when not ;; running on the master node. Don't attempt to restart it. (respawn? #f) (start #~(make-forkexec-constructor (list #$(file-append ganeti "/sbin/ganeti-luxid") #$@(if no-voting? #~("--no-voting" "--yes-do-it") #~()) #$@(if debug? #~("--debug") #~())) #:environment-variables '#$%default-ganeti-environment-variables #:pid-file "/var/run/ganeti/ganeti-luxid.pid")) (stop #~(make-kill-destructor))))))) (define ganeti-luxid-service-type (service-type (name 'ganeti-luxid) (extensions (list (service-extension shepherd-root-service-type ganeti-luxid-service))) (default-value (ganeti-luxid-configuration)) (description "@command{ganeti-luxid} is a daemon used to answer queries related to the configuration and the current live state of a Ganeti cluster. Additionally, it is the authoritative daemon for the Ganeti job queue. Jobs can be submitted via this daemon and it schedules and starts them."))) (define-record-type* <ganeti-rapi-configuration> ganeti-rapi-configuration make-ganeti-rapi-configuration ganeti-rapi-configuration? (ganeti ganeti-rapi-configuration-ganeti ;file-like (default ganeti)) (require-authentication? ganeti-rapi-configuration-require-authentication? ;Boolean (default #f)) (port ganeti-rapi-configuration-port ;integer (default 5080)) (address ganeti-rapi-configuration-address ;string (default "0.0.0.0")) (interface ganeti-rapi-configuration-interface ;string | #f (default #f)) (max-clients ganeti-rapi-configuration-max-clients ;integer (default 20)) (ssl? ganeti-rapi-configuration-ssl? ;Boolean (default #t)) (ssl-key ganeti-rapi-configuration-ssl-key ;string (default "/var/lib/ganeti/server.pem")) (ssl-cert ganeti-rapi-configuration-ssl-cert ;string (default "/var/lib/ganeti/server.pem")) (debug? ganeti-rapi-configuration-debug? ;Boolean (default #f))) (define ganeti-rapi-service (match-lambda (($ <ganeti-rapi-configuration> ganeti require-authentication? port address interface max-clients ssl? ssl-key ssl-cert debug?) (list (shepherd-service (documentation "Run the Ganeti RAPI daemon.") (provision '(ganeti-rapi)) (requirement '(user-processes networking)) ;; This service will automatically disable itself when not ;; running on the master node. Don't attempt to restart it. (respawn? #f) (start #~(make-forkexec-constructor (list #$(file-append ganeti "/sbin/ganeti-rapi") #$@(if require-authentication? #~("--require-authentication") #~()) #$(string-append "--port=" (number->string port)) #$(string-append "--bind=" address) #$@(if interface #~((string-append "--interface=" #$interface)) #~()) #$(string-append "--max-clients=" (number->string max-clients)) #$@(if ssl? #~((string-append "--ssl-key=" #$ssl-key) (string-append "--ssl-cert=" #$ssl-cert)) #~("--no-ssl")) #$@(if debug? #~("--debug") #~())) #:environment-variables '#$%default-ganeti-environment-variables #:pid-file "/var/run/ganeti/ganeti-rapi.pid")) (stop #~(make-kill-destructor))))))) (define ganeti-rapi-service-type (service-type (name 'ganeti-rapi) (extensions (list (service-extension shepherd-root-service-type ganeti-rapi-service))) (default-value (ganeti-rapi-configuration)) (description "@command{ganeti-rapi} is the daemon providing a remote API for Ganeti clusters."))) (define-record-type* <ganeti-kvmd-configuration> ganeti-kvmd-configuration make-ganeti-kvmd-configuration ganeti-kvmd-configuration? (ganeti ganeti-kvmd-configuration-ganeti ;file-like (default ganeti)) (debug? ganeti-kvmd-configuration-debug? ;Boolean (default #f))) (define ganeti-kvmd-service (match-lambda (($ <ganeti-kvmd-configuration> ganeti debug?) (list (shepherd-service (documentation "Run the Ganeti KVM daemon.") (provision '(ganeti-kvmd)) (requirement '(user-processes)) ;; This service will automatically disable itself when not ;; needed. Don't attempt to restart it. (respawn? #f) (start #~(make-forkexec-constructor (list #$(file-append ganeti "/sbin/ganeti-kvmd") #$@(if debug? #~("--debug") #~())) #:environment-variables '#$%default-ganeti-environment-variables #:pid-file "/var/run/ganeti/ganeti-kvmd.pid")) (stop #~(make-kill-destructor))