confdroid/confdroid_clamav
1
0
Fork 0
Code Issues Wiki Activity

testing slaves

Browse Source
This commit is contained in:
Arne Teuke
2019-10-28 17:40:12 +01:00
parent d3b25136a0
commit 03e4718163
8 changed files with 663 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
README.md
View File

@@ -1,3 +1,102 @@
# cd_clamav
|Repo Name| version | Build Status|
|---|---|---|---|
|`cd_clamav`| 0.0.0.1 | [![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_clamav)](https://pipelines.confdroid.com/job/cd_clamav/)|
Puppet module for installing and managing clamav components
### Synopsis
`Clamav` is a powerful antivirus scanner with several components.
`cd_clamav` is a puppet module to manage clamav installations and configurations.
### 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!!! __**`
### Table of Contents
* [Features](#features)
* [Repo Structure](https://gitlab.confdroid.com/12WW1160/cd_clamav/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)
* [Changelog](https://gitlab.confdroid.com/12WW1160/cd_clamav/blob/master/CHANGELOG.md)
* [Contact Us](https://confdroid.com/contact/)
* [Disclaimer](#disclaimer)
### Features
### Repo Structure
Repostructure has moved to REPOSTRUCTURE.md in repo.
### Repo Documentation
See the full Puppet documentation in docs/index.html
### Dependencies
All dependencies must be included in the catalogue.
* [cd_resources](https://gitlab.confdroid.com/12WW1160/cd_resources) to manage yum base repos
### Deployment
##### native Puppet deployment
via site.pp or nodes.pp
```
node 'example.example.net' {
include cd_clamav
}
```
#### through Foreman:
In order to apply parameters through Foreman, **__cd_clamav::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/).
### 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_clamav-parameters/) is available [here](https://confdroid.com/2019/09/cd_clamav-parameters/) and in the docs folder in the software repo.
#### Mandatory Parameters
There are currently no mandatory parameters, i.e. the module will function right out of box as is.
#### Optional Parameters
### SELINUX
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
### Known Problems
### Support
* OS: CentOS 7
* Puppet 5.x
### Tests
* Puppet Lint
* excluded tests:
* `--no-class_inherits_from_params_class-check`:relavant 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-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.
* Puppet Parser
* ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code as this causes problems with PuppetDB (see tests/UTF_Files)
### Contact Us
[contact Us](https://confdroid.com/contact/)
### Disclaimer
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.