arangodb: Add arangodb as a NixOS service #40167

babariviere · 2018-05-08T09:40:48Z

Motivation for this change

For the same reason of this pull request: #31880

Things done

Tested using sandboxing (nix.useSandbox on NixOS, or option build-use-sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Fits CONTRIBUTING.md.

emmanuelrosa · 2018-05-09T22:03:37Z

nixos/modules/services/databases/arangodb.nix

+
+    users.extraGroups.arangodb.gid = config.ids.gids.arangodb;
+
+    environment.systemPackages = [ pkgs.arangodb ];


You shouldn't need to add the arangodb package system wide. See comment below...

Okay, I have removed it

But if I remove it, I don't have access to arangosh and else by default

emmanuelrosa

But if I remove it, I don't have access to arangosh and else by default.

Correct.

NixOS service modules are only responsible for setting up systemd units. They don't need to install packages into the user environment (which is what environment.systemPackages = [ pkgs.arangodb ]; does) in order to perform this function.

If users want access to the arangosh administration utilities (such as arangosh) then they should add the package to the user environment, just like they would any other package.

This maintains separation of concerns: services create systemd units and user environments set up $PATH to make executables available to users.

emmanuelrosa · 2018-05-09T22:06:55Z

nixos/modules/services/databases/arangodb.nix

+        '';
+
+      script = ''
+        exec arangod \


Instead of exec arangod you can do exec ${pkgs.arangodb}/bin/arangod. That will pull in arangodb as a dependency with no need for environment.systemPackages = [ pkgs.arangodb ]; If a user wants to use other binaries in the package (client tools perhaps), he/she can then add the package explicitly either system wide or through nix-env.

Ok thanks I will change this

nixos-discourse · 2019-03-15T21:23:01Z

This pull request has been mentioned on Nix community. There might be relevant details there:

https://discourse.nixos.org/t/arangodb-installation-and-how-to/2105/3

nixos/modules/services/databases/arangodb.nix

aanderse · 2019-05-25T17:21:56Z

@babariviere Do you have motivation to continue with this PR?

babariviere · 2019-05-26T17:37:36Z

I will finish it, but I cannot test it for now.

aanderse

Please let me know if you need any clarification on my comments or help in general with the module. Seems to be sought after in NixOS so thanks for tackling 👍

You mentioned testing... a NixOS test would be very valuable to have so are you able to write one?

aanderse · 2019-05-26T19:41:03Z

nixos/modules/misc/ids.nix

@@ -340,6 +340,7 @@
      cockroachdb = 313;
      zoneminder = 314;
      paperless = 315;
+      arangodb = 316;


Does the service actually require a predefined uid and gid? Often times you can get away without.

Yeah chance is very high that this isn't needed, cc #65698

aanderse · 2019-05-26T19:44:32Z

nixos/modules/services/databases/arangodb.nix

+    services.arangodb = {
+      enable = mkEnableOption "ArangoDB server";
+
+      dataDir = mkOption {


There are some nice features of systemd you can take advantage of if you hardcode this directory to something like /var/lib/arangodb, such as StateDirectory.

By no means is this a requirement, but recently I'm asking people to question if they actually provide value to users in adding this option. Sometimes the answer is yes, sometimes no. Up to you to decide.

aanderse · 2019-05-26T19:51:53Z

nixos/modules/services/databases/arangodb.nix

+      serviceConfig = {
+        User = "arangodb";
+        Group = "arangodb";
+        PermissionsStartOnly = true;


This is deprecated so please do not use. Your best alternatives are either hard coding the database.directory/dataDir to something like /var/lib/arangodb or user systemd.tmpfiles.rules.

See #56265 (comment) for some discussion on the topic.

aanderse · 2019-05-26T19:54:02Z

nixos/modules/services/databases/arangodb.nix

+
+      after = [ "network.target" ];
+
+      preStart = ''


This should be removed. See my comments below about PermissionsStartOnly.

aanderse · 2019-05-26T19:56:21Z

nixos/modules/services/databases/arangodb.nix

+        exec ${pkgs.arangodb}/bin/arangod \
+            --database.directory ${cfg.dataDir} \
+            --javascript.app-path ${cfg.dataDir} \
+            --log.file ${cfg.dataDir}/arangodb.log \


Is there a way to redirect output to standard system log (journald) as this is the standard in NixOS and preferred.

If there is no way to redirect output to journald instead of a log file does arangodb automatically rotate this log file?

aanderse · 2019-07-20T12:35:07Z

@volth Weren't you working on a service for this too?

GrahamcOfBorg added 6.topic: nixos 8.has: module (update) labels May 8, 2018

babariviere force-pushed the master branch 3 times, most recently from 1a8aef7 to ec2effc Compare May 8, 2018 17:46

GrahamcOfBorg added 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels May 8, 2018

babariviere force-pushed the master branch 3 times, most recently from 921c16e to 21f4f95 Compare May 9, 2018 18:04

emmanuelrosa reviewed May 9, 2018

View reviewed changes

babariviere force-pushed the master branch 2 times, most recently from 78455a6 to 8c9275f Compare May 10, 2018 09:03

emmanuelrosa reviewed May 10, 2018

View reviewed changes

babariviere force-pushed the master branch from 8c9275f to 9bf6c92 Compare May 10, 2018 14:16

c0bw3b mentioned this pull request May 18, 2019

arangodb: Add a NixOS service #31880

Closed

8 tasks

bachp reviewed May 19, 2019

View reviewed changes

nixos/modules/services/databases/arangodb.nix Show resolved Hide resolved

arangodb: Add arangodb as a NixOS service

29c0202

babariviere force-pushed the master branch from 9bf6c92 to 29c0202 Compare May 26, 2019 17:45

babariviere requested a review from infinisil as a code owner May 26, 2019 17:45

ofborg bot added the 2.status: merge conflict label May 26, 2019

Merge remote-tracking branch 'upstream/master'

11ba7e2

babariviere force-pushed the master branch from ec10236 to 11ba7e2 Compare May 26, 2019 17:55

ofborg bot removed the 2.status: merge conflict label May 26, 2019

aanderse requested changes May 26, 2019

View reviewed changes

aanderse mentioned this pull request Jul 12, 2019

arangod default config tries to write into nix store #64406

Closed

babariviere closed this Sep 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

arangodb: Add arangodb as a NixOS service #40167

arangodb: Add arangodb as a NixOS service #40167

babariviere commented May 8, 2018

emmanuelrosa May 9, 2018

babariviere May 10, 2018

babariviere May 10, 2018 •

edited

emmanuelrosa left a comment

emmanuelrosa May 9, 2018

babariviere May 10, 2018

nixos-discourse commented Mar 15, 2019

aanderse commented May 25, 2019

babariviere commented May 26, 2019

aanderse left a comment

aanderse May 26, 2019

infinisil Aug 9, 2019

aanderse May 26, 2019

aanderse May 26, 2019

aanderse May 26, 2019

aanderse May 26, 2019

aanderse commented Jul 20, 2019


		users.extraGroups.arangodb.gid = config.ids.gids.arangodb;

		environment.systemPackages = [ pkgs.arangodb ];

arangodb: Add arangodb as a NixOS service #40167

arangodb: Add arangodb as a NixOS service #40167

Conversation

babariviere commented May 8, 2018

Motivation for this change

Things done

Choose a reason for hiding this comment

Choose a reason for hiding this comment

babariviere May 10, 2018 • edited

Choose a reason for hiding this comment

emmanuelrosa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nixos-discourse commented Mar 15, 2019

aanderse commented May 25, 2019

babariviere commented May 26, 2019

aanderse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aanderse commented Jul 20, 2019

babariviere May 10, 2018 •

edited