Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prometheus: add tls_config #56017

Merged
merged 1 commit into from Apr 12, 2019
Merged

prometheus: add tls_config #56017

merged 1 commit into from Apr 12, 2019

Conversation

elohmeier
Copy link
Contributor

Motivation for this change

added this config part for tls_auth:
https://prometheus.io/docs/prometheus/latest/configuration/configuration/#tls_config

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@matthewbauer
Copy link
Member

@GrahamcOfBorg eval

promTypes.tls_config = types.submodule {
options = {
ca_file = mkOption {
type = types.nullOr types.path;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change the type to types.nullOr types.str.

Using a path like:

{
  tls_config = {
    ca_file = ./my-secret-ca-file;
  };
}

causes ./my-secret-ca-file to end up in the world-readable Nix store. We shouldn't force users to store their secrets there.

When using a string users can specify a path which is relative to the target system like "/run/keys/my-secret-ca-file" for example. This then won't cause that file to be copied to the Nix store.

If users do want to store their secret in the Nix store they can always use:

{
  tls_config = {
    ca_file = "${./my-secret-ca-file}";
  };
}

@elohmeier
Copy link
Contributor Author

Hi @basvandijk, thanks for your feedback and that thoughtful change request. I've changed the path's to types.str.

@basvandijk
Copy link
Member

@GrahamcOfBorg test prometheus prometheus2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants