document automatic package update on RHEL 8

2022-08-31 11:24:59 +02:00
parent 5e66fba414
commit 2d80233635
3 changed files with 41 additions and 2 deletions
@@ -191,6 +191,7 @@ Profiles
   profiles/afs_client
   profiles/autofs
   profiles/custom_timers
+   profiles/dnf_automatic
   profiles/epics
   profiles/filecopy
   profiles/files
@@ -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.
+
@@ -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