diff --git a/README.md b/README.md index dd0daed..a6365aa 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,19 @@ # 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 @@ -12,22 +23,23 @@ dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9. ## 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 -* manage main configurations files via parameters -* manage service +- install required binaries, files and services +- manage selinux context +- manage main configurations files via parameters +- manage service ## Dependencies ## Support -* Rocky 9 -* 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. @@ -37,16 +49,17 @@ ALmost every puppet setup is done in very custom ways, and hence the way the mod ## 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 +- 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/) +- [contact Us](https://confdroid.com/contact/) +- [Feedback Portal](https://feedback.confdroid.com/) ## Disclaimer diff --git a/doc/file.README.html b/doc/file.README.html index 6d9092b..0d56297 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -60,9 +60,30 @@

Readme

-

|

- -

[[TOC]]

+

+

Synopsis

@@ -72,12 +93,16 @@

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

-

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.

@@ -117,8 +142,11 @@

Contact Us

- +

Disclaimer

diff --git a/doc/index.html b/doc/index.html index 4aa7897..81a7261 100644 --- a/doc/index.html +++ b/doc/index.html @@ -60,9 +60,30 @@

Readme

-

|

- -

[[TOC]]

+

+

Synopsis

@@ -72,12 +93,16 @@

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

  • +

    manage selinux context

    +

  • manage main configurations files via parameters

  • manage service

    @@ -92,7 +117,7 @@

    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.

@@ -117,8 +142,11 @@

Contact Us

- +

Disclaimer

diff --git a/doc/puppet_classes/confdroid_automatic_3A_3Aparams.html b/doc/puppet_classes/confdroid_automatic_3A_3Aparams.html index db62b5f..1fb97ab 100644 --- a/doc/puppet_classes/confdroid_automatic_3A_3Aparams.html +++ b/doc/puppet_classes/confdroid_automatic_3A_3Aparams.html @@ -155,7 +155,7 @@ —
-

what upgrades to manage

+

what upgrades to manage. Can be ‘default’, ‘security’, ‘minimal’ or ‘all’

@@ -273,10 +273,10 @@ ac_email_to - (String) + (Array[String]) - (defaults to: 'root@example.net') + (defaults to: ['root@example.net','ops@example.net']) — @@ -315,7 +315,6 @@ 
 
 
-17
 18
 19
 20
@@ -347,10 +346,11 @@
 46
 47
 48
-49
+49 +50 - 
# File 'manifests/params.pp', line 17
+        
# File 'manifests/params.pp', line 18
 
 class confdroid_automatic::params (
 
@@ -365,7 +365,7 @@ class confdroid_automatic::params (
   String $ac_apply_updates            = 'yes',
   String $ac_reboot                   = 'never',
   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',
 
 ) {
diff --git a/manifests/params.pp b/manifests/params.pp
index 1fdceb5..558ed25 100644
--- a/manifests/params.pp
+++ b/manifests/params.pp
@@ -4,14 +4,15 @@
 # @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
 # @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 [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
 ##############################################################################
 class confdroid_automatic::params (
@@ -27,7 +28,7 @@ class confdroid_automatic::params (
   String $ac_apply_updates            = 'yes',
   String $ac_reboot                   = 'never',
   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',
 
 ) {