mirrors/nixpkgs
1
0
Fork 1
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-03-06 23:31:34 +00:00
Code Issues Wiki Activity

nixos/grafana: add support for declarative plugin installation

Browse source
This commit is contained in:
Luke Granger-Brown 2020-12-30 17:59:52 +00:00
parent fafe7b24bf
commit d0a9e1ec83
2 changed files with 21 additions and 2 deletions
nixos
modules/services/monitoring
grafana.nix
tests
grafana.nix

9
nixos/modules/services/monitoring/grafana.nix
View file

@ -5,10 +5,11 @@ with lib;
let let
cfg = config.services.grafana; cfg = config.services.grafana;
opt = options.services.grafana; opt = options.services.grafana;
declarativePlugins = pkgs.linkFarm "grafana-plugins" (builtins.map (pkg: { name = pkg.pname; path = pkg; }) cfg.declarativePlugins);
envOptions = { envOptions = {
PATHS_DATA = cfg.dataDir; PATHS_DATA = cfg.dataDir;
PATHS_PLUGINS = "${cfg.dataDir}/plugins"; PATHS_PLUGINS = if builtins.isNull cfg.declarativePlugins then "${cfg.dataDir}/plugins" else declarativePlugins;
PATHS_LOGS = "${cfg.dataDir}/log"; PATHS_LOGS = "${cfg.dataDir}/log";
SERVER_PROTOCOL = cfg.protocol; SERVER_PROTOCOL = cfg.protocol;
@ -260,6 +261,12 @@ in {
defaultText = "pkgs.grafana"; defaultText = "pkgs.grafana";
type = types.package; type = types.package;
}; };
declarativePlugins = mkOption {
type = with types; nullOr (listOf path);
default = null;
description = "If non-null, then a list of packages containing Grafana plugins to install. If set, plugins cannot be manually installed.";
example = literalExample "with pkgs.grafanaPlugins; [ grafana-piechart-panel ]";
};
dataDir = mkOption { dataDir = mkOption {
description = "Data directory."; description = "Data directory.";

14
nixos/tests/grafana.nix
View file

@ -17,6 +17,10 @@ let
}; };
extraNodeConfs = { extraNodeConfs = {
declarativePlugins = {
services.grafana.declarativePlugins = [ pkgs.grafanaPlugins.grafana-clock-panel ];
};
postgresql = { postgresql = {
services.grafana.database = { services.grafana.database = {
host = "127.0.0.1:5432"; host = "127.0.0.1:5432";
@ -52,7 +56,7 @@ let
nameValuePair dbName (mkMerge [ nameValuePair dbName (mkMerge [
baseGrafanaConf baseGrafanaConf
(extraNodeConfs.${dbName} or {}) (extraNodeConfs.${dbName} or {})
])) [ "sqlite" "postgresql" "mysql" ]); ])) [ "sqlite" "declarativePlugins" "postgresql" "mysql" ]);
in { in {
name = "grafana"; name = "grafana";
@ -66,6 +70,14 @@ in {
testScript = '' testScript = ''
start_all() start_all()
with subtest("Declarative plugins installed"):
declarativePlugins.wait_for_unit("grafana.service")
declarativePlugins.wait_for_open_port(3000)
declarativePlugins.succeed(
"curl -sSfN -u testadmin:snakeoilpwd http://127.0.0.1:3000/api/plugins | grep -q grafana-clock-panel"
)
declarativePlugins.shutdown()
with subtest("Successful API query as admin user with sqlite db"): with subtest("Successful API query as admin user with sqlite db"):
sqlite.wait_for_unit("grafana.service") sqlite.wait_for_unit("grafana.service")
sqlite.wait_for_open_port(3000) sqlite.wait_for_open_port(3000)