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

Auto-merge for build 10

See merge request puppet/confdroid_automatic!8

README.md

@@ -2,7 +2,7 @@
 
 [![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)
@@ -10,25 +10,28 @@
   - [Dependencies](#dependencies)
   - [Support](#support)
   - [Parameter Inheritance](#parameter-inheritance)
-  - [Module Deployment](#module-deployment)
+  - [SELINUX](#selinux)
+  - [Deployment](#deployment)
   - [Tests](#tests)
   - [Contact Us](#contact-us)
   - [Disclaimer](#disclaimer)
 
 ## Synopsis
 
-dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.
+dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9 and similar RHEL 9 based operating systems.
 
 `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.
+
 ## 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**
 
 ## Features
 
-- install required binaries, files and services
+- install required binaries,
-- manage selinux context
+- manage files and directories with proper selinux context
 - manage main configurations files via parameters
 - manage service
 
@@ -36,16 +39,34 @@ dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.
 
 ## Support
 
-- Rocky 9
+- Rocky 9 (any RHEL 9-based OS should work)
 - Puppet 8
 
 ## 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.
 
-## Module Deployment
+## SELINUX
 
-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.
+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/).
 
 ## Tests
 
@@ -55,6 +76,7 @@ ALmost every puppet setup is done in very custom ways, and hence the way the mod
 - Puppet Parser
 - ERB Template Parser
 - Sonar Quality Gate
+- End-to-end deployments in Rocky-9 environments
 
 ## Contact Us
 
@@ -65,5 +87,3 @@ ALmost every puppet setup is done in very custom ways, and hence the way the mod
 
 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

doc/file.README.html

@@ -60,37 +60,16 @@
       <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></p>
+<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>
-<ul><li>
-<p><a href="#readme">Readme</a></p>
-</li><li>
-<p><a href="#synopsis">Synopsis</a></p>
-</li><li>
-<p><a href="#warning">WARNING</a></p>
-</li><li>
-<p><a href="#features">Features</a></p>
-</li><li>
-<p><a href="#dependencies">Dependencies</a></p>
-</li><li>
-<p><a href="#support">Support</a></p>
-</li><li>
-<p><a href="#parameter-inheritance">Parameter Inheritance</a></p>
-</li><li>
-<p><a href="#module-deployment">Module Deployment</a></p>
-</li><li>
-<p><a href="#tests">Tests</a></p>
-</li><li>
-<p><a href="#contact-us">Contact Us</a></p>
-</li><li>
-<p><a href="#disclaimer">Disclaimer</a></p>
-</li></ul>
 
 <h2 id="label-Synopsis">Synopsis</h2>
 
-<p>dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.</p>
+<p>dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9 and similar RHEL 9 based operating systems.</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>
@@ -99,9 +78,9 @@
 
 <h2 id="label-Features">Features</h2>
 <ul><li>
-<p>install required binaries, files and services</p>
+<p>install required binaries,</p>
 </li><li>
-<p>manage selinux context</p>
+<p>manage files and directories with proper selinux context</p>
 </li><li>
 <p>manage main configurations files via parameters</p>
 </li><li>
@@ -112,7 +91,7 @@
 
 <h2 id="label-Support">Support</h2>
 <ul><li>
-<p>Rocky 9</p>
+<p>Rocky 9 (any RHEL 9-based OS should work)</p>
 </li><li>
 <p>Puppet 8</p>
 </li></ul>
@@ -121,9 +100,28 @@
 
 <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-Module+Deployment">Module Deployment</h2>
+<h2 id="label-SELINUX">SELINUX</h2>
 
-<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>
+<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>
 
 <h2 id="label-Tests">Tests</h2>
 <ul><li>
@@ -139,6 +137,8 @@
 <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>

doc/index.html

@@ -60,37 +60,16 @@
       <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></p>
+<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>
-<ul><li>
-<p><a href="#readme">Readme</a></p>
-</li><li>
-<p><a href="#synopsis">Synopsis</a></p>
-</li><li>
-<p><a href="#warning">WARNING</a></p>
-</li><li>
-<p><a href="#features">Features</a></p>
-</li><li>
-<p><a href="#dependencies">Dependencies</a></p>
-</li><li>
-<p><a href="#support">Support</a></p>
-</li><li>
-<p><a href="#parameter-inheritance">Parameter Inheritance</a></p>
-</li><li>
-<p><a href="#module-deployment">Module Deployment</a></p>
-</li><li>
-<p><a href="#tests">Tests</a></p>
-</li><li>
-<p><a href="#contact-us">Contact Us</a></p>
-</li><li>
-<p><a href="#disclaimer">Disclaimer</a></p>
-</li></ul>
 
 <h2 id="label-Synopsis">Synopsis</h2>
 
-<p>dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.</p>
+<p>dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9 and similar RHEL 9 based operating systems.</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>
@@ -99,9 +78,9 @@
 
 <h2 id="label-Features">Features</h2>
 <ul><li>
-<p>install required binaries, files and services</p>
+<p>install required binaries,</p>
 </li><li>
-<p>manage selinux context</p>
+<p>manage files and directories with proper selinux context</p>
 </li><li>
 <p>manage main configurations files via parameters</p>
 </li><li>
@@ -112,7 +91,7 @@
 
 <h2 id="label-Support">Support</h2>
 <ul><li>
-<p>Rocky 9</p>
+<p>Rocky 9 (any RHEL 9-based OS should work)</p>
 </li><li>
 <p>Puppet 8</p>
 </li></ul>
@@ -121,9 +100,28 @@
 
 <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-Module+Deployment">Module Deployment</h2>
+<h2 id="label-SELINUX">SELINUX</h2>
 
-<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>
+<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>
 
 <h2 id="label-Tests">Tests</h2>
 <ul><li>
@@ -139,6 +137,8 @@
 <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>

doc/puppet_classes/confdroid_automatic_3A_3Aparams.html

@@ -273,10 +273,10 @@
         <span class='name'>ac_email_to</span>
       
       
-        <span class='type'>(<tt>Array[String]</tt>)</span>
+        <span class='type'>(<tt>String</tt>)</span>
       
       
-        <em class="default">(defaults to: <tt>[&#39;root@example.net&#39;,&#39;ops@example.net&#39;]</tt>)</em>
+        <em class="default">(defaults to: <tt>&#39;root@example.net&#39;</tt>)</em>
       
       
         &mdash;
@@ -365,7 +365,7 @@ class confdroid_automatic::params (
   String $ac_apply_updates            = &#39;yes&#39;,
   String $ac_reboot                   = &#39;never&#39;,
   String $ac_emit_via                 = &#39;email&#39;,
-  Array[String] $ac_email_to           = [&#39;root@example.net&#39;,&#39;ops@example.net&#39;],
+  String $ac_email_to                 = &#39;root@example.net&#39;,
   String $ac_email_host               = &#39;localhost&#39;,
 
 ) {

manifests/params.pp

@@ -12,7 +12,7 @@
 # @param [String] ac_apply_updates whether to apply available updates
 # @param [String] ac_reboot when to reboot after applied updates
 # @param [String] ac_emit_via  how to inform about emitted updates
-# @param [Array[String]] ac_email_to where to send the email to
+# @param [String] ac_email_to where to send the email to
 # @param [String] ac_email_host which host to use to send the email
 ##############################################################################
 class confdroid_automatic::params (
@@ -28,7 +28,7 @@ class confdroid_automatic::params (
   String $ac_apply_updates            = 'yes',
   String $ac_reboot                   = 'never',
   String $ac_emit_via                 = 'email',
-  Array[String] $ac_email_to           = ['root@example.net','ops@example.net'],
+  String $ac_email_to                 = 'root@example.net',
   String $ac_email_host               = 'localhost',
 
 ) {