nixos/pgadmin4: init

[mkg20001]

Motivation for this change

This adds a module for pgadmin4

NOTE: depends on #154764

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 22.05 Release Notes (or backporting 21.11 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
  • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
• Fits CONTRIBUTING.md.

[gador]

Thanks for the writeup of the module!
I added some comments and would suggest you add options for the state dir and log dir. Possibly you should consider adding an option to use Desktop Mode (which would enable the user to use initial passwords and emails), although I'd personally prefer to only support Server Edition.

[gador]

I'd remove that

[mkg20001]

@gador Desktop mode sounds like something that should go under programs.pgadmin4, but I'm not sure how much configuration (if any) it requires. To me it seems like mostly adding pgadmin4 to systemPackages.

Edit: or maybe should even go into home-manager, as it would likely be something specific to each user.

[mkg20001]

Does it make sense to split out the python config generator into it's own type in pkgs/build-support/formats.nix?

[gador]

Does it make sense to split out the python config generator into it's own type in pkgs/build-support/formats.nix?

Do you mean pkgs/pkgs-lib/formats.nix?
I don't believe so. Looking at the directory /var/lib/pgadmin I only see a pgadmin4.db file (a sqlite file), which contains the config.
Even if we add a config-to-sql generator to formats.nix: We'd still add the clear password to the service-configuration. Also the config file includes a whole lot more than just the user and (hashed) password.

I think it makes sense to let pgadmin create its own config database. Can we make sure the user runs it (interactively) the first time?

[mkg20001]

@gador Running interactivly imo is not an option. Similar to archisteamfarm, they also don't allow interactive stuff afaik.

As for concerns with putting stuff into the store: Instead a password file could be specified which would get read by the service on first startup, similar to e.g. discourse services.discourse.admin.passwordFile

Also the config that I'm talking about is /etc/pgadmin/config_system.py, which contains stuff like the port and oauth2 config, among others, not the config database, which is something different.

[mkg20001]

bikeshed: pgadmin4 or pgadmin as module name?

[gador]

I like the idea about the passwordFile. Its a way better option.

Also the config that I'm talking about is /etc/pgadmin/config_system.py, which contains stuff like the port and oauth2 config, among others, not the config database, which is something different.

Ok, that makes more sense. I don't mind the conversion logic within the module. Putting it in formats.nix seems to be a bit overkill..

It still does not solve the problem about the initial password, which gets asked on first run interactively.

[gador]

bikeshed: pgadmin4 or pgadmin as module name?

I'd suggest pgadmin.

pgadmin3 doesn't need a module, and we already aliased pgadmin --> pgadmin4

EDIT:
Nevermind, we didn't alias. I'd still use pgadmin. Maybe we should alias 🤷

[mkg20001]

@gador The interactive part is already solved by the preStart script

[gador]

Ok. Then we just have to add the logic of a passwordFile to it?

I just noticed the use of pgadmin4-setup..Where does that binary come from? When I build pgadmin4, I just have pgadmin4 as a binary.

[mkg20001]

@gador I made a patch d3a4625 (#161521)

This exposes setup.py as proper binary

[wmertens]

LGTM 👍