confdroid/confdroid_clamav
1
0
Fork 0
Code Issues Wiki Activity

fix Readme

Browse Source
This commit is contained in:
Arne Teuke
2025-06-08 12:26:05 +02:00
parent bf4616bed2
commit ab428b8fde
1 changed files with 6 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -1,6 +1,6 @@
# Readme # Readme
[![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=cd_clamav)](https://jenkins.confdroid.com/job/cd_clamav/)| [![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=clamav_cd)](https://jenkins.confdroid.com/job/clamav_cd/)|
[[_TOC_]] [[_TOC_]]
@@ -8,7 +8,7 @@
`Clamav` is a powerful antivirus scanner with several components. `Clamav` is a powerful antivirus scanner with several components.
`cd_clamav` is a puppet module to manage clamav installations and configurations. `clamav_cd` is a puppet module to manage clamav installations and configurations.
## WARNING ## WARNING
@@ -28,13 +28,13 @@ via site.pp or nodes.pp
```bash ```bash
node 'example.example.net' { node 'example.example.net' {
include cd_clamav include clamav_cd
} }
``` ```
* through Foreman: * through Foreman:
In order to apply parameters through Foreman, **__cd_clamav::params__** must be added to the host or host group in question. In order to apply parameters through Foreman, **__clamav_cd::params__** must be added to the host or host group 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/).
@@ -48,20 +48,16 @@ All files and directories are configured with correct selinux context. If selinu
## Support ## Support
* OS: CentOS 7 * OS: Rocky 9
* Puppet 5 * Puppet 6-8
## Tests ## Tests
* Puppet Lint * Puppet Lint
* excluded tests: * excluded tests:
* `--no-class_inherits_from_params_class-check`:relevant 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-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 * Puppet Parser
* ERB Template Parser * ERB Template Parser
* Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
* Sonar Quality Gate * Sonar Quality Gate
## Contact Us ## Contact Us