diff --git a/README.md b/README.md index e13d2d42..f88c8d5d 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,15 @@ This role allows users to configure local storage with minimal input. As of now, the role supports managing file systems and mount entries on -- unpartitioned disks -- lvm (unpartitioned whole-disk physical volumes only) +- disks +- LVM volume groups +- Stratis pools + +Encryption (using LUKS) and RAID (using MD) is also supported. Support +for managing pre-existing devices is limited, but new LVM volumes and +Stratis filesystems can be added to existing setups and mount points +and some other features can be added to (or removed from) existing +devices. ## Requirements @@ -46,13 +53,17 @@ keys: - `type` This specifies the type of pool to manage. - Valid values for `type`: `lvm`. + Valid values for `type`: `lvm`, `stratis`. - `grow_to_fill` When set, the pool Physical Volumes will be resized to match their respective device sizes. (e.g. after Virtual Machine disk size increase) + Default: `false` + + __NOTE__: This argument is valid only for LVM pools. + - `shared` If set to `true`, the role creates or manages a shared volume group. Requires lvmlockd and @@ -64,6 +75,8 @@ keys: destructive operation. The pool itself will be removed as part of the process. + __NOTE__: This argument is valid only for LVM pools. + - `disks` A list which specifies the set of disks to use as backing storage for the pool. @@ -107,11 +120,11 @@ keys: - `encryption_cipher` - ifies a non-default cipher to be used by LUKS. + This string specifies a non-default cipher to be used by LUKS. - `encryption_key_size` - s the LUKS key size (in bytes). + This integer specifies the LUKS key size (in bytes). - `encryption_luks_version` @@ -144,9 +157,21 @@ variables: - `type` This specifies the type of volume on which the file system will reside. - Valid values for `type`: `lvm`, `disk` or `raid`. + Valid values for `type`: `lvm`, `disk`, `partition` or `raid`. The default is determined according to the OS and release (currently `lvm`). + __NOTE__: Support for managing partition volumes is currently very limited, + the role allows creating only a single partition spanning the + entire disk. + +- `state` + + Valid values are `present` (default behavior) or `absent`. Volumes marked as + `absent` will be removed by the role. Volumes marked as `present` will be either + created (if volume with specified `name` doesn't exist) or preserved and possibly + changed to match other values (for example if a volume with the specified `name` + exists but doesn't have the required `size` it will be resized if possible). + - `disks` This specifies the set of disks to use as backing storage for the file system.