Merge branch 'jenkins-build-1' into 'master'

Auto-merge for build 1 See merge request puppet/confdroid_automatic!1
2026-03-29 16:04:36 +02:00
5 changed files with 50 additions and 140 deletions
--- a/README.md
+++ b/README.md
@@ -1,89 +1,56 @@
 # Readme

-[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_automatic&style=plastic)](https://jenkins.confdroid.com/job/confdroid_automatic/)
-[![Security Hotspots](https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_automatic&metric=security_hotspots&token=sqb_c40a62afc3787918ade945dbc43089bb68ea7ab1)](https://sonarqube.confdroid.com/dashboard?id=confdroid_automatic)
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/grizzlycoda/puppet_collection)
- [Readme](#readme)
-  - [Synopsis](#synopsis)
-  - [WARNING](#warning)
-  - [Features](#features)
-  - [Dependencies](#dependencies)
-  - [Support](#support)
-  - [Parameter Inheritance](#parameter-inheritance)
-  - [SELINUX](#selinux)
-  - [Deployment](#deployment)
-  - [Tests](#tests)
-  - [Contact Us](#contact-us)
-  - [Disclaimer](#disclaimer)
+[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_automatic)](https://jenkins.confdroid.com/job/confdroid_automatic/)|
+
+[[_TOC_]]

 ## Synopsis

-dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9 and similar RHEL 9 based operating systems.
+dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.

-`confdroid_automatic` manages dnf-automatic installations and configurations. 
-
-Choose the required update and reboot policy per host, host group, environment etc. Set the email notification about updates, that's all it needs.
+`confdroid_automatic` manages dnf-automatic installations and configurations.

 ## WARNING

-> **Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production**
+***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production***

 ## Features

- install required binaries,
- manage files and directories with proper selinux context
- manage main configurations files via parameters
- manage service
+* install required binaries, files and services
+* manage main configurations files via parameters
+* manage service

 ## Dependencies

 ## Support

- Rocky 9 (any RHEL 9-based OS should work)
- Puppet 8
+* Rocky 9
+* Puppet 8

-## Parameter Inheritance
+# Parameter Inheritance

 All parameters are listed in `params.pp` and inherited from there.  Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.

-## SELINUX
+## Module Deployment

-All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
-
-## Deployment
-
- native Puppet deployment
-
-via site.pp or nodes.pp
-
-```ruby
-node 'example.example.net' {
-  include confdroid_automatic
-}
-```
-
- through Foreman:
-
-In order to apply parameters through Foreman, **confdroid_automatic::params**- must be added to the host or host group in question.
-
-See [more details about class deployment on confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
+ALmost every puppet setup is done in very custom ways, and hence the way the modules are deployed to nodes are different. This module assumes [Foreman][def] as ENC, so the modules just have to be present on the master node and Foreman will take care for it.

 ## Tests

- Puppet Lint
-  - excluded tests:
-    - `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
- Puppet Parser
- ERB Template Parser
- Sonar Quality Gate
- End-to-end deployments in Rocky-9 environments
+* Puppet Lint
+  * excluded tests:
+    * `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
+* Puppet Parser
+* ERB Template Parser
+* Sonar Quality Gate

 ## Contact Us

- [contact Us](https://confdroid.com/contact/)
- [Feedback Portal](https://feedback.confdroid.com/)
+[contact Us](https://confdroid.com/contact/)

 ## Disclaimer

 ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.
 The modules are tested and supported only as documented, and require testing in designated environments  (i.e. lab or development environments) for parameter tuning etc. before deploying into production environments.
+
+[def]: https://www.theforeman.org/manuals/3.13/quickstart_guide.html
--- a/doc/file.README.html
+++ b/doc/file.README.html
@@ -60,27 +60,23 @@
      <div id="content"><div id='filecontents'>
 <h1 id="label-Readme">Readme</h1>

-<p><a href="https://jenkins.confdroid.com/job/confdroid_automatic/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_automatic&amp;style=plastic"></a> <a href="https://sonarqube.confdroid.com/dashboard?id=confdroid_automatic"><img src="https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_automatic&amp;metric=security_hotspots&amp;token=sqb_c40a62afc3787918ade945dbc43089bb68ea7ab1"></a> <a href="https://deepwiki.com/grizzlycoda/puppet_collection"><img src="https://deepwiki.com/badge.svg"></a> - <a href="#readme">Readme</a>  - <a href="#synopsis">Synopsis</a>  - <a href="#warning">WARNING</a>  - <a href="#features">Features</a>  - <a href="#dependencies">Dependencies</a>  - <a href="#support">Support</a>  - <a href="#parameter-inheritance">Parameter Inheritance</a>  - <a href="#selinux">SELINUX</a>  - <a href="#deployment">Deployment</a>  - <a href="#tests">Tests</a>  - <a href="#contact-us">Contact Us</a>  - <a href="#disclaimer">Disclaimer</a></p>
+<p><a href="https://jenkins.confdroid.com/job/confdroid_automatic/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_automatic"></a>|</p>
+
+<p>[[<em>TOC</em>]]</p>

 <h2 id="label-Synopsis">Synopsis</h2>

-<p>dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9 and similar RHEL 9 based operating systems.</p>
+<p>dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.</p>

 <p><code>confdroid_automatic</code> manages dnf-automatic installations and configurations.</p>

-<p>Choose the required update and reboot policy per host, host group, environment etc. Set the email notification about updates, that’s all it needs.</p>
-
 <h2 id="label-WARNING">WARNING</h2>

-<blockquote>
-<p><strong>Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production</strong></p>
-</blockquote>
+<p><strong><em>Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production</em></strong></p>

 <h2 id="label-Features">Features</h2>
 <ul><li>
-<p>install required binaries,</p>
-</li><li>
-<p>manage files and directories with proper selinux context</p>
+<p>install required binaries, files and services</p>
 </li><li>
 <p>manage main configurations files via parameters</p>
 </li><li>
@@ -91,37 +87,18 @@

 <h2 id="label-Support">Support</h2>
 <ul><li>
-<p>Rocky 9 (any RHEL 9-based OS should work)</p>
+<p>Rocky 9</p>
 </li><li>
 <p>Puppet 8</p>
 </li></ul>

-<h2 id="label-Parameter+Inheritance">Parameter Inheritance</h2>
+<h1 id="label-Parameter+Inheritance">Parameter Inheritance</h1>

 <p>All parameters are listed in <code>params.pp</code> and inherited from there. Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.</p>

-<h2 id="label-SELINUX">SELINUX</h2>
+<h2 id="label-Module+Deployment">Module Deployment</h2>

-<p>All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.</p>
-
-<h2 id="label-Deployment">Deployment</h2>
-<ul><li>
-<p>native Puppet deployment</p>
-</li></ul>
-
-<p>via site.pp or nodes.pp</p>
-
-<pre class="code ruby"><code class="ruby">node &#39;example.example.net&#39; {
-  include confdroid_automatic
-}
-</code></pre>
-<ul><li>
-<p>through Foreman:</p>
-</li></ul>
-
-<p>In order to apply parameters through Foreman, <strong>confdroid_automatic::params</strong>- must be added to the host or host group in question.</p>
-
-<p>See <a href="https://confdroid.com/2017/05/deploying-our-puppet-modules/">more details about class deployment on confdroid.com</a>.</p>
+<p>ALmost every puppet setup is done in very custom ways, and hence the way the modules are deployed to nodes are different. This module assumes <a href="https://www.theforeman.org/manuals/3.13/quickstart_guide.html">Foreman</a> as ENC, so the modules just have to be present on the master node and Foreman will take care for it.</p>

 <h2 id="label-Tests">Tests</h2>
 <ul><li>
@@ -137,16 +114,11 @@
 <p>ERB Template Parser</p>
 </li><li>
 <p>Sonar Quality Gate</p>
-</li><li>
-<p>End-to-end deployments in Rocky-9 environments</p>
 </li></ul>

 <h2 id="label-Contact+Us">Contact Us</h2>
-<ul><li>
+
 <p><a href="https://confdroid.com/contact/">contact Us</a></p>
-</li><li>
-<p><a href="https://feedback.confdroid.com/">Feedback Portal</a></p>
-</li></ul>

 <h2 id="label-Disclaimer">Disclaimer</h2>

--- a/doc/index.html
+++ b/doc/index.html
@@ -60,27 +60,23 @@
      <div id="content"><div id='filecontents'>
 <h1 id="label-Readme">Readme</h1>

-<p><a href="https://jenkins.confdroid.com/job/confdroid_automatic/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_automatic&amp;style=plastic"></a> <a href="https://sonarqube.confdroid.com/dashboard?id=confdroid_automatic"><img src="https://sonarqube.confdroid.com/api/project_badges/measure?project=confdroid_automatic&amp;metric=security_hotspots&amp;token=sqb_c40a62afc3787918ade945dbc43089bb68ea7ab1"></a> <a href="https://deepwiki.com/grizzlycoda/puppet_collection"><img src="https://deepwiki.com/badge.svg"></a> - <a href="#readme">Readme</a>  - <a href="#synopsis">Synopsis</a>  - <a href="#warning">WARNING</a>  - <a href="#features">Features</a>  - <a href="#dependencies">Dependencies</a>  - <a href="#support">Support</a>  - <a href="#parameter-inheritance">Parameter Inheritance</a>  - <a href="#selinux">SELINUX</a>  - <a href="#deployment">Deployment</a>  - <a href="#tests">Tests</a>  - <a href="#contact-us">Contact Us</a>  - <a href="#disclaimer">Disclaimer</a></p>
+<p><a href="https://jenkins.confdroid.com/job/confdroid_automatic/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_automatic"></a>|</p>
+
+<p>[[<em>TOC</em>]]</p>

 <h2 id="label-Synopsis">Synopsis</h2>

-<p>dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9 and similar RHEL 9 based operating systems.</p>
+<p>dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.</p>

 <p><code>confdroid_automatic</code> manages dnf-automatic installations and configurations.</p>

-<p>Choose the required update and reboot policy per host, host group, environment etc. Set the email notification about updates, that’s all it needs.</p>
-
 <h2 id="label-WARNING">WARNING</h2>

-<blockquote>
-<p><strong>Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production</strong></p>
-</blockquote>
+<p><strong><em>Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production</em></strong></p>

 <h2 id="label-Features">Features</h2>
 <ul><li>
-<p>install required binaries,</p>
-</li><li>
-<p>manage files and directories with proper selinux context</p>
+<p>install required binaries, files and services</p>
 </li><li>
 <p>manage main configurations files via parameters</p>
 </li><li>
@@ -91,37 +87,18 @@

 <h2 id="label-Support">Support</h2>
 <ul><li>
-<p>Rocky 9 (any RHEL 9-based OS should work)</p>
+<p>Rocky 9</p>
 </li><li>
 <p>Puppet 8</p>
 </li></ul>

-<h2 id="label-Parameter+Inheritance">Parameter Inheritance</h2>
+<h1 id="label-Parameter+Inheritance">Parameter Inheritance</h1>

 <p>All parameters are listed in <code>params.pp</code> and inherited from there. Variable parameters are in the upper section and also documented in the top. These can be overridden by the ENC. Parameters in the bottom section (curly brackets) cannot be overridden and usually are used for keeping the code in the classes more readable.</p>

-<h2 id="label-SELINUX">SELINUX</h2>
+<h2 id="label-Module+Deployment">Module Deployment</h2>

-<p>All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.</p>
-
-<h2 id="label-Deployment">Deployment</h2>
-<ul><li>
-<p>native Puppet deployment</p>
-</li></ul>
-
-<p>via site.pp or nodes.pp</p>
-
-<pre class="code ruby"><code class="ruby">node &#39;example.example.net&#39; {
-  include confdroid_automatic
-}
-</code></pre>
-<ul><li>
-<p>through Foreman:</p>
-</li></ul>
-
-<p>In order to apply parameters through Foreman, <strong>confdroid_automatic::params</strong>- must be added to the host or host group in question.</p>
-
-<p>See <a href="https://confdroid.com/2017/05/deploying-our-puppet-modules/">more details about class deployment on confdroid.com</a>.</p>
+<p>ALmost every puppet setup is done in very custom ways, and hence the way the modules are deployed to nodes are different. This module assumes <a href="https://www.theforeman.org/manuals/3.13/quickstart_guide.html">Foreman</a> as ENC, so the modules just have to be present on the master node and Foreman will take care for it.</p>

 <h2 id="label-Tests">Tests</h2>
 <ul><li>
@@ -137,16 +114,11 @@
 <p>ERB Template Parser</p>
 </li><li>
 <p>Sonar Quality Gate</p>
-</li><li>
-<p>End-to-end deployments in Rocky-9 environments</p>
 </li></ul>

 <h2 id="label-Contact+Us">Contact Us</h2>
-<ul><li>
+
 <p><a href="https://confdroid.com/contact/">contact Us</a></p>
-</li><li>
-<p><a href="https://feedback.confdroid.com/">Feedback Portal</a></p>
-</li></ul>

 <h2 id="label-Disclaimer">Disclaimer</h2>

--- a/doc/puppet_classes/confdroid_automatic_3A_3Aparams.html
+++ b/doc/puppet_classes/confdroid_automatic_3A_3Aparams.html
@@ -155,7 +155,7 @@
      
        &mdash;
        <div class='inline'>
-<p>what upgrades to manage. Can be ‘default’, ‘security’, ‘minimal’ or ‘all’</p>
+<p>what upgrades to manage</p>
 </div>
      
    </li>
@@ -315,6 +315,7 @@
        <pre class="lines">


+17
 18
 19
 20
@@ -346,11 +347,10 @@
 46
 47
 48
-49
-50</pre>
+49</pre>
      </td>
      <td>
-        <pre class="code"><span class="info file"># File 'manifests/params.pp', line 18</span>
+        <pre class="code"><span class="info file"># File 'manifests/params.pp', line 17</span>

 class confdroid_automatic::params (

--- a/manifests/params.pp
+++ b/manifests/params.pp
@@ -4,8 +4,7 @@
 # @summary Class manages all parameters for the confdroid_automatic module
 # @param [String] ac_reqpackages which packages to install
 # @param [String] ac_pkg_ensure which version of packages to install
-# @param [String] ac_upgrade_type what upgrades to manage. Can be 
-#   'default', 'security', 'minimal' or 'all'
+# @param [String] ac_upgrade_type what upgrades to manage
 # @param [String] ac_random_sleep random sleep seconds
 # @param [String] ac_network_online_timeout Maximum time until be online
 # @param [String] ac_download_updates whether to download available updates