58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
# ZFS Block {#blocks-zfs}
|
|
|
|
Defined in [`/modules/blocks/zfs.nix`](@REPO@/modules/blocks/zfs.nix):
|
|
|
|
```nix
|
|
{
|
|
inputs,
|
|
...
|
|
}:
|
|
{
|
|
imports = [
|
|
inputs.selfhostblocks.nixosModules.zfs
|
|
];
|
|
}
|
|
```
|
|
|
|
This block creates ZFS datasets, optionally mounts them and sets permissions on the mount point.
|
|
|
|
## Features {#blocks-zfs-features}
|
|
|
|
- Creates ZFS dataset which is [optionally mounted](#blocks-zfs-options-shb.zfs.pools._name_.datasets._name_.path).
|
|
- Sets permissions, [owner](#blocks-zfs-options-shb.zfs.pools._name_.datasets._name_.owner), [group](#blocks-zfs-options-shb.zfs.pools._name_.datasets._name_.group) and [ACL](#blocks-zfs-options-shb.zfs.pools._name_.datasets._name_.defaultACLs) on the mount point.
|
|
|
|
## Usage {#blocks-zfs-usage}
|
|
|
|
Create a dataset at `root/safe/users` mounted on `/var/lib/nixos`:
|
|
|
|
```nix
|
|
shb.zfs.pools.root.datasets."safe/users".path = "/var/lib/nixos";
|
|
```
|
|
|
|
Create a dataset at `backup/syncoid` but do not mount it:
|
|
|
|
```nix
|
|
shb.zfs.pools.backup.datasets."syncoid".path = "none";
|
|
```
|
|
|
|
Create a dataset at `root/syncthing` and set custom permissions and ACL.
|
|
Permission and ACL are only enforced for the mount point.
|
|
|
|
```nix
|
|
shb.zfs.pools.root.datasets."syncthing" = {
|
|
path = "/srv/syncthing";
|
|
|
|
mode = "ug=rwx,g+s,o=";
|
|
owner = "syncthing";
|
|
group = "syncthing";
|
|
defaultACLs = "g:syncthing:rwX";
|
|
};
|
|
```
|
|
|
|
## Options Reference {#blocks-zfs-options}
|
|
|
|
```{=include=} options
|
|
id-prefix: blocks-zfs-options-
|
|
list-id: selfhostblocks-block-zfs-options
|
|
source: @OPTIONS_JSON@
|
|
```
|