nixos/prometheus: remove services.prometheus.environmentFile #144984
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The option `services.prometheus.environmentFile` has been removed since it was causing [issues](NixOS#126083) and Prometheus now has native support for secret files.
github-actions
bot
added
6.topic: nixos
|
@GrahamcOfBorg test prometheus |
ofborg
bot
added
10.rebuild-darwin: 0
Mic92
reviewed
Nov 7, 2021
| serviceConfig = { | ||
| ExecStart = "${cfg.package}/bin/prometheus" + | ||
| optionalString (length cmdlineArgs != 0) (" \\\n " + | ||
| concatStringsSep " \\\n " cmdlineArgs); | ||
| ExecReload = mkIf cfg.enableReload "+${reload}/bin/reload-prometheus"; | ||
| User = "prometheus"; | ||
| Restart = "always"; | ||
| EnvironmentFile = mkIf (cfg.environmentFile != null && !cfg.enableReload) [ cfg.environmentFile ]; |
There was a problem hiding this comment.
Should there maybe a deprecation phase with a warning?
There was a problem hiding this comment.
Since this is causing issues (#126083, #127889 (comment)) and since there's now an alternative I think it's better to go without a deprecation cycle. I did now add a mkRemovedOptionModule so that users get a helpful error message when they define services.prometheus.environmentFile.
Mic92
reviewed
Nov 7, 2021
| @@ -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" | |||
There was a problem hiding this comment.
Also how does the new secrets work? Can we add documentation for this?
There was a problem hiding this comment.
I added the alternatives to the release notes and to the mkRemovedOptionModule error message.
…ronmentFile is defined
|
@GrahamcOfBorg test prometheus |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
The option
services.prometheus.environmentFilehas been removed since it was causing issues and Prometheus now has native support for secret files.This fixes #126083 and replaces #128731.
Things done
sandbox = trueset innix.conf? (See Nix manual)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"./result/bin/)