diskimage-builder

History

Steve Baker f61548d863 Add thin provisioning support to growvols This change enhances the growvols script to support all volumes being backed by one thin provisioning pool. If a pool is detected, the following occurs: - validation to confirm every volume is backed by the pool - only the pool is extended into the new partition - volumes are extended by the same amount as the non thin-provisioned case This results in no volumes being over-provisioned, so out-of-space behaviour will be the same as the non thin-provisioned case. This change also switches to using /dev/mapper device mapper paths for volume block devices, since that is the only path the thin pool is mapped to. Change-Id: I96085fc889e72c942cfef7e3acb6f6cd73f606dd		2022-08-24 10:14:26 +12:00
..
environment.d	Add a growvols utility for growing LVM volumes	2021-07-01 11:16:31 +12:00
init-scripts/systemd	Make growvols config path platform independent	2022-02-04 00:23:13 +03:00
post-install.d	Make growvols config path platform independent	2022-02-04 00:23:13 +03:00
static/usr/local/sbin	Add thin provisioning support to growvols	2022-08-24 10:14:26 +12:00
tests	Add thin provisioning support to growvols	2022-08-24 10:14:26 +12:00
__init__.py	Add a growvols utility for growing LVM volumes	2021-07-01 11:16:31 +12:00
element-deps	Add a growvols utility for growing LVM volumes	2021-07-01 11:16:31 +12:00
package-installs.yaml	Add a growvols utility for growing LVM volumes	2021-07-01 11:16:31 +12:00
README.rst	Add a growvols utility for growing LVM volumes	2021-07-01 11:16:31 +12:00

README.rst

========
growvols
========

Grow one or more LVM volumes on first boot.

This installs utility `growvols` which grows the logical volumes in an LVM group
to take available device space.

The positional arguments specify how available space is allocated. They
have the format <volume>=<amount><unit> where:

<volume> is the label or the mountpoint of the logical volume
<amount> is an integer growth amount in the specified unit
<unit> is one of the supported units

Supported units are:

% percentage of available device space before any changes are made
MiB mebibyte (1048576 bytes)
GiB gibibyte (1073741824 bytes)
MB megabyte (1000000 bytes)
GB gigabyte (1000000000 bytes)

Each argument is processed in order and the requested amount is allocated
to each volume until the disk is full. This means that if space is
overallocated, the last volumes may only grow by the remaining space, or
not grow at all, and a warning will be printed. When space is underallocated
the remaining space will be given to the root volume (mounted at /).

The currently supported partition layout is:
- Exactly one of the partitions containing an LVM group
- The disk having unpartitioned space to grow with
- The LVM logical volumes being formatted with XFS filesystems

Example usage:

growvols /var=80% /home=20GB

growvols --device sda --group vg img-rootfs=20% fs_home=20GiB fs_var=60%

Environment variables can be set during image build to enable a systemd unit
which will run growvols on boot:

# DIB_GROWVOLS_TRIGGER defaults to 'manual'. When set to 'systemd' a systemd
# unit will run using the following arguments
export DIB_GROWVOLS_TRIGGER=systemd

# DIB_GROWVOLS_ARGS contains the positional arguments for which volumes to grow
# by what amount. If omitted the volume mounted at / will grow by all available
# space
export DIB_GROWVOLS_ARGS="img-rootfs=20% fs_home=20GiB fs_var=60%"

# DIB_GROWVOLS_GROUP contains the name of the LVM group to extend. Defaults the
# discovered group if only one exists.
export DIB_GROWVOLS_GROUP=vg

# DIB_GROWVOLS_DEVICE is the name of the disk block device to grow the
# volumes in (such as "sda"). Defaults to the disk containing the root mount.
export DIB_GROWVOLS_DEVICE=sda