commit c93541b24eb1166ba14aa34fe315cbe26c93c190 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       799
        
         ./services/monitoring/munin.nix

     

       800
        
         ./services/monitoring/nagios.nix

     

       801
        
         ./services/monitoring/netdata.nix

     

       0
        
       
     

       802
        
         ./services/monitoring/opentelemetry-collector.nix

     

       803
        
         ./services/monitoring/osquery.nix

     

       804
        
         ./services/monitoring/parsedmarc.nix

···

       799
        
         ./services/monitoring/munin.nix

     

       800
        
         ./services/monitoring/nagios.nix

     

       801
        
         ./services/monitoring/netdata.nix

     

       802
       +
         ./services/monitoring/ocsinventory-agent.nix

     

       803
        
         ./services/monitoring/opentelemetry-collector.nix

     

       804
        
         ./services/monitoring/osquery.nix

     

       805
        
         ./services/monitoring/parsedmarc.nix

+33

nixos/modules/services/monitoring/ocsinventory-agent.md

···

       1
       +
       # OCS Inventory Agent {#module-services-ocsinventory-agent}

     

       2
       +
       

     

       3
       +
       [OCS Inventory NG](https://ocsinventory-ng.org/) or Open Computers and Software inventory

     

       4
       +
       is an application designed to help IT administrator to keep track of the hardware and software

     

       5
       +
       configurations of computers that are installed on their network.

     

       6
       +
       

     

       7
       +
       OCS Inventory collects information about the hardware and software of networked machines

     

       8
       +
       through the **OCS Inventory Agent** program.

     

       9
       +
       

     

       10
       +
       This NixOS module enables you to install and configure this agent so that it sends information from your computer to the OCS Inventory server.

     

       11
       +
       

     

       12
       +
       For more technical information about OCS Inventory Agent, refer to [the Wiki documentation](https://wiki.ocsinventory-ng.org/03.Basic-documentation/Setting-up-the-UNIX-agent-manually-on-client-computers/).

     

       13
       +
       

     

       14
       +
       

     

       15
       +
       ## Basic Usage {#module-services-ocsinventory-agent-basic-usage}

     

       16
       +
       

     

       17
       +
       A minimal configuration looks like this:

     

       18
       +
       

     

       19
       +
       ```nix

     

       20
       +
       {

     

       21
       +
         services.ocsinventory-agent = {

     

       22
       +
           enable = true;

     

       23
       +
           settings = {

     

       24
       +
             server = "https://ocsinventory.localhost:8080/ocsinventory";

     

       25
       +
             tag = "01234567890123";

     

       26
       +
           };

     

       27
       +
         };

     

       28
       +
       }

     

       29
       +
       ```

     

       30
       +
       

     

       31
       +
       This configuration will periodically run the ocsinventory-agent SystemD service.

     

       32
       +
       

     

       33
       +
       The OCS Inventory Agent will inventory the computer and then sends the results to the specified OCS Inventory Server.

+134

nixos/modules/services/monitoring/ocsinventory-agent.nix

···

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

     

       2
       +
       

     

       3
       +
       let

     

       4
       +
         cfg = config.services.ocsinventory-agent;

     

       5
       +
       

     

       6
       +
         settingsFormat = pkgs.formats.keyValue {

     

       7
       +
           mkKeyValue = lib.generators.mkKeyValueDefault { } "=";

     

       8
       +
         };

     

       9
       +
       

     

       10
       +
       in

     

       11
       +
       {

     

       12
       +
         meta = {

     

       13
       +
           doc = ./ocsinventory-agent.md;

     

       14
       +
           maintainers = with lib.maintainers; [ anthonyroussel ];

     

       15
       +
         };

     

       16
       +
       

     

       17
       +
         options = {

     

       18
       +
           services.ocsinventory-agent = {

     

       19
       +
             enable = lib.mkEnableOption (lib.mdDoc "OCS Inventory Agent");

     

       20
       +
       

     

       21
       +
             package = lib.mkPackageOptionMD pkgs "ocsinventory-agent" { };

     

       22
       +
       

     

       23
       +
             settings = lib.mkOption {

     

       24
       +
               type = lib.types.submodule {

     

       25
       +
                 freeformType = settingsFormat.type.nestedTypes.elemType;

     

       26
       +
       

     

       27
       +
                 options = {

     

       28
       +
                   server = lib.mkOption {

     

       29
       +
                     type = lib.types.nullOr lib.types.str;

     

       30
       +
                     example = "https://ocsinventory.localhost:8080/ocsinventory";

     

       31
       +
                     default = null;

     

       32
       +
                     description = lib.mdDoc ''

     

       33
       +
                       The URI of the OCS Inventory server where to send the inventory file.

     

       34
       +
       

     

       35
       +
                       This option is ignored if {option}`services.ocsinventory-agent.settings.local` is set.

     

       36
       +
                     '';

     

       37
       +
                   };

     

       38
       +
       

     

       39
       +
                   local = lib.mkOption {

     

       40
       +
                     type = lib.types.nullOr lib.types.path;

     

       41
       +
                     example = "/var/lib/ocsinventory-agent/reports";

     

       42
       +
                     default = null;

     

       43
       +
                     description = lib.mdDoc ''

     

       44
       +
                       If specified, the OCS Inventory Agent will run in offline mode

     

       45
       +
                       and the resulting inventory file will be stored in the specified path.

     

       46
       +
                     '';

     

       47
       +
                   };

     

       48
       +
       

     

       49
       +
                   ca = lib.mkOption {

     

       50
       +
                     type = lib.types.path;

     

       51
       +
                     default = "/etc/ssl/certs/ca-certificates.crt";

     

       52
       +
                     description = lib.mdDoc ''

     

       53
       +
                       Path to CA certificates file in PEM format, for server

     

       54
       +
                       SSL certificate validation.

     

       55
       +
                     '';

     

       56
       +
                   };

     

       57
       +
       

     

       58
       +
                   tag = lib.mkOption {

     

       59
       +
                     type = lib.types.nullOr lib.types.str;

     

       60
       +
                     default = null;

     

       61
       +
                     example = "01234567890123";

     

       62
       +
                     description = lib.mdDoc "Tag for the generated inventory.";

     

       63
       +
                   };

     

       64
       +
       

     

       65
       +
                   debug = lib.mkEnableOption (lib.mdDoc "debug mode");

     

       66
       +
                 };

     

       67
       +
               };

     

       68
       +
               default = { };

     

       69
       +
               example = {

     

       70
       +
                 ca = "/etc/ssl/certs/ca-certificates.crt";

     

       71
       +
                 debug = true;

     

       72
       +
                 server = "https://ocsinventory.localhost:8080/ocsinventory";

     

       73
       +
                 tag = "01234567890123";

     

       74
       +
               };

     

       75
       +
               description = lib.mdDoc ''

     

       76
       +
                 Configuration for /etc/ocsinventory-agent/ocsinventory-agent.cfg.

     

       77
       +
       

     

       78
       +
                 Refer to

     

       79
       +
                 {manpage}`ocsinventory-agent(1)` for available options.

     

       80
       +
               '';

     

       81
       +
             };

     

       82
       +
       

     

       83
       +
             interval = lib.mkOption {

     

       84
       +
               type = lib.types.str;

     

       85
       +
               default = "daily";

     

       86
       +
               example = "06:00";

     

       87
       +
               description = lib.mdDoc ''

     

       88
       +
                 How often we run the ocsinventory-agent service. Runs by default every daily.

     

       89
       +
       

     

       90
       +
                 The format is described in

     

       91
       +
                 {manpage}`systemd.time(7)`.

     

       92
       +
               '';

     

       93
       +
             };

     

       94
       +
           };

     

       95
       +
         };

     

       96
       +
       

     

       97
       +
         config =

     

       98
       +
           let

     

       99
       +
             configFile = settingsFormat.generate "ocsinventory-agent.cfg" cfg.settings;

     

       100
       +
       

     

       101
       +
           in lib.mkIf cfg.enable {

     

       102
       +
             # Path of the configuration file is hard-coded and cannot be changed

     

       103
       +
             # https://github.com/OCSInventory-NG/UnixAgent/blob/v2.10.0/lib/Ocsinventory/Agent/Config.pm#L78

     

       104
       +
             #

     

       105
       +
             environment.etc."ocsinventory-agent/ocsinventory-agent.cfg".source = configFile;

     

       106
       +
       

     

       107
       +
             systemd.services.ocsinventory-agent = {

     

       108
       +
               description = "OCS Inventory Agent service";

     

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

     

       110
       +
               after = [ "network.target" ];

     

       111
       +
       

     

       112
       +
               reloadTriggers = [ configFile ];

     

       113
       +
       

     

       114
       +
               serviceConfig = {

     

       115
       +
                 ExecStart = lib.getExe cfg.package;

     

       116
       +
                 ConfigurationDirectory = "ocsinventory-agent";

     

       117
       +
                 StateDirectory = "ocsinventory-agent";

     

       118
       +
               };

     

       119
       +
             };

     

       120
       +
       

     

       121
       +
             systemd.timers.ocsinventory-agent = {

     

       122
       +
               description = "Launch OCS Inventory Agent regularly";

     

       123
       +
               wantedBy = [ "timers.target" ];

     

       124
       +
       

     

       125
       +
               timerConfig = {

     

       126
       +
                 OnCalendar = cfg.interval;

     

       127
       +
                 AccuracySec = "1h";

     

       128
       +
                 RandomizedDelaySec = 240;

     

       129
       +
                 Persistent = true;

     

       130
       +
                 Unit = "ocsinventory-agent.service";

     

       131
       +
               };

     

       132
       +
             };

     

       133
       +
           };

     

       134
       +
       }

nixos/tests/all-tests.nix

···

       616
        
         openstack-image-userdata = (handleTestOn ["x86_64-linux"] ./openstack-image.nix {}).userdata or {};

     

       617
        
         opentabletdriver = handleTest ./opentabletdriver.nix {};

     

       618
        
         opentelemetry-collector = handleTest ./opentelemetry-collector.nix {};

     

       0
        
       
     

       619
        
         owncast = handleTest ./owncast.nix {};

     

       620
        
         outline = handleTest ./outline.nix {};

     

       621
        
         image-contents = handleTest ./image-contents.nix {};

···

       616
        
         openstack-image-userdata = (handleTestOn ["x86_64-linux"] ./openstack-image.nix {}).userdata or {};

     

       617
        
         opentabletdriver = handleTest ./opentabletdriver.nix {};

     

       618
        
         opentelemetry-collector = handleTest ./opentelemetry-collector.nix {};

     

       619
       +
         ocsinventory-agent = handleTestOn [ "x86_64-linux" "aarch64-linux" ] ./ocsinventory-agent.nix {};

     

       620
        
         owncast = handleTest ./owncast.nix {};

     

       621
        
         outline = handleTest ./outline.nix {};

     

       622
        
         image-contents = handleTest ./image-contents.nix {};

+33

nixos/tests/ocsinventory-agent.nix

···

       1
       +
       import ./make-test-python.nix ({ pkgs, ...} : {

     

       2
       +
         name = "ocsinventory-agent";

     

       3
       +
       

     

       4
       +
         nodes.machine = { pkgs, ... }: {

     

       5
       +
           services.ocsinventory-agent = {

     

       6
       +
             enable = true;

     

       7
       +
             settings = {

     

       8
       +
               debug = true;

     

       9
       +
               local = "/var/lib/ocsinventory-agent/reports";

     

       10
       +
               tag = "MY_INVENTORY_TAG";

     

       11
       +
             };

     

       12
       +
           };

     

       13
       +
         };

     

       14
       +
       

     

       15
       +
         testScript = ''

     

       16
       +
           path = "/var/lib/ocsinventory-agent/reports"

     

       17
       +
       

     

       18
       +
           # Run the agent to generate the inventory file in offline mode

     

       19
       +
           start_all()

     

       20
       +
           machine.succeed("mkdir -p {}".format(path))

     

       21
       +
           machine.wait_for_unit("ocsinventory-agent.service")

     

       22
       +
           machine.wait_until_succeeds("journalctl -u ocsinventory-agent.service | grep 'Inventory saved in'")

     

       23
       +
       

     

       24
       +
           # Fetch the path to the generated inventory file

     

       25
       +
           report_file = machine.succeed("find {}/*.ocs -type f | head -n1".format(path))

     

       26
       +
       

     

       27
       +
           with subtest("Check the tag value"):

     

       28
       +
             tag = machine.succeed(

     

       29
       +
               "${pkgs.libxml2}/bin/xmllint --xpath 'string(/REQUEST/CONTENT/ACCOUNTINFO/KEYVALUE)' {}".format(report_file)

     

       30
       +
             ).rstrip()

     

       31
       +
             assert tag == "MY_INVENTORY_TAG", f"tag is not valid, was '{tag}'"

     

       32
       +
         '';

     

       33
       +
       })

+9 -5

pkgs/by-name/oc/ocsinventory-agent/package.nix

···

       15
        
       , pciutils

     

       16
        
       , usbutils

     

       17
        
       , util-linux

     

       0
        
       
     

       18
        
       , testers

     

       19
        
       , ocsinventory-agent

     

       20
        
       , nix-update-script

     
···

       75
        
         '';

     

       76
        
       

     

       77
        
         passthru = {

     

       78
       -
           tests.version = testers.testVersion {

     

       79
       -
             package = ocsinventory-agent;

     

       80
       -
             command = "ocsinventory-agent --version";

     

       81
       -
             # upstream has not updated version in lib/Ocsinventory/Agent/Config.pm

     

       82
       -
             version = "2.10.0";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       83
        
           };

     

       84
        
           updateScript = nix-update-script { };

     

       85
        
         };

···

       15
        
       , pciutils

     

       16
        
       , usbutils

     

       17
        
       , util-linux

     

       18
       +
       , nixosTests

     

       19
        
       , testers

     

       20
        
       , ocsinventory-agent

     

       21
        
       , nix-update-script

     
···

       76
        
         '';

     

       77
        
       

     

       78
        
         passthru = {

     

       79
       +
           tests = {

     

       80
       +
             inherit (nixosTests) ocsinventory-agent;

     

       81
       +
             version = testers.testVersion {

     

       82
       +
               package = ocsinventory-agent;

     

       83
       +
               command = "ocsinventory-agent --version";

     

       84
       +
               # upstream has not updated version in lib/Ocsinventory/Agent/Config.pm

     

       85
       +
               version = "2.10.0";

     

       86
       +
             };

     

       87
        
           };

     

       88
        
           updateScript = nix-update-script { };

     

       89
        
         };