diff --git a/docs/machineregistration-reference.md b/docs/machineregistration-reference.md index 40703f7d2..cf9a5300f 100644 --- a/docs/machineregistration-reference.md +++ b/docs/machineregistration-reference.md @@ -103,7 +103,7 @@ Supports the following values: | tty | string | empty | Add named tty to grub | | poweroff | bool | false | Shutdown the system after install | | reboot | bool | false | Reboot the system after install | -| snapshotter | string | loopdevice | Type of device used to manage snapshots in OS images ('loopdevice' or 'btrfs'). | +| snapshotter | obj | empty | Snapshotter configuration. See [reference](#configelementalinstallsnapshotter) | | eject-cd | bool | false | Try to eject the cd on reboot | :::warning warning @@ -185,6 +185,17 @@ The currently supported keys are: The rules are AND:ed together, which means all rules must match the targeted device. +#### config.elemental.install.snapshotter + +You can configure how Elemental manages snapshots on the installed machine. +New snapshots are created for example when [upgrading](./upgrade) the machine with a new OS image. +The `loopdevice` snapshotter will unpack new images on a `ext4` filesystem, while the `btrfs` snapshotter will make use of the underlying [btrfs snapshots](https://archive.kernel.org/oldwiki/btrfs.wiki.kernel.org/index.php/SysadminGuide.html#Snapshots) functionality, greatly reducing the amount of disk space needed to store multiple snapshots. + +| Key | Type | Default value | Description | +|----------|--------|---------------|---------------------------------------------------------------------------------| +| type | string | loopdevice | Type of device used to manage snapshots in OS images ('loopdevice' or 'btrfs'). | +| maxSnaps | int | 2 | Maximum amount of snapshots to keep. | + #### config.elemental.reset Contains the reset configuration that would be applied via `elemental-register --reset`, when booted from the recovery partition and passed to [`elemental reset`](https://github.com/rancher/elemental-toolkit/blob/main/docs/elemental_reset.md) diff --git a/versioned_docs/version-1.6/machineregistration-reference.md b/versioned_docs/version-1.6/machineregistration-reference.md index 445df7ae3..86aa12e86 100644 --- a/versioned_docs/version-1.6/machineregistration-reference.md +++ b/versioned_docs/version-1.6/machineregistration-reference.md @@ -92,7 +92,7 @@ Supports the following values: | tty | string | empty | Add named tty to grub | | poweroff | bool | false | Shutdown the system after install | | reboot | bool | false | Reboot the system after install | -| snapshotter | string | loopdevice | Type of device used to manage snapshots in OS images ('loopdevice' or 'btrfs'). | +| snapshotter | obj | empty | Snapshotter configuration. See [reference](#configelementalinstallsnapshotter) | | eject-cd | bool | false | Try to eject the cd on reboot | :::warning warning @@ -174,6 +174,16 @@ The currently supported keys are: The rules are AND:ed together, which means all rules must match the targeted device. +#### config.elemental.install.snapshotter + +You can configure how Elemental manages snapshots on the installed machine. +New snapshots are created for example when [upgrading](./upgrade) the machine with a new OS image. +The `loopdevice` snapshotter will unpack new images on a `ext4` filesystem, while the `btrfs` snapshotter will make use of the underlying [btrfs snapshots](https://archive.kernel.org/oldwiki/btrfs.wiki.kernel.org/index.php/SysadminGuide.html#Snapshots) functionality, greatly reducing the amount of disk space needed to store multiple snapshots. + +| Key | Type | Default value | Description | +|----------|--------|---------------|---------------------------------------------------------------------------------| +| type | string | loopdevice | Type of device used to manage snapshots in OS images ('loopdevice' or 'btrfs'). | + #### config.elemental.reset Contains the reset configuration that would be applied via `elemental-register --reset`, when booted from the recovery partition and passed to [`elemental reset`](https://github.com/rancher/elemental-toolkit/blob/main/docs/elemental_reset.md)