snix/users/edef/fetchroots
Florian Klink 36e4d017f5 chore(snix): s/tvix/snix/
Change-Id: Iae961416eea0a38bc57df7b736f6dda5903b0828
2025-03-17 17:15:08 +00:00
..
src feat(users/edef/fetchroots): init 2024-10-17 16:40:38 +00:00
.gitignore chore(users/edef/fetchroots): wire up the build 2024-10-17 16:41:03 +00:00
Cargo.lock chore(nix-compat): bump to nom 8.x 2025-03-04 08:17:05 +00:00
Cargo.nix chore(snix): s/tvix/snix/ 2025-03-17 17:15:08 +00:00
Cargo.toml chore(snix): s/tvix/snix/ 2025-03-17 17:15:08 +00:00
default.nix chore(snix): s/tvix/snix/ 2025-03-17 17:15:08 +00:00
README.md docs(users/edef/fetchroots): add a README for other users 2024-10-17 16:41:03 +00:00

fetchroots

This tool is part of a suite of tools built to manage cache.nixos.org.

This tool's purpose is to build an index of all the GC roots from the channels.nixos.org releases. The result is then combined with other tools.

It does this by:

  1. Listing all the release files in the bucket.
  2. Getting the data for each of the release.
  3. Putting them in a local parquet file.

Getting started

In order to run this, you'll need AWS SSO credentials from the NixOS Infra team.

Get the creds from https://nixos.awsapps.com/start/ -> LBNixOS_Dev_PDX -> AWSReadOnlyAccess.

Run mg run, you should see a progress bar.

Congrats, you now have a roots.parquet file. You can now load it with python polars-rs or clickhouse.

roots.parquet file format

  • key (String): the release, eg nixos/22.11-small/nixos-22.11.513.563dc6476b8
  • timestamp (DateTime): the timestamp of the GC roots file for this release
  • store_path_hash (List[Binary]): hash part of the store paths rooted by this release

Development

When the Cargo.lock changes, run mg run //tools:crate2nix-generate.

To build the project, run mg build.

To get a dev environment, run nix-shell -p cargo.