From 9a32e649259b58c590c26f0e55db8d703165dfe5 Mon Sep 17 00:00:00 2001 From: Rich Megginson Date: Tue, 23 Jul 2024 09:18:31 -0600 Subject: [PATCH] docs(changelog): version 1.18.0 [citest skip] Update changelog and .README.html for version 1.18.0 Signed-off-by: Rich Megginson --- .README.html | 92 ++++++++++++++++++++++++++++++++-------------------- CHANGELOG.md | 11 +++++++ 2 files changed, 67 insertions(+), 36 deletions(-) diff --git a/.README.html b/.README.html index e2c2d2cc..d51764fa 100644 --- a/.README.html +++ b/.README.html @@ -146,18 +146,6 @@

Contents

id="toc-storage_pools">storage_pools
  • storage_volumes
    • -
  • cached
    • -
  • cache_size
    • -
  • cache_mode
    • -
  • cache_devices
    • -
  • thin
    • -
  • thin_pool_name
    • -
  • thin_pool_size
  • storage_safe_mode
  • Contents

    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

    See below

    Collection requirements

    @@ -205,11 +199,20 @@

    storage_pools

    (One example of a pool is an LVM volume group.)

  • type

    This specifies the type of pool to manage. Valid values for -type: lvm.

    • +type: lvm, stratis.

    +

  • state

    +

    Valid values are present (default behavior) or +absent. Pools marked as absent will be removed +by the role. Pools marked as present will be either created +(if pool with the specified name doesn't already exist) or +preserved.

  • 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)

    • +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 dlm services configured and @@ -217,7 +220,9 @@

    storage_pools

    Default: false

    WARNING: Modifying the shared value on an existing pool is a destructive operation. The pool itself will be -removed as part of the process.

    • +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. Supported identifiers include: device node (like @@ -254,9 +259,10 @@

    storage_pools

    user of this role to securely copy this file to the managed nodes, or otherwise ensure that the file is on the managed nodes.

  • 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

    This integer specifies the LUKS version to use.

  • encryption_clevis_pin

    @@ -279,8 +285,21 @@

    storage_volumes

  • type

    This specifies the type of volume on which the file system will reside. Valid values for type: lvm, -disk or raid. The default is determined -according to the OS and release (currently 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. This is currently only relevant for volumes of type @@ -409,25 +428,25 @@

    storage_volumes

    set by size parameter. vdo_pool_size format is intended to be human-readable, e.g.: "30g", "50GiB". Default value is equal to the size of the volume.

    • - -

    cached

    +

  • cached

    This specifies whether the volume should be cached or not. This is -currently supported only for LVM volumes where dm-cache is used.

    -

    cache_size

    +currently supported only for LVM volumes where dm-cache is +used.

    • +

  • cache_size

    Size of the cache. cache_size format is intended to be -human-readable, e.g.: "30g", "50GiB".

    -

    cache_mode

    +human-readable, e.g.: "30g", "50GiB".

    • +

  • cache_mode

    Mode for the cache. Supported values include -writethrough (default) and writeback.

    -

    cache_devices

    +writethrough (default) and writeback.

    • +

  • cache_devices

    List of devices that will be used for the cache. These should be either physical volumes or drives these physical volumes are allocated on. Generally you want to select fast devices like SSD or NVMe drives -for cache.

    -

    thin

    +for cache.

    • +

  • thin

    Whether the volume should be thinly provisioned or not. This is -supported only for LVM volumes.

    -

    thin_pool_name

    +supported only for LVM volumes.

    • +

  • thin_pool_name

    For thin volumes, this can be used to specify the name of the LVM thin pool that will be used for the volume. If the pool with the provided name already exists, the volume will be added to that pool. @@ -440,10 +459,11 @@

    thin_pool_name

    added to it and
  • if there are multiple thin pools present an exception will be raised.
    • - -

    thin_pool_size

    + +

  • thin_pool_size

    Size for the thin pool. thin_pool_size format is -intended to be human-readable, e.g.: "30g", "50GiB".

    +intended to be human-readable, e.g.: "30g", "50GiB".

    • +

    storage_safe_mode

    When true (the default), an error will occur instead of automatically removing existing devices and/or formatting.

    diff --git a/CHANGELOG.md b/CHANGELOG.md index b10e27dd..dfa12f39 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,17 @@ Changelog ========= +[1.18.0] - 2024-07-23 +-------------------- + +### New Features + +- feat: write storage role fingerprint to /etc/fstab (#458) + +### Other Changes + +- docs: Fix multiple small issues in README.md (#456) + [1.17.1] - 2024-07-02 --------------------