From 2d8023363549b0a5dd58857a340c66795b9412cd Mon Sep 17 00:00:00 2001
From: Konrad Bucheli <konrad.bucheli@psi.ch>
Date: Wed, 31 Aug 2022 11:24:59 +0200
Subject: [PATCH] document automatic package update on RHEL 8

---
 admin-guide/puppet/modules.rst                |  1 +
 admin-guide/puppet/profiles/dnf_automatic.rst | 38 +++++++++++++++++++
 admin-guide/puppet/roles/base.rst             |  4 +-
 3 files changed, 41 insertions(+), 2 deletions(-)
 create mode 100644 admin-guide/puppet/profiles/dnf_automatic.rst

diff --git a/admin-guide/puppet/modules.rst b/admin-guide/puppet/modules.rst
index 18cba66d..6be9d6f9 100644
--- a/admin-guide/puppet/modules.rst
+++ b/admin-guide/puppet/modules.rst
@@ -191,6 +191,7 @@ Profiles
    profiles/afs_client
    profiles/autofs
    profiles/custom_timers
+   profiles/dnf_automatic
    profiles/epics
    profiles/filecopy
    profiles/files
diff --git a/admin-guide/puppet/profiles/dnf_automatic.rst b/admin-guide/puppet/profiles/dnf_automatic.rst
new file mode 100644
index 00000000..61c33abd
--- /dev/null
+++ b/admin-guide/puppet/profiles/dnf_automatic.rst
@@ -0,0 +1,38 @@
+``profile::dnf_automatic``
+==========================
+
+This profile configures automatic package updates using ``dnf-automatic``
+
+It is used by ``role::base`` and there configured with the ``base::automatic_updates::*`` hiera keys.
+
+Parameters
+----------
+
+===============================  ========  ================================================
+**Name**                         **Type**  **Default**
+-------------------------------  --------  ------------------------------------------------
+interval                         Enum
+type                             Enum
+exclude                          Array
+incldue_kernel                   Boolean
+===============================  ========  ================================================
+
+
+``interval``
+~~~~~~~~~~~~
+How often should the automatic updates be installed. Valid options are ``never``, ``daily`` and ``weekly``. ``never`` disables it altogether.
+
+
+``type``
+~~~~~~~~
+What type of package updates should be installed automatically, either ``security`` for only security updates or ``all`` for all updates.
+
+
+``exclude``
+~~~~~~~~~~~
+List of packages which shall not be updated automatically. Wildcards like * are allowed. The kernel is excluded by default.
+
+``incldue_kernel``
+~~~~~~~~~~~~~~~~~~
+Marks if also the kernel package should be automatically updated. Note that the necessary reboot to run the new kernel needs to be done manually.
+
diff --git a/admin-guide/puppet/roles/base.rst b/admin-guide/puppet/roles/base.rst
index 786af0a2..a8ac7693 100644
--- a/admin-guide/puppet/roles/base.rst
+++ b/admin-guide/puppet/roles/base.rst
@@ -9,9 +9,9 @@ need anyway.
 Parameters
 ----------
 
-=========================  ========  ================================================
+=========================  ========  ====================================================
 **Name**                   **Type**  **Default**
--------------------------  --------  ------------------------------------------------
+-------------------------  --------  ----------------------------------------------------
 default_target             string    ``multi-user``
 default_enable_afs         bool      undef
 default_enable_pmodules    bool      undef