From 551be6580ffbb31995850e6ad573905d6854bfac Mon Sep 17 00:00:00 2001 From: Sergei Petrosian <30409084+spetrosi@users.noreply.github.com> Date: Fri, 8 Sep 2023 15:13:24 +0200 Subject: [PATCH] docs(changelog): version 1.12.4 [citest skip] (#381) Update changelog and .README.html for version 1.12.4 Signed-off-by: Sergei Petrosian --- .README.html | 464 +++++++++++++++++++++++++++++++++++++++++++++++++++ CHANGELOG.md | 22 +++ 2 files changed, 486 insertions(+) create mode 100644 .README.html diff --git a/.README.html b/.README.html new file mode 100644 index 00000000..2f19b4f3 --- /dev/null +++ b/.README.html @@ -0,0 +1,464 @@ + + + + + + + + Linux Storage Role + + + + + + +
+
+

Linux Storage Role

+
+
+ +
+

This role allows users to configure local storage with minimal +input.

+

As of now, the role supports managing file systems and mount entries +on

+ +

Requirements

+

See below

+

Collection requirements

+

The role requires the mount module from +ansible.posix. If you are using ansible-core, +you must install the ansible.posix collection.

+
ansible-galaxy collection install -vv -r meta/collection-requirements.yml
+

If you are using Ansible Engine 2.9, or are using an Ansible bundle +which includes these collections/modules, you should have to do +nothing.

+

Role Variables

+

NOTE: Beginning with version 1.3.0, unspecified +parameters are interpreted differently for existing and non-existing +pools/volumes. For new/non-existent pools and volumes, any omitted +parameters will use the default value as described in +defaults/main.yml. For existing pools and volumes, omitted +parameters will inherit whatever setting the pool or volume already has. +This means that to change/override role defaults in an existing pool or +volume, you must explicitly specify the new values/settings in the role +variables.

+

storage_pools

+

The storage_pools variable is a list of pools to manage. +Each pool contains a nested list of volume dicts as +described below, as well as the following keys:

+ +

storage_volumes

+

The storage_volumes variable is a list of volumes to +manage. Each volume has the following variables:

+ +

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

+

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

+

cache_mode

+

Mode for the cache. Supported values include +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

+

Whether the volume should be thinly provisioned or not. This is +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. +If it doesn't exist a new pool named thin_pool_name will be +created. If not specified:

+ +

thin_pool_size

+

Size for the thin pool. thin_pool_size format is +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.

+

storage_udevadm_trigger

+

When true (the default is false), the role will use udevadm trigger +to cause udev changes to take effect immediately. This may help on some +platforms with "buggy" udev.

+

Example Playbook

+
- name: Manage storage
+  hosts: all
+  roles:
+    - name: linux-system-roles.storage
+      storage_pools:
+        - name: app
+          disks:
+            - sdb
+            - sdc
+          volumes:
+            - name: shared
+              size: "100 GiB"
+              mount_point: "/mnt/app/shared"
+              #fs_type: xfs
+              state: present
+            - name: users
+              size: "400g"
+              fs_type: ext4
+              mount_point: "/mnt/app/users"
+      storage_volumes:
+        - name: images
+          type: disk
+          disks: ["mpathc"]
+          mount_point: /opt/images
+          fs_label: images
+

License

+

MIT

+
+ + diff --git a/CHANGELOG.md b/CHANGELOG.md index bf1b0c2b..5f774548 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,28 @@ Changelog ========= +[1.12.4] - 2023-09-07 +-------------------- + +### Other Changes + +- docs: Make badges consistent, run markdownlint on all .md files (#379) + + - Consistently generate badges for GH workflows in README RHELPLAN-146921 + - Run markdownlint on all .md files + - Add custom-woke-action if not used already + - Rename woke action to Woke for a pretty badge + + Signed-off-by: Sergei Petrosian + +- ci: Remove badges from README.md prior to converting to HTML (#380) + + - Remove thematic break after badges + - Remove badges from README.md prior to converting to HTML + + Signed-off-by: Sergei Petrosian + + [1.12.3] - 2023-08-17 --------------------