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

Auto-merge for build 4

See merge request puppet/confdroid_automatic!3
This commit is contained in:
Jenkins
2026-03-29 14:30:32 +00:00
5 changed files with 108 additions and 38 deletions

View File

@@ -1,8 +1,19 @@
# Readme # 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_]] - [Readme](#readme)
- [Synopsis](#synopsis)
- [WARNING](#warning)
- [Features](#features)
- [Dependencies](#dependencies)
- [Support](#support)
- [Parameter Inheritance](#parameter-inheritance)
- [Module Deployment](#module-deployment)
- [Tests](#tests)
- [Contact Us](#contact-us)
- [Disclaimer](#disclaimer)
## Synopsis ## Synopsis
@@ -12,22 +23,23 @@ dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.
## WARNING ## 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 ## Features
* install required binaries, files and services - install required binaries, files and services
* manage main configurations files via parameters - manage selinux context
* manage service - manage main configurations files via parameters
- manage service
## Dependencies ## Dependencies
## Support ## Support
* Rocky 9 - Rocky 9
* 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. 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.
@@ -37,16 +49,17 @@ ALmost every puppet setup is done in very custom ways, and hence the way the mod
## Tests ## 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
## Contact Us ## Contact Us
[contact Us](https://confdroid.com/contact/) - [contact Us](https://confdroid.com/contact/)
- [Feedback Portal](https://feedback.confdroid.com/)
## Disclaimer ## Disclaimer

View File

@@ -60,9 +60,30 @@
<div id="content"><div id='filecontents'> <div id="content"><div id='filecontents'>
<h1 id="label-Readme">Readme</h1> <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></p>
<ul><li>
<p>[[<em>TOC</em>]]</p> <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> <h2 id="label-Synopsis">Synopsis</h2>
@@ -72,12 +93,16 @@
<h2 id="label-WARNING">WARNING</h2> <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> <h2 id="label-Features">Features</h2>
<ul><li> <ul><li>
<p>install required binaries, files and services</p> <p>install required binaries, files and services</p>
</li><li> </li><li>
<p>manage selinux context</p>
</li><li>
<p>manage main configurations files via parameters</p> <p>manage main configurations files via parameters</p>
</li><li> </li><li>
<p>manage service</p> <p>manage service</p>
@@ -92,7 +117,7 @@
<p>Puppet 8</p> <p>Puppet 8</p>
</li></ul> </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> <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>
@@ -117,8 +142,11 @@
</li></ul> </li></ul>
<h2 id="label-Contact+Us">Contact Us</h2> <h2 id="label-Contact+Us">Contact Us</h2>
<ul><li>
<p><a href="https://confdroid.com/contact/">contact Us</a></p> <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> <h2 id="label-Disclaimer">Disclaimer</h2>

View File

@@ -60,9 +60,30 @@
<div id="content"><div id='filecontents'> <div id="content"><div id='filecontents'>
<h1 id="label-Readme">Readme</h1> <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></p>
<ul><li>
<p>[[<em>TOC</em>]]</p> <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> <h2 id="label-Synopsis">Synopsis</h2>
@@ -72,12 +93,16 @@
<h2 id="label-WARNING">WARNING</h2> <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> <h2 id="label-Features">Features</h2>
<ul><li> <ul><li>
<p>install required binaries, files and services</p> <p>install required binaries, files and services</p>
</li><li> </li><li>
<p>manage selinux context</p>
</li><li>
<p>manage main configurations files via parameters</p> <p>manage main configurations files via parameters</p>
</li><li> </li><li>
<p>manage service</p> <p>manage service</p>
@@ -92,7 +117,7 @@
<p>Puppet 8</p> <p>Puppet 8</p>
</li></ul> </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> <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>
@@ -117,8 +142,11 @@
</li></ul> </li></ul>
<h2 id="label-Contact+Us">Contact Us</h2> <h2 id="label-Contact+Us">Contact Us</h2>
<ul><li>
<p><a href="https://confdroid.com/contact/">contact Us</a></p> <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> <h2 id="label-Disclaimer">Disclaimer</h2>

View File

@@ -155,7 +155,7 @@
&mdash; &mdash;
<div class='inline'> <div class='inline'>
<p>what upgrades to manage</p> <p>what upgrades to manage. Can be default, security, minimal or all</p>
</div> </div>
</li> </li>
@@ -273,10 +273,10 @@
<span class='name'>ac_email_to</span> <span class='name'>ac_email_to</span>
<span class='type'>(<tt>String</tt>)</span> <span class='type'>(<tt>Array[String]</tt>)</span>
<em class="default">(defaults to: <tt>&#39;root@example.net&#39;</tt>)</em> <em class="default">(defaults to: <tt>[&#39;root@example.net&#39;,&#39;ops@example.net&#39;]</tt>)</em>
&mdash; &mdash;
@@ -315,7 +315,6 @@
<pre class="lines"> <pre class="lines">
17
18 18
19 19
20 20
@@ -347,10 +346,11 @@
46 46
47 47
48 48
49</pre> 49
50</pre>
</td> </td>
<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 ( class confdroid_automatic::params (
@@ -365,7 +365,7 @@ class confdroid_automatic::params (
String $ac_apply_updates = &#39;yes&#39;, String $ac_apply_updates = &#39;yes&#39;,
String $ac_reboot = &#39;never&#39;, String $ac_reboot = &#39;never&#39;,
String $ac_emit_via = &#39;email&#39;, String $ac_emit_via = &#39;email&#39;,
String $ac_email_to = &#39;root@example.net&#39;, Array[String] $ac_email_to = [&#39;root@example.net&#39;,&#39;ops@example.net&#39;],
String $ac_email_host = &#39;localhost&#39;, String $ac_email_host = &#39;localhost&#39;,
) { ) {

View File

@@ -4,14 +4,15 @@
# @summary Class manages all parameters for the confdroid_automatic module # @summary Class manages all parameters for the confdroid_automatic module
# @param [String] ac_reqpackages which packages to install # @param [String] ac_reqpackages which packages to install
# @param [String] ac_pkg_ensure which version of 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_random_sleep random sleep seconds
# @param [String] ac_network_online_timeout Maximum time until be online # @param [String] ac_network_online_timeout Maximum time until be online
# @param [String] ac_download_updates whether to download available updates # @param [String] ac_download_updates whether to download available updates
# @param [String] ac_apply_updates whether to apply available updates # @param [String] ac_apply_updates whether to apply available updates
# @param [String] ac_reboot when to reboot after applied updates # @param [String] ac_reboot when to reboot after applied updates
# @param [String] ac_emit_via how to inform about emitted updates # @param [String] ac_emit_via how to inform about emitted updates
# @param [String] ac_email_to where to send the email to # @param [Array[String]] ac_email_to where to send the email to
# @param [String] ac_email_host which host to use to send the email # @param [String] ac_email_host which host to use to send the email
############################################################################## ##############################################################################
class confdroid_automatic::params ( class confdroid_automatic::params (
@@ -27,7 +28,7 @@ class confdroid_automatic::params (
String $ac_apply_updates = 'yes', String $ac_apply_updates = 'yes',
String $ac_reboot = 'never', String $ac_reboot = 'never',
String $ac_emit_via = 'email', String $ac_emit_via = 'email',
String $ac_email_to = 'root@example.net', Array[String] $ac_email_to = ['root@example.net','ops@example.net'],
String $ac_email_host = 'localhost', String $ac_email_host = 'localhost',
) { ) {