document vgroot puppet module

2022-07-22 15:46:36 +02:00
parent edcc652296
commit 9c8da903dd
2 changed files with 28 additions and 0 deletions
@@ -243,6 +243,7 @@ Profiles
   profiles/ssh_server.rst
   profiles/sysinfo
   profiles/telegraf
+   profiles/vgroot
   profiles/web_server


@@ -0,0 +1,27 @@
+``profile::vgroot``
+=======================
+
+This module allows to resize logical volumes/partitions on the default volume group ``vg_root``.
+
+If you alternatively want to control the full volume group or add an additional one, please configure in Hiera the `lvm Puppet module <https://forge.puppet.com/modules/puppetlabs/lvm>`_.
+
+
+Parameters
+----------
+
+===============================  ========  ================================================
+**Name**                         **Type**  **Default**
+-------------------------------  --------  ------------------------------------------------
+vgroot                          hash      hiera_hash('vgroot::path')
+===============================  ========  ================================================
+
+
+``vgroot``
+~~~~~~~~~~~
+
+A hash containing as key the name of the volume group (``/dev/mapper/vg_root-$NAME``) to be adjusted and the volume size as value. 
+
+  vgroot::path:
+    lv_root: 20GB
+
+The contained file system will then automatically resized if needed.