From 6144155f82a09574ccbe8ae6c82ea3b26bd8b8ba Mon Sep 17 00:00:00 2001 From: Jenkins Server Date: Sun, 8 Jun 2025 12:30:06 +0200 Subject: [PATCH] Recommit for updates in build 4 --- doc/_index.html | 14 +- doc/file.README.html | 20 +- doc/index.html | 20 +- doc/puppet_class_list.html | 28 +- doc/puppet_classes/clamav_cd.html | 129 +++++ .../clamav_cd_3A_3Amain_3A_3Aconfig.html | 131 ++++++ .../clamav_cd_3A_3Amain_3A_3Adirs.html | 154 ++++++ .../clamav_cd_3A_3Amain_3A_3Afiles.html | 184 ++++++++ .../clamav_cd_3A_3Amain_3A_3Ainstall.html | 139 ++++++ .../clamav_cd_3A_3Amain_3A_3Aservice.html | 144 ++++++ doc/puppet_classes/clamav_cd_3A_3Aparams.html | 443 ++++++++++++++++++ 11 files changed, 1357 insertions(+), 49 deletions(-) create mode 100644 doc/puppet_classes/clamav_cd.html create mode 100644 doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aconfig.html create mode 100644 doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Adirs.html create mode 100644 doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Afiles.html create mode 100644 doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Ainstall.html create mode 100644 doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aservice.html create mode 100644 doc/puppet_classes/clamav_cd_3A_3Aparams.html diff --git a/doc/_index.html b/doc/_index.html index d039182..dc4ce47 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -69,37 +69,37 @@ diff --git a/doc/index.html b/doc/index.html index da6b464..f203196 100644 --- a/doc/index.html +++ b/doc/index.html @@ -60,7 +60,7 @@

Readme

-

|

+

|

[[TOC]]

@@ -68,7 +68,7 @@

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

@@ -89,14 +89,14 @@

via site.pp or nodes.pp

node 'example.example.net' {
-  include cd_clamav
+  include clamav_cd
 }

  • 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.

@@ -110,9 +110,9 @@

Support

  • -

    OS: CentOS 7

    +

    OS: Rocky 9

  • -

    Puppet 5

    +

    Puppet 6-8

Tests

@@ -122,20 +122,12 @@

excluded tests:

  • --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

  • ERB Template Parser

  • -

    Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)

    -

  • Sonar Quality Gate

    • diff --git a/doc/puppet_class_list.html b/doc/puppet_class_list.html index 8b4dbae..f1ba29d 100644 --- a/doc/puppet_class_list.html +++ b/doc/puppet_class_list.html @@ -36,51 +36,51 @@
      -
    • +
    • - cd_clamav + clamav_cd
      • -
    • +
    • - cd_clamav::main::config + clamav_cd::main::config
      • -
    • +
    • - cd_clamav::main::dirs + clamav_cd::main::dirs
      • -
    • +
    • - cd_clamav::main::files + clamav_cd::main::files
      • -
    • +
    • - cd_clamav::main::install + clamav_cd::main::install
      • -
    • +
    • - cd_clamav::main::service + clamav_cd::main::service
      • -
    • +
    • - cd_clamav::params + clamav_cd::params
      • diff --git a/doc/puppet_classes/clamav_cd.html b/doc/puppet_classes/clamav_cd.html new file mode 100644 index 0000000..af7fc10 --- /dev/null +++ b/doc/puppet_classes/clamav_cd.html @@ -0,0 +1,129 @@ + + + + + + + Puppet Class: clamav_cd + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + +
      + +
      +
      + +
      + + +

      Puppet Class: clamav_cd

      +
      + + +
      +
      Defined in:
      +
      + manifests/init.pp +
      +
      +
      + +

      Summary

      + Class initializes the clamav_cd Module. + +

      Overview

      +
      +
      + +

      clamav_cd::init.pp Module name: clamav_cd Author: Arne Teuke (arne_teuke@confdroid.com)

      + +
      +
      + + + +
      + + + +
      + + + + + +
      + 
      +
+
+6
+7
+8
+9
+10
+11
+12
      +       		+ 
      # File 'manifests/init.pp', line 6
+
+class clamav_cd {
+  include clamav_cd::params
+
+  resources { 'firewall':
+    purge => true,
+  }
+}
      +
      +
      +
      + + + +
      + + \ No newline at end of file diff --git a/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aconfig.html b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aconfig.html new file mode 100644 index 0000000..4791da5 --- /dev/null +++ b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aconfig.html @@ -0,0 +1,131 @@ + + + + + + + Puppet Class: clamav_cd::main::config + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + +
      + +
      +
      + +
      + + +

      Puppet Class: clamav_cd::main::config

      +
      + +
      +
      Inherits:
      +
      clamav_cd::params
      +
      + + +
      +
      Defined in:
      +
      + manifests/main/config.pp +
      +
      +
      + +

      Summary

      + Class manages all aspects of configuring the module logic for +clamav_cd. + +

      Overview

      +
      +
      + +

      clamav_cd::main::config.pp Module name: clamav_cd Author: Arne Teuke (arne_teuke@confdroid.com)

      + +
      +
      + + + +
      + + + +
      + + + + + +
      + 
      +
+
+7
+8
+9
+10
+11
      +       		+ 
      # File 'manifests/main/config.pp', line 7
+
+class clamav_cd::main::config (
+
+) inherits clamav_cd::params {
+  include clamav_cd::main::service
+}
      +
      +
      +
      + + + +
      + + \ No newline at end of file diff --git a/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Adirs.html b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Adirs.html new file mode 100644 index 0000000..8a41eb8 --- /dev/null +++ b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Adirs.html @@ -0,0 +1,154 @@ + + + + + + + Puppet Class: clamav_cd::main::dirs + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + +
      + +
      +
      + +
      + + +

      Puppet Class: clamav_cd::main::dirs

      +
      + +
      +
      Inherits:
      +
      clamav_cd::params
      +
      + + +
      +
      Defined in:
      +
      + manifests/main/dirs.pp +
      +
      +
      + +

      Summary

      + Class manages all directories required for clamav_cd. + +

      Overview

      +
      +
      + +

      clamav_cd::main::dirs.pp Module name: clamav_cd Author: Arne Teuke (arne_teuke@confdroid.com)

      + +
      +
      + + + +
      + + + +
      + + + + + +
      + 
      +
+
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
      +       		+ 
      # File 'manifests/main/dirs.pp', line 6
+
+class clamav_cd::main::dirs (
+
+) inherits clamav_cd::params {
+  require clamav_cd::main::install
+
+  # config.d dir
+  file { $cv_config_d_dir:
+    ensure   => directory,
+    owner    => 'root',
+    group    => 'root',
+    mode     => '0755',
+    selrange => s0,
+    selrole  => object_r,
+    seltype  => etc_t,
+    seluser  => system_u,
+  }
+}
      +
      +
      +
      + + + +
      + + \ No newline at end of file diff --git a/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Afiles.html b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Afiles.html new file mode 100644 index 0000000..ca42a88 --- /dev/null +++ b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Afiles.html @@ -0,0 +1,184 @@ + + + + + + + Puppet Class: clamav_cd::main::files + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + +
      + +
      +
      + +
      + + +

      Puppet Class: clamav_cd::main::files

      +
      + +
      +
      Inherits:
      +
      clamav_cd::params
      +
      + + +
      +
      Defined in:
      +
      + manifests/main/files.pp +
      +
      +
      + +

      Summary

      + Class manages all configuration files required for clamav_cd. + +

      Overview

      +
      +
      + +

      clamav_cd::main::files.pp Module name: clamav_cd Author: Arne Teuke (arne_teuke@confdroid.com)

      + +
      +
      + + + +
      + + + +
      + + + + + +
      + 
      +
+
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
      +       		+ 
      # File 'manifests/main/files.pp', line 6
+
+class clamav_cd::main::files (
+
+) inherits clamav_cd::params {
+  require clamav_cd::main::dirs
+
+  # clamd config file
+  file { $cv_clamd_config_file:
+    ensure   => file,
+    owner    => 'root',
+    group    => 'root',
+    mode     => '0644',
+    selrange => s0,
+    selrole  => object_r,
+    seltype  => etc_t,
+    seluser  => system_u,
+    content  => template($cv_clamd_config_erb),
+#    notify   => Service[$cv_service],
+  }
+
+  # freshclam config file
+  file { $cv_freshclam_file:
+    ensure   => file,
+    owner    => 'root',
+    group    => 'root',
+    mode     => '0600',
+    selrange => s0,
+    selrole  => object_r,
+    seltype  => etc_t,
+    seluser  => system_u,
+    content  => template($cv_freshclam_erb),
+  }
+}
      +
      +
      +
      + + + +
      + + \ No newline at end of file diff --git a/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Ainstall.html b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Ainstall.html new file mode 100644 index 0000000..ddb3a7d --- /dev/null +++ b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Ainstall.html @@ -0,0 +1,139 @@ + + + + + + + Puppet Class: clamav_cd::main::install + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + +
      + +
      +
      + +
      + + +

      Puppet Class: clamav_cd::main::install

      +
      + +
      +
      Inherits:
      +
      clamav_cd::params
      +
      + + +
      +
      Defined in:
      +
      + manifests/main/install.pp +
      +
      +
      + +

      Summary

      + Class manage all aspects of installing binaries required for +clamav_cd + +

      Overview

      +
      +
      + +

      clamav_cd ::main::install.pp Module name: clamav_cd Author: Arne Teuke (arne_teuke@confdroid.com)

      + +
      +
      + + + +
      + + + +
      + + + + + +
      + 
      +
+
+7
+8
+9
+10
+11
+12
+13
+14
+15
      +       		+ 
      # File 'manifests/main/install.pp', line 7
+
+class clamav_cd::main::install (
+
+) inherits clamav_cd::params {
+  require resources_cd::main::epel
+
+  package { $reqpackages:
+    ensure => $pkg_ensure,
+  }
+}
      +
      +
      +
      + + + +
      + + \ No newline at end of file diff --git a/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aservice.html b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aservice.html new file mode 100644 index 0000000..4e0ff55 --- /dev/null +++ b/doc/puppet_classes/clamav_cd_3A_3Amain_3A_3Aservice.html @@ -0,0 +1,144 @@ + + + + + + + Puppet Class: clamav_cd::main::service + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + +
      + +
      +
      + +
      + + +

      Puppet Class: clamav_cd::main::service

      +
      + +
      +
      Inherits:
      +
      clamav_cd::params
      +
      + + +
      +
      Defined in:
      +
      + manifests/main/service.pp +
      +
      +
      + +

      Summary

      + Class manages the service(s) for clamav_cd. + +

      Overview

      +
      +
      + +

      clamav_cd::main::service.pp Module name: clamav_cd Author: Arne Teuke (arne_teuke@confdroid.com)

      + +
      +
      + + + +
      + + + +
      + + + + + +
      + 
      +
+
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
      +       		+ 
      # File 'manifests/main/service.pp', line 6
+
+class clamav_cd::main::service (
+
+) inherits clamav_cd::params {
+  require clamav_cd::main::files
+
+#  service { $cv_service:
+#    ensure     => running,
+#    hasstatus  => true,
+#    hasrestart => true,
+#    enable     => true,
+#  }
+}
      +
      +
      +
      + + + +
      + + \ No newline at end of file diff --git a/doc/puppet_classes/clamav_cd_3A_3Aparams.html b/doc/puppet_classes/clamav_cd_3A_3Aparams.html new file mode 100644 index 0000000..1332fa8 --- /dev/null +++ b/doc/puppet_classes/clamav_cd_3A_3Aparams.html @@ -0,0 +1,443 @@ + + + + + + + Puppet Class: clamav_cd::params + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + +
      + +
      +
      + +
      + + +

      Puppet Class: clamav_cd::params

      +
      + + +
      +
      Inherited by:
      +
      + + clamav_cd::main::dirs
      + + clamav_cd::main::files
      + + clamav_cd::main::config
      + + clamav_cd::main::install
      + + clamav_cd::main::service
      + +
      +
      + +
      +
      Defined in:
      +
      + manifests/params.pp +
      +
      +
      + +

      Summary

      + Class holds all parameters for the clamav_cd module and is +inherited by all classes except defines. + +

      Overview

      +
      +
      + +

      clamav_cd::params.pp Module name: clamav_cd Author: Arne Teuke (arne_teuke@confdroid.com)

      + +
      +
      + + + +
      +

      Parameters:

      +
        + +
      • + + reqpackages + + + (String) + + + (defaults to: ['clamav','clamav-update','clamd']) + + + — +
        +

        List of packages to install.

        +
        + +
        • + +
      • + + pkg_ensure + + + (String) + + + (defaults to: 'present') + + + — +
        +

        which package type to choose, i.e. latest or present.

        +
        + +
        • + +
      • + + cv_logfile + + + (String) + + + (defaults to: '/var/log/clamd.scan') + + + — +
        +

        where to log messages for the clamd service.

        +
        + +
        • + +
      • + + cv_logfileunlock + + + (String) + + + (defaults to: 'no') + + + — +
        +

        whether log file should be locked for writing -the lock protects against running clamd multiple times

        +
        + +
        • + +
      • + + cv_logfilemaxsize + + + (String) + + + (defaults to: '2M') + + + — +
        +

        the max size for the logfile. This also enables logrotation.

        +
        + +
        • + +
      • + + cv_logtime + + + (String) + + + (defaults to: 'yes') + + + — +
        +

        Whether to log the time with each message.

        +
        + +
        • + +
      • + + cv_logclean + + + (String) + + + (defaults to: 'no') + + + — +
        +

        whether to log clean files. Useful in debugging but drastically increases the log size.

        +
        + +
        • + +
      • + + cv_logsyslog + + + (String) + + + (defaults to: 'yes') + + + — +
        +

        Use system logger (can work together with LogFile).

        +
        + +
        • + +
      • + + cv_logfacility + + + (String) + + + (defaults to: 'LOG_MAIL') + + + — +
        +

        type of syslog messages - please refer to ‘man syslog’for facility names

        +
        + +
        • + +
      • + + cv_logverbose + + + (String) + + + (defaults to: 'no') + + + — +
        +

        Whether to log verbose.

        +
        + +
        • + +
      • + + cv_logrotate + + + (String) + + + (defaults to: 'yes') + + + — +
        +

        whether to enable log rotation. Always enabled when LogFileMaxSize is enabled.

        +
        + +
        • + +
      • + + cv_preludeenable + + + (String) + + + (defaults to: 'no') + + + — +
        +

        whether to enable prelude output.

        +
        + +
        • + +
      • + + cv_preludeanalyzername + + + (String) + + + (defaults to: 'ClamAV') + + + — +
        +

        name of the analyzer used by prelude-admin.

        +
        + +
        • + +
      + + + +
      + + + + + +
      + 
      +
+
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
      +       		+ 
      # File 'manifests/params.pp', line 29
+
+class clamav_cd::params (
+
+# installation
+  String $reqpackages            = ['clamav','clamav-update','clamd'],
+  String $pkg_ensure             = 'present',
+
+# clamd
+  String $cv_logfile             = '/var/log/clamd.scan',
+  String $cv_logfileunlock       = 'no',
+  String $cv_logfilemaxsize      = '2M',
+  String $cv_logtime             = 'yes',
+  String $cv_logclean            = 'no',
+  String $cv_logsyslog           = 'yes',
+  String $cv_logfacility         = 'LOG_MAIL',
+  String $cv_logverbose          = 'no',
+  String $cv_logrotate           = 'yes',
+  String $cv_preludeenable       = 'no',
+  String $cv_preludeanalyzername = 'ClamAV',
+
+) {
+  # service
+  $cv_service           = 'clamd@.service'
+
+  # dirs
+  $cv_config_d_dir      = '/etc/clamd.d'
+
+  # files
+  $cv_clamd_config_file = "${cv_config_d_dir}/scan.conf"
+  $cv_clamd_config_erb  = 'clamav_cd/scan_conf.erb'
+  $cv_freshclam_file    = '/etc/freshclam.conf'
+  $cv_freshclam_erb     = 'clamav_cd/freshclam_conf.erb'
+
+  # includes must be last
+
+  include clamav_cd::main::config
+}
      +
      +
      +
      + + + +
      + + \ No newline at end of file