Merge branch 'master' of sourcecode.confdroid.com:12ww1160/cd_clamav into development
This commit is contained in:
Arne Teuke
@@ -58,10 +58,14 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="content"><div id='filecontents'>
|
<div id="content"><div id='filecontents'>
|
||||||
|
<h1 id="label-Readme">Readme</h1>
|
||||||
|
|
||||||
<p><a href="https://pipelines.confdroid.com/job/cd_clamav/"><img
|
<p><a href="https://pipelines.confdroid.com/job/cd_clamav/"><img
|
||||||
src="https://pipelines.confdroid.com/buildStatus/icon?job=cd_clamav"></a>|</p>
|
src="https://pipelines.confdroid.com/buildStatus/icon?job=cd_clamav"></a>|</p>
|
||||||
|
|
||||||
<h3 id="label-Synopsis">Synopsis</h3>
|
<p>[[<em>TOC</em>]]</p>
|
||||||
|
|
||||||
|
<h2 id="label-Synopsis">Synopsis</h2>
|
||||||
|
|
||||||
<p><code>Clamav</code> is a powerful antivirus scanner with several
|
<p><code>Clamav</code> is a powerful antivirus scanner with several
|
||||||
components.</p>
|
components.</p>
|
||||||
@@ -69,7 +73,7 @@ components.</p>
|
|||||||
<p><code>cd_clamav</code> is a puppet module to manage clamav installations
|
<p><code>cd_clamav</code> is a puppet module to manage clamav installations
|
||||||
and configurations.</p>
|
and configurations.</p>
|
||||||
|
|
||||||
<h3 id="label-WARNING">WARNING</h3>
|
<h2 id="label-WARNING">WARNING</h2>
|
||||||
|
|
||||||
<p><code>**__!!! Attention: Never use this puppet module on systems which have
|
<p><code>**__!!! Attention: Never use this puppet module on systems which have
|
||||||
been previously configured manually. It is impossible to predict how and
|
been previously configured manually. It is impossible to predict how and
|
||||||
@@ -79,54 +83,13 @@ test environment to verify that the module suits the purpose intended by
|
|||||||
the user, as well as tune the parameters, before deploying into live
|
the user, as well as tune the parameters, before deploying into live
|
||||||
production!!! __**</code></p>
|
production!!! __**</code></p>
|
||||||
|
|
||||||
<h3 id="label-Table+of+Contents">Table of Contents</h3>
|
<h2 id="label-Features">Features</h2>
|
||||||
<ul><li>
|
|
||||||
<p><a href="#label-Features">Features</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a
|
|
||||||
href="https://sourcecode.confdroid.com/12WW1160/cd_clamav/blob/master/REPOSTRUCTURE.md">Repo
|
|
||||||
Structure</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Repo+documentation"> Repo Documentation</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Dependencies">Dependencies</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Deployment">Deployment</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Native+puppet+deployment">native Puppet deployment</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Through+foreman">through Foreman</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Parameters">Parameters</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Mandatory+parameters">Mandatory Parameters</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Optional+parameters">Optional Parameters</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Selinux">SELINUX</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Known+problems">Known Problems</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Support">Support</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Tests">Tests</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="https://confdroid.com/contact/">Contact Us</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Disclaimer">Disclaimer</a></p>
|
|
||||||
</li></ul>
|
|
||||||
|
|
||||||
<h3 id="label-Features">Features</h3>
|
<h2 id="label-Repo+Documentation">Repo Documentation</h2>
|
||||||
|
|
||||||
<h3 id="label-Repo+Structure">Repo Structure</h3>
|
|
||||||
|
|
||||||
<p>Repostructure has moved to REPOSTRUCTURE.md in repo.</p>
|
|
||||||
|
|
||||||
<h3 id="label-Repo+Documentation">Repo Documentation</h3>
|
|
||||||
|
|
||||||
<p>See the full Puppet documentation in docs/index.html</p>
|
<p>See the full Puppet documentation in docs/index.html</p>
|
||||||
|
|
||||||
<h3 id="label-Dependencies">Dependencies</h3>
|
<h2 id="label-Dependencies">Dependencies</h2>
|
||||||
|
|
||||||
<p>All dependencies must be included in the catalogue.</p>
|
<p>All dependencies must be included in the catalogue.</p>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
@@ -136,64 +99,51 @@ to manage yum base repos</p>
|
|||||||
</li></ul>
|
</li></ul>
|
||||||
|
|
||||||
<h3 id="label-Deployment">Deployment</h3>
|
<h3 id="label-Deployment">Deployment</h3>
|
||||||
|
<ul><li>
|
||||||
<h5 id="label-native+Puppet+deployment">native Puppet deployment</h5>
|
<p>native Puppet deployment</p>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
<p>via site.pp or nodes.pp</p>
|
<p>via site.pp or nodes.pp</p>
|
||||||
|
|
||||||
<pre class="code ruby"><code class="ruby">node 'example.example.net' {
|
<pre class="code ruby"><code class="ruby">node 'example.example.net' {
|
||||||
include cd_clamav
|
include cd_clamav
|
||||||
}</code></pre>
|
}</code></pre>
|
||||||
|
<ul><li>
|
||||||
<h4 id="label-through+Foreman-3A">through Foreman:</h4>
|
<p>through Foreman:</p>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
<p>In order to apply parameters through Foreman,
|
<p>In order to apply parameters through Foreman,
|
||||||
<strong>cd_clamav::params</strong> must be added to the host or hostgroup
|
<strong>cd_clamav::params</strong> must be added to the host or host group
|
||||||
in question.</p>
|
in question.</p>
|
||||||
|
|
||||||
<p>See <a
|
<p>See <a
|
||||||
href="https://confdroid.com/2017/05/deploying-our-puppet-modules/">more
|
href="https://confdroid.com/2017/05/deploying-our-puppet-modules/">more
|
||||||
details about class deployment on Confdroid.com</a>.</p>
|
details about class deployment on Confdroid.com</a>.</p>
|
||||||
|
|
||||||
<h3 id="label-Parameters">Parameters</h3>
|
<h2 id="label-Parameters">Parameters</h2>
|
||||||
|
|
||||||
<p>The following parameters are editable via params.pp or through ENC
|
<p>The parameters are documented via puppet strings and <a
|
||||||
(<strong>recommended</strong>). Values changed will take immediate effect
|
href="/docs/index.html">listed here</a>. Simply open in web browser.</p>
|
||||||
at next puppet run. Services will be restarted where neccessary.</p>
|
|
||||||
|
|
||||||
<p>The <a href="https://confdroid.com/2017/08/cd_clamav-parameters/">full list
|
<h2 id="label-SELINUX">SELINUX</h2>
|
||||||
of Parameters</a> is available <a
|
|
||||||
href="https://confdroid.com/2019/09/cd_clamav-parameters/">here</a> and in
|
|
||||||
the docs folder in the software repo.</p>
|
|
||||||
|
|
||||||
<h4 id="label-Mandatory+Parameters">Mandatory Parameters</h4>
|
|
||||||
|
|
||||||
<p>There are currently no mandatory parameters, i.e. the module will function
|
|
||||||
right out of box as is.</p>
|
|
||||||
|
|
||||||
<h4 id="label-Optional+Parameters">Optional Parameters</h4>
|
|
||||||
|
|
||||||
<h3 id="label-SELINUX">SELINUX</h3>
|
|
||||||
|
|
||||||
<p>All files and directories are configured with correct selinux context. If
|
<p>All files and directories are configured with correct selinux context. If
|
||||||
selinux is disabled, these contexts are ignored.</p>
|
selinux is disabled, these contexts are ignored.</p>
|
||||||
|
|
||||||
<h3 id="label-Known+Problems">Known Problems</h3>
|
<h2 id="label-Support">Support</h2>
|
||||||
|
|
||||||
<h3 id="label-Support">Support</h3>
|
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<p>OS: CentOS 7</p>
|
<p>OS: CentOS 7</p>
|
||||||
</li><li>
|
</li><li>
|
||||||
<p>Puppet 5.x</p>
|
<p>Puppet 5</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
|
|
||||||
<h3 id="label-Tests">Tests</h3>
|
<h2 id="label-Tests">Tests</h2>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<p>Puppet Lint</p>
|
<p>Puppet Lint</p>
|
||||||
</li><li>
|
</li><li>
|
||||||
<p>excluded tests:</p>
|
<p>excluded tests:</p>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<p><code>--no-class_inherits_from_params_class-check</code>:relavant only to
|
<p><code>--no-class_inherits_from_params_class-check</code>:relevant only to
|
||||||
non-supported outdated puppet versions</p>
|
non-supported outdated puppet versions</p>
|
||||||
</li><li>
|
</li><li>
|
||||||
<p><code>--no-variable_scope-check</code>: not applicable as we are inheriting
|
<p><code>--no-variable_scope-check</code>: not applicable as we are inheriting
|
||||||
@@ -213,15 +163,20 @@ block</code>, not per class.</p>
|
|||||||
</li><li>
|
</li><li>
|
||||||
<p>ERB Template Parser</p>
|
<p>ERB Template Parser</p>
|
||||||
</li><li>
|
</li><li>
|
||||||
<p>Test for unwanted UTF8 files in the Puppet code as this causes problems
|
<p>Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)</p>
|
||||||
with PuppetDB (see tests/UTF_Files)</p>
|
</li><li>
|
||||||
|
<p>Markdown-lint</p>
|
||||||
<h3 id="label-Contact+Us">Contact Us</h3>
|
</li><li>
|
||||||
|
<p>Spellcheck</p>
|
||||||
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
|
</li><li>
|
||||||
|
<p>Sonar Quality Gate</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
|
|
||||||
<h3 id="label-Disclaimer">Disclaimer</h3>
|
<h2 id="label-Contact+Us">Contact Us</h2>
|
||||||
|
|
||||||
|
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
|
||||||
|
|
||||||
|
<h2 id="label-Disclaimer">Disclaimer</h2>
|
||||||
|
|
||||||
<p>ConfDroid as entity is entirely independent from Puppet. We provide custom
|
<p>ConfDroid as entity is entirely independent from Puppet. We provide custom
|
||||||
configuration modules, written for specific purposes and specific
|
configuration modules, written for specific purposes and specific
|
||||||
|
|||||||
117
doc/index.html
117
doc/index.html
@@ -58,10 +58,14 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div id="content"><div id='filecontents'>
|
<div id="content"><div id='filecontents'>
|
||||||
|
<h1 id="label-Readme">Readme</h1>
|
||||||
|
|
||||||
<p><a href="https://pipelines.confdroid.com/job/cd_clamav/"><img
|
<p><a href="https://pipelines.confdroid.com/job/cd_clamav/"><img
|
||||||
src="https://pipelines.confdroid.com/buildStatus/icon?job=cd_clamav"></a>|</p>
|
src="https://pipelines.confdroid.com/buildStatus/icon?job=cd_clamav"></a>|</p>
|
||||||
|
|
||||||
<h3 id="label-Synopsis">Synopsis</h3>
|
<p>[[<em>TOC</em>]]</p>
|
||||||
|
|
||||||
|
<h2 id="label-Synopsis">Synopsis</h2>
|
||||||
|
|
||||||
<p><code>Clamav</code> is a powerful antivirus scanner with several
|
<p><code>Clamav</code> is a powerful antivirus scanner with several
|
||||||
components.</p>
|
components.</p>
|
||||||
@@ -69,7 +73,7 @@ components.</p>
|
|||||||
<p><code>cd_clamav</code> is a puppet module to manage clamav installations
|
<p><code>cd_clamav</code> is a puppet module to manage clamav installations
|
||||||
and configurations.</p>
|
and configurations.</p>
|
||||||
|
|
||||||
<h3 id="label-WARNING">WARNING</h3>
|
<h2 id="label-WARNING">WARNING</h2>
|
||||||
|
|
||||||
<p><code>**__!!! Attention: Never use this puppet module on systems which have
|
<p><code>**__!!! Attention: Never use this puppet module on systems which have
|
||||||
been previously configured manually. It is impossible to predict how and
|
been previously configured manually. It is impossible to predict how and
|
||||||
@@ -79,54 +83,13 @@ test environment to verify that the module suits the purpose intended by
|
|||||||
the user, as well as tune the parameters, before deploying into live
|
the user, as well as tune the parameters, before deploying into live
|
||||||
production!!! __**</code></p>
|
production!!! __**</code></p>
|
||||||
|
|
||||||
<h3 id="label-Table+of+Contents">Table of Contents</h3>
|
<h2 id="label-Features">Features</h2>
|
||||||
<ul><li>
|
|
||||||
<p><a href="#label-Features">Features</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a
|
|
||||||
href="https://sourcecode.confdroid.com/12WW1160/cd_clamav/blob/master/REPOSTRUCTURE.md">Repo
|
|
||||||
Structure</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Repo+documentation"> Repo Documentation</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Dependencies">Dependencies</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Deployment">Deployment</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Native+puppet+deployment">native Puppet deployment</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Through+foreman">through Foreman</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Parameters">Parameters</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Mandatory+parameters">Mandatory Parameters</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Optional+parameters">Optional Parameters</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Selinux">SELINUX</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Known+problems">Known Problems</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Support">Support</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Tests">Tests</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="https://confdroid.com/contact/">Contact Us</a></p>
|
|
||||||
</li><li>
|
|
||||||
<p><a href="#label-Disclaimer">Disclaimer</a></p>
|
|
||||||
</li></ul>
|
|
||||||
|
|
||||||
<h3 id="label-Features">Features</h3>
|
<h2 id="label-Repo+Documentation">Repo Documentation</h2>
|
||||||
|
|
||||||
<h3 id="label-Repo+Structure">Repo Structure</h3>
|
|
||||||
|
|
||||||
<p>Repostructure has moved to REPOSTRUCTURE.md in repo.</p>
|
|
||||||
|
|
||||||
<h3 id="label-Repo+Documentation">Repo Documentation</h3>
|
|
||||||
|
|
||||||
<p>See the full Puppet documentation in docs/index.html</p>
|
<p>See the full Puppet documentation in docs/index.html</p>
|
||||||
|
|
||||||
<h3 id="label-Dependencies">Dependencies</h3>
|
<h2 id="label-Dependencies">Dependencies</h2>
|
||||||
|
|
||||||
<p>All dependencies must be included in the catalogue.</p>
|
<p>All dependencies must be included in the catalogue.</p>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
@@ -136,64 +99,51 @@ to manage yum base repos</p>
|
|||||||
</li></ul>
|
</li></ul>
|
||||||
|
|
||||||
<h3 id="label-Deployment">Deployment</h3>
|
<h3 id="label-Deployment">Deployment</h3>
|
||||||
|
<ul><li>
|
||||||
<h5 id="label-native+Puppet+deployment">native Puppet deployment</h5>
|
<p>native Puppet deployment</p>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
<p>via site.pp or nodes.pp</p>
|
<p>via site.pp or nodes.pp</p>
|
||||||
|
|
||||||
<pre class="code ruby"><code class="ruby">node 'example.example.net' {
|
<pre class="code ruby"><code class="ruby">node 'example.example.net' {
|
||||||
include cd_clamav
|
include cd_clamav
|
||||||
}</code></pre>
|
}</code></pre>
|
||||||
|
<ul><li>
|
||||||
<h4 id="label-through+Foreman-3A">through Foreman:</h4>
|
<p>through Foreman:</p>
|
||||||
|
</li></ul>
|
||||||
|
|
||||||
<p>In order to apply parameters through Foreman,
|
<p>In order to apply parameters through Foreman,
|
||||||
<strong>cd_clamav::params</strong> must be added to the host or hostgroup
|
<strong>cd_clamav::params</strong> must be added to the host or host group
|
||||||
in question.</p>
|
in question.</p>
|
||||||
|
|
||||||
<p>See <a
|
<p>See <a
|
||||||
href="https://confdroid.com/2017/05/deploying-our-puppet-modules/">more
|
href="https://confdroid.com/2017/05/deploying-our-puppet-modules/">more
|
||||||
details about class deployment on Confdroid.com</a>.</p>
|
details about class deployment on Confdroid.com</a>.</p>
|
||||||
|
|
||||||
<h3 id="label-Parameters">Parameters</h3>
|
<h2 id="label-Parameters">Parameters</h2>
|
||||||
|
|
||||||
<p>The following parameters are editable via params.pp or through ENC
|
<p>The parameters are documented via puppet strings and <a
|
||||||
(<strong>recommended</strong>). Values changed will take immediate effect
|
href="/docs/index.html">listed here</a>. Simply open in web browser.</p>
|
||||||
at next puppet run. Services will be restarted where neccessary.</p>
|
|
||||||
|
|
||||||
<p>The <a href="https://confdroid.com/2017/08/cd_clamav-parameters/">full list
|
<h2 id="label-SELINUX">SELINUX</h2>
|
||||||
of Parameters</a> is available <a
|
|
||||||
href="https://confdroid.com/2019/09/cd_clamav-parameters/">here</a> and in
|
|
||||||
the docs folder in the software repo.</p>
|
|
||||||
|
|
||||||
<h4 id="label-Mandatory+Parameters">Mandatory Parameters</h4>
|
|
||||||
|
|
||||||
<p>There are currently no mandatory parameters, i.e. the module will function
|
|
||||||
right out of box as is.</p>
|
|
||||||
|
|
||||||
<h4 id="label-Optional+Parameters">Optional Parameters</h4>
|
|
||||||
|
|
||||||
<h3 id="label-SELINUX">SELINUX</h3>
|
|
||||||
|
|
||||||
<p>All files and directories are configured with correct selinux context. If
|
<p>All files and directories are configured with correct selinux context. If
|
||||||
selinux is disabled, these contexts are ignored.</p>
|
selinux is disabled, these contexts are ignored.</p>
|
||||||
|
|
||||||
<h3 id="label-Known+Problems">Known Problems</h3>
|
<h2 id="label-Support">Support</h2>
|
||||||
|
|
||||||
<h3 id="label-Support">Support</h3>
|
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<p>OS: CentOS 7</p>
|
<p>OS: CentOS 7</p>
|
||||||
</li><li>
|
</li><li>
|
||||||
<p>Puppet 5.x</p>
|
<p>Puppet 5</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
|
|
||||||
<h3 id="label-Tests">Tests</h3>
|
<h2 id="label-Tests">Tests</h2>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<p>Puppet Lint</p>
|
<p>Puppet Lint</p>
|
||||||
</li><li>
|
</li><li>
|
||||||
<p>excluded tests:</p>
|
<p>excluded tests:</p>
|
||||||
<ul><li>
|
<ul><li>
|
||||||
<p><code>--no-class_inherits_from_params_class-check</code>:relavant only to
|
<p><code>--no-class_inherits_from_params_class-check</code>:relevant only to
|
||||||
non-supported outdated puppet versions</p>
|
non-supported outdated puppet versions</p>
|
||||||
</li><li>
|
</li><li>
|
||||||
<p><code>--no-variable_scope-check</code>: not applicable as we are inheriting
|
<p><code>--no-variable_scope-check</code>: not applicable as we are inheriting
|
||||||
@@ -213,15 +163,20 @@ block</code>, not per class.</p>
|
|||||||
</li><li>
|
</li><li>
|
||||||
<p>ERB Template Parser</p>
|
<p>ERB Template Parser</p>
|
||||||
</li><li>
|
</li><li>
|
||||||
<p>Test for unwanted UTF8 files in the Puppet code as this causes problems
|
<p>Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)</p>
|
||||||
with PuppetDB (see tests/UTF_Files)</p>
|
</li><li>
|
||||||
|
<p>Markdown-lint</p>
|
||||||
<h3 id="label-Contact+Us">Contact Us</h3>
|
</li><li>
|
||||||
|
<p>Spellcheck</p>
|
||||||
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
|
</li><li>
|
||||||
|
<p>Sonar Quality Gate</p>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
|
|
||||||
<h3 id="label-Disclaimer">Disclaimer</h3>
|
<h2 id="label-Contact+Us">Contact Us</h2>
|
||||||
|
|
||||||
|
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
|
||||||
|
|
||||||
|
<h2 id="label-Disclaimer">Disclaimer</h2>
|
||||||
|
|
||||||
<p>ConfDroid as entity is entirely independent from Puppet. We provide custom
|
<p>ConfDroid as entity is entirely independent from Puppet. We provide custom
|
||||||
configuration modules, written for specific purposes and specific
|
configuration modules, written for specific purposes and specific
|
||||||
|
|||||||
Reference in New Issue
Block a user