diff options
author | Bas van Dijk <bas@van.dijk.ch> | 2021-11-07 14:45:40 +0000 |
---|---|---|
committer | Bas van Dijk <bas@van.dijk.ch> | 2021-11-07 14:45:40 +0000 |
commit | 0e4abb0df773cf7d9ff8dc2792358c0b8508d5eb (patch) | |
tree | 6f5522bfd1bf27f3d39d4a3f6cc763b78d8e6ee1 /nixos | |
parent | dd1edacb7bb7d60af46467c1d27c1c457d33210b (diff) |
nixos/prometheus: remove services.prometheus.environmentFile
The option `services.prometheus.environmentFile` has been removed since it was causing [issues](https://github.com/NixOS/nixpkgs/issues/126083) and Prometheus now has native support for secret files.
Diffstat (limited to 'nixos')
-rw-r--r-- | nixos/doc/manual/from_md/release-notes/rl-2111.section.xml | 9 | ||||
-rw-r--r-- | nixos/doc/manual/release-notes/rl-2111.section.md | 2 | ||||
-rw-r--r-- | nixos/modules/services/monitoring/prometheus/default.nix | 91 | ||||
-rw-r--r-- | nixos/tests/prometheus.nix | 11 |
4 files changed, 21 insertions, 92 deletions
diff --git a/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml index e5e7c112c617..ebf4bd2bd5e5 100644 --- a/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml +++ b/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml @@ -1805,6 +1805,15 @@ Superuser created successfully. </listitem> <listitem> <para> + The option + <literal>services.prometheus.environmentFile</literal> has + been removed since it was causing + <link xlink:href="https://github.com/NixOS/nixpkgs/issues/126083">issues</link> + and Prometheus now has native support for secret files. + </para> + </listitem> + <listitem> + <para> Dokuwiki now supports caddy! However </para> <itemizedlist spacing="compact"> diff --git a/nixos/doc/manual/release-notes/rl-2111.section.md b/nixos/doc/manual/release-notes/rl-2111.section.md index 144e08340157..c0b12b479a22 100644 --- a/nixos/doc/manual/release-notes/rl-2111.section.md +++ b/nixos/doc/manual/release-notes/rl-2111.section.md @@ -508,6 +508,8 @@ In addition to numerous new and upgraded packages, this release has the followin - A new option `services.prometheus.enableReload` has been added which can be enabled to reload the prometheus service when its config file changes instead of restarting. +- The option `services.prometheus.environmentFile` has been removed since it was causing [issues](https://github.com/NixOS/nixpkgs/issues/126083) and Prometheus now has native support for secret files. + - Dokuwiki now supports caddy! However - the nginx option has been removed, in the new configuration, please use the `dokuwiki.webserver = "nginx"` instead. - The "${hostname}" option has been deprecated, please use `dokuwiki.sites = [ "${hostname}" ]` instead diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index cdda6c5ce3ae..a35bf145308d 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -9,13 +9,6 @@ let prometheusYmlOut = "${workingDir}/prometheus-substituted.yaml"; - writeConfig = pkgs.writeShellScriptBin "write-prometheus-config" '' - PATH="${makeBinPath (with pkgs; [ coreutils envsubst ])}" - touch '${prometheusYmlOut}' - chmod 600 '${prometheusYmlOut}' - envsubst -o '${prometheusYmlOut}' -i '${prometheusYml}' - ''; - triggerReload = pkgs.writeShellScriptBin "trigger-reload-prometheus" '' PATH="${makeBinPath (with pkgs; [ systemd ])}" if systemctl -q is-active prometheus.service; then @@ -76,8 +69,8 @@ let "--storage.tsdb.path=${workingDir}/data/" "--config.file=${ if cfg.enableReload - then prometheusYmlOut - else "/run/prometheus/prometheus-substituted.yaml" + then "/etc/prometheus/prometheus.yaml" + else prometheusYml }" "--web.listen-address=${cfg.listenAddress}:${builtins.toString cfg.port}" "--alertmanager.notification-queue-capacity=${toString cfg.alertmanagerNotificationQueueCapacity}" @@ -1625,51 +1618,6 @@ in (<literal>switch-to-configuration</literal>) that changes the prometheus configuration only finishes successully when prometheus has finished loading the new configuration. - - Note that prometheus will also get reloaded when the location of the - <option>environmentFile</option> changes but not when its contents - changes. So when you change it contents make sure to reload prometheus - manually or include the hash of <option>environmentFile</option> in its - name. - ''; - }; - - environmentFile = mkOption { - type = types.nullOr types.path; - default = null; - example = "/root/prometheus.env"; - description = '' - Environment file as defined in <citerefentry> - <refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum> - </citerefentry>. - - Secrets may be passed to the service without adding them to the - world-readable Nix store, by specifying placeholder variables as - the option value in Nix and setting these variables accordingly in the - environment file. - - Environment variables from this file will be interpolated into the - config file using envsubst with this syntax: - <literal>$ENVIRONMENT ''${VARIABLE}</literal> - - <programlisting> - # Example scrape config entry handling an OAuth bearer token - { - job_name = "home_assistant"; - metrics_path = "/api/prometheus"; - scheme = "https"; - bearer_token = "\''${HOME_ASSISTANT_BEARER_TOKEN}"; - [...] - } - </programlisting> - - <programlisting> - # Content of the environment file - HOME_ASSISTANT_BEARER_TOKEN=someoauthbearertoken - </programlisting> - - Note that this file needs to be available on the host on which - <literal>Prometheus</literal> is running. ''; }; @@ -1830,13 +1778,12 @@ in uid = config.ids.uids.prometheus; group = "prometheus"; }; + environment.etc."prometheus/prometheus.yaml" = mkIf cfg.enableReload { + source = prometheusYml; + }; systemd.services.prometheus = { wantedBy = [ "multi-user.target" ]; after = [ "network.target" ]; - preStart = mkIf (!cfg.enableReload) '' - ${lib.getBin pkgs.envsubst}/bin/envsubst -o "/run/prometheus/prometheus-substituted.yaml" \ - -i "${prometheusYml}" - ''; serviceConfig = { ExecStart = "${cfg.package}/bin/prometheus" + optionalString (length cmdlineArgs != 0) (" \\\n " + @@ -1844,7 +1791,6 @@ in ExecReload = mkIf cfg.enableReload "+${reload}/bin/reload-prometheus"; User = "prometheus"; Restart = "always"; - EnvironmentFile = mkIf (cfg.environmentFile != null && !cfg.enableReload) [ cfg.environmentFile ]; RuntimeDirectory = "prometheus"; RuntimeDirectoryMode = "0700"; WorkingDirectory = workingDir; @@ -1852,18 +1798,6 @@ in StateDirectoryMode = "0700"; }; }; - systemd.services.prometheus-config-write = mkIf cfg.enableReload { - wantedBy = [ "prometheus.service" ]; - before = [ "prometheus.service" ]; - serviceConfig = { - Type = "oneshot"; - User = "prometheus"; - StateDirectory = cfg.stateDir; - StateDirectoryMode = "0700"; - EnvironmentFile = mkIf (cfg.environmentFile != null) [ cfg.environmentFile ]; - ExecStart = "${writeConfig}/bin/write-prometheus-config"; - }; - }; # prometheus-config-reload will activate after prometheus. However, what we # don't want is that on startup it immediately reloads prometheus because # prometheus itself might have just started. @@ -1873,26 +1807,19 @@ in # harmless message and then stay active (RemainAfterExit). # # Then, when the config file has changed, switch-to-configuration notices - # that this service has changed and needs to be reloaded - # (reloadIfChanged). The reload command then actually writes the new config - # and reloads prometheus. + # that this service has changed (restartTriggers) and needs to be reloaded + # (reloadIfChanged). The reload command then reloads prometheus. systemd.services.prometheus-config-reload = mkIf cfg.enableReload { wantedBy = [ "prometheus.service" ]; after = [ "prometheus.service" ]; reloadIfChanged = true; + restartTriggers = [ prometheusYml ]; serviceConfig = { Type = "oneshot"; - User = "prometheus"; - StateDirectory = cfg.stateDir; - StateDirectoryMode = "0700"; - EnvironmentFile = mkIf (cfg.environmentFile != null) [ cfg.environmentFile ]; RemainAfterExit = true; TimeoutSec = 60; ExecStart = "${pkgs.logger}/bin/logger 'prometheus-config-reload will only reload prometheus when reloaded itself.'"; - ExecReload = [ - "${writeConfig}/bin/write-prometheus-config" - "+${triggerReload}/bin/trigger-reload-prometheus" - ]; + ExecReload = [ "${triggerReload}/bin/trigger-reload-prometheus" ]; }; }; }; diff --git a/nixos/tests/prometheus.nix b/nixos/tests/prometheus.nix index d102b4c07518..20f8c4459e10 100644 --- a/nixos/tests/prometheus.nix +++ b/nixos/tests/prometheus.nix @@ -130,14 +130,10 @@ in import ./make-test-python.nix { # This configuration just adds a new prometheus job # to scrape the node_exporter metrics of the s3 machine. - # We also use an environmentFile to test if that works correctly. services.prometheus = { - environmentFile = pkgs.writeText "prometheus-config-env-file" '' - JOB_NAME=s3-node_exporter - ''; scrapeConfigs = [ { - job_name = "$JOB_NAME"; + job_name = "s3-node_exporter"; static_configs = [ { targets = [ "s3:9100" ]; @@ -232,11 +228,6 @@ in import ./make-test-python.nix { # Check if prometheus responds to requests: prometheus.wait_for_unit("prometheus.service") - # Check if prometheus' config file is correctly locked down because it could contain secrets. - prometheus.succeed( - "stat -c '%a %U' /var/lib/prometheus2/prometheus-substituted.yaml | grep '600 prometheus'" - ) - prometheus.wait_for_open_port(${toString queryPort}) prometheus.succeed("curl -sf http://127.0.0.1:${toString queryPort}/metrics") |