Declarative disk partitioning and formatting using nix [maintainer=@Lassulus]
Go to file
github-actions[bot] 6cbdfdba2e flake.lock: Update
Flake lock file updates:

• Updated input 'nixpkgs':
    'github:NixOS/nixpkgs/1046c7b92e908a1202c0f1ba3fc21d19e1cf1b62' (2023-02-06)
  → 'github:NixOS/nixpkgs/6ccc4a59c3f1b56d039d93da52696633e641bc71' (2023-02-09)
2023-02-13 01:42:50 +00:00
.github ci: remove unneeded github token 2023-02-07 13:37:43 +01:00
disk-deactivate jq: filter null values from mountpoints from lsblk output 2023-02-03 14:57:55 +01:00
docs better structure 2023-02-03 13:27:21 +01:00
example style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
tests style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
types fix mdadm raid device numbering style 2023-02-09 01:08:13 +00:00
.gitignore add gitignore 2022-08-17 14:53:43 +02:00
bors.toml update bors toml 2023-01-23 15:35:25 +01:00
ci.nix style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
cli.nix style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
default.nix style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
disko add support for another mountpoint than /mnt 2023-01-28 18:08:31 +01:00
doc.nix style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
flake.lock flake.lock: Update 2023-02-13 01:42:50 +00:00
flake.nix style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
LICENSE Create LICENSE 2022-10-02 22:31:39 +02:00
linux-testing-bcachefs.nix style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
module.nix style: Apply nixpkgs-fmt and fix 2023-02-06 14:24:34 +00:00
package.nix delete obsolete types.nix 2023-02-02 14:42:09 +01:00
README.md insert output of the cli --help 2023-02-03 13:29:45 +01:00

disko - declarative disk partitioning

Disko takes the NixOS module system and makes it work for disk partitioning as well.

I wanted to write a curses NixOS installer, and that was the first step that I hit; the disk formatting is a manual process. Once that's done, the NixOS system itself is declarative, but the actual formatting of disks is manual.

Features

  • supports LVM, ZFS, btrfs, GPT, mdadm, ext4, ...
  • supports recursive layouts
  • outputs a NixOS-compatible module
  • CLI

How-to guides

NixOS installation

For a NixOS installation follow this quickstart guid.

Using without NixOS

Reference

Module options

TODO: link to generated module options

Examples

./examples

CLI

$ nix run github:nix-community/disko --

disko [options] disk-config.nix
or disko [options] --flake github:somebody/somewhere

Options:

* -m, --mode mode
  set the mode, either create or mount
* -f, --flake uri
  fetch the disko config relative to this flake's root
* --arg name value
  pass value to nix-build. can be used to set disk-names for example
* --argstr name value
  pass value to nix-build as string
* --root-mountpoint /mnt
  where to mount the device tree
* --dry-run
  just show the path to the script instead of running it
* --debug
  run with set -x

Installing NixOS module

You can use the NixOS module in one of the following ways:

Flakes (Current recommendation)

If you use nix flakes support:

{
  inputs.disko.url = "github:nix-community/disko";
  inputs.disko.inputs.nixpkgs.follows = "nixpkgs";

  outputs = { self, nixpkgs, disko }: {
    # change `yourhostname` to your actual hostname
    nixosConfigurations.yourhostname = nixpkgs.lib.nixosSystem {
      # change to your system:
      system = "x86_64-linux";
      modules = [
        ./configuration.nix
        disko.nixosModules.disko
      ];
    };
  };
}
niv

First add it to niv:

$ niv add nix-community/disko

Then add the following to your configuration.nix in the imports list:

{
  imports = [ "${(import ./nix/sources.nix).disko}/modules/disko.nix" ];
}
nix-channel

As root run:

$ nix-channel --add https://github.com/nix-community/disko/archive/master.tar.gz disko
$ nix-channel --update

Then add the following to your configuration.nix in the imports list:

{
  imports = [ <disko/modules/disko.nix> ];
}
fetchTarball

Add the following to your configuration.nix:

{
  imports = [ "${builtins.fetchTarball "https://github.com/nix-community/disko/archive/master.tar.gz"}/module.nix" ];
}

or with pinning:

{
  imports = let
    # replace this with an actual commit id or tag
    commit = "f2783a8ef91624b375a3cf665c3af4ac60b7c278";
  in [ 
    "${builtins.fetchTarball {
      url = "https://github.com/nix-community/disko/archive/${commit}.tar.gz";
      # replace this with an actual hash
      sha256 = "0000000000000000000000000000000000000000000000000000";
    }}/module.nix"
  ];
}

Using the NixOS module

{
  # checkout the example folder for how to configure different disko layouts
  disko.devices = {
    disk.sda = {
      device = "/dev/sda";
      type = "disk";
      content = {
        type = "table";
        format = "gpt";
        partitions = [
          {
            type = "partition";
            name = "ESP";
            start = "1MiB";
            end = "100MiB";
            bootable = true;
            content = {
              type = "filesystem";
              format = "vfat";
              mountpoint = "/boot";
            };
          }
          {
            name = "root";
            type = "partition";
            start = "100MiB";
            end = "100%";
            part-type = "primary";
            bootable = true;
            content = {
              type = "filesystem";
              format = "ext4";
              mountpoint = "/";
            };
          }
        ];
      };
    };
  };
}

this will configure fileSystems and other required NixOS options to boot the specified configuration.

If you are on an installer, you probably want to disable enableConfig.

disko will create the scripts disko-create and disko-mount which can be used to create/mount the configured disk layout.