175 lines
5.4 KiB
HTML
175 lines
5.4 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>
|
|
File: README
|
|
|
|
— Documentation by YARD 0.9.36
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
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="puppet_class_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'>
|
|
<h1 id="label-Readme">Readme</h1>
|
|
|
|
<p><a href="https://jenkins.confdroid.com/job/fail2ban_cd/"><img src="https://jenkins.confdroid.com/buildStatus/icon?job=fail2ban_cd"></a></p>
|
|
|
|
<p>[[<em>TOC</em>]]</p>
|
|
|
|
<h2 id="label-Synopsis">Synopsis</h2>
|
|
|
|
<p>Fail2Ban is an intrusion prevention software framework that protects computer servers from brute-force attacks.</p>
|
|
|
|
<p><code>fail2ban_cd</code> is a Puppet module to automate installation, configuration and management of fail2ban settings and rules.</p>
|
|
|
|
<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>
|
|
|
|
<h2 id="label-Features">Features</h2>
|
|
|
|
<p>Installation</p>
|
|
<ul><li>
|
|
<p>install required binaries</p>
|
|
</li></ul>
|
|
|
|
<p>Configuration</p>
|
|
<ul><li>
|
|
<p>manage directory structure (file system permissions, selinux context)</p>
|
|
</li><li>
|
|
<p>manage configuration files (file system permissions, selinux context, content based on parameters)</p>
|
|
</li></ul>
|
|
|
|
<p>Service</p>
|
|
<ul><li>
|
|
<p>manage service status</p>
|
|
</li></ul>
|
|
|
|
<h2 id="label-Dependencies">Dependencies</h2>
|
|
|
|
<p>All dependencies must be included in the catalogue.</p>
|
|
<ul><li>
|
|
<p><a href="https://gitlab.confdroid.com/puppet/cd_resources">cd_resources</a> to manage yum base repos</p>
|
|
</li><li>
|
|
<p><a href="https://gitlab.confdroid.com/puppet/cd_firewall">cd_firewall</a> or puppetlabs-firewall to manage firewall settings (optional)</p>
|
|
</li></ul>
|
|
|
|
<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 'example.example.net' {
|
|
include cd_elasticsearch
|
|
}
|
|
</code></pre>
|
|
<ul><li>
|
|
<p>through Foreman:</p>
|
|
</li></ul>
|
|
|
|
<p>In order to apply parameters through Foreman, <strong>fail2ban_cd::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-Parameters">Parameters</h2>
|
|
|
|
<p>The parameters are documented via puppet strings and <a href="/docs/index.html">listed here</a>. Simply open in web browser.</p>
|
|
|
|
<h2 id="label-SELINUX">SELINUX</h2>
|
|
|
|
<p>All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.</p>
|
|
|
|
<h2 id="label-Known+Problems">Known Problems</h2>
|
|
<ul><li>
|
|
<p>firewalld: firewalld is auto-installed on CentOS7 as dependency of fail2ban by yum.</p>
|
|
</li></ul>
|
|
|
|
<h2 id="label-Support">Support</h2>
|
|
<ul><li>
|
|
<p>OS: Rocky 9</p>
|
|
</li><li>
|
|
<p>Puppet 8</p>
|
|
</li></ul>
|
|
|
|
<h2 id="label-Tests">Tests</h2>
|
|
<ul><li>
|
|
<p>Puppet Lint</p>
|
|
</li><li>
|
|
<p>excluded tests:</p>
|
|
<ul><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></ul>
|
|
</li><li>
|
|
<p>Puppet Parser</p>
|
|
</li><li>
|
|
<p>ERB Template Parser</p>
|
|
</li><li>
|
|
<p>Sonar Quality Gate</p>
|
|
</li></ul>
|
|
|
|
<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 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> |