Merge pull request #241690 from hercules-ci/nixos-nix-modules (54303b65) · Commits · nix / nixpkgs

nixos/modules/config/nix-channel.nix

0 → 100644

+70 −0

Original line number	Diff line number	Diff line
		/*
		Manages the things that are needed for a traditional nix-channel based
		configuration to work.

		See also
		- ./nix.nix
		- ./nix-flakes.nix
		*/
		{ config, lib, ... }:
		let
		inherit (lib)
		mkIf
		mkOption
		stringAfter
		types
		;

		cfg = config.nix;

		in
		{
		options = {
		nix = {
		nixPath = mkOption {
		type = types.listOf types.str;
		default = [
		"nixpkgs=/nix/var/nix/profiles/per-user/root/channels/nixos"
		"nixos-config=/etc/nixos/configuration.nix"
		"/nix/var/nix/profiles/per-user/root/channels"
		];
		description = lib.mdDoc ''
		The default Nix expression search path, used by the Nix
		evaluator to look up paths enclosed in angle brackets
		(e.g. `<nixpkgs>`).
		'';
		};
		};

		system = {
		defaultChannel = mkOption {
		internal = true;
		type = types.str;
		default = "https://nixos.org/channels/nixos-unstable";
		description = lib.mdDoc "Default NixOS channel to which the root user is subscribed.";
		};
		};
		};

		config = mkIf cfg.enable {

		environment.extraInit =
		''
		if [ -e "$HOME/.nix-defexpr/channels" ]; then
		export NIX_PATH="$HOME/.nix-defexpr/channels''${NIX_PATH:+:$NIX_PATH}"
		fi
		'';

		environment.sessionVariables = {
		NIX_PATH = cfg.nixPath;
		};

		system.activationScripts.nix-channel = stringAfter [ "etc" "users" ]
		''
		# Subscribe the root user to the NixOS channel by default.
		if [ ! -e "/root/.nix-channels" ]; then
		echo "${config.system.defaultChannel} nixos" > "/root/.nix-channels"
		fi
		'';
		};
		}

nixos/modules/config/nix-flakes.nix

0 → 100644

+95 −0

Original line number	Diff line number	Diff line
		/*
		Manages the flake registry.

		See also
		- ./nix.nix
		- ./nix-channel.nix
		*/
		{ config, lib, ... }:
		let
		inherit (lib)
		filterAttrs
		literalExpression
		mapAttrsToList
		mkDefault
		mkIf
		mkOption
		types
		;

		cfg = config.nix;

		in
		{
		options = {
		nix = {
		registry = mkOption {
		type = types.attrsOf (types.submodule (
		let
		referenceAttrs = with types; attrsOf (oneOf [
		str
		int
		bool
		path
		package
		]);
		in
		{ config, name, ... }:
		{
		options = {
		from = mkOption {
		type = referenceAttrs;
		example = { type = "indirect"; id = "nixpkgs"; };
		description = lib.mdDoc "The flake reference to be rewritten.";
		};
		to = mkOption {
		type = referenceAttrs;
		example = { type = "github"; owner = "my-org"; repo = "my-nixpkgs"; };
		description = lib.mdDoc "The flake reference {option}`from` is rewritten to.";
		};
		flake = mkOption {
		type = types.nullOr types.attrs;
		default = null;
		example = literalExpression "nixpkgs";
		description = lib.mdDoc ''
		The flake input {option}`from` is rewritten to.
		'';
		};
		exact = mkOption {
		type = types.bool;
		default = true;
		description = lib.mdDoc ''
		Whether the {option}`from` reference needs to match exactly. If set,
		a {option}`from` reference like `nixpkgs` does not
		match with a reference like `nixpkgs/nixos-20.03`.
		'';
		};
		};
		config = {
		from = mkDefault { type = "indirect"; id = name; };
		to = mkIf (config.flake != null) (mkDefault (
		{
		type = "path";
		path = config.flake.outPath;
		} // filterAttrs
		(n: _: n == "lastModified" \|\| n == "rev" \|\| n == "revCount" \|\| n == "narHash")
		config.flake
		));
		};
		}
		));
		default = { };
		description = lib.mdDoc ''
		A system-wide flake registry.
		'';
		};
		};
		};

		config = mkIf cfg.enable {
		environment.etc."nix/registry.json".text = builtins.toJSON {
		version = 2;
		flakes = mapAttrsToList (n: v: { inherit (v) from to exact; }) cfg.registry;
		};
		};
		}

nixos/modules/config/nix-remote-build.nix

0 → 100644

+230 −0

Original line number	Diff line number	Diff line
		/*
		Manages the remote build configuration, /etc/nix/machines

		See also
		- ./nix.nix
		- nixos/modules/services/system/nix-daemon.nix
		*/
		{ config, lib, ... }:

		let
		inherit (lib)
		any
		concatMapStrings
		concatStringsSep
		filter
		getVersion
		mkIf
		mkMerge
		mkOption
		optional
		optionalString
		types
		versionAtLeast
		;

		cfg = config.nix;

		nixPackage = cfg.package.out;

		isNixAtLeast = versionAtLeast (getVersion nixPackage);

		buildMachinesText =
		concatMapStrings
		(machine:
		(concatStringsSep " " ([
		"${optionalString (machine.protocol != null) "${machine.protocol}://"}${optionalString (machine.sshUser != null) "${machine.sshUser}@"}${machine.hostName}"
		(if machine.system != null then machine.system else if machine.systems != [ ] then concatStringsSep "," machine.systems else "-")
		(if machine.sshKey != null then machine.sshKey else "-")
		(toString machine.maxJobs)
		(toString machine.speedFactor)
		(let res = (machine.supportedFeatures ++ machine.mandatoryFeatures);
		in if (res == []) then "-" else (concatStringsSep "," res))
		(let res = machine.mandatoryFeatures;
		in if (res == []) then "-" else (concatStringsSep "," machine.mandatoryFeatures))
		]
		++ optional (isNixAtLeast "2.4pre") (if machine.publicHostKey != null then machine.publicHostKey else "-")))
		+ "\n"
		)
		cfg.buildMachines;

		in
		{
		imports = [
		./nix.nix
		];

		options = {
		nix = {
		buildMachines = mkOption {
		type = types.listOf (types.submodule {
		options = {
		hostName = mkOption {
		type = types.str;
		example = "nixbuilder.example.org";
		description = lib.mdDoc ''
		The hostname of the build machine.
		'';
		};
		protocol = mkOption {
		type = types.enum [ null "ssh" "ssh-ng" ];
		default = "ssh";
		example = "ssh-ng";
		description = lib.mdDoc ''
		The protocol used for communicating with the build machine.
		Use `ssh-ng` if your remote builder and your
		local Nix version support that improved protocol.

		Use `null` when trying to change the special localhost builder
		without a protocol which is for example used by hydra.
		'';
		};
		system = mkOption {
		type = types.nullOr types.str;
		default = null;
		example = "x86_64-linux";
		description = lib.mdDoc ''
		The system type the build machine can execute derivations on.
		Either this attribute or {var}`systems` must be
		present, where {var}`system` takes precedence if
		both are set.
		'';
		};
		systems = mkOption {
		type = types.listOf types.str;
		default = [ ];
		example = [ "x86_64-linux" "aarch64-linux" ];
		description = lib.mdDoc ''
		The system types the build machine can execute derivations on.
		Either this attribute or {var}`system` must be
		present, where {var}`system` takes precedence if
		both are set.
		'';
		};
		sshUser = mkOption {
		type = types.nullOr types.str;
		default = null;
		example = "builder";
		description = lib.mdDoc ''
		The username to log in as on the remote host. This user must be
		able to log in and run nix commands non-interactively. It must
		also be privileged to build derivations, so must be included in
		{option}`nix.settings.trusted-users`.
		'';
		};
		sshKey = mkOption {
		type = types.nullOr types.str;
		default = null;
		example = "/root/.ssh/id_buildhost_builduser";
		description = lib.mdDoc ''
		The path to the SSH private key with which to authenticate on
		the build machine. The private key must not have a passphrase.
		If null, the building user (root on NixOS machines) must have an
		appropriate ssh configuration to log in non-interactively.

		Note that for security reasons, this path must point to a file
		in the local filesystem, not to the nix store.
		'';
		};
		maxJobs = mkOption {
		type = types.int;
		default = 1;
		description = lib.mdDoc ''
		The number of concurrent jobs the build machine supports. The
		build machine will enforce its own limits, but this allows hydra
		to schedule better since there is no work-stealing between build
		machines.
		'';
		};
		speedFactor = mkOption {
		type = types.int;
		default = 1;
		description = lib.mdDoc ''
		The relative speed of this builder. This is an arbitrary integer
		that indicates the speed of this builder, relative to other
		builders. Higher is faster.
		'';
		};
		mandatoryFeatures = mkOption {
		type = types.listOf types.str;
		default = [ ];
		example = [ "big-parallel" ];
		description = lib.mdDoc ''
		A list of features mandatory for this builder. The builder will
		be ignored for derivations that don't require all features in
		this list. All mandatory features are automatically included in
		{var}`supportedFeatures`.
		'';
		};
		supportedFeatures = mkOption {
		type = types.listOf types.str;
		default = [ ];
		example = [ "kvm" "big-parallel" ];
		description = lib.mdDoc ''
		A list of features supported by this builder. The builder will
		be ignored for derivations that require features not in this
		list.
		'';
		};
		publicHostKey = mkOption {
		type = types.nullOr types.str;
		default = null;
		description = lib.mdDoc ''
		The (base64-encoded) public host key of this builder. The field
		is calculated via {command}`base64 -w0 /etc/ssh/ssh_host_type_key.pub`.
		If null, SSH will use its regular known-hosts file when connecting.
		'';
		};
		};
		});
		default = [ ];
		description = lib.mdDoc ''
		This option lists the machines to be used if distributed builds are
		enabled (see {option}`nix.distributedBuilds`).
		Nix will perform derivations on those machines via SSH by copying the
		inputs to the Nix store on the remote machine, starting the build,
		then copying the output back to the local Nix store.
		'';
		};

		distributedBuilds = mkOption {
		type = types.bool;
		default = false;
		description = lib.mdDoc ''
		Whether to distribute builds to the machines listed in
		{option}`nix.buildMachines`.
		'';
		};
		};
		};

		# distributedBuilds does not inhibit /etc/machines generation; caller may
		# override that nix option.
		config = mkIf cfg.enable {
		assertions =
		let badMachine = m: m.system == null && m.systems == [ ];
		in
		[
		{
		assertion = !(any badMachine cfg.buildMachines);
		message = ''
		At least one system type (via <varname>system</varname> or
		<varname>systems</varname>) must be set for every build machine.
		Invalid machine specifications:
		'' + " " +
		(concatStringsSep "\n "
		(map (m: m.hostName)
		(filter (badMachine) cfg.buildMachines)));
		}
		];

		# List of machines for distributed Nix builds
		environment.etc."nix/machines" =
		mkIf (cfg.buildMachines != [ ]) {
		text = buildMachinesText;
		};

		# Legacy configuration conversion.
		nix.settings = mkIf (!cfg.distributedBuilds) { builders = null; };
		};
		}

nixos/modules/services/misc/nix-daemon.nix→nixos/modules/config/nix.nix

+379 −0

File changed and moved.

Preview size limit exceeded, changes collapsed.

nixos/modules/misc/version.nix

+0 −7

Original line number	Diff line number	Diff line
		@@ -140,13 +140,6 @@ in
		'';
		};

		defaultChannel = mkOption {
		internal = true;
		type = types.str;
		default = "https://nixos.org/channels/nixos-unstable";
		description = lib.mdDoc "Default NixOS channel to which the root user is subscribed.";
		};

		configurationRevision = mkOption {
		type = types.nullOr types.str;
		default = null;

Admin message