320 lines
11 KiB
Nix
320 lines
11 KiB
Nix
{ config, lib, options, pkgs, ... }:
|
|
|
|
let
|
|
cfg = config.services.zabbixServer;
|
|
opt = options.services.zabbixServer;
|
|
pgsql = config.services.postgresql;
|
|
mysql = config.services.mysql;
|
|
|
|
inherit (lib) mkAfter mkDefault mkEnableOption mkIf mkMerge mkOption;
|
|
inherit (lib) attrValues concatMapStringsSep getName literalExpression optional optionalAttrs optionalString types;
|
|
inherit (lib.generators) toKeyValue;
|
|
|
|
user = "zabbix";
|
|
group = "zabbix";
|
|
runtimeDir = "/run/zabbix";
|
|
stateDir = "/var/lib/zabbix";
|
|
passwordFile = "${runtimeDir}/zabbix-dbpassword.conf";
|
|
|
|
moduleEnv = pkgs.symlinkJoin {
|
|
name = "zabbix-server-module-env";
|
|
paths = attrValues cfg.modules;
|
|
};
|
|
|
|
configFile = pkgs.writeText "zabbix_server.conf" (toKeyValue { listsAsDuplicateKeys = true; } cfg.settings);
|
|
|
|
mysqlLocal = cfg.database.createLocally && cfg.database.type == "mysql";
|
|
pgsqlLocal = cfg.database.createLocally && cfg.database.type == "pgsql";
|
|
|
|
in
|
|
|
|
{
|
|
imports = [
|
|
(lib.mkRenamedOptionModule [ "services" "zabbixServer" "dbServer" ] [ "services" "zabbixServer" "database" "host" ])
|
|
(lib.mkRemovedOptionModule [ "services" "zabbixServer" "dbPassword" ] "Use services.zabbixServer.database.passwordFile instead.")
|
|
(lib.mkRemovedOptionModule [ "services" "zabbixServer" "extraConfig" ] "Use services.zabbixServer.settings instead.")
|
|
];
|
|
|
|
# interface
|
|
|
|
options = {
|
|
|
|
services.zabbixServer = {
|
|
enable = mkEnableOption (lib.mdDoc "the Zabbix Server");
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = if cfg.database.type == "mysql" then pkgs.zabbix.server-mysql else pkgs.zabbix.server-pgsql;
|
|
defaultText = literalExpression "pkgs.zabbix.server-pgsql";
|
|
description = lib.mdDoc "The Zabbix package to use.";
|
|
};
|
|
|
|
extraPackages = mkOption {
|
|
type = types.listOf types.package;
|
|
default = with pkgs; [ nettools nmap traceroute ];
|
|
defaultText = literalExpression "[ nettools nmap traceroute ]";
|
|
description = lib.mdDoc ''
|
|
Packages to be added to the Zabbix {env}`PATH`.
|
|
Typically used to add executables for scripts, but can be anything.
|
|
'';
|
|
};
|
|
|
|
modules = mkOption {
|
|
type = types.attrsOf types.package;
|
|
description = lib.mdDoc "A set of modules to load.";
|
|
default = {};
|
|
example = literalExpression ''
|
|
{
|
|
"dummy.so" = pkgs.stdenv.mkDerivation {
|
|
name = "zabbix-dummy-module-''${cfg.package.version}";
|
|
src = cfg.package.src;
|
|
buildInputs = [ cfg.package ];
|
|
sourceRoot = "zabbix-''${cfg.package.version}/src/modules/dummy";
|
|
installPhase = '''
|
|
mkdir -p $out/lib
|
|
cp dummy.so $out/lib/
|
|
''';
|
|
};
|
|
}
|
|
'';
|
|
};
|
|
|
|
database = {
|
|
type = mkOption {
|
|
type = types.enum [ "mysql" "pgsql" ];
|
|
example = "mysql";
|
|
default = "pgsql";
|
|
description = lib.mdDoc "Database engine to use.";
|
|
};
|
|
|
|
host = mkOption {
|
|
type = types.str;
|
|
default = "localhost";
|
|
description = lib.mdDoc "Database host address.";
|
|
};
|
|
|
|
port = mkOption {
|
|
type = types.port;
|
|
default = if cfg.database.type == "mysql" then mysql.port else pgsql.port;
|
|
defaultText = literalExpression ''
|
|
if config.${opt.database.type} == "mysql"
|
|
then config.${options.services.mysql.port}
|
|
else config.${options.services.postgresql.port}
|
|
'';
|
|
description = lib.mdDoc "Database host port.";
|
|
};
|
|
|
|
name = mkOption {
|
|
type = types.str;
|
|
default = "zabbix";
|
|
description = lib.mdDoc "Database name.";
|
|
};
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = "zabbix";
|
|
description = lib.mdDoc "Database user.";
|
|
};
|
|
|
|
passwordFile = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = null;
|
|
example = "/run/keys/zabbix-dbpassword";
|
|
description = lib.mdDoc ''
|
|
A file containing the password corresponding to
|
|
{option}`database.user`.
|
|
'';
|
|
};
|
|
|
|
socket = mkOption {
|
|
type = types.nullOr types.path;
|
|
default = null;
|
|
example = "/run/postgresql";
|
|
description = lib.mdDoc "Path to the unix socket file to use for authentication.";
|
|
};
|
|
|
|
createLocally = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = lib.mdDoc "Whether to create a local database automatically.";
|
|
};
|
|
};
|
|
|
|
listen = {
|
|
ip = mkOption {
|
|
type = types.str;
|
|
default = "0.0.0.0";
|
|
description = lib.mdDoc ''
|
|
List of comma delimited IP addresses that the trapper should listen on.
|
|
Trapper will listen on all network interfaces if this parameter is missing.
|
|
'';
|
|
};
|
|
|
|
port = mkOption {
|
|
type = types.port;
|
|
default = 10051;
|
|
description = lib.mdDoc ''
|
|
Listen port for trapper.
|
|
'';
|
|
};
|
|
};
|
|
|
|
openFirewall = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Open ports in the firewall for the Zabbix Server.
|
|
'';
|
|
};
|
|
|
|
settings = mkOption {
|
|
type = with types; attrsOf (oneOf [ int str (listOf str) ]);
|
|
default = {};
|
|
description = lib.mdDoc ''
|
|
Zabbix Server configuration. Refer to
|
|
<https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server>
|
|
for details on supported values.
|
|
'';
|
|
example = {
|
|
CacheSize = "1G";
|
|
SSHKeyLocation = "/var/lib/zabbix/.ssh";
|
|
StartPingers = 32;
|
|
};
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
# implementation
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
assertions = [
|
|
{ assertion = cfg.database.createLocally -> cfg.database.user == user && cfg.database.user == cfg.database.name;
|
|
message = "services.zabbixServer.database.user must be set to ${user} if services.zabbixServer.database.createLocally is set true";
|
|
}
|
|
{ assertion = cfg.database.createLocally -> cfg.database.passwordFile == null;
|
|
message = "a password cannot be specified if services.zabbixServer.database.createLocally is set to true";
|
|
}
|
|
];
|
|
|
|
services.zabbixServer.settings = mkMerge [
|
|
{
|
|
LogType = "console";
|
|
ListenIP = cfg.listen.ip;
|
|
ListenPort = cfg.listen.port;
|
|
# TODO: set to cfg.database.socket if database type is pgsql?
|
|
DBHost = optionalString (cfg.database.createLocally != true) cfg.database.host;
|
|
DBName = cfg.database.name;
|
|
DBUser = cfg.database.user;
|
|
PidFile = "${runtimeDir}/zabbix_server.pid";
|
|
SocketDir = runtimeDir;
|
|
FpingLocation = "/run/wrappers/bin/fping";
|
|
LoadModule = builtins.attrNames cfg.modules;
|
|
}
|
|
(mkIf (cfg.database.createLocally != true) { DBPort = cfg.database.port; })
|
|
(mkIf (cfg.database.passwordFile != null) { Include = [ "${passwordFile}" ]; })
|
|
(mkIf (mysqlLocal && cfg.database.socket != null) { DBSocket = cfg.database.socket; })
|
|
(mkIf (cfg.modules != {}) { LoadModulePath = "${moduleEnv}/lib"; })
|
|
];
|
|
|
|
networking.firewall = mkIf cfg.openFirewall {
|
|
allowedTCPPorts = [ cfg.listen.port ];
|
|
};
|
|
|
|
services.mysql = optionalAttrs mysqlLocal {
|
|
enable = true;
|
|
package = mkDefault pkgs.mariadb;
|
|
};
|
|
|
|
systemd.services.mysql.postStart = mkAfter (optionalString mysqlLocal ''
|
|
( echo "CREATE DATABASE IF NOT EXISTS \`${cfg.database.name}\` CHARACTER SET utf8 COLLATE utf8_bin;"
|
|
echo "CREATE USER IF NOT EXISTS '${cfg.database.user}'@'localhost' IDENTIFIED WITH ${if (getName config.services.mysql.package == getName pkgs.mariadb) then "unix_socket" else "auth_socket"};"
|
|
echo "GRANT ALL PRIVILEGES ON \`${cfg.database.name}\`.* TO '${cfg.database.user}'@'localhost';"
|
|
) | ${config.services.mysql.package}/bin/mysql -N
|
|
'');
|
|
|
|
services.postgresql = optionalAttrs pgsqlLocal {
|
|
enable = true;
|
|
ensureDatabases = [ cfg.database.name ];
|
|
ensureUsers = [
|
|
{ name = cfg.database.user;
|
|
ensureDBOwnership = true;
|
|
}
|
|
];
|
|
};
|
|
|
|
users.users.${user} = {
|
|
description = "Zabbix daemon user";
|
|
uid = config.ids.uids.zabbix;
|
|
inherit group;
|
|
};
|
|
|
|
users.groups.${group} = {
|
|
gid = config.ids.gids.zabbix;
|
|
};
|
|
|
|
security.wrappers = {
|
|
fping =
|
|
{ setuid = true;
|
|
owner = "root";
|
|
group = "root";
|
|
source = "${pkgs.fping}/bin/fping";
|
|
};
|
|
};
|
|
|
|
systemd.services.zabbix-server = {
|
|
description = "Zabbix Server";
|
|
|
|
wantedBy = [ "multi-user.target" ];
|
|
after = optional mysqlLocal "mysql.service" ++ optional pgsqlLocal "postgresql.service";
|
|
|
|
path = [ "/run/wrappers" ] ++ cfg.extraPackages;
|
|
preStart = ''
|
|
# pre 19.09 compatibility
|
|
if test -e "${runtimeDir}/db-created"; then
|
|
mv "${runtimeDir}/db-created" "${stateDir}/"
|
|
fi
|
|
'' + optionalString pgsqlLocal ''
|
|
if ! test -e "${stateDir}/db-created"; then
|
|
cat ${cfg.package}/share/zabbix/database/postgresql/schema.sql | ${pgsql.package}/bin/psql ${cfg.database.name}
|
|
cat ${cfg.package}/share/zabbix/database/postgresql/images.sql | ${pgsql.package}/bin/psql ${cfg.database.name}
|
|
cat ${cfg.package}/share/zabbix/database/postgresql/data.sql | ${pgsql.package}/bin/psql ${cfg.database.name}
|
|
touch "${stateDir}/db-created"
|
|
fi
|
|
'' + optionalString mysqlLocal ''
|
|
if ! test -e "${stateDir}/db-created"; then
|
|
cat ${cfg.package}/share/zabbix/database/mysql/schema.sql | ${mysql.package}/bin/mysql ${cfg.database.name}
|
|
cat ${cfg.package}/share/zabbix/database/mysql/images.sql | ${mysql.package}/bin/mysql ${cfg.database.name}
|
|
cat ${cfg.package}/share/zabbix/database/mysql/data.sql | ${mysql.package}/bin/mysql ${cfg.database.name}
|
|
touch "${stateDir}/db-created"
|
|
fi
|
|
'' + optionalString (cfg.database.passwordFile != null) ''
|
|
# create a copy of the supplied password file in a format zabbix can consume
|
|
touch ${passwordFile}
|
|
chmod 0600 ${passwordFile}
|
|
echo -n "DBPassword = " > ${passwordFile}
|
|
cat ${cfg.database.passwordFile} >> ${passwordFile}
|
|
'';
|
|
|
|
serviceConfig = {
|
|
ExecStart = "@${cfg.package}/sbin/zabbix_server zabbix_server -f --config ${configFile}";
|
|
Restart = "always";
|
|
RestartSec = 2;
|
|
|
|
User = user;
|
|
Group = group;
|
|
RuntimeDirectory = "zabbix";
|
|
StateDirectory = "zabbix";
|
|
PrivateTmp = true;
|
|
};
|
|
};
|
|
|
|
systemd.services.httpd.after =
|
|
optional (config.services.zabbixWeb.enable && mysqlLocal) "mysql.service" ++
|
|
optional (config.services.zabbixWeb.enable && pgsqlLocal) "postgresql.service";
|
|
|
|
};
|
|
|
|
}
|