248 lines
7.4 KiB
HTML
248 lines
7.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.9
|
||
|
|
|
||
|
|
</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
||
|
|
|
||
|
|
<script type="text/javascript" charset="utf-8">
|
||
|
|
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'>
|
||
|
|
<p>|Repo Name| version | Build
|
||
|
|
Status|
|
||
|
|
|---|---|---|---|
|
||
|
|
|<code>cd_fail2ban</code>| 0.0.0.2 | <a
|
||
|
|
href="https://jenkins.confdroid.com/buildStatus/icon?job=cd_fail2ban">{Build
|
||
|
|
Status</a>/]|</p>
|
||
|
|
|
||
|
|
<h3 id="label-Synopsis">Synopsis</h3>
|
||
|
|
|
||
|
|
<p>Fail2Ban is an intrusion prevention software framework that protects
|
||
|
|
computer servers from brute-force attacks.</p>
|
||
|
|
|
||
|
|
<p><code>cd_fail2ban</code> is a Puppet module to automate installation,
|
||
|
|
configuration and management of fail2ban settings and rules.</p>
|
||
|
|
|
||
|
|
<h3 id="label-WARNING">WARNING</h3>
|
||
|
|
|
||
|
|
<p><code>**__!!! 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 previuos 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!!! __**</code></p>
|
||
|
|
|
||
|
|
<h3 id="label-Table+of+Contents">Table of Contents</h3>
|
||
|
|
<ul><li>
|
||
|
|
<p><a href="#features">Features</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a
|
||
|
|
href="https://gitlab.puppetsoft.com/12WW1160/cd_fail2ban/blob/master/REPOSTRUCTURE.md">Repo
|
||
|
|
Structure</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#repo-documentation"> Repo Documentation</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#dependencies">Dependencies</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#deployment">Deployment</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#native-puppet-deployment">native Puppet deployment</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#through-foreman">through Foreman</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#parameters">Parameters</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#mandatory-parameters">Mandatory Parameters</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#optional-parameters">Optional Parameters</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#selinux">SELINUX</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#known-problems">Known Problems</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#support">Support</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#tests">Tests</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a
|
||
|
|
href="https://gitlab.puppetsoft.com/12WW1160/cd_fail2ban/blob/master/CHANGELOG.md">Changelog</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="https://confdroid.com/contact/">Contact Us</a></p>
|
||
|
|
</li><li>
|
||
|
|
<p><a href="#disclaimer">Disclaimer</a></p>
|
||
|
|
</li></ul>
|
||
|
|
|
||
|
|
<h3 id="label-Features">Features</h3>
|
||
|
|
|
||
|
|
<p>Installation
|
||
|
|
* install required binaries</p>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<h3 id="label-Dependencies">Dependencies</h3>
|
||
|
|
|
||
|
|
<p>All dependencies must be included in the catalogue.</p>
|
||
|
|
|
||
|
|
<h3 id="label-Deployment">Deployment</h3>
|
||
|
|
|
||
|
|
<h5 id="label-native+Puppet+deployment">native Puppet deployment</h5>
|
||
|
|
|
||
|
|
<p>via site.pp or nodes.pp</p>
|
||
|
|
|
||
|
|
<pre class="code ruby"><code class="ruby">node 'example.example.net' {
|
||
|
|
include cd_puppetdb
|
||
|
|
}</code></pre>
|
||
|
|
|
||
|
|
<h4 id="label-through+Foreman%3A">through Foreman:</h4>
|
||
|
|
|
||
|
|
<p>In order to apply parameters through Foreman,
|
||
|
|
<strong>cd_fail2ban::params</strong> must be added to the host or hostgroup
|
||
|
|
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>
|
||
|
|
|
||
|
|
<h3 id="label-Parameters">Parameters</h3>
|
||
|
|
|
||
|
|
<p>The following parameters are editable via params.pp or through ENC
|
||
|
|
(<strong>recommended</strong>). Values changed will take immediate effect
|
||
|
|
at next puppet run. Services will be restarted where neccessary.</p>
|
||
|
|
|
||
|
|
<p>The <a href="https://confdroid.com/2017/08/cd_fail2ban-parameters/">full
|
||
|
|
list of Parameters</a> is available <a
|
||
|
|
href="https://confdroid.com/2017/08/cd_fail2ban-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
|
||
|
|
selinux is disabled, these contexts are ignored.</p>
|
||
|
|
|
||
|
|
<h3 id="label-Known+Problems">Known Problems</h3>
|
||
|
|
|
||
|
|
<h3 id="label-Support">Support</h3>
|
||
|
|
<ul><li>
|
||
|
|
<p>OS: CentOS 6, 7</p>
|
||
|
|
</li><li>
|
||
|
|
<p>Puppet 3.x</p>
|
||
|
|
</li></ul>
|
||
|
|
|
||
|
|
<h3 id="label-Tests">Tests</h3>
|
||
|
|
<ul><li>
|
||
|
|
<p>Puppet Lint</p>
|
||
|
|
</li><li>
|
||
|
|
<p>excluded tests:</p>
|
||
|
|
<ul><li>
|
||
|
|
<p><code>--no-class_inherits_from_params_class-check</code>:relavant only to
|
||
|
|
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>
|
||
|
|
<p>Test for unwanted UTF8 files in the Puppet code as this causes problems
|
||
|
|
with PuppetDB (see tests/UTF_Files)</p>
|
||
|
|
|
||
|
|
<h3 id="label-Contact+Us">Contact Us</h3>
|
||
|
|
|
||
|
|
<p><a href="https://confdroid.com/contact/">contact Us</a></p>
|
||
|
|
</li></ul>
|
||
|
|
|
||
|
|
<h3 id="label-Disclaimer">Disclaimer</h3>
|
||
|
|
|
||
|
|
<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 on Thu Aug 3 14:12:30 2017 by
|
||
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||
|
|
0.9.9 (ruby-2.0.0).
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|