···

       
1300
       
 
       
                <para>

     

       
1301
       
 
       
                  Instead of declaring datasources and dashboards in

     

       
1302
       
 
       
                  pure Nix, it’s also possible to specify configuration

     

       
1303
       
-
       
                  files with YAML instead using

     

       
1304
       
 
       
                  <xref linkend="opt-services.grafana.provision.datasources.path" />

     

       
1305
       
 
       
                  (or

     

       
1306
       
 
       
                  <xref linkend="opt-services.grafana.provision.dashboards.path" />.

     

···

       
1300
       
 
       
                <para>

     

       
1301
       
 
       
                  Instead of declaring datasources and dashboards in

     

       
1302
       
 
       
                  pure Nix, it’s also possible to specify configuration

     

       
1303
       
+
       
                  files (or directories) with YAML instead using

     

       
1304
       
 
       
                  <xref linkend="opt-services.grafana.provision.datasources.path" />

     

       
1305
       
 
       
                  (or

     

       
1306
       
 
       
                  <xref linkend="opt-services.grafana.provision.dashboards.path" />.

     

···

       
420
       
 
       
      [](#opt-services.grafana.provision.dashboards.settings.apiVersion)).

     

       
421
       
 
       


     

       
422
       
 
       
    - Instead of declaring datasources and dashboards in pure Nix, it's also possible

     

       
423
       
-
       
      to specify configuration files with YAML instead using

     

       
424
       
 
       
      [](#opt-services.grafana.provision.datasources.path) (or

     

       
425
       
 
       
      [](#opt-services.grafana.provision.dashboards.path). This is useful when having

     

       
426
       
 
       
      provisioning files from non-NixOS Grafana instances that you also want to

     

···

       
420
       
 
       
      [](#opt-services.grafana.provision.dashboards.settings.apiVersion)).

     

       
421
       
 
       


     

       
422
       
 
       
    - Instead of declaring datasources and dashboards in pure Nix, it's also possible

     

       
423
       
+
       
      to specify configuration files (or directories) with YAML instead using

     

       
424
       
 
       
      [](#opt-services.grafana.provision.datasources.path) (or

     

       
425
       
 
       
      [](#opt-services.grafana.provision.dashboards.path). This is useful when having

     

       
426
       
 
       
      provisioning files from non-NixOS Grafana instances that you also want to

     

···

       
25
       
 
       
            ${attr} = [];

     

       
26
       
 
       
          });

     

       
27
       
 
       


     

       
28
       
-
       
  datasourceFile = mkProvisionCfg "datasource" "datasources" cfg.provision.datasources;

     

       
29
       
-
       
  dashboardFile = mkProvisionCfg "dashboard" "providers" cfg.provision.dashboards;

     

       
30
       
 
       


     

       
31
       
 
       
  notifierConfiguration = {

     

       
32
       
 
       
    apiVersion = 1;

     

       
33
       
 
       
    notifiers = cfg.provision.notifiers;

     

       
34
       
 
       
  };

     

       
35
       
 
       


     

       
36
       
-
       
  notifierFile = pkgs.writeText "notifier.yaml" (builtins.toJSON notifierConfiguration);

     

       
37
       
 
       


     

       
38
       
 
       
  generateAlertingProvisioningYaml = x: if (cfg.provision.alerting."${x}".path == null)

     

       
39
       
 
       
                                        then provisioningSettingsFormat.generate "${x}.yaml" cfg.provision.alerting."${x}".settings

     

       
40
       
 
       
                                        else cfg.provision.alerting."${x}".path;

     

       
41
       
-
       
  rulesFile = generateAlertingProvisioningYaml "rules";

     

       
42
       
-
       
  contactPointsFile = generateAlertingProvisioningYaml "contactPoints";

     

       
43
       
-
       
  policiesFile = generateAlertingProvisioningYaml "policies";

     

       
44
       
-
       
  templatesFile = generateAlertingProvisioningYaml "templates";

     

       
45
       
-
       
  muteTimingsFile = generateAlertingProvisioningYaml "muteTimings";

     

       
46
       
 
       


     

       
47
       
-
       
  provisionConfDir =  pkgs.runCommand "grafana-provisioning" { } ''

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
48
       
 
       
    mkdir -p $out/{datasources,dashboards,notifiers,alerting}

     

       
49
       
-
       
    ln -sf ${datasourceFile} $out/datasources/datasource.yaml

     

       
50
       
-
       
    ln -sf ${dashboardFile} $out/dashboards/dashboard.yaml

     

       
51
       
-
       
    ln -sf ${notifierFile} $out/notifiers/notifier.yaml

     

       
52
       
-
       
    ln -sf ${rulesFile} $out/alerting/rules.yaml

     

       
53
       
-
       
    ln -sf ${contactPointsFile} $out/alerting/contactPoints.yaml

     

       
54
       
-
       
    ln -sf ${policiesFile} $out/alerting/policies.yaml

     

       
55
       
-
       
    ln -sf ${templatesFile} $out/alerting/templates.yaml

     

       
56
       
-
       
    ln -sf ${muteTimingsFile} $out/alerting/muteTimings.yaml

     

       
57
       
 
       
  '';

     

       
58
       
 
       


     

       
59
       
 
       
  # Get a submodule without any embedded metadata:

     

       
60
       
 
       
  _filter = x: filterAttrs (k: v: k != "_module") x;

     

       
61
       
 
       


     

       
62
       
 
       
  # FIXME(@Ma27) remove before 23.05. This is just a helper-type

     

       
63
       
-
       
  # because `mkRenamedOptionModule` doesn't work if `foo.bar` is renamed

     

       
64
       
 
       
  # to `foo.bar.baz`.

     

       
65
       
 
       
  submodule' = module: types.coercedTo

     

       
66
       
 
       
    (mkOptionType {

     
···

       
342
       
 
       
                Don't change the value of this option if you are planning to use `services.grafana.provision` options.

     

       
343
       
 
       
              '';

     

       
344
       
 
       
              default = provisionConfDir;

     

       
345
       
-
       
              defaultText = literalExpression ''

     

       
346
       
-
       
                pkgs.runCommand "grafana-provisioning" { } \'\'

     

       
347
       
-
       
                  mkdir -p $out/{datasources,dashboards,notifiers,alerting}

     

       
348
       
-
       
                  ln -sf ''${datasourceFile} $out/datasources/datasource.yaml

     

       
349
       
-
       
                  ln -sf ''${dashboardFile} $out/dashboards/dashboard.yaml

     

       
350
       
-
       
                  ln -sf ''${notifierFile} $out/notifiers/notifier.yaml

     

       
351
       
-
       
                  ln -sf ''${rulesFile} $out/alerting/rules.yaml

     

       
352
       
-
       
                  ln -sf ''${contactPointsFile} $out/alerting/contactPoints.yaml

     

       
353
       
-
       
                  ln -sf ''${policiesFile} $out/alerting/policies.yaml

     

       
354
       
-
       
                  ln -sf ''${templatesFile} $out/alerting/templates.yaml

     

       
355
       
-
       
                  ln -sf ''${muteTimingsFile} $out/alerting/muteTimings.yaml

     

       
356
       
-
       
                  \'\'

     

       
357
       
-
       
              '';

     

       
358
       
 
       
              type = types.path;

     

       
359
       
 
       
            };

     

       
360
       
 
       
          };

     
···

       
641
       
 
       
            description = lib.mdDoc ''

     

       
642
       
 
       
              Path to YAML datasource configuration. Can't be used with

     

       
643
       
 
       
              [](#opt-services.grafana.provision.datasources.settings) simultaneously.

     

       
0
       
 
       

     

       
644
       
 
       
            '';

     

       
645
       
 
       
            default = null;

     

       
646
       
 
       
            type = types.nullOr types.path;

     
···

       
692
       
 
       
            description = lib.mdDoc ''

     

       
693
       
 
       
              Path to YAML dashboard configuration. Can't be used with

     

       
694
       
 
       
              [](#opt-services.grafana.provision.dashboards.settings) simultaneously.

     

       
0
       
 
       

     

       
695
       
 
       
            '';

     

       
696
       
 
       
            default = null;

     

       
697
       
 
       
            type = types.nullOr types.path;

     
···

       
714
       
 
       
            description = lib.mdDoc ''

     

       
715
       
 
       
              Path to YAML rules configuration. Can't be used with

     

       
716
       
 
       
              [](#opt-services.grafana.provision.alerting.rules.settings) simultaneously.

     

       
0
       
 
       

     

       
717
       
 
       
            '';

     

       
718
       
 
       
            default = null;

     

       
719
       
 
       
            type = types.nullOr types.path;

     
···

       
837
       
 
       
            description = lib.mdDoc ''

     

       
838
       
 
       
              Path to YAML contact points configuration. Can't be used with

     

       
839
       
 
       
              [](#opt-services.grafana.provision.alerting.contactPoints.settings) simultaneously.

     

       
0
       
 
       

     

       
840
       
 
       
            '';

     

       
841
       
 
       
            default = null;

     

       
842
       
 
       
            type = types.nullOr types.path;

     
···

       
917
       
 
       
            description = lib.mdDoc ''

     

       
918
       
 
       
              Path to YAML notification policies configuration. Can't be used with

     

       
919
       
 
       
              [](#opt-services.grafana.provision.alerting.policies.settings) simultaneously.

     

       
0
       
 
       

     

       
920
       
 
       
            '';

     

       
921
       
 
       
            default = null;

     

       
922
       
 
       
            type = types.nullOr types.path;

     
···

       
986
       
 
       
            description = lib.mdDoc ''

     

       
987
       
 
       
              Path to YAML templates configuration. Can't be used with

     

       
988
       
 
       
              [](#opt-services.grafana.provision.alerting.templates.settings) simultaneously.

     

       
0
       
 
       

     

       
989
       
 
       
            '';

     

       
990
       
 
       
            default = null;

     

       
991
       
 
       
            type = types.nullOr types.path;

     
···

       
1067
       
 
       
            description = lib.mdDoc ''

     

       
1068
       
 
       
              Path to YAML mute timings configuration. Can't be used with

     

       
1069
       
 
       
              [](#opt-services.grafana.provision.alerting.muteTimings.settings) simultaneously.

     

       
0
       
 
       

     

       
1070
       
 
       
            '';

     

       
1071
       
 
       
            default = null;

     

       
1072
       
 
       
            type = types.nullOr types.path;

     

···

       
25
       
 
       
            ${attr} = [];

     

       
26
       
 
       
          });

     

       
27
       
 
       


     

       
28
       
+
       
  datasourceFileOrDir = mkProvisionCfg "datasource" "datasources" cfg.provision.datasources;

     

       
29
       
+
       
  dashboardFileOrDir = mkProvisionCfg "dashboard" "providers" cfg.provision.dashboards;

     

       
30
       
 
       


     

       
31
       
 
       
  notifierConfiguration = {

     

       
32
       
 
       
    apiVersion = 1;

     

       
33
       
 
       
    notifiers = cfg.provision.notifiers;

     

       
34
       
 
       
  };

     

       
35
       
 
       


     

       
36
       
+
       
  notifierFileOrDir = pkgs.writeText "notifier.yaml" (builtins.toJSON notifierConfiguration);

     

       
37
       
 
       


     

       
38
       
 
       
  generateAlertingProvisioningYaml = x: if (cfg.provision.alerting."${x}".path == null)

     

       
39
       
 
       
                                        then provisioningSettingsFormat.generate "${x}.yaml" cfg.provision.alerting."${x}".settings

     

       
40
       
 
       
                                        else cfg.provision.alerting."${x}".path;

     

       
41
       
+
       
  rulesFileOrDir = generateAlertingProvisioningYaml "rules";

     

       
42
       
+
       
  contactPointsFileOrDir = generateAlertingProvisioningYaml "contactPoints";

     

       
43
       
+
       
  policiesFileOrDir = generateAlertingProvisioningYaml "policies";

     

       
44
       
+
       
  templatesFileOrDir = generateAlertingProvisioningYaml "templates";

     

       
45
       
+
       
  muteTimingsFileOrDir = generateAlertingProvisioningYaml "muteTimings";

     

       
46
       
 
       


     

       
47
       
+
       
  ln = { src, dir, filename }: ''

     

       
48
       
+
       
    if [[ -d "${src}" ]]; then

     

       
49
       
+
       
      pushd $out/${dir} &>/dev/null

     

       
50
       
+
       
        lndir "${src}"

     

       
51
       
+
       
      popd &>/dev/null

     

       
52
       
+
       
    else

     

       
53
       
+
       
      ln -sf ${src} $out/${dir}/${filename}.yaml

     

       
54
       
+
       
    fi

     

       
55
       
+
       
  '';

     

       
56
       
+
       
  provisionConfDir = pkgs.runCommand "grafana-provisioning" { nativeBuildInputs = [ pkgs.xorg.lndir ]; } ''

     

       
57
       
 
       
    mkdir -p $out/{datasources,dashboards,notifiers,alerting}

     

       
58
       
+
       
    ${ln { src = datasourceFileOrDir;    dir = "datasources"; filename = "datasource"; }}

     

       
59
       
+
       
    ${ln { src = dashboardFileOrDir;     dir = "dashboards";  filename = "dashbaord"; }}

     

       
60
       
+
       
    ${ln { src = notifierFileOrDir;      dir = "notifiers";   filename = "notifier"; }}

     

       
61
       
+
       
    ${ln { src = rulesFileOrDir;         dir = "alerting";    filename = "rules"; }}

     

       
62
       
+
       
    ${ln { src = contactPointsFileOrDir; dir = "alerting";    filename = "contactPoints"; }}

     

       
63
       
+
       
    ${ln { src = policiesFileOrDir;      dir = "alerting";    filename = "policies"; }}

     

       
64
       
+
       
    ${ln { src = templatesFileOrDir;     dir = "alerting";    filename = "templates"; }}

     

       
65
       
+
       
    ${ln { src = muteTimingsFileOrDir;   dir = "alerting";    filename = "muteTimings"; }}

     

       
66
       
 
       
  '';

     

       
67
       
 
       


     

       
68
       
 
       
  # Get a submodule without any embedded metadata:

     

       
69
       
 
       
  _filter = x: filterAttrs (k: v: k != "_module") x;

     

       
70
       
 
       


     

       
71
       
 
       
  # FIXME(@Ma27) remove before 23.05. This is just a helper-type

     

       
72
       
+
       
  # because `mkRenamedOptionMthere's there's odule` doesn't work if `foo.bar` is renamed

     

       
73
       
 
       
  # to `foo.bar.baz`.

     

       
74
       
 
       
  submodule' = module: types.coercedTo

     

       
75
       
 
       
    (mkOptionType {

     
···

       
351
       
 
       
                Don't change the value of this option if you are planning to use `services.grafana.provision` options.

     

       
352
       
 
       
              '';

     

       
353
       
 
       
              default = provisionConfDir;

     

       
354
       
+
       
              defaultText = "directory with all provisioning files linked together";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
355
       
 
       
              type = types.path;

     

       
356
       
 
       
            };

     

       
357
       
 
       
          };

     
···

       
638
       
 
       
            description = lib.mdDoc ''

     

       
639
       
 
       
              Path to YAML datasource configuration. Can't be used with

     

       
640
       
 
       
              [](#opt-services.grafana.provision.datasources.settings) simultaneously.

     

       
641
       
+
       
              Can be either a directory or a single YAML file. Will end up in the store.

     

       
642
       
 
       
            '';

     

       
643
       
 
       
            default = null;

     

       
644
       
 
       
            type = types.nullOr types.path;

     
···

       
690
       
 
       
            description = lib.mdDoc ''

     

       
691
       
 
       
              Path to YAML dashboard configuration. Can't be used with

     

       
692
       
 
       
              [](#opt-services.grafana.provision.dashboards.settings) simultaneously.

     

       
693
       
+
       
              Can be either a directory or a single YAML file. Will end up in the store.

     

       
694
       
 
       
            '';

     

       
695
       
 
       
            default = null;

     

       
696
       
 
       
            type = types.nullOr types.path;

     
···

       
713
       
 
       
            description = lib.mdDoc ''

     

       
714
       
 
       
              Path to YAML rules configuration. Can't be used with

     

       
715
       
 
       
              [](#opt-services.grafana.provision.alerting.rules.settings) simultaneously.

     

       
716
       
+
       
              Can be either a directory or a single YAML file. Will end up in the store.

     

       
717
       
 
       
            '';

     

       
718
       
 
       
            default = null;

     

       
719
       
 
       
            type = types.nullOr types.path;

     
···

       
837
       
 
       
            description = lib.mdDoc ''

     

       
838
       
 
       
              Path to YAML contact points configuration. Can't be used with

     

       
839
       
 
       
              [](#opt-services.grafana.provision.alerting.contactPoints.settings) simultaneously.

     

       
840
       
+
       
              Can be either a directory or a single YAML file. Will end up in the store.

     

       
841
       
 
       
            '';

     

       
842
       
 
       
            default = null;

     

       
843
       
 
       
            type = types.nullOr types.path;

     
···

       
918
       
 
       
            description = lib.mdDoc ''

     

       
919
       
 
       
              Path to YAML notification policies configuration. Can't be used with

     

       
920
       
 
       
              [](#opt-services.grafana.provision.alerting.policies.settings) simultaneously.

     

       
921
       
+
       
              Can be either a directory or a single YAML file. Will end up in the store.

     

       
922
       
 
       
            '';

     

       
923
       
 
       
            default = null;

     

       
924
       
 
       
            type = types.nullOr types.path;

     
···

       
988
       
 
       
            description = lib.mdDoc ''

     

       
989
       
 
       
              Path to YAML templates configuration. Can't be used with

     

       
990
       
 
       
              [](#opt-services.grafana.provision.alerting.templates.settings) simultaneously.

     

       
991
       
+
       
              Can be either a directory or a single YAML file. Will end up in the store.

     

       
992
       
 
       
            '';

     

       
993
       
 
       
            default = null;

     

       
994
       
 
       
            type = types.nullOr types.path;

     
···

       
1070
       
 
       
            description = lib.mdDoc ''

     

       
1071
       
 
       
              Path to YAML mute timings configuration. Can't be used with

     

       
1072
       
 
       
              [](#opt-services.grafana.provision.alerting.muteTimings.settings) simultaneously.

     

       
1073
       
+
       
              Can be either a directory or a single YAML file. Will end up in the store.

     

       
1074
       
 
       
            '';

     

       
1075
       
 
       
            default = null;

     

       
1076
       
 
       
            type = types.nullOr types.path;

     

···

       
163
       
 
       
        };

     

       
164
       
 
       
      };

     

       
165
       
 
       
    };

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
166
       
 
       
  };

     

       
167
       
 
       


     

       
168
       
 
       
  nodes = builtins.mapAttrs (_: val: mkMerge [ val baseGrafanaConf ]) extraNodeConfs;

     
···

       
180
       
 
       


     

       
181
       
 
       
    nodeNix = ("Nix (new format)", provisionNix)

     

       
182
       
 
       
    nodeYaml = ("Nix (YAML)", provisionYaml)

     

       
0
       
 
       

     

       
183
       
 
       


     

       
184
       
-
       
    for description, machine in [nodeNix, nodeYaml]:

     

       
185
       
 
       
        with subtest(f"Should start provision node: {description}"):

     

       
186
       
 
       
            machine.wait_for_unit("grafana.service")

     

       
187
       
 
       
            machine.wait_for_open_port(3000)

     

···

       
163
       
 
       
        };

     

       
164
       
 
       
      };

     

       
165
       
 
       
    };

     

       
166
       
+
       


     

       
167
       
+
       
    provisionYamlDirs = let

     

       
168
       
+
       
      mkdir = p: pkgs.writeTextDir (baseNameOf p) (builtins.readFile p);

     

       
169
       
+
       
    in {

     

       
170
       
+
       
      services.grafana.provision = {

     

       
171
       
+
       
        datasources.path = mkdir ./datasources.yaml;

     

       
172
       
+
       
        dashboards.path = mkdir ./dashboards.yaml;

     

       
173
       
+
       
        alerting = {

     

       
174
       
+
       
          rules.path = mkdir ./rules.yaml;

     

       
175
       
+
       
          contactPoints.path = mkdir ./contact-points.yaml;

     

       
176
       
+
       
          policies.path = mkdir ./policies.yaml;

     

       
177
       
+
       
          templates.path = mkdir ./templates.yaml;

     

       
178
       
+
       
          muteTimings.path = mkdir ./mute-timings.yaml;

     

       
179
       
+
       
        };

     

       
180
       
+
       
      };

     

       
181
       
+
       
    };

     

       
182
       
 
       
  };

     

       
183
       
 
       


     

       
184
       
 
       
  nodes = builtins.mapAttrs (_: val: mkMerge [ val baseGrafanaConf ]) extraNodeConfs;

     
···

       
196
       
 
       


     

       
197
       
 
       
    nodeNix = ("Nix (new format)", provisionNix)

     

       
198
       
 
       
    nodeYaml = ("Nix (YAML)", provisionYaml)

     

       
199
       
+
       
    nodeYamlDir = ("Nix (YAML in dirs)", provisionYamlDirs)

     

       
200
       
 
       


     

       
201
       
+
       
    for description, machine in [nodeNix, nodeYaml, nodeYamlDir]:

     

       
202
       
 
       
        with subtest(f"Should start provision node: {description}"):

     

       
203
       
 
       
            machine.wait_for_unit("grafana.service")

     

       
204
       
 
       
            machine.wait_for_open_port(3000)