Skip to content

single-disk 🔹

Configures partitioning of the main disk

Categories

System

Primary Disk Layout

A module for the "disk-layout" category MUST be chosen.

There is exactly one slot for this type of module in the UI, if you don't fill the slot, your machine cannot boot

This module is a good choice for most machines. In the future clan will offer a broader choice of disk-layouts

The UI will ask for the options of this module:

device: "/dev/null"

Usage example

inventory.json 

"services": {
    "single-disk": {
        "default": {
            "meta": {
                "name": "single-disk"
            },
            "roles": {
                "default": {
                    "machines": ["jon"]
                }
            },
            "machines": {
                "jon": {
                    "config": {
                        "device": "/dev/null"
                    }
                }
            }
        }
    }
}

Usage via Inventory

Roles

This module can be used via predefined roles

- `default`

Every role has its own configuration options. Which are each listed below.

For more information, see the inventory guide.

Example

For example the admin module adds the following options globally to all machines where it is used.

clan.admin.allowedkeys

This means there are two equivalent ways to set the allowedkeys option. Either via a nixos module or via the inventory interface. But it is recommended to keep together imports and config to preserve locality of the module configuration.

clan-core.lib.buildClan {
    inventory.services = {
        admin.me = {
            roles.default.machines = [ "jon" ];
            config.allowedkeys = [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQD..." ];
        };
    };
};

clan-core.lib.buildClan {
    machines = {
        jon = {
            clan.admin.allowedkeys = [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQD..." ];
            imports = [ clanModules.admin ];
        };
    };
};

Options of default role

The following options are available when using the default role.

clan.single-disk.device

The primary disk device to install the system on

Type: null or string

Default:

null

default.nix

Usage via Nix

This module can be also imported directly in your nixos configuration. Although it is recommended to use the inventory interface if available.

Some modules are considered 'low-level' or 'expert modules' and are not available via the inventory interface.

{config, lib, inputs, ...}: {
    imports = [ inputs.clan-core.clanModules.single-disk ];
    # ...
}

Module Options

The following options are available for this module.

clan.single-disk.device

The primary disk device to install the system on

Type: null or string

Default:

null

default.nix