confdroid/confdroid_fail2ban
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update README for markdown lint

Browse Source
This commit is contained in:
Arne Teuke
2021-09-07 15:38:08 +02:00
parent 2fce2245a6
commit e1b3960c31
2 changed files with 40 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
README.md
View File

@@ -1,56 +1,48 @@
# Readme
[![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_fail2ban)](https://pipelines.confdroid.com/job/cd_fail2ban/) [![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_fail2ban)](https://pipelines.confdroid.com/job/cd_fail2ban/)
### Synopsis [[_TOC_]]
## Synopsis
Fail2Ban is an intrusion prevention software framework that protects computer servers from brute-force attacks. Fail2Ban is an intrusion prevention software framework that protects computer servers from brute-force attacks.
`cd_fail2ban` is a Puppet module to automate installation, configuration and management of fail2ban settings and rules. `cd_fail2ban` is a Puppet module to automate installation, configuration and management of fail2ban settings and rules.
### WARNING ## WARNING
`**__!!! 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!!! __**` `**__!!! 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!!! __**`
### Table of Contents ## Features
* [Features](#features)
* [Repo Structure](https://sourcecode.confdroid.com/12WW1160/cd_fail2ban/blob/master/REPOSTRUCTURE.md)
* [ Repo Documentation](#repo-documentation)
* [Dependencies](#dependencies)
* [Deployment](#deployment)
* [native Puppet deployment](#native-puppet-deployment)
* [through Foreman](#through-foreman)
* [Parameters](#parameters)
* [Mandatory Parameters](#mandatory-parameters)
* [Optional Parameters](#optional-parameters)
* [SELINUX](#selinux)
* [Known Problems](#known-problems)
* [Support](#support)
* [Tests](#tests)
* [Contact Us](https://confdroid.com/contact/)
* [Disclaimer](#disclaimer)
### Features
Installation Installation
* install required binaries * install required binaries
Configuration Configuration
* manage directory structure (file system permissions, selinux context) * manage directory structure (file system permissions, selinux context)
* manage configration files (file system permissions, selinux context, content based on parameters) * manage configration files (file system permissions, selinux context, content based on parameters)
Service Service
* manage service status (running or stopped) * manage service status (running or stopped)
### Repo Structure ## Repo Documentation
Repostructure has moved to REPOSTRUCTURE.md in repo.
### Repo Documentation
See the full Puppet documentation in docs/index.html See the full Puppet documentation in docs/index.html
### Dependencies ## Dependencies
All dependencies must be included in the catalogue. All dependencies must be included in the catalogue.
* [cd_resources](https://sourcecode.confdroid.com/12WW1160/cd_resources) to manage yum base repos
* [cd_firewall](https://sourcecode.confdroid.com/12WW1160/cd_firewall) or puppetlabs-firewall to manage firewall settings (optional)
### Deployment ## Deployment
##### native Puppet deployment * native Puppet deployment
via site.pp or nodes.pp via site.pp or nodes.pp
@@ -59,49 +51,52 @@ node 'example.example.net' {
include cd_puppetdb include cd_puppetdb
} }
``` ```
#### through Foreman: * through Foreman:
In order to apply parameters through Foreman, **__cd_fail2ban::params__** must be added to the host or hostgroup in question. In order to apply parameters through Foreman, **__cd_fail2ban::params__** must be added to the host or hostgroup in question.
See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/). See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
### Parameters ## Parameters
The following parameters are editable via params.pp or through ENC (**__recommended__**). Values changed will take immediate effect at next puppet run. Services will be restarted where neccessary.
The [full list of Parameters](https://confdroid.com/2017/08/cd_fail2ban-parameters/) is available [here](https://confdroid.com/2017/08/cd_fail2ban-parameters/) and in the docs folder in the software repo. The parameters are documented via puppet strings and [listed here](/docs/index.html). Simply open in web browser.
#### Mandatory Parameters
There are currently no mandatory parameters, i.e. the module will function right out of box as is.
#### Optional Parameters
## SELINUX
### SELINUX
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored. All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
### Known Problems ## Known Problems
* firewalld: firewalld is auto-installed on CentOS7 as dependency of fail2ban by yum. * firewalld: firewalld is auto-installed on CentOS7 as dependency of fail2ban by yum.
### Support ## Support
* OS: CentOS 7 * OS: CentOS 7
* Puppet 5.x * Puppet 5.x
### Tests ## Tests
* Puppet Lint * Puppet Lint
* excluded tests: * excluded tests:
* `--no-class_inherits_from_params_class-check`:relavant only to non-supported outdated puppet versions * `--no-class_inherits_from_params_class-check`:relevant only to non-supported outdated puppet versions
* `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters. * `--no-variable_scope-check`: not applicable as we are inheriting parameters from params class. the lint check does not distinguish between facts and inherited parameters.
* `--no-80chars-check`: it is not always possible to stay within 80 characters, although typically only occurring on the parameter vault `params.pp`. * `--no-80chars-check`: it is not always possible to stay within 80 characters, although typically only occurring on the parameter vault `params.pp`.
* `--no-arrow_alignment-check`: this check leads to actually not having am easily readable arrow alignment, as this checks `per block`, not per class. * `--no-arrow_alignment-check`: this check leads to actually not having am easily readable arrow alignment, as this checks `per block`, not per class.
* Puppet Parser * Puppet Parser
* ERB Template Parser * ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code as this causes problems with PuppetDB (see tests/UTF_Files) * Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
### Contact Us * Markdown-lint
* Spellcheck
* Sonar Quality Gate
## Contact Us
[contact Us](https://confdroid.com/contact/) [contact Us](https://confdroid.com/contact/)
### Disclaimer ## Disclaimer
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments. 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. 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.

50
REPOSTRUCTURE.md
View File

@@ -1,50 +0,0 @@
.
|-- doc
| |-- css
| | |-- common.css
| | |-- full_list.css
| | `-- style.css
| |-- js
| | |-- app.js
| | |-- full_list.js
| | `-- jquery.js
| |-- puppet_classes
| | |-- cd_fail2ban_3A_3Amain_3A_3Aconfig.html
| | |-- cd_fail2ban_3A_3Amain_3A_3Adirs.html
| | |-- cd_fail2ban_3A_3Amain_3A_3Afiles.html
| | |-- cd_fail2ban_3A_3Amain_3A_3Ainstall.html
| | |-- cd_fail2ban_3A_3Amain_3A_3Aservice.html
| | |-- cd_fail2ban_3A_3Aparams.html
| | `-- cd_fail2ban.html
| |-- file.README.html
| |-- frames.html
| |-- _index.html
| |-- index.html
| |-- puppet_class_list.html
| `-- top-level-namespace.html
|-- manifests
| |-- main
| | |-- config.pp
| | |-- dirs.pp
| | |-- files.pp
| | |-- install.pp
| | `-- service.pp
| |-- init.pp
| `-- params.pp
|-- templates
| |-- fail2ban_conf.erb
| |-- fail2ban_local.erb
| |-- jail_conf.erb
| |-- jail_local.erb
| `-- paths_common_conf.erb
|-- tests
| `-- UTF_Files
|-- CHANGELOG.md
|-- Gemfile
|-- Gemfile.lock
|-- Jenkinsfile
|-- LICENSE
|-- README.md
`-- REPOSTRUCTURE.md
8 directories, 39 files