diskimage-builder/diskimage_builder/elements/growvols/README.rst
Steve Baker a6e0bf83db Add a growvols utility for growing LVM volumes
There is currently no automated way of growing LVM volumes on boot
like single partition images do with their growroot mechanism. This
lack likely contributes to LVM not being widely used on VM and
baremetal workloads, since growing to the full disk requires workload
knowledge to determine which volumes to grow and by what amount.

The growvols element contributes a growvols python script which can be
run on firstboot (via systemd or cloud-init) or manually via
automation such as ansible. It is also an interactive script which
displays the full list of modifying commands before prompting for
confirmation to run them all.

By default the script will grow the root volume, but arguments allow
any volume to grow by a specified amount, or a percentage of the
available disk space.

Blueprint: whole-disk-default
Change-Id: Idcf774384e56cce03e56c0e19c7d08a768606399
2021-07-01 11:16:31 +12:00

60 lines
2.2 KiB
ReStructuredText

========
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