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

Auto-merge for build 6

See merge request puppet/confdroid_automatic!5

README.md

@@ -10,14 +10,15 @@
   - [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.
 
@@ -27,8 +28,8 @@ dnf-automatic is a mechanism to allow automatic OS updates for Rocky 9.
 
 ## Features
 
-- install required binaries, files and services
-- manage selinux context
+- install required binaries,
+- mane files and directories with proper selinux context
 - manage main configurations files via parameters
 - manage service
 
@@ -36,16 +37,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 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
 
@@ -65,5 +84,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

@@ -76,7 +76,9 @@
 </li><li>
 <p><a href="#parameter-inheritance">Parameter Inheritance</a></p>
 </li><li>
-<p><a href="#module-deployment">Module Deployment</a></p>
+<p><a href="#selinux">SELINUX</a></p>
+</li><li>
+<p><a href="#deployment">Deployment</a></p>
 </li><li>
 <p><a href="#tests">Tests</a></p>
 </li><li>
@@ -87,7 +89,7 @@
 
 <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>
 
@@ -99,9 +101,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>mane files and directories with proper selinux context</p>
 </li><li>
 <p>manage main configurations files via parameters</p>
 </li><li>
@@ -112,7 +114,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 +123,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 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>

doc/index.html

@@ -76,7 +76,9 @@
 </li><li>
 <p><a href="#parameter-inheritance">Parameter Inheritance</a></p>
 </li><li>
-<p><a href="#module-deployment">Module Deployment</a></p>
+<p><a href="#selinux">SELINUX</a></p>
+</li><li>
+<p><a href="#deployment">Deployment</a></p>
 </li><li>
 <p><a href="#tests">Tests</a></p>
 </li><li>
@@ -87,7 +89,7 @@
 
 <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>
 
@@ -99,9 +101,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>mane files and directories with proper selinux context</p>
 </li><li>
 <p>manage main configurations files via parameters</p>
 </li><li>
@@ -112,7 +114,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 +123,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 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>