mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-01-06 04:53:27 +00:00
a63a884c00
In a critical setup of bird with many BGP sessions, you want to control the exact time when configuration changes are applied. Therefore, an option was added, to disable automatic reloading the systemd unit, when configuration changes are made. The administrator how has the ability to control how changes are applied.
110 lines
3.4 KiB
Nix
110 lines
3.4 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
let
|
|
inherit (lib) mkEnableOption mkIf mkOption optionalString types;
|
|
|
|
cfg = config.services.bird2;
|
|
caps = [ "CAP_NET_ADMIN" "CAP_NET_BIND_SERVICE" "CAP_NET_RAW" ];
|
|
in
|
|
{
|
|
###### interface
|
|
options = {
|
|
services.bird2 = {
|
|
enable = mkEnableOption (lib.mdDoc "BIRD Internet Routing Daemon");
|
|
config = mkOption {
|
|
type = types.lines;
|
|
description = lib.mdDoc ''
|
|
BIRD Internet Routing Daemon configuration file.
|
|
<http://bird.network.cz/>
|
|
'';
|
|
};
|
|
autoReload = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = lib.mdDoc ''
|
|
Whether bird2 should be automatically reloaded when the configuration changes.
|
|
'';
|
|
};
|
|
checkConfig = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = lib.mdDoc ''
|
|
Whether the config should be checked at build time.
|
|
When the config can't be checked during build time, for example when it includes
|
|
other files, either disable this option or use `preCheckConfig` to create
|
|
the included files before checking.
|
|
'';
|
|
};
|
|
preCheckConfig = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
example = ''
|
|
echo "cost 100;" > include.conf
|
|
'';
|
|
description = lib.mdDoc ''
|
|
Commands to execute before the config file check. The file to be checked will be
|
|
available as `bird2.conf` in the current directory.
|
|
|
|
Files created with this option will not be available at service runtime, only during
|
|
build time checking.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
|
|
imports = [
|
|
(lib.mkRemovedOptionModule [ "services" "bird" ] "Use services.bird2 instead")
|
|
(lib.mkRemovedOptionModule [ "services" "bird6" ] "Use services.bird2 instead")
|
|
];
|
|
|
|
###### implementation
|
|
config = mkIf cfg.enable {
|
|
environment.systemPackages = [ pkgs.bird ];
|
|
|
|
environment.etc."bird/bird2.conf".source = pkgs.writeTextFile {
|
|
name = "bird2";
|
|
text = cfg.config;
|
|
checkPhase = optionalString cfg.checkConfig ''
|
|
ln -s $out bird2.conf
|
|
${cfg.preCheckConfig}
|
|
${pkgs.buildPackages.bird}/bin/bird -d -p -c bird2.conf
|
|
'';
|
|
};
|
|
|
|
systemd.services.bird2 = {
|
|
description = "BIRD Internet Routing Daemon";
|
|
wantedBy = [ "multi-user.target" ];
|
|
reloadTriggers = lib.optional cfg.autoReload config.environment.etc."bird/bird2.conf".source;
|
|
serviceConfig = {
|
|
Type = "forking";
|
|
Restart = "on-failure";
|
|
User = "bird2";
|
|
Group = "bird2";
|
|
ExecStart = "${pkgs.bird}/bin/bird -c /etc/bird/bird2.conf";
|
|
ExecReload = "${pkgs.bird}/bin/birdc configure";
|
|
ExecStop = "${pkgs.bird}/bin/birdc down";
|
|
RuntimeDirectory = "bird";
|
|
CapabilityBoundingSet = caps;
|
|
AmbientCapabilities = caps;
|
|
ProtectSystem = "full";
|
|
ProtectHome = "yes";
|
|
ProtectKernelTunables = true;
|
|
ProtectControlGroups = true;
|
|
PrivateTmp = true;
|
|
PrivateDevices = true;
|
|
SystemCallFilter = "~@cpu-emulation @debug @keyring @module @mount @obsolete @raw-io";
|
|
MemoryDenyWriteExecute = "yes";
|
|
};
|
|
};
|
|
users = {
|
|
users.bird2 = {
|
|
description = "BIRD Internet Routing Daemon user";
|
|
group = "bird2";
|
|
isSystemUser = true;
|
|
};
|
|
groups.bird2 = { };
|
|
};
|
|
};
|
|
}
|