| commit | 4d6b6a4921ebb6b114439a3262af2350c52669f6 | [log] [tgz] |
|---|---|---|
| author | Skyler Grey <sky@a.starrysky.fyi> | Mon Aug 05 18:08:19 2024 +0000 |
| committer | Skyler Grey <minion@clicks.codes> | Thu Aug 08 21:25:44 2024 +0000 |
| tree | b09fd95c969dc48a2eb47eb141a7e5dc787c987f | |
| parent | ec13fbd7a8bfe2eff569df5ad77d007599bbffc2 [diff] |
test(modules): Check eval is identical to nixpkgs We want these modules to be importable by people, as a set, even if they don't want to use all of the options or import all of the dependencies This test makes sure of 2 things - Our modules can be evaluated on the default configuration with only stuff that is permitted in our README - Without some configuration, our modules do not change the outputted system toplevel This can be used as a rough proxy for being "safe to import", as hopefully these modules won't introduce any changes to your config from only an import Change-Id: Ied99c3460a76f205de1724db2c531723cc3506b5 Reviewed-on: https://git.clicks.codes/c/Infra/NixFiles/+/812 Reviewed-by: Skyler Grey <minion@clicks.codes> Tested-by: Skyler Grey <minion@clicks.codes>
This repository contains system configuration for Clicks's infrastructure.
Config is written using Snowfall lib. It keeps us organized and has some nice features like namespaces.
Devices are named after colors, areas are named as a letter, with the matching phonetic alphabet word. Areas are generally managed by one member of Clicks, who has full access to all of the servers in that area. If you require help for a specific area you can email admin@clicks.codes and in the subject line include the area you want help for.
| System | Description | Address |
|---|---|---|
| teal | Primary Host | teal.alpha.clicks.domains |
| a1d2 | Build Server | d2.a1.clicks.domains |
Deploys are done with deploy-rs, you'll need to be able to ssh into a machine with its hostname (either by a nifty .ssh/config rule or tailscale).
Once you've done that, you'll be able to deploy with
$ deploy .#MACHINE_NAME
If you're importing our modules, even if you don't enable most of them, you'll find it easiest and best to import them all. This is because the nixpkgs module system checks if all given options are defined, even if they aren't enabled in your specific configuration.
The module system doesn't do this with traditional if statements or lib.optionalAttrs, only lib.mkIf, so we've made sure to use lib.optionalAttrs for anything that depends on things not in this list:
nixpkgsWe expect the majority of you will already have all of these imported. We use and test against stateVersion = "24.05", and while we expect these modules to generally work with earlier or later stateVersions, please be aware that this could cause unexpcted effects
We may also depend on:
lib.nixosSystem (lib, pkgs, etc.) being passed into our moduleslib being extended such that lib.clicks is equal to the lib exported from our flakeWe expect the lib extension to be a minor change, and providing standard arguments to modules to already be the case.
This means that, provided you don't enable any options, importing the Clicks modules will be safe so long as your flake fulfils all of these factors: we won't break eval and we won't change any of your settings. If you'd like to see how we test that, please check out ./modules.spec.nix
We expect no additions to this list, except a potential future change of adding auxolotl modules to this list when we consider them stable and easily-importable. Additions to this list will always be considered breaking changes.
(n.b. If you're wondering why we didn't use lib.optionalAttrs everywhere, it's because using it loses us some laziness, making it much easier to make infinite recursions. If we replaced every lib.mkIf with lib.optionalAttrs in our own config, for instance, it would no longer evaluate)