2019-12-24 22:08:56 +01:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
<title>
|
|
|
|
|
File: README
|
|
|
|
|
|
2021-12-29 14:11:47 +01:00
|
|
|
— Documentation by YARD 0.9.26
|
2019-12-24 22:08:56 +01:00
|
|
|
|
|
|
|
|
</title>
|
|
|
|
|
|
2021-12-29 14:11:47 +01:00
|
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
2019-12-24 22:08:56 +01:00
|
|
|
|
2021-12-29 14:11:47 +01:00
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
2019-12-24 22:08:56 +01:00
|
|
|
|
2021-12-29 14:11:47 +01:00
|
|
|
<script type="text/javascript">
|
2019-12-24 22:08:56 +01:00
|
|
|
pathId = "";
|
|
|
|
|
relpath = '';
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div class="nav_wrap">
|
|
|
|
|
<iframe id="nav" src="file_list.html?1"></iframe>
|
|
|
|
|
<div id="resizer"></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="main" tabindex="-1">
|
|
|
|
|
<div id="header">
|
|
|
|
|
<div id="menu">
|
|
|
|
|
|
|
|
|
|
<a href="_index.html">Index</a> »
|
|
|
|
|
<span class="title">File: README</span>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="search">
|
|
|
|
|
|
|
|
|
|
<a class="full_list_link" id="puppet_class_list_link"
|
|
|
|
|
href="puppet_class_list.html">
|
|
|
|
|
|
|
|
|
|
<svg width="24" height="24">
|
|
|
|
|
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
|
|
|
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
|
|
|
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
|
|
|
</svg>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<div class="clear"></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div id="content"><div id='filecontents'>
|
2021-08-05 17:53:17 +02:00
|
|
|
<h1 id="label-Readme">Readme</h1>
|
|
|
|
|
|
2020-12-01 18:23:54 +01:00
|
|
|
<p><a href="https://pipelines.confdroid.com/job/cd_clamav/"><img
|
|
|
|
|
src="https://pipelines.confdroid.com/buildStatus/icon?job=cd_clamav"></a>|</p>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<p>[[<em>TOC</em>]]</p>
|
|
|
|
|
|
|
|
|
|
<h2 id="label-Synopsis">Synopsis</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
|
|
|
|
<p><code>Clamav</code> is a powerful antivirus scanner with several
|
|
|
|
|
components.</p>
|
|
|
|
|
|
|
|
|
|
<p><code>cd_clamav</code> is a puppet module to manage clamav installations
|
|
|
|
|
and configurations.</p>
|
|
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<h2 id="label-WARNING">WARNING</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
2021-09-10 13:57:29 +02:00
|
|
|
<p><strong><em>Attention: Never use this puppet module on systems which have
|
2019-12-24 22:08:56 +01:00
|
|
|
been previously configured manually. It is impossible to predict how and
|
2021-09-10 12:46:35 +02:00
|
|
|
what would have been configured, hence previous configurations outside the
|
2019-12-24 22:08:56 +01:00
|
|
|
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
|
2021-09-10 13:57:29 +02:00
|
|
|
production</em></strong></p>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<h2 id="label-Dependencies">Dependencies</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
|
|
|
|
<p>All dependencies must be included in the catalogue.</p>
|
|
|
|
|
<ul><li>
|
|
|
|
|
<p><a
|
2020-12-09 16:22:12 +01:00
|
|
|
href="https://sourcecode.confdroid.com/12WW1160/cd_resources">cd_resources</a>
|
2019-12-24 22:08:56 +01:00
|
|
|
to manage yum base repos</p>
|
|
|
|
|
</li></ul>
|
|
|
|
|
|
|
|
|
|
<h3 id="label-Deployment">Deployment</h3>
|
2021-08-05 17:53:17 +02:00
|
|
|
<ul><li>
|
|
|
|
|
<p>native Puppet deployment</p>
|
|
|
|
|
</li></ul>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
|
|
|
|
<p>via site.pp or nodes.pp</p>
|
|
|
|
|
|
|
|
|
|
<pre class="code ruby"><code class="ruby">node 'example.example.net' {
|
|
|
|
|
include cd_clamav
|
2021-12-29 14:11:47 +01:00
|
|
|
}
|
|
|
|
|
</code></pre>
|
2021-08-05 17:53:17 +02:00
|
|
|
<ul><li>
|
|
|
|
|
<p>through Foreman:</p>
|
|
|
|
|
</li></ul>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
|
|
|
|
<p>In order to apply parameters through Foreman,
|
2021-08-05 17:53:17 +02:00
|
|
|
<strong>cd_clamav::params</strong> must be added to the host or host group
|
2019-12-24 22:08:56 +01:00
|
|
|
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>
|
|
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<h2 id="label-Parameters">Parameters</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<p>The parameters are documented via puppet strings and <a
|
|
|
|
|
href="/docs/index.html">listed here</a>. Simply open in web browser.</p>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<h2 id="label-SELINUX">SELINUX</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
|
|
|
|
<p>All files and directories are configured with correct selinux context. If
|
|
|
|
|
selinux is disabled, these contexts are ignored.</p>
|
|
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<h2 id="label-Support">Support</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
<ul><li>
|
|
|
|
|
<p>OS: CentOS 7</p>
|
|
|
|
|
</li><li>
|
2021-08-05 17:53:17 +02:00
|
|
|
<p>Puppet 5</p>
|
2019-12-24 22:08:56 +01:00
|
|
|
</li></ul>
|
|
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<h2 id="label-Tests">Tests</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
<ul><li>
|
|
|
|
|
<p>Puppet Lint</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>excluded tests:</p>
|
|
|
|
|
<ul><li>
|
2021-08-05 17:53:17 +02:00
|
|
|
<p><code>--no-class_inherits_from_params_class-check</code>:relevant only to
|
2019-12-24 22:08:56 +01:00
|
|
|
non-supported outdated puppet versions</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p><code>--no-variable_scope-check</code>: not applicable as we are inheriting
|
|
|
|
|
parameters from params class. the lint check does not distinguish between
|
|
|
|
|
facts and inherited parameters.</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p><code>--no-80chars-check</code>: it is not always possible to stay within
|
|
|
|
|
80 characters, although typically only occurring on the parameter vault
|
|
|
|
|
<code>params.pp</code>.</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p><code>--no-arrow_alignment-check</code>: this check leads to actually not
|
|
|
|
|
having am easily readable arrow alignment, as this checks <code>per
|
|
|
|
|
block</code>, not per class.</p>
|
|
|
|
|
</li></ul>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>Puppet Parser</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>ERB Template Parser</p>
|
|
|
|
|
</li><li>
|
2021-08-05 17:53:17 +02:00
|
|
|
<p>Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>Markdown-lint</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>Spellcheck</p>
|
|
|
|
|
</li><li>
|
|
|
|
|
<p>Sonar Quality Gate</p>
|
|
|
|
|
</li></ul>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<h2 id="label-Contact+Us">Contact Us</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
|
|
|
|
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
|
|
|
|
|
|
2021-08-05 17:53:17 +02:00
|
|
|
<h2 id="label-Disclaimer">Disclaimer</h2>
|
2019-12-24 22:08:56 +01:00
|
|
|
|
|
|
|
|
<p>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.</p>
|
|
|
|
|
</div></div>
|
|
|
|
|
|
|
|
|
|
<div id="footer">
|
|
|
|
|
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
