Maximilian Bosch ec7dc46bfc nixos/grafana: update instructions on secret rotation
Closes #495278

Turns out that the documentation about secrets[1] is actually a little
misleading and I let myself fool by it: the rotation is about moving
to envelope-based encryption, i.e. a way where a key is generated and
stored in the DB that is encrypted with `secret_key` and used to
decrypt actual secrets.

In fact, there's no official way to rotate this on a running instance.
The reason this wasn't noticed so far is because I'd expect most people
to

* use provisioning to set up their datasources (or)
* talk to a local Prometheus (or else) API that is exposed on the
  machine only and thus no authentication is needed if you trust that
  machine enough.

On top, the encryption is unauthenticated so only changing secret_key
appears to work, but uses gibberish as password for authentication
against data-sources.

So effectively there are two ways to migrate (short of a fresh setup):

* keep the old secret and call it a day. IMHO this is fine if the setup
  is e.g. a single-node machine where both the secret and the DB are on
  the same file-system, in the same data-dir and protected by the same
  permissions.

* use a 3rd-party rotation tool[2]. I ensured by hand on a test-instance
  that following the instructions works and you end up with a freshly
  generated secret_key that you need to deploy. With that key deployed,
  the credentials still decrypt to the same plaintext.

[1] https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-database-encryption/#envelope-encryption
[2] https://github.com/erooke/grafana-secretkey-rotation-tool/tree/d9dc788902fa5185e15cb15ce6129f7237ab6138
2026-03-08 19:00:21 +01:00
2026-03-08 17:39:09 +00:00

NixOS logo

Contributors badge Open Collective supporters

Nixpkgs is a collection of over 120,000 software packages that can be installed with the Nix package manager. It also implements NixOS, a purely-functional Linux distribution.

Manuals

  • NixOS Manual - how to install, configure, and maintain a purely-functional Linux distribution
  • Nixpkgs Manual - contributing to Nixpkgs and using programming-language-specific Nix expressions
  • Nix Package Manager Manual - how to write Nix expressions (programs), and how to use Nix command line tools

Community

Other Project Repositories

The sources of all official Nix-related projects are in the NixOS organization on GitHub. Here are some of the main ones:

Continuous Integration and Distribution

Nixpkgs and NixOS are built and tested by our continuous integration system, Hydra.

Artifacts successfully built with Hydra are published to cache at https://cache.nixos.org/. When successful build and test criteria are met, the Nixpkgs expressions are distributed via Nix channels.

Contributing

Nixpkgs is among the most active projects on GitHub. While thousands of open issues and pull requests might seem like a lot at first, it helps to consider it in the context of the scope of the project. Nixpkgs describes how to build tens of thousands of pieces of software and implements a Linux distribution. The GitHub Insights page gives a sense of the project activity.

Community contributions are always welcome through GitHub Issues and Pull Requests.

For more information about contributing to the project, please visit the contributing page.

Donations

The infrastructure for NixOS and related projects is maintained by a nonprofit organization, the NixOS Foundation. To ensure the continuity and expansion of the NixOS infrastructure, we are looking for donations to our organization.

You can donate to the NixOS Foundation through SEPA bank transfers or by using Open Collective:

License

Nixpkgs is licensed under the MIT License.

Note

MIT license does not apply to the packages built by Nixpkgs, merely to the files in this repository (the Nix expressions, build scripts, NixOS modules, etc.). It also might not apply to patches included in Nixpkgs, which may be derivative works of the packages to which they apply. The aforementioned artifacts are all covered by the licenses of the respective packages.

S
Description
No description provided
Readme
5 GiB
Languages
Nix 95%
Shell 2%
Python 1.8%
Rust 0.3%
JavaScript 0.2%
Other 0.4%