Mirrors/disko
2
0
Fork 0
mirror of https://github.com/nix-community/disko synced 2024-11-10 06:14:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

types: refactor into diskoLib

Browse source
This commit is contained in:
lassulus 2023-05-16 13:40:03 +02:00
parent efb2016c8e
commit 22b33a4fd6
21 changed files with 146 additions and 146 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
default.nix
View file

@ -3,45 +3,45 @@
, checked ? false
}:
let
types = import ./types { inherit lib rootMountPoint; };
diskoLib = import ./lib { inherit lib rootMountPoint; };
eval = cfg: lib.evalModules {
modules = lib.singleton {
# _file = toString input;
imports = lib.singleton { disko.devices = cfg.disko.devices; };
options = {
disko.devices = lib.mkOption {
type = types.devices;
type = diskoLib.devices;
};
};
};
};
in
{
types = types;
create = cfg: types.diskoLib.create (eval cfg).config.disko.devices;
createScript = cfg: pkgs: (types.diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-create" ''
export PATH=${lib.makeBinPath (types.diskoLib.packages (eval cfg).config.disko.devices pkgs)}:$PATH
${types.diskoLib.create (eval cfg).config.disko.devices}
lib = diskoLib;
create = cfg: diskoLib.create (eval cfg).config.disko.devices;
createScript = cfg: pkgs: (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-create" ''
export PATH=${lib.makeBinPath (diskoLib.packages (eval cfg).config.disko.devices pkgs)}:$PATH
${diskoLib.create (eval cfg).config.disko.devices}
'';
createScriptNoDeps = cfg: pkgs: (types.diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-create" ''
${types.diskoLib.create (eval cfg).config.disko.devices}
createScriptNoDeps = cfg: pkgs: (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-create" ''
${diskoLib.create (eval cfg).config.disko.devices}
'';
mount = cfg: types.diskoLib.mount (eval cfg).config.disko.devices;
mountScript = cfg: pkgs: (types.diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-mount" ''
export PATH=${lib.makeBinPath (types.diskoLib.packages (eval cfg).config.disko.devices pkgs)}:$PATH
${types.diskoLib.mount (eval cfg).config.disko.devices}
mount = cfg: diskoLib.mount (eval cfg).config.disko.devices;
mountScript = cfg: pkgs: (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-mount" ''
export PATH=${lib.makeBinPath (diskoLib.packages (eval cfg).config.disko.devices pkgs)}:$PATH
${diskoLib.mount (eval cfg).config.disko.devices}
'';
mountScriptNoDeps = cfg: pkgs: (types.diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-mount" ''
${types.diskoLib.mount (eval cfg).config.disko.devices}
mountScriptNoDeps = cfg: pkgs: (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-mount" ''
${diskoLib.mount (eval cfg).config.disko.devices}
'';
zapCreateMount = cfg: types.diskoLib.zapCreateMount (eval cfg).config.disko.devices;
zapCreateMountScript = cfg: pkgs: (types.diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-zap-create-mount" ''
export PATH=${lib.makeBinPath (types.diskoLib.packages (eval cfg).config.disko.devices pkgs)}:$PATH
${types.diskoLib.zapCreateMount (eval cfg).config.disko.devices}
zapCreateMount = cfg: diskoLib.zapCreateMount (eval cfg).config.disko.devices;
zapCreateMountScript = cfg: pkgs: (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-zap-create-mount" ''
export PATH=${lib.makeBinPath (diskoLib.packages (eval cfg).config.disko.devices pkgs)}:$PATH
${diskoLib.zapCreateMount (eval cfg).config.disko.devices}
'';
zapCreateMountScriptNoDeps = cfg: pkgs: (types.diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-zap-create-mount" ''
${types.diskoLib.zapCreateMount (eval cfg).config.disko.devices}
zapCreateMountScriptNoDeps = cfg: pkgs: (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko-zap-create-mount" ''
${diskoLib.zapCreateMount (eval cfg).config.disko.devices}
'';
config = cfg: { imports = types.diskoLib.config (eval cfg).config.disko.devices; };
packages = cfg: types.diskoLib.packages (eval cfg).config.disko.devices;
config = cfg: { imports = diskoLib.config (eval cfg).config.disko.devices; };
packages = cfg: diskoLib.packages (eval cfg).config.disko.devices;
}

4
doc.nix
View file

@ -1,7 +1,7 @@
{ lib, nixosOptionsDoc, runCommand, fetchurl, pandoc }:
let
types = import ./types {
diskoLib = import ./lib {
inherit lib;
rootMountPoint = "/mnt";
};
@ -10,7 +10,7 @@ let
{
options.disko = {
devices = lib.mkOption {
type = types.devices;
type = diskoLib.devices;
default = { };
description = "The devices to set up";
};

8
types/btrfs.nix → lib/btrfs.nix
View file

@ -1,4 +1,4 @@
({ config, options, diskoLib, lib, subTypes, optionTypes, rootMountPoint, ... }:
{ config, options, diskoLib, lib, rootMountPoint, ... }:
{
options = {
type = lib.mkOption {
@ -17,12 +17,12 @@
description = "A list of options to pass to mount.";
};
subvolumes = lib.mkOption {
type = lib.types.attrsOf subTypes.btrfs_subvol;
type = lib.types.attrsOf diskoLib.types.btrfs_subvol;
default = { };
description = "Subvolumes to define for BTRFS.";
};
mountpoint = lib.mkOption {
type = lib.types.nullOr optionTypes.absolute-pathname;
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = null;
description = "A path to mount the BTRFS filesystem to.";
};
@ -83,4 +83,4 @@
description = "Packages";
};
};
})
}

4
types/btrfs_subvol.nix → lib/btrfs_subvol.nix
View file

@ -1,4 +1,4 @@
{ config, options, diskoLib, lib, optionTypes, rootMountPoint, ... }:
{ config, options, diskoLib, lib, rootMountPoint, ... }:
{
options = {
name = lib.mkOption {
@ -23,7 +23,7 @@
description = "Options to pass to mount";
};
mountpoint = lib.mkOption {
type = lib.types.nullOr optionTypes.absolute-pathname;
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = null;
description = "Location to mount the subvolume to.";
};

163
types/default.nix → lib/default.nix
View file

@ -2,7 +2,7 @@
with lib;
with builtins;
rec {
let
diskoLib = {
# like lib.types.oneOf but instead of a list takes an attrset
@ -17,14 +17,14 @@ rec {
# option for valid contents of partitions (basically like devices, but without tables)
partitionType = lib.mkOption {
type = lib.types.nullOr (diskoLib.subType { inherit (subTypes) btrfs filesystem zfs mdraid luks lvm_pv swap; });
type = lib.types.nullOr (diskoLib.subType { inherit (diskoLib.types) btrfs filesystem zfs mdraid luks lvm_pv swap; });
default = null;
description = "The type of partition";
};
# option for valid contents of devices
deviceType = lib.mkOption {
type = lib.types.nullOr (diskoLib.subType { inherit (subTypes) table btrfs filesystem zfs mdraid luks lvm_pv swap; });
type = lib.types.nullOr (diskoLib.subType { inherit (diskoLib.types) table btrfs filesystem zfs mdraid luks lvm_pv swap; });
default = null;
description = "The type of device";
};
@ -160,7 +160,7 @@ rec {
postMountHook = diskoLib.mkHook "shell commands to run after mount";
};
config._module.args = {
inherit diskoLib optionTypes subTypes rootMountPoint;
inherit diskoLib rootMountPoint;
};
}
];
@ -274,87 +274,88 @@ rec {
packages :: lib.types.devices -> pkgs -> [ derivation ]
*/
packages = devices: pkgs: unique (flatten (map (dev: dev._pkgs pkgs) (flatten (map attrValues (attrValues devices)))));
};
optionTypes = rec {
filename = lib.mkOptionType {
name = "filename";
check = isString;
merge = mergeOneOption;
description = "A filename";
};
optionTypes = rec {
filename = lib.mkOptionType {
name = "filename";
check = isString;
merge = mergeOneOption;
description = "A filename";
};
absolute-pathname = lib.mkOptionType {
name = "absolute pathname";
check = x: isString x && substring 0 1 x == "/" && pathname.check x;
merge = mergeOneOption;
description = "An absolute path";
};
absolute-pathname = lib.mkOptionType {
name = "absolute pathname";
check = x: isString x && substring 0 1 x == "/" && pathname.check x;
merge = mergeOneOption;
description = "An absolute path";
};
pathname = lib.mkOptionType {
name = "pathname";
check = x:
let
# The filter is used to normalize paths, i.e. to remove duplicated and
# trailing slashes. It also removes leading slashes, thus we have to
# check for "/" explicitly below.
xs = filter (s: stringLength s > 0) (splitString "/" x);
in
isString x && (x == "/" || (length xs > 0 && all filename.check xs));
merge = mergeOneOption;
description = "A path name";
};
};
/* topLevel type of the disko config, takes attrsets of disks, mdadms, zpools, nodevs, and lvm vgs.
*/
devices = lib.types.submodule {
options = {
disk = lib.mkOption {
type = lib.types.attrsOf subTypes.disk;
default = { };
description = "Block device";
};
mdadm = lib.mkOption {
type = lib.types.attrsOf subTypes.mdadm;
default = { };
description = "mdadm device";
};
zpool = lib.mkOption {
type = lib.types.attrsOf subTypes.zpool;
default = { };
description = "ZFS pool device";
};
lvm_vg = lib.mkOption {
type = lib.types.attrsOf subTypes.lvm_vg;
default = { };
description = "LVM VG device";
};
nodev = lib.mkOption {
type = lib.types.attrsOf subTypes.nodev;
default = { };
description = "A non-block device";
pathname = lib.mkOptionType {
name = "pathname";
check = x:
let
# The filter is used to normalize paths, i.e. to remove duplicated and
# trailing slashes. It also removes leading slashes, thus we have to
# check for "/" explicitly below.
xs = filter (s: stringLength s > 0) (splitString "/" x);
in
isString x && (x == "/" || (length xs > 0 && all filename.check xs));
merge = mergeOneOption;
description = "A path name";
};
};
};
subTypes = lib.mapAttrs (_: diskoLib.mkSubType) {
nodev = ./nodev.nix;
btrfs = ./btrfs.nix;
btrfs_subvol = ./btrfs_subvol.nix;
filesystem = ./filesystem.nix;
table = ./table.nix;
swap = ./swap.nix;
lvm_pv = ./lvm_pv.nix;
lvm_vg = ./lvm_vg.nix;
zfs = ./zfs.nix;
zpool = ./zpool.nix;
zfs_dataset = ./zfs_dataset.nix;
zfs_fs = ./zfs_fs.nix;
zfs_volume = ./zfs_volume.nix;
mdadm = ./mdadm.nix;
mdraid = ./mdraid.nix;
luks = ./luks.nix;
disk = ./disk.nix;
/* topLevel type of the disko config, takes attrsets of disks, mdadms, zpools, nodevs, and lvm vgs.
*/
devices = lib.types.submodule {
options = {
disk = lib.mkOption {
type = lib.types.attrsOf diskoLib.types.disk;
default = { };
description = "Block device";
};
mdadm = lib.mkOption {
type = lib.types.attrsOf diskoLib.types.mdadm;
default = { };
description = "mdadm device";
};
zpool = lib.mkOption {
type = lib.types.attrsOf diskoLib.types.zpool;
default = { };
description = "ZFS pool device";
};
lvm_vg = lib.mkOption {
type = lib.types.attrsOf diskoLib.types.lvm_vg;
default = { };
description = "LVM VG device";
};
nodev = lib.mkOption {
type = lib.types.attrsOf diskoLib.types.nodev;
default = { };
description = "A non-block device";
};
};
};
types = lib.mapAttrs (_: diskoLib.mkSubType) {
nodev = ./nodev.nix;
btrfs = ./btrfs.nix;
btrfs_subvol = ./btrfs_subvol.nix;
filesystem = ./filesystem.nix;
table = ./table.nix;
swap = ./swap.nix;
lvm_pv = ./lvm_pv.nix;
lvm_vg = ./lvm_vg.nix;
zfs = ./zfs.nix;
zpool = ./zpool.nix;
zfs_dataset = ./zfs_dataset.nix;
zfs_fs = ./zfs_fs.nix;
zfs_volume = ./zfs_volume.nix;
mdadm = ./mdadm.nix;
mdraid = ./mdraid.nix;
luks = ./luks.nix;
disk = ./disk.nix;
};
};
}
in
diskoLib

4
types/disk.nix → lib/disk.nix
View file

@ -1,4 +1,4 @@
{ config, options, lib, diskoLib, optionTypes, ... }:
{ config, options, lib, diskoLib, ... }:
{
options = {
name = lib.mkOption {
@ -13,7 +13,7 @@
description = "Type";
};
device = lib.mkOption {
type = optionTypes.absolute-pathname; # TODO check if subpath of /dev ? - No! eg: /.swapfile
type = diskoLib.optionTypes.absolute-pathname; # TODO check if subpath of /dev ? - No! eg: /.swapfile
description = "Device path";
};
content = diskoLib.deviceType;

4
types/filesystem.nix → lib/filesystem.nix
View file

@ -1,4 +1,4 @@
{ config, options, lib, diskoLib, optionTypes, rootMountPoint, ... }:
{ config, options, lib, diskoLib, rootMountPoint, ... }:
{
options = {
type = lib.mkOption {
@ -17,7 +17,7 @@
description = "Options to pass to mount";
};
mountpoint = lib.mkOption {
type = lib.types.nullOr optionTypes.absolute-pathname;
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = null;
description = "Path to mount the filesystem to";
};

4
types/luks.nix → lib/luks.nix
View file

@ -1,4 +1,4 @@
{ config, options, lib, diskoLib, optionTypes, ... }:
{ config, options, lib, diskoLib, ... }:
{
options = {
type = lib.mkOption {
@ -11,7 +11,7 @@
description = "Name of the LUKS";
};
keyFile = lib.mkOption {
type = lib.types.nullOr optionTypes.absolute-pathname;
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = null;
description = "Path to the key for encryption";
example = "/tmp/disk.key";

0
types/lvm_pv.nix → lib/lvm_pv.nix
View file

2
types/lvm_vg.nix → lib/lvm_vg.nix
View file

@ -1,4 +1,4 @@
{ config, options, lib, diskoLib, subTypes, ... }:
{ config, options, lib, diskoLib, ... }:
{
options = {
name = lib.mkOption {

0
types/mdadm.nix → lib/mdadm.nix
View file

0
types/mdraid.nix → lib/mdraid.nix
View file

4
types/nodev.nix → lib/nodev.nix
View file

@ -1,4 +1,4 @@
{ lib, config, options, diskoLib, optionTypes, rootMountPoint, ... }:
{ lib, config, options, diskoLib, rootMountPoint, ... }:
{
options = {
type = lib.mkOption {
@ -17,7 +17,7 @@
description = "Device to use";
};
mountpoint = lib.mkOption {
type = lib.types.nullOr optionTypes.absolute-pathname;
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = config._module.args.name;
description = "Location to mount the file system at";
};

0
types/swap.nix → lib/swap.nix
View file

2
types/table.nix → lib/table.nix
View file

@ -1,4 +1,4 @@
{ config, options, lib, diskoLib, subTypes, ... }:
{ config, options, lib, diskoLib, ... }:
{
options = {
type = lib.mkOption {

0
types/zfs.nix → lib/zfs.nix
View file

4
types/zfs_fs.nix → lib/zfs_fs.nix
View file

@ -1,4 +1,4 @@
{ config, options, lib, diskoLib, optionTypes, rootMountPoint, ... }:
{ config, options, lib, diskoLib, rootMountPoint, ... }:
{
options = {
name = lib.mkOption {
@ -24,7 +24,7 @@
};
mountpoint = lib.mkOption {
type = lib.types.nullOr optionTypes.absolute-pathname;
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = null;
description = "Path to mount the dataset to";
};

2
types/zfs_volume.nix → lib/zfs_volume.nix
View file

@ -1,4 +1,4 @@
{ config, options, lib, diskoLib, optionTypes, rootMountPoint, ... }:
{ config, options, lib, diskoLib, rootMountPoint, ... }:
{
options = {
name = lib.mkOption {

7
types/zpool.nix → lib/zpool.nix
View file

@ -1,4 +1,4 @@
{ config, options, lib, diskoLib, optionTypes, subTypes, rootMountPoint, ... }:
{ config, options, lib, diskoLib, rootMountPoint, ... }:
{
options = {
name = lib.mkOption {
@ -28,7 +28,7 @@
description = "Options for the root filesystem";
};
mountpoint = lib.mkOption {
type = lib.types.nullOr optionTypes.absolute-pathname;
type = lib.types.nullOr diskoLib.optionTypes.absolute-pathname;
default = null;
description = "The mountpoint of the pool";
};
@ -49,8 +49,7 @@
'';
};
datasets = lib.mkOption {
type = lib.types.attrsOf (diskoLib.subType { inherit (subTypes) zfs_fs zfs_volume; });
# type = lib.types.attrsOf subTypes.zfs_fs;
type = lib.types.attrsOf (diskoLib.subType { inherit (diskoLib.types) zfs_fs zfs_volume; });
description = "List of datasets to define";
};
_meta = lib.mkOption {

32
module.nix
View file

@ -1,6 +1,6 @@
{ config, lib, pkgs, ... }:
let
types = import ./types {
diskoLib = import ./lib {
inherit lib;
rootMountPoint = config.disko.rootMountPoint;
};
@ -10,7 +10,7 @@ in
{
options.disko = {
devices = lib.mkOption {
type = types.devices;
type = diskoLib.devices;
default = { };
description = "The devices to set up";
};
@ -37,29 +37,29 @@ in
};
};
config = lib.mkIf (cfg.devices.disk != { }) {
system.build.formatScript = (types.diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-create" ''
export PATH=${lib.makeBinPath (types.diskoLib.packages cfg.devices pkgs)}:$PATH
${types.diskoLib.create cfg.devices}
system.build.formatScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-create" ''
export PATH=${lib.makeBinPath (diskoLib.packages cfg.devices pkgs)}:$PATH
${diskoLib.create cfg.devices}
'';
system.build.mountScript = (types.diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-mount" ''
export PATH=${lib.makeBinPath (types.diskoLib.packages cfg.devices pkgs)}:$PATH
${types.diskoLib.mount cfg.devices}
system.build.mountScript = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko-mount" ''
export PATH=${lib.makeBinPath (diskoLib.packages cfg.devices pkgs)}:$PATH
${diskoLib.mount cfg.devices}
'';
system.build.disko = (types.diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko" ''
export PATH=${lib.makeBinPath (types.diskoLib.packages cfg.devices pkgs)}:$PATH
${types.diskoLib.zapCreateMount cfg.devices}
system.build.disko = (diskoLib.writeCheckedBash { inherit pkgs checked; }) "disko" ''
export PATH=${lib.makeBinPath (diskoLib.packages cfg.devices pkgs)}:$PATH
${diskoLib.zapCreateMount cfg.devices}
'';
# This is useful to skip copying executables uploading a script to an in-memory installer
system.build.diskoNoDeps = (types.diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko" ''
${types.diskoLib.zapCreateMount cfg.devices}
system.build.diskoNoDeps = (diskoLib.writeCheckedBash { inherit pkgs checked; noDeps = true; }) "disko" ''
${diskoLib.zapCreateMount cfg.devices}
'';
# Remember to add config keys here if they are added to types
fileSystems = lib.mkIf cfg.enableConfig (lib.mkMerge (lib.catAttrs "fileSystems" (types.diskoLib.config cfg.devices)));
boot = lib.mkIf cfg.enableConfig (lib.mkMerge (lib.catAttrs "boot" (types.diskoLib.config cfg.devices)));
swapDevices = lib.mkIf cfg.enableConfig (lib.mkMerge (lib.catAttrs "swapDevices" (types.diskoLib.config cfg.devices)));
fileSystems = lib.mkIf cfg.enableConfig (lib.mkMerge (lib.catAttrs "fileSystems" (diskoLib.config cfg.devices)));
boot = lib.mkIf cfg.enableConfig (lib.mkMerge (lib.catAttrs "boot" (diskoLib.config cfg.devices)));
swapDevices = lib.mkIf cfg.enableConfig (lib.mkMerge (lib.catAttrs "swapDevices" (diskoLib.config cfg.devices)));
};
}

2
package.nix
View file

@ -8,7 +8,7 @@ stdenvNoCC.mkDerivation rec {
];
installPhase = ''
mkdir -p $out/bin $out/share/disko
cp -r cli.nix default.nix disk-deactivate types $out/share/disko
cp -r cli.nix default.nix disk-deactivate lib $out/share/disko
sed \
-e "s|libexec_dir=\".*\"|libexec_dir=\"$out/share/disko\"|" \
-e "s|#!/usr/bin/env.*|#!/usr/bin/env bash|" \