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

Auto-merge for build 10

See merge request puppet/confdroid_automatic!8

Jenkinsfile

@@ -1,134 +0,0 @@
-pipeline {
-    agent any
-
-    post {
-        always {
-            deleteDir() /* clean up our workspace */
-        }
-        success {
-            updateGitlabCommitStatus state: 'success'
-        }
-        failure {
-            updateGitlabCommitStatus state: 'failed'
-            step([$class: 'Mailer', notifyEveryUnstableBuild: true, recipients: 'support@confdroid.com', sendToIndividuals: true])
-        }
-    }
-
-    options {
-          gitLabConnection('gitlab.confdroid.com')
-    }
-
-    stages {
-
-      stage('pull master') {
-        steps {
-          sshagent(['edd05eb6-26b5-4c7b-a5cc-ea2ab899f4fa']) {
-            sh '''
-                git config user.name "Jenkins Server"
-                git config user.email jenkins@confdroid.com
-                # Ensure we're on the development branch (triggered by push)
-                git checkout development
-                # Create jenkins branch from development
-                git checkout -b jenkins-build-$BUILD_NUMBER
-                # Optionally merge master into jenkins to ensure compatibility
-                git merge origin/master --no-ff || { echo "Merge conflict detected"; exit 1; }
-            '''
-        }
-      }
-    }
-
-      stage('puppet parser') {
-        steps {
-          sh '''for file in $(find . -iname \'*.pp\'); do
-            /opt/puppetlabs/bin/puppet parser validate --color false --render-as s --modulepath=modules $file || exit 1;
-            done;'''
-          }
-        }
-
-      stage('check templates') {
-        steps{
-          sh '''for file in $(find . -iname \'*.erb\');
-            do erb -P -x -T "-" $file | ruby -c || exit 1;
-            done;'''
-        }
-      }
-
-      stage('puppet-lint') {
-        steps {
-          sh '''/usr/local/bin/puppet-lint . \\
-                --no-variable_scope-check \\
-                || { echo "Puppet lint failed"; exit 1; }
-            '''
-          }
-        }
-
-      stage('SonarScan') {
-         steps {
-            withCredentials([string(credentialsId: 'sonar-token', variable: 'SONAR_TOKEN')]) {
-              sh '''
-              /opt/sonar-scanner/bin/sonar-scanner \
-                -Dsonar.projectKey=confdroid_automatic \
-                -Dsonar.sources=. \
-                -Dsonar.host.url=https://sonarqube.confdroid.com \
-                -Dsonar.token=$SONAR_TOKEN
-                '''
-              }
-            }
-          }
-
-      stage('create Puppet documentation') {
-        steps {
-          sh '/opt/puppetlabs/bin/puppet strings'
-        }
-      }
-
-      stage('update repo') {
-        steps {
-          sshagent(['edd05eb6-26b5-4c7b-a5cc-ea2ab899f4fa']) {
-            sh '''
-                git config user.name "Jenkins Server"
-                git config user.email jenkins@confdroid.com
-                git rm -r --cached .scannerwork || echo "No .scannerwork to remove from git"
-                git rm -r --cached .yardoc || echo "No .yardoc to remove from git"
-                git rm -r --cached .vscode || echo "No .vscode to remove from git"
-                  git commit --amend --no-edit --allow-empty
-                git add -A && git commit -am "Recommit for updates in build $BUILD_NUMBER" || echo "No changes to commit"
-                git push -o merge_request.create \
-                         -o merge_request.target=master \
-                         -o merge_request.title="Auto-merge for build $BUILD_NUMBER" \
-                         -o merge_request.description="Automated changes from Jenkins build $BUILD_NUMBER" \
-                         -o merge_request.merge_when_pipeline_succeeds=true \
-                         origin jenkins-build-$BUILD_NUMBER
-            '''
-        }
-      }
-    }
-
-      stage('Mirror to Gitea') {
-        steps {
-          withCredentials([usernamePassword(
-            credentialsId: 'Jenkins-gitea',
-            usernameVariable: 'GITEA_USER',
-            passwordVariable: 'GITEA_TOKEN')]) {
-            script {
-              // Checkout from GitLab (already done implicitly)
-                sh '''
-                  git checkout master
-                  git pull origin master
-                  git branch -D development
-                  git branch -D jenkins-build-$BUILD_NUMBER
-                  git rm -f Jenkinsfile
-                  git rm -r --cached .scannerwork || echo "No .scannerwork to remove from git"
-                  git rm -r --cached .yardoc || echo "No .yardoc to remove from git"
-                  git rm -r --cached .vscode || echo "No .vscode to remove from git"
-                  git commit --amend --no-edit --allow-empty
-                  git remote add master https://sourcecode.confdroid.com/confdroid/confdroid_automatic.git
-                  git -c credential.helper="!f() { echo username=${GITEA_USER}; echo password=${GITEA_TOKEN}; }; f" \
-                  push master --mirror
-                  '''
-          }
-        }
-      }
-    }
-  }
-}

README.md

@@ -1,56 +1,89 @@
 # Readme
 
-[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_automatic)](https://jenkins.confdroid.com/job/confdroid_automatic/)|
+[![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)
-[[_TOC_]]
+[![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)
 
 ## 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.
+`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***
+> **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 main configurations files via parameters
+- manage files and directories with proper selinux context
-* manage service
+- manage main configurations files via parameters
+- manage service
 
 ## Dependencies
 
 ## Support
 
-* Rocky 9
+- Rocky 9 (any RHEL 9-based OS should work)
-* Puppet 8
+- 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.
 
-## 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
 
-* Puppet Lint
+- Puppet Lint
-  * excluded tests:
+  - 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.
+    - `--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
+- Puppet Parser
-* ERB Template Parser
+- ERB Template Parser
-* Sonar Quality Gate
+- Sonar Quality Gate
+- End-to-end deployments in Rocky-9 environments
 
 ## Contact Us
 
-[contact Us](https://confdroid.com/contact/)
+- [contact Us](https://confdroid.com/contact/)
+- [Feedback Portal](https://feedback.confdroid.com/)
 
 ## 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

doc/file.README.html

@@ -60,23 +60,27 @@
       <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"></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>
-
-<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.</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>
 
-<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>
+<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>
 
 <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 files and directories with proper selinux context</p>
 </li><li>
 <p>manage main configurations files via parameters</p>
 </li><li>
@@ -87,18 +91,37 @@
 
 <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>
 
-<h1 id="label-Parameter+Inheritance">Parameter Inheritance</h1>
+<h2 id="label-Parameter+Inheritance">Parameter Inheritance</h2>
 
 <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>
@@ -114,11 +137,16 @@
 <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>
 

doc/index.html

@@ -60,23 +60,27 @@
       <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"></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>
-
-<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.</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>
 
-<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>
+<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>
 
 <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 files and directories with proper selinux context</p>
 </li><li>
 <p>manage main configurations files via parameters</p>
 </li><li>
@@ -87,18 +91,37 @@
 
 <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>
 
-<h1 id="label-Parameter+Inheritance">Parameter Inheritance</h1>
+<h2 id="label-Parameter+Inheritance">Parameter Inheritance</h2>
 
 <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>
@@ -114,11 +137,16 @@
 <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>
 

doc/puppet_classes/confdroid_automatic_3A_3Aparams.html

@@ -155,7 +155,7 @@
       
         —
         <div class='inline'>
-<p>what upgrades to manage</p>
+<p>what upgrades to manage. Can be ‘default’, ‘security’, ‘minimal’ or ‘all’</p>
 </div>
       
     </li>
@@ -315,7 +315,6 @@
         <pre class="lines">
 
 
-17
 18
 19
 20
@@ -347,10 +346,11 @@
 46
 47
 48
-49</pre>
+49
+50</pre>
       </td>
       <td>
-        <pre class="code"><span class="info file"># File 'manifests/params.pp', line 17</span>
+        <pre class="code"><span class="info file"># File 'manifests/params.pp', line 18</span>
 
 class confdroid_automatic::params (
 

manifests/params.pp

@@ -4,7 +4,8 @@
 # @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
+# @param [String] ac_upgrade_type what upgrades to manage. Can be 
+#   'default', 'security', 'minimal' or 'all'
 # @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