Skip to content

Commit

Permalink
nixos/specialisation.nix: Extract module
Browse files Browse the repository at this point in the history
  • Loading branch information
roberth authored and rtimush committed Sep 21, 2023
1 parent a5d6315 commit 7da2585
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 63 deletions.
1 change: 1 addition & 0 deletions nixos/modules/module-list.nix
Original file line number Diff line number Diff line change
Expand Up @@ -1224,6 +1224,7 @@
./services/x11/xfs.nix
./services/x11/xserver.nix
./system/activation/activation-script.nix
./system/activation/specialisation.nix
./system/activation/top-level.nix
./system/boot/binfmt.nix
./system/boot/emergency-mode.nix
Expand Down
85 changes: 85 additions & 0 deletions nixos/modules/system/activation/specialisation.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
{ config, lib, pkgs, extendModules, noUserModules, ... }:

let
inherit (lib)
concatStringsSep
mapAttrs
mapAttrsToList
mkOption
types
;

# This attribute is responsible for creating boot entries for
# child configuration. They are only (directly) accessible
# when the parent configuration is boot default. For example,
# you can provide an easy way to boot the same configuration
# as you use, but with another kernel
# !!! fix this
children =
mapAttrs
(childName: childConfig: childConfig.configuration.system.build.toplevel)
config.specialisation;

in
{
options = {

specialisation = mkOption {
default = { };
example = lib.literalExpression "{ fewJobsManyCores.configuration = { nix.settings = { core = 0; max-jobs = 1; }; }; }";
description = lib.mdDoc ''
Additional configurations to build. If
`inheritParentConfig` is true, the system
will be based on the overall system configuration.
To switch to a specialised configuration
(e.g. `fewJobsManyCores`) at runtime, run:
```
sudo /run/current-system/specialisation/fewJobsManyCores/bin/switch-to-configuration test
```
'';
type = types.attrsOf (types.submodule (
local@{ ... }:
let
extend =
if local.config.inheritParentConfig
then extendModules
else noUserModules.extendModules;
in
{
options.inheritParentConfig = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Include the entire system's configuration. Set to false to make a completely differently configured system.";
};

options.configuration = mkOption {
default = { };
description = lib.mdDoc ''
Arbitrary NixOS configuration.
Anything you can add to a normal NixOS configuration, you can add
here, including imports and config values, although nested
specialisations will be ignored.
'';
visible = "shallow";
inherit (extend { modules = [ ./no-clone.nix ]; }) type;
};
}
));
};

};

config = {
system.systemBuilderCommands = ''
mkdir $out/specialisation
${concatStringsSep "\n"
(mapAttrsToList (name: path: "ln -s ${path} $out/specialisation/${name}") children)}
'';
};

# uses extendModules to generate a type
meta.buildDocsInSandbox = false;
}
64 changes: 1 addition & 63 deletions nixos/modules/system/activation/top-level.nix
Original file line number Diff line number Diff line change
@@ -1,21 +1,8 @@
{ config, lib, pkgs, extendModules, noUserModules, ... }:
{ config, lib, pkgs, ... }:

with lib;

let


# This attribute is responsible for creating boot entries for
# child configuration. They are only (directly) accessible
# when the parent configuration is boot default. For example,
# you can provide an easy way to boot the same configuration
# as you use, but with another kernel
# !!! fix this
children =
mapAttrs
(childName: childConfig: childConfig.configuration.system.build.toplevel)
config.specialisation;

systemBuilder =
let
kernelPath = "${config.boot.kernelPackages.kernel}/" +
Expand Down Expand Up @@ -77,10 +64,6 @@ let
echo -n "$nixosLabel" > $out/nixos-version
echo -n "${config.boot.kernelPackages.stdenv.hostPlatform.system}" > $out/system
mkdir $out/specialisation
${concatStringsSep "\n"
(mapAttrsToList (name: path: "ln -s ${path} $out/specialisation/${name}") children)}
mkdir $out/bin
export localeArchive="${config.i18n.glibcLocales}/lib/locale/locale-archive"
substituteAll ${./switch-to-configuration.pl} $out/bin/switch-to-configuration
Expand Down Expand Up @@ -163,49 +146,6 @@ in

options = {

specialisation = mkOption {
default = {};
example = lib.literalExpression "{ fewJobsManyCores.configuration = { nix.settings = { core = 0; max-jobs = 1; }; }; }";
description = lib.mdDoc ''
Additional configurations to build. If
`inheritParentConfig` is true, the system
will be based on the overall system configuration.
To switch to a specialised configuration
(e.g. `fewJobsManyCores`) at runtime, run:
```
sudo /run/current-system/specialisation/fewJobsManyCores/bin/switch-to-configuration test
```
'';
type = types.attrsOf (types.submodule (
local@{ ... }: let
extend = if local.config.inheritParentConfig
then extendModules
else noUserModules.extendModules;
in {
options.inheritParentConfig = mkOption {
type = types.bool;
default = true;
description = lib.mdDoc "Include the entire system's configuration. Set to false to make a completely differently configured system.";
};

options.configuration = mkOption {
default = {};
description = lib.mdDoc ''
Arbitrary NixOS configuration.
Anything you can add to a normal NixOS configuration, you can add
here, including imports and config values, although nested
specialisations will be ignored.
'';
visible = "shallow";
inherit (extend { modules = [ ./no-clone.nix ]; }) type;
};
})
);
};

system.boot.loader.id = mkOption {
internal = true;
default = "";
Expand Down Expand Up @@ -377,6 +317,4 @@ in

};

# uses extendModules to generate a type
meta.buildDocsInSandbox = false;
}

0 comments on commit 7da2585

Please sign in to comment.