pyrox.dev / nixpkgs
lol
fork atom

nixos/loki: skip config validation when it's impossible to validate

This is a follow-up to 8d7f3c9dbde7d235f3e256f2dc13ec07e68f60f6 and
ae48735c531aaa01fb083333b1ec7e538c04b99d.

Running the config validation in the build sandbox is impossible and
will fail when using `cfg.configFile` or `-config.expand-env=true`.

`cfg.configFile` is a string of a path which is simply not available to
the build sandbox.

Similarly, one may opt to use `cfg.configuration` with environment
variables in combination with `-config.expand-env=true`.

The environment variables referenced that way are also not available
in the build sandbox.

So we skip the validation when it's impossible (`cfg.configFile`) or
likely impossible (`-config.expand-env=true`).

An alternative approach would be something like nixos/prometheus'
`services.prometheus.checkConfig` that takes a boolean and makes
toggling the config validation user-facing.

emilylange 100c1501 68ead292

options
unified split
Changed files
+7 -2
nixos
modules
services
monitoring
loki.nix
+7 -2
nixos/modules/services/monitoring/loki.nix 
···

       
97

       
 

       



     

       
98

       
 

       
      serviceConfig = let


     

       
99

       
 

       
        conf = if cfg.configFile == null


     

       
100

       
-

       
               then prettyJSON cfg.configuration


     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       

       

       
     

       
101

       
 

       
               else cfg.configFile;


     

       
102

       
 

       
        validateConfig = file:


     

       
103

       
 

       
        pkgs.runCommand "validate-loki-conf" {


     
···

       
108

       
 

       
          '';


     

       
109

       
 

       
      in


     

       
110

       
 

       
      {


     

       
111

       
-

       
        ExecStart = "${cfg.package}/bin/loki --config.file=${validateConfig conf} ${escapeShellArgs cfg.extraFlags}";


     

       
112

       
 

       
        User = cfg.user;


     

       
113

       
 

       
        Restart = "always";


     

       
114

       
 

       
        PrivateTmp = true;


     
···

       
97

       
 

       



     

       
98

       
 

       
      serviceConfig = let


     

       
99

       
 

       
        conf = if cfg.configFile == null


     

       
100

       
+

       
               then


     

       
101

       
+

       
                 # Config validation may fail when using extraFlags = [ "-config.expand-env=true" ].


     

       
102

       
+

       
                 # To work around this, we simply skip it when extraFlags is not empty.


     

       
103

       
+

       
                 if cfg.extraFlags == []


     

       
104

       
+

       
                 then validateConfig (prettyJSON cfg.configuration)


     

       
105

       
+

       
                 else prettyJSON cfg.configuration


     

       
106

       
 

       
               else cfg.configFile;


     

       
107

       
 

       
        validateConfig = file:


     

       
108

       
 

       
        pkgs.runCommand "validate-loki-conf" {


     
···

       
113

       
 

       
          '';


     

       
114

       
 

       
      in


     

       
115

       
 

       
      {


     

       
116

       
+

       
        ExecStart = "${cfg.package}/bin/loki --config.file=${conf} ${escapeShellArgs cfg.extraFlags}";


     

       
117

       
 

       
        User = cfg.user;


     

       
118

       
 

       
        Restart = "always";


     

       
119

       
 

       
        PrivateTmp = true;