commit 0098575c865cff58e2d7d4c11d2e42223712a3c2 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       744
       744
        
         ./services/networking/flannel.nix

     

       745
       745
        
         ./services/networking/freenet.nix

     

       746
       746
        
         ./services/networking/freeradius.nix

     

       747
       747
       +
         ./services/networking/frr.nix

     

       747
       748
        
         ./services/networking/gateone.nix

     

       748
       749
        
         ./services/networking/gdomap.nix

     

       749
       750
        
         ./services/networking/ghostunnel.nix

+211

nixos/modules/services/networking/frr.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
       

     

       7
       7
       +
         cfg = config.services.frr;

     

       8
       8
       +
       

     

       9
       9
       +
         services = [

     

       10
       10
       +
           "static"

     

       11
       11
       +
           "bgp"

     

       12
       12
       +
           "ospf"

     

       13
       13
       +
           "ospf6"

     

       14
       14
       +
           "rip"

     

       15
       15
       +
           "ripng"

     

       16
       16
       +
           "isis"

     

       17
       17
       +
           "pim"

     

       18
       18
       +
           "ldp"

     

       19
       19
       +
           "nhrp"

     

       20
       20
       +
           "eigrp"

     

       21
       21
       +
           "babel"

     

       22
       22
       +
           "sharp"

     

       23
       23
       +
           "pbr"

     

       24
       24
       +
           "bfd"

     

       25
       25
       +
           "fabric"

     

       26
       26
       +
         ];

     

       27
       27
       +
       

     

       28
       28
       +
         allServices = services ++ [ "zebra" ];

     

       29
       29
       +
       

     

       30
       30
       +
         isEnabled = service: cfg.${service}.enable;

     

       31
       31
       +
       

     

       32
       32
       +
         daemonName = service: if service == "zebra" then service else "${service}d";

     

       33
       33
       +
       

     

       34
       34
       +
         configFile = service:

     

       35
       35
       +
           let

     

       36
       36
       +
             scfg = cfg.${service};

     

       37
       37
       +
           in

     

       38
       38
       +
             if scfg.configFile != null then scfg.configFile

     

       39
       39
       +
             else pkgs.writeText "${daemonName service}.conf"

     

       40
       40
       +
               ''

     

       41
       41
       +
                 ! FRR ${daemonName service} configuration

     

       42
       42
       +
                 !

     

       43
       43
       +
                 hostname ${config.networking.hostName}

     

       44
       44
       +
                 log syslog

     

       45
       45
       +
                 service password-encryption

     

       46
       46
       +
                 !

     

       47
       47
       +
                 ${scfg.config}

     

       48
       48
       +
                 !

     

       49
       49
       +
                 end

     

       50
       50
       +
               '';

     

       51
       51
       +
       

     

       52
       52
       +
         serviceOptions = service:

     

       53
       53
       +
           {

     

       54
       54
       +
             enable = mkEnableOption "the FRR ${toUpper service} routing protocol";

     

       55
       55
       +
       

     

       56
       56
       +
             configFile = mkOption {

     

       57
       57
       +
               type = types.nullOr types.path;

     

       58
       58
       +
               default = null;

     

       59
       59
       +
               example = "/etc/frr/${daemonName service}.conf";

     

       60
       60
       +
               description = ''

     

       61
       61
       +
                 Configuration file to use for FRR ${daemonName service}.

     

       62
       62
       +
                 By default the NixOS generated files are used.

     

       63
       63
       +
               '';

     

       64
       64
       +
             };

     

       65
       65
       +
       

     

       66
       66
       +
             config = mkOption {

     

       67
       67
       +
               type = types.lines;

     

       68
       68
       +
               default = "";

     

       69
       69
       +
               example =

     

       70
       70
       +
                 let

     

       71
       71
       +
                   examples = {

     

       72
       72
       +
                     rip = ''

     

       73
       73
       +
                       router rip

     

       74
       74
       +
                         network 10.0.0.0/8

     

       75
       75
       +
                     '';

     

       76
       76
       +
       

     

       77
       77
       +
                     ospf = ''

     

       78
       78
       +
                       router ospf

     

       79
       79
       +
                         network 10.0.0.0/8 area 0

     

       80
       80
       +
                     '';

     

       81
       81
       +
       

     

       82
       82
       +
                     bgp = ''

     

       83
       83
       +
                       router bgp 65001

     

       84
       84
       +
                         neighbor 10.0.0.1 remote-as 65001

     

       85
       85
       +
                     '';

     

       86
       86
       +
                   };

     

       87
       87
       +
                 in

     

       88
       88
       +
                   examples.${service} or "";

     

       89
       89
       +
               description = ''

     

       90
       90
       +
                 ${daemonName service} configuration statements.

     

       91
       91
       +
               '';

     

       92
       92
       +
             };

     

       93
       93
       +
       

     

       94
       94
       +
             vtyListenAddress = mkOption {

     

       95
       95
       +
               type = types.str;

     

       96
       96
       +
               default = "localhost";

     

       97
       97
       +
               description = ''

     

       98
       98
       +
                 Address to bind to for the VTY interface.

     

       99
       99
       +
               '';

     

       100
       100
       +
             };

     

       101
       101
       +
       

     

       102
       102
       +
             vtyListenPort = mkOption {

     

       103
       103
       +
               type = types.nullOr types.int;

     

       104
       104
       +
               default = null;

     

       105
       105
       +
               description = ''

     

       106
       106
       +
                 TCP Port to bind to for the VTY interface.

     

       107
       107
       +
               '';

     

       108
       108
       +
             };

     

       109
       109
       +
           };

     

       110
       110
       +
       

     

       111
       111
       +
       in

     

       112
       112
       +
       

     

       113
       113
       +
       {

     

       114
       114
       +
       

     

       115
       115
       +
         ###### interface

     

       116
       116
       +
         imports = [

     

       117
       117
       +
           {

     

       118
       118
       +
             options.services.frr = {

     

       119
       119
       +
               zebra = (serviceOptions "zebra") // {

     

       120
       120
       +
                 enable = mkOption {

     

       121
       121
       +
                   type = types.bool;

     

       122
       122
       +
                   default = any isEnabled services;

     

       123
       123
       +
                   description = ''

     

       124
       124
       +
                     Whether to enable the Zebra routing manager.

     

       125
       125
       +
       

     

       126
       126
       +
                     The Zebra routing manager is automatically enabled

     

       127
       127
       +
                     if any routing protocols are configured.

     

       128
       128
       +
                   '';

     

       129
       129
       +
                 };

     

       130
       130
       +
               };

     

       131
       131
       +
             };

     

       132
       132
       +
           }

     

       133
       133
       +
           { options.services.frr = (genAttrs services serviceOptions); }

     

       134
       134
       +
         ];

     

       135
       135
       +
       

     

       136
       136
       +
         ###### implementation

     

       137
       137
       +
       

     

       138
       138
       +
         config = mkIf (any isEnabled allServices) {

     

       139
       139
       +
       

     

       140
       140
       +
           environment.systemPackages = [

     

       141
       141
       +
             pkgs.frr # for the vtysh tool

     

       142
       142
       +
           ];

     

       143
       143
       +
       

     

       144
       144
       +
           users.users.frr = {

     

       145
       145
       +
             description = "FRR daemon user";

     

       146
       146
       +
             isSystemUser = true;

     

       147
       147
       +
             group = "frr";

     

       148
       148
       +
           };

     

       149
       149
       +
       

     

       150
       150
       +
           users.groups = {

     

       151
       151
       +
             frr = {};

     

       152
       152
       +
             # Members of the frrvty group can use vtysh to inspect the FRR daemons

     

       153
       153
       +
             frrvty = { members = [ "frr" ]; };

     

       154
       154
       +
           };

     

       155
       155
       +
       

     

       156
       156
       +
           environment.etc = let

     

       157
       157
       +
             mkEtcLink = service: {

     

       158
       158
       +
               name = "frr/${service}.conf";

     

       159
       159
       +
               value.source = configFile service;

     

       160
       160
       +
             };

     

       161
       161
       +
           in

     

       162
       162
       +
             (builtins.listToAttrs

     

       163
       163
       +
             (map mkEtcLink (filter isEnabled allServices))) // {

     

       164
       164
       +
               "frr/vtysh.conf".text = "";

     

       165
       165
       +
             };

     

       166
       166
       +
       

     

       167
       167
       +
           systemd.tmpfiles.rules = [

     

       168
       168
       +
             "d /run/frr 0750 frr frr -"

     

       169
       169
       +
           ];

     

       170
       170
       +
       

     

       171
       171
       +
           systemd.services =

     

       172
       172
       +
             let

     

       173
       173
       +
               frrService = service:

     

       174
       174
       +
                 let

     

       175
       175
       +
                   scfg = cfg.${service};

     

       176
       176
       +
                   daemon = daemonName service;

     

       177
       177
       +
                 in

     

       178
       178
       +
                   nameValuePair daemon ({

     

       179
       179
       +
                     wantedBy = [ "multi-user.target" ];

     

       180
       180
       +
                     after = [ "network-pre.target" "systemd-sysctl.service" ] ++ lib.optionals (service != "zebra") [ "zebra.service" ];

     

       181
       181
       +
                     bindsTo = lib.optionals (service != "zebra") [ "zebra.service" ];

     

       182
       182
       +
                     wants = [ "network.target" ];

     

       183
       183
       +
       

     

       184
       184
       +
                     description = if service == "zebra" then "FRR Zebra routing manager"

     

       185
       185
       +
                       else "FRR ${toUpper service} routing daemon";

     

       186
       186
       +
       

     

       187
       187
       +
                     unitConfig.Documentation = if service == "zebra" then "man:zebra(8)"

     

       188
       188
       +
                       else "man:${daemon}(8) man:zebra(8)";

     

       189
       189
       +
       

     

       190
       190
       +
                     restartTriggers = [

     

       191
       191
       +
                       (configFile service)

     

       192
       192
       +
                     ];

     

       193
       193
       +
                     reloadIfChanged = true;

     

       194
       194
       +
       

     

       195
       195
       +
                     serviceConfig = {

     

       196
       196
       +
                       PIDFile = "frr/${daemon}.pid";

     

       197
       197
       +
                       ExecStart = "${pkgs.frr}/libexec/frr/${daemon} -f /etc/frr/${service}.conf"

     

       198
       198
       +
                         + optionalString (scfg.vtyListenAddress != "") " -A ${scfg.vtyListenAddress}"

     

       199
       199
       +
                         + optionalString (scfg.vtyListenPort != null) " -P ${toString scfg.vtyListenPort}";

     

       200
       200
       +
                       ExecReload = "${pkgs.python3.interpreter} ${pkgs.frr}/libexec/frr/frr-reload.py --reload --daemon ${daemonName service} --bindir ${pkgs.frr}/bin --rundir /run/frr /etc/frr/${service}.conf";

     

       201
       201
       +
                       Restart = "on-abnormal";

     

       202
       202
       +
                     };

     

       203
       203
       +
                   });

     

       204
       204
       +
              in

     

       205
       205
       +
                listToAttrs (map frrService (filter isEnabled allServices));

     

       206
       206
       +
       

     

       207
       207
       +
         };

     

       208
       208
       +
       

     

       209
       209
       +
         meta.maintainers = with lib.maintainers; [ woffs ];

     

       210
       210
       +
       

     

       211
       211
       +
       }