Readme
+|
Synopsis
+[[TOC]]
+ +Synopsis
Clamav is a powerful antivirus scanner with several
components.
cd_clamav is a puppet module to manage clamav installations
and configurations.
WARNING
+WARNING
**__!!! Attention: Never use this puppet module on systems which have
been previously configured manually. It is impossible to predict how and
@@ -79,54 +83,13 @@ 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
- -Repostructure has moved to REPOSTRUCTURE.md in repo.
- -Repo Documentation
+Repo Documentation
See the full Puppet documentation in docs/index.html
-Dependencies
+Dependencies
All dependencies must be included in the catalogue.
- @@ -136,64 +99,51 @@ to manage yum base repos
Deployment
- -native Puppet deployment
+-
+
native Puppet deployment
+
via site.pp or nodes.pp
node 'example.example.net' {
include cd_clamav
}through Foreman:
+-
+
through Foreman:
+
In order to apply parameters through Foreman, -cd_clamav::params must be added to the host or hostgroup +cd_clamav::params must be added to the host or host group in question.
See more details about class deployment on Confdroid.com.
-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 parameters are documented via puppet strings and listed here. Simply open in web browser.
-The full list -of Parameters is available here 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
+SELINUX
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
-Known Problems
- -Support
+Support
-
OS: CentOS 7
-
-
Puppet 5.x
+Puppet 5
Tests
+Tests
-
Puppet Lint
-
excluded tests:
-
-
--no-class_inherits_from_params_class-check:relavant only to +--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 @@ -213,15 +163,20 @@ block, not per class. -
ERB Template Parser
-
-
Test for unwanted UTF8 files in the Puppet code as this causes problems -with PuppetDB (see tests/UTF_Files)
- -Contact Us
- - +Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
+ -
+
Markdown-lint
+ -
+
Spellcheck
+ -
+
Sonar Quality Gate
Disclaimer
+Contact Us
+ + + +Disclaimer
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific diff --git a/doc/index.html b/doc/index.html index a593acf..f94f72c 100644 --- a/doc/index.html +++ b/doc/index.html @@ -58,10 +58,14 @@
-
-
Readme
+|
Synopsis
+[[TOC]]
+ +Synopsis
Clamav is a powerful antivirus scanner with several
components.
cd_clamav is a puppet module to manage clamav installations
and configurations.
WARNING
+WARNING
**__!!! Attention: Never use this puppet module on systems which have
been previously configured manually. It is impossible to predict how and
@@ -79,54 +83,13 @@ 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
- -Repostructure has moved to REPOSTRUCTURE.md in repo.
- -Repo Documentation
+Repo Documentation
See the full Puppet documentation in docs/index.html
-Dependencies
+Dependencies
All dependencies must be included in the catalogue.
- @@ -136,64 +99,51 @@ to manage yum base repos
Deployment
- -native Puppet deployment
+-
+
native Puppet deployment
+
via site.pp or nodes.pp
node 'example.example.net' {
include cd_clamav
}through Foreman:
+-
+
through Foreman:
+
In order to apply parameters through Foreman, -cd_clamav::params must be added to the host or hostgroup +cd_clamav::params must be added to the host or host group in question.
See more details about class deployment on Confdroid.com.
-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 parameters are documented via puppet strings and listed here. Simply open in web browser.
-The full list -of Parameters is available here 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
+SELINUX
All files and directories are configured with correct selinux context. If selinux is disabled, these contexts are ignored.
-Known Problems
- -Support
+Support
-
OS: CentOS 7
-
-
Puppet 5.x
+Puppet 5
Tests
+Tests
-
Puppet Lint
-
excluded tests:
-
-
--no-class_inherits_from_params_class-check:relavant only to +--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 @@ -213,15 +163,20 @@ block, not per class. -
ERB Template Parser
-
-
Test for unwanted UTF8 files in the Puppet code as this causes problems -with PuppetDB (see tests/UTF_Files)
- -Contact Us
- - +Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
+ -
+
Markdown-lint
+ -
+
Spellcheck
+ -
+
Sonar Quality Gate
Disclaimer
+Contact Us
+ + + +Disclaimer
ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific
-
-