nixos/bird: rename bird2 to bird, switch to bird3 by default

This is done in view of the Release of the new v3 of Bird.

Switch to the bird3 package for the `services.bird.package` option.

Switch the `bird` package alias to bird3.

Changed files
+46 -38
nixos
doc
manual
release-notes
modules
services
monitoring
prometheus
exporters
networking
tests
pkgs
top-level
+2
nixos/doc/manual/release-notes/rl-2505.section.md
···
- `tldr` now uses [`tldr-python-client`](https://github.com/tldr-pages/tldr-python-client) instead of [`tldr-c-client`](https://github.com/tldr-pages/tldr-c-client) which is unmaintained.
+
- `services.bird2` has been renamed to `services.bird` and the default bird package has been switched to `bird3`. `bird2` can still be choosen via the `services.bird.package` option.
+
- `renovate` was updated to v39. See the [upstream release notes](https://docs.renovatebot.com/release-notes-for-major-versions/#version-39) for breaking changes.
Like upstream's docker images, renovate now runs on NodeJS 22.
+1 -1
nixos/modules/services/monitoring/prometheus/exporters/bird.nix
···
};
serviceOpts = {
serviceConfig = {
-
SupplementaryGroups = singleton (if cfg.birdVersion == 1 then "bird" else "bird2");
+
SupplementaryGroups = "bird";
ExecStart = ''
${pkgs.prometheus-bird-exporter}/bin/bird_exporter \
-web.listen-address ${cfg.listenAddress}:${toString cfg.port} \
+1 -1
nixos/modules/services/networking/bird-lg.nix
···
groups."bird-lg" = lib.mkIf (cfg.group == "bird-lg") { };
users."bird-lg" = lib.mkIf (cfg.user == "bird-lg") {
description = "Bird Looking Glass user";
-
extraGroups = lib.optionals (config.services.bird2.enable) [ "bird2" ];
+
extraGroups = lib.optionals (config.services.bird.enable) [ "bird" ];
group = cfg.group;
isSystemUser = true;
};
+25 -19
nixos/modules/services/networking/bird.nix
···
types
;
-
cfg = config.services.bird2;
+
cfg = config.services.bird;
caps = [
"CAP_NET_ADMIN"
"CAP_NET_BIND_SERVICE"
···
{
###### interface
options = {
-
services.bird2 = {
+
services.bird = {
enable = mkEnableOption "BIRD Internet Routing Daemon";
-
package = lib.mkPackageOption pkgs "bird2" { };
+
package = lib.mkPackageOption pkgs "bird3" { };
config = mkOption {
type = types.lines;
description = ''
···
type = types.bool;
default = true;
description = ''
-
Whether bird2 should be automatically reloaded when the configuration changes.
+
Whether bird should be automatically reloaded when the configuration changes.
'';
};
checkConfig = mkOption {
···
'';
description = ''
Commands to execute before the config file check. The file to be checked will be
-
available as `bird2.conf` in the current directory.
+
available as `bird.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")
+
(lib.mkRemovedOptionModule [ "services" "bird2" ]
+
"Use services.bird instead. bird3 is the new default bird package. You can choose to remain with bird2 by setting the service.bird.package option."
+
)
+
(lib.mkRemovedOptionModule [ "services" "bird6" ] "Use services.bird instead")
];
###### implementation
config = mkIf cfg.enable {
environment.systemPackages = [ cfg.package ];
-
environment.etc."bird/bird2.conf".source = pkgs.writeTextFile {
-
name = "bird2";
+
environment.etc."bird/bird.conf".source = pkgs.writeTextFile {
+
name = "bird";
text = cfg.config;
derivationArgs.nativeBuildInputs = lib.optional cfg.checkConfig cfg.package;
checkPhase = optionalString cfg.checkConfig ''
-
ln -s $out bird2.conf
+
ln -s $out bird.conf
${cfg.preCheckConfig}
-
bird -d -p -c bird2.conf
+
bird -d -p -c bird.conf
'';
};
-
systemd.services.bird2 = {
+
systemd.services.bird = {
description = "BIRD Internet Routing Daemon";
wantedBy = [ "multi-user.target" ];
-
reloadTriggers = lib.optional cfg.autoReload config.environment.etc."bird/bird2.conf".source;
+
reloadTriggers = lib.optional cfg.autoReload config.environment.etc."bird/bird.conf".source;
serviceConfig = {
Type = "forking";
Restart = "on-failure";
-
User = "bird2";
-
Group = "bird2";
-
ExecStart = "${lib.getExe' cfg.package "bird"} -c /etc/bird/bird2.conf";
+
User = "bird";
+
Group = "bird";
+
ExecStart = "${lib.getExe' cfg.package "bird"} -c /etc/bird/bird.conf";
ExecReload = "${lib.getExe' cfg.package "birdc"} configure";
ExecStop = "${lib.getExe' cfg.package "birdc"} down";
RuntimeDirectory = "bird";
···
};
};
users = {
-
users.bird2 = {
+
users.bird = {
description = "BIRD Internet Routing Daemon user";
-
group = "bird2";
+
group = "bird";
isSystemUser = true;
};
-
groups.bird2 = { };
+
groups.bird = { };
};
+
};
+
+
meta = {
+
maintainers = with lib.maintainers; [ herbetom ];
};
}
+1 -1
nixos/modules/services/networking/birdwatcher.nix
···
[bird]
listen = "0.0.0.0:29184"
-
config = "/etc/bird/bird2.conf"
+
config = "/etc/bird/bird.conf"
birdc = "''${pkgs.bird}/bin/birdc"
ttl = 5 # time to live (in minutes) for caching of cli output
+8 -8
nixos/tests/bird.nix
···
inherit (import ../lib/testing-python.nix { inherit system pkgs; }) makeTest;
inherit (pkgs.lib) optionalString;
-
makeBird2Host =
+
makeBirdHost =
hostId:
{ pkgs, ... }:
{
···
networkConfig.Address = "10.0.0.${hostId}/24";
};
-
services.bird2 = {
+
services.bird = {
enable = true;
config = ''
···
};
in
makeTest {
-
name = "bird2";
+
name = "bird";
-
nodes.host1 = makeBird2Host "1";
-
nodes.host2 = makeBird2Host "2";
+
nodes.host1 = makeBirdHost "1";
+
nodes.host2 = makeBirdHost "2";
testScript = ''
start_all()
-
host1.wait_for_unit("bird2.service")
-
host2.wait_for_unit("bird2.service")
-
host1.succeed("systemctl reload bird2.service")
+
host1.wait_for_unit("bird.service")
+
host2.wait_for_unit("bird.service")
+
host1.succeed("systemctl reload bird.service")
with subtest("Waiting for advertised IPv4 routes"):
host1.wait_until_succeeds("ip --json r | jq -e 'map(select(.dst == \"10.10.0.2\")) | any'")
+3 -3
nixos/tests/birdwatcher.nix
···
nodes = {
host1 = {
environment.systemPackages = with pkgs; [ jq ];
-
services.bird2 = {
+
services.bird = {
enable = true;
config = ''
log syslog all;
···
filter_fields = []
[bird]
listen = "0.0.0.0:29184"
-
config = "/etc/bird/bird2.conf"
+
config = "/etc/bird/bird.conf"
birdc = "${pkgs.bird}/bin/birdc"
ttl = 5 # time to live (in minutes) for caching of cli output
[parser]
···
testScript = ''
start_all()
-
host1.wait_for_unit("bird2.service")
+
host1.wait_for_unit("bird.service")
host1.wait_for_unit("birdwatcher.service")
host1.wait_for_open_port(29184)
host1.succeed("curl http://[::]:29184/status | jq -r .status.message | grep 'Daemon is up and running'")
+2 -2
nixos/tests/fastnetmon-advanced.nix
···
{ ... }:
{
networking.firewall.allowedTCPPorts = [ 179 ];
-
services.bird2 = {
+
services.bird = {
enable = true;
config = ''
router id 192.168.1.1;
···
''
start_all()
fnm.wait_for_unit("fastnetmon.service")
-
bird.wait_for_unit("bird2.service")
+
bird.wait_for_unit("bird.service")
fnm.wait_until_succeeds('journalctl -eu fastnetmon.service | grep "BGP daemon restarted correctly"')
fnm.wait_until_succeeds("journalctl -eu gobgp.service | grep BGP_FSM_OPENCONFIRM")
+2 -2
nixos/tests/prometheus-exporters.nix
···
enable = true;
};
metricProvider = {
-
services.bird2.enable = true;
-
services.bird2.config = ''
+
services.bird.enable = true;
+
services.bird.config = ''
router id 127.0.0.1;
protocol kernel MyObviousTestString {
+1 -1
pkgs/top-level/aliases.nix
···
bibata-extra-cursors = throw "bibata-cursors has been removed as it was broken"; # Added 2024-07-15
bitcoin-unlimited = throw "bitcoin-unlimited has been removed as it was broken and unmaintained"; # Added 2024-07-15
bitcoind-unlimited = throw "bitcoind-unlimited has been removed as it was broken and unmaintained"; # Added 2024-07-15
-
bird = bird2; # Added 2025-01-11
+
bird = bird3; # Added 2025-01-11
bisq-desktop = throw "bisq-desktop has been removed because OpenJFX 11 was removed"; # Added 2024-11-17
bitwarden = bitwarden-desktop; # Added 2024-02-25
blender-with-packages = args: