commit 6298d3e530ee25b42490d790a960cecf5d89dcd4 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2505.section.md

···

       43
       43
        
       

     

       44
       44
        
       - [Omnom](https://github.com/asciimoo/omnom), a webpage bookmarking and snapshotting service. Available as [services.omnom](options.html#opt-services.omnom.enable).

     

       45
       45
        
       

     

       46
       46
       +
       - [Zenoh](https://zenoh.io/), a pub/sub/query protocol with low overhead. The Zenoh router daemon is available as [services.zenohd](options.html#opt-services.zenohd.enable)

     

       47
       47
       +
       

     

       46
       48
        
       - [MaryTTS](https://github.com/marytts/marytts), an open-source, multilingual text-to-speech synthesis system written in pure Java. Available as [services.marytts](options.html#opt-services.marytts).

     

       47
       49
        
       

     

       48
       50
        
       - [networking.modemmanager](options.html#opt-networking.modemmanager) has been split out of [networking.networkmanager](options.html#opt-networking.networkmanager). NetworkManager still enables ModemManager by default, but options exist now to run NetworkManager without ModemManager.

nixos/modules/module-list.nix

···

       1315
       1315
        
         ./services/networking/yggdrasil.nix

     

       1316
       1316
        
         ./services/networking/zapret.nix

     

       1317
       1317
        
         ./services/networking/zerobin.nix

     

       1318
       1318
       +
         ./services/networking/zenohd.nix

     

       1318
       1319
        
         ./services/networking/zeronet.nix

     

       1319
       1320
        
         ./services/networking/zerotierone.nix

     

       1320
       1321
        
         ./services/networking/zeronsd.nix

+136

nixos/modules/services/networking/zenohd.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         config,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit (lib)

     

       10
       10
       +
           types

     

       11
       11
       +
           mkDefault

     

       12
       12
       +
           mkOption

     

       13
       13
       +
           ;

     

       14
       14
       +
       

     

       15
       15
       +
         json = pkgs.formats.json { };

     

       16
       16
       +
       

     

       17
       17
       +
         cfg = config.services.zenohd;

     

       18
       18
       +
       

     

       19
       19
       +
       in

     

       20
       20
       +
       {

     

       21
       21
       +
         options = {

     

       22
       22
       +
           services.zenohd = {

     

       23
       23
       +
             enable = lib.mkEnableOption "Zenoh daemon.";

     

       24
       24
       +
       

     

       25
       25
       +
             package = mkOption {

     

       26
       26
       +
               description = "The zenoh package to use.";

     

       27
       27
       +
               type = types.package;

     

       28
       28
       +
               default = pkgs.zenoh;

     

       29
       29
       +
               defaultText = "pkgs.zenoh";

     

       30
       30
       +
             };

     

       31
       31
       +
       

     

       32
       32
       +
             settings = mkOption {

     

       33
       33
       +
               description = ''

     

       34
       34
       +
                 Config options for `zenoh.json5` configuration file.

     

       35
       35
       +
       

     

       36
       36
       +
                 See <https://github.com/eclipse-zenoh/zenoh/blob/main/DEFAULT_CONFIG.json5>

     

       37
       37
       +
                 for more information.

     

       38
       38
       +
               '';

     

       39
       39
       +
               default = { };

     

       40
       40
       +
               type = types.submodule {

     

       41
       41
       +
                 freeformType = json.type;

     

       42
       42
       +
               };

     

       43
       43
       +
             };

     

       44
       44
       +
       

     

       45
       45
       +
             plugins = mkOption {

     

       46
       46
       +
               description = "Plugin packages to add to zenohd search paths.";

     

       47
       47
       +
               type = with types; listOf package;

     

       48
       48
       +
               default = [ ];

     

       49
       49
       +
               example = lib.literalExpression ''

     

       50
       50
       +
                 [ pkgs.zenoh-plugin-mqtt ]

     

       51
       51
       +
               '';

     

       52
       52
       +
             };

     

       53
       53
       +
       

     

       54
       54
       +
             backends = mkOption {

     

       55
       55
       +
               description = "Storage backend packages to add to zenohd search paths.";

     

       56
       56
       +
               type = with types; listOf package;

     

       57
       57
       +
               default = [ ];

     

       58
       58
       +
               example = lib.literalExpression ''

     

       59
       59
       +
                 [ pkgs.zenoh-backend-rocksdb ]

     

       60
       60
       +
               '';

     

       61
       61
       +
             };

     

       62
       62
       +
       

     

       63
       63
       +
             home = mkOption {

     

       64
       64
       +
               description = "Base directory for zenohd related files defined via ZENOH_HOME.";

     

       65
       65
       +
               type = types.str;

     

       66
       66
       +
               default = "/var/lib/zenoh";

     

       67
       67
       +
             };

     

       68
       68
       +
       

     

       69
       69
       +
             env = mkOption {

     

       70
       70
       +
               description = ''

     

       71
       71
       +
                 Set environment variables consumed by zenohd and its plugins.

     

       72
       72
       +
               '';

     

       73
       73
       +
               type = with types; attrsOf str;

     

       74
       74
       +
               default = { };

     

       75
       75
       +
             };

     

       76
       76
       +
       

     

       77
       77
       +
             extraOptions = mkOption {

     

       78
       78
       +
               description = "Extra command line options for zenohd.";

     

       79
       79
       +
               type = with types; listOf str;

     

       80
       80
       +
               default = [ ];

     

       81
       81
       +
             };

     

       82
       82
       +
           };

     

       83
       83
       +
         };

     

       84
       84
       +
       

     

       85
       85
       +
         config = lib.mkIf cfg.enable {

     

       86
       86
       +
           systemd.services.zenohd =

     

       87
       87
       +
             let

     

       88
       88
       +
               cfgFile = json.generate "zenohd.json" cfg.settings;

     

       89
       89
       +
       

     

       90
       90
       +
             in

     

       91
       91
       +
             {

     

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

     

       93
       93
       +
               wants = [ "network-online.target" ];

     

       94
       94
       +
               after = [ "network-online.target" ];

     

       95
       95
       +
       

     

       96
       96
       +
               environment = cfg.env;

     

       97
       97
       +
       

     

       98
       98
       +
               serviceConfig = {

     

       99
       99
       +
                 Type = "simple";

     

       100
       100
       +
                 User = "zenohd";

     

       101
       101
       +
                 Group = "zenohd";

     

       102
       102
       +
                 ExecStart =

     

       103
       103
       +
                   "${lib.getExe cfg.package} -c ${cfgFile} " + (lib.concatStringsSep " " cfg.extraOptions);

     

       104
       104
       +
               };

     

       105
       105
       +
             };

     

       106
       106
       +
       

     

       107
       107
       +
           users = {

     

       108
       108
       +
             users.zenohd = {

     

       109
       109
       +
               description = "Zenoh daemon user";

     

       110
       110
       +
               group = "zenohd";

     

       111
       111
       +
               isSystemUser = true;

     

       112
       112
       +
             };

     

       113
       113
       +
       

     

       114
       114
       +
             groups.zenohd = { };

     

       115
       115
       +
           };

     

       116
       116
       +
       

     

       117
       117
       +
           services.zenohd = {

     

       118
       118
       +
             env.ZENOH_HOME = cfg.home;

     

       119
       119
       +
       

     

       120
       120
       +
             settings = {

     

       121
       121
       +
               plugins_loading = {

     

       122
       122
       +
                 enabled = mkDefault true;

     

       123
       123
       +
                 search_dirs = mkDefault (

     

       124
       124
       +
                   (map (x: "${lib.getLib x}/lib") cfg.plugins) ++ [ "${lib.getLib cfg.package}/lib" ]

     

       125
       125
       +
                 ); # needed for internal plugins

     

       126
       126
       +
               };

     

       127
       127
       +
       

     

       128
       128
       +
               plugins.storage_manager.backend_search_dirs = mkDefault (

     

       129
       129
       +
                 map (x: "${lib.getLib x}/lib") cfg.backends

     

       130
       130
       +
               );

     

       131
       131
       +
             };

     

       132
       132
       +
           };

     

       133
       133
       +
       

     

       134
       134
       +
           systemd.tmpfiles.rules = [ "d ${cfg.home} 750 zenohd zenohd -" ];

     

       135
       135
       +
         };

     

       136
       136
       +
       }

nixos/tests/all-tests.nix

···

       1186
       1186
        
         yggdrasil = handleTest ./yggdrasil.nix {};

     

       1187
       1187
        
         your_spotify = handleTest ./your_spotify.nix {};

     

       1188
       1188
        
         zammad = handleTest ./zammad.nix {};

     

       1189
       1189
       +
         zenohd = handleTest ./zenohd.nix {};

     

       1189
       1190
        
         zeronet-conservancy = handleTest ./zeronet-conservancy.nix {};

     

       1190
       1191
        
         zfs = handleTest ./zfs.nix {};

     

       1191
       1192
        
         zigbee2mqtt = handleTest ./zigbee2mqtt.nix {};

+94

nixos/tests/zenohd.nix

···

       1
       1
       +
       import ./make-test-python.nix (

     

       2
       2
       +
         { pkgs, lib, ... }:

     

       3
       3
       +
       

     

       4
       4
       +
         {

     

       5
       5
       +
           name = "zenohd";

     

       6
       6
       +
           meta.maintainers = [ lib.maintainers.markuskowa ];

     

       7
       7
       +
       

     

       8
       8
       +
           nodes = {

     

       9
       9
       +
             router =

     

       10
       10
       +
               {

     

       11
       11
       +
                 pkgs,

     

       12
       12
       +
                 lib,

     

       13
       13
       +
                 config,

     

       14
       14
       +
                 ...

     

       15
       15
       +
               }:

     

       16
       16
       +
               {

     

       17
       17
       +
                 networking.firewall.allowedTCPPorts = [

     

       18
       18
       +
                   7447 # zenohd default port

     

       19
       19
       +
                   config.services.zenohd.settings.plugins.mqtt.port

     

       20
       20
       +
                   config.services.zenohd.settings.plugins.webserver.http_port

     

       21
       21
       +
                 ];

     

       22
       22
       +
       

     

       23
       23
       +
                 services.zenohd = {

     

       24
       24
       +
                   enable = true;

     

       25
       25
       +
       

     

       26
       26
       +
                   plugins = with pkgs; [

     

       27
       27
       +
                     zenoh-plugin-mqtt

     

       28
       28
       +
                     zenoh-plugin-webserver

     

       29
       29
       +
                   ];

     

       30
       30
       +
       

     

       31
       31
       +
                   backends = with pkgs; [

     

       32
       32
       +
                     zenoh-backend-filesystem

     

       33
       33
       +
                     zenoh-backend-rocksdb

     

       34
       34
       +
                   ];

     

       35
       35
       +
       

     

       36
       36
       +
                   settings = {

     

       37
       37
       +
                     plugins = {

     

       38
       38
       +
                       mqtt = {

     

       39
       39
       +
                         port = 1883;

     

       40
       40
       +
                         allow = ".*";

     

       41
       41
       +
                       };

     

       42
       42
       +
                       webserver.http_port = 8000;

     

       43
       43
       +
                       storage_manager = {

     

       44
       44
       +
                         volumes = {

     

       45
       45
       +
                           fs = { };

     

       46
       46
       +
                           rocksdb = { };

     

       47
       47
       +
                         };

     

       48
       48
       +
                         storages = {

     

       49
       49
       +
                           mem = {

     

       50
       50
       +
                             key_expr = "mem/**";

     

       51
       51
       +
                             volume = "memory";

     

       52
       52
       +
                           };

     

       53
       53
       +
                           fs = {

     

       54
       54
       +
                             key_expr = "fs/**";

     

       55
       55
       +
                             volume = {

     

       56
       56
       +
                               id = "fs";

     

       57
       57
       +
                               dir = "zenoh-fs";

     

       58
       58
       +
                               strip_prefix = "fs";

     

       59
       59
       +
                             };

     

       60
       60
       +
                           };

     

       61
       61
       +
                           rocksdb = {

     

       62
       62
       +
                             key_expr = "rocksdb/**";

     

       63
       63
       +
                             volume = {

     

       64
       64
       +
                               id = "rocksdb";

     

       65
       65
       +
                               dir = "zenoh-rocksdb";

     

       66
       66
       +
                               strip_prefix = "rocksdb";

     

       67
       67
       +
                               create_db = true;

     

       68
       68
       +
                             };

     

       69
       69
       +
                           };

     

       70
       70
       +
                         };

     

       71
       71
       +
                       };

     

       72
       72
       +
                     };

     

       73
       73
       +
                   };

     

       74
       74
       +
                 };

     

       75
       75
       +
               };

     

       76
       76
       +
       

     

       77
       77
       +
             client = {

     

       78
       78
       +
               environment.systemPackages = [

     

       79
       79
       +
                 pkgs.mosquitto

     

       80
       80
       +
               ];

     

       81
       81
       +
             };

     

       82
       82
       +
           };

     

       83
       83
       +
       

     

       84
       84
       +
           testScript = ''

     

       85
       85
       +
             start_all()

     

       86
       86
       +
             router.wait_for_unit("zenohd.service")

     

       87
       87
       +
             client.wait_for_unit("multi-user.target")

     

       88
       88
       +
       

     

       89
       89
       +
             for be in ["fs", "rocksdb", "mem" ]:

     

       90
       90
       +
               client.succeed(f"mosquitto_pub -h router -t {be}/test -m hello")

     

       91
       91
       +
               client.succeed(f"curl router:8000/{be}/test | grep hello")

     

       92
       92
       +
           '';

     

       93
       93
       +
         }

     

       94
       94
       +
       )