EN-0001 - add new stages

This commit is contained in:
Arne Teuke
2021-08-05 17:34:50 +02:00
parent c33f1670e9
commit 2f48d84502
9 changed files with 84 additions and 267 deletions

4
.mdl_style.rb Normal file
View File

@@ -0,0 +1,4 @@
all
# exlude line lenght
# exclude_rule 'MD013'
rule 'MD013', :line_length => 1000

2
.mdlrc Normal file
View File

@@ -0,0 +1,2 @@
style '.mdl_style.rb'

18
.spelling Normal file
View File

@@ -0,0 +1,18 @@
# markdown-spellcheck spelling configuration file
# Format - lines begining # are comments
# global dictionary is at the start, file overrides afterwards
# one word per line, to define a file override use ' - filename'
# where filename is relative to this configuration file
Readme.md
sudo
selinux
site.pp
nodes.pp
cd_sudo
::
params
Foreman
cd_resources
CentOS
Puppet
ConfDroid

View File

@@ -1,169 +0,0 @@
<h1> Git Changelog changelog </h1>
<p>
Changelog of Git Changelog.
</p>
<h2> Unreleased </h2>
<h2> No issue </h2>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/96cb29bd1845c61">96cb29bd1845c61</a> Jenkins ConfDroid <i>2019-12-26 16:26:48</i>
<p>
<h3>recommit for updates in build 25</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/795543319c34b3b">795543319c34b3b</a> Arne Teuke <i>2019-12-26 16:26:06</i>
<p>
<h3>changes packages</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/3f2934b4a3e16c4">3f2934b4a3e16c4</a> Jenkins ConfDroid <i>2019-12-26 16:03:26</i>
<p>
<h3>recommit for updates in build 24</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/1e6d36787bd5827">1e6d36787bd5827</a> Arne Teuke <i>2019-12-26 16:02:49</i>
<p>
<h3>changes packages</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/a69c0e096e10f44">a69c0e096e10f44</a> Jenkins ConfDroid <i>2019-12-26 16:01:59</i>
<p>
<h3>recommit for updates in build 23</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/321186fc7f76c7a">321186fc7f76c7a</a> Arne Teuke <i>2019-12-26 16:01:18</i>
<p>
<h3>changes packages</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/87b72468db8186a">87b72468db8186a</a> Jenkins ConfDroid <i>2019-12-24 22:58:56</i>
<p>
<h3>recommit for updates in build 22</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/830805df577ff60">830805df577ff60</a> Arne Teuke <i>2019-12-24 22:58:13</i>
<p>
<h3>adds controls for service, files and dirs, plus templates</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/9f2852d61edbc5b">9f2852d61edbc5b</a> Jenkins ConfDroid <i>2019-12-24 22:24:14</i>
<p>
<h3>recommit for updates in build 21</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/08d621b25c90d4d">08d621b25c90d4d</a> Arne Teuke <i>2019-12-24 22:23:25</i>
<p>
<h3>adds controls for service, files and dirs, plus templates</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/0d8da38d9c95ac7">0d8da38d9c95ac7</a> Jenkins ConfDroid <i>2019-12-24 21:37:12</i>
<p>
<h3>recommit for updates in build 20</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/c18a28c767382a2">c18a28c767382a2</a> Arne Teuke <i>2019-12-24 21:36:34</i>
<p>
<h3>removes link to yumrepo</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/18ea2b3878bb807">18ea2b3878bb807</a> Jenkins ConfDroid <i>2019-12-24 21:17:31</i>
<p>
<h3>recommit for updates in build 19</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/f57ba6bdd6fa0f0">f57ba6bdd6fa0f0</a> Arne Teuke <i>2019-12-24 21:16:56</i>
<p>
<h3>changes jenkinsfile</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/02ba2a45c27f44d">02ba2a45c27f44d</a> Jenkins ConfDroid <i>2019-12-24 21:14:23</i>
<p>
<h3>recommit for updates in build 18</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/df9e0543567ec50">df9e0543567ec50</a> Arne Teuke <i>2019-12-24 21:13:49</i>
<p>
<h3>uses local jenkins</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/637fcb8e3542fae">637fcb8e3542fae</a> Jenkins ConfDroid <i>2019-12-24 21:11:15</i>
<p>
<h3>recommit for updates in build 17</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/cb490dde982aa67">cb490dde982aa67</a> Arne Teuke <i>2019-12-24 21:10:41</i>
<p>
<h3>uses local jenkins</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/27917c238c71e25">27917c238c71e25</a> Jenkins ConfDroid <i>2019-12-24 21:08:56</i>
<p>
<h3>recommit for updates in build 16</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/c9cb8ab6c66eb34">c9cb8ab6c66eb34</a> Arne Teuke <i>2019-12-24 21:08:19</i>
<p>
<h3>uses local jenkins</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/1030d02d6008fe1">1030d02d6008fe1</a> Arne Teuke <i>2019-12-24 21:01:44</i>
<p>
<h3>uses local jenkins</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/27d92691fa6671a">27d92691fa6671a</a> Arne Teuke <i>2019-12-24 20:56:22</i>
<p>
<h3>updates params</h3>
</p>
<h2> 0.0.0.1 </h2>
<h2> No issue </h2>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/ed8495b996a33c4">ed8495b996a33c4</a> Arne Teuke <i>2019-11-14 20:08:28</i>
<p>
<h3>edited README</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/27fe01f972f377d">27fe01f972f377d</a> Arne Teuke <i>2019-11-14 19:37:19</i>
<p>
<h3>updates Readme</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/557fbb02f14d54a">557fbb02f14d54a</a> Arne Teuke <i>2019-10-28 16:55:37</i>
<p>
<h3>testing slaves</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/c1b525e5f2ca2d8">c1b525e5f2ca2d8</a> Arne Teuke <i>2019-10-28 16:54:08</i>
<p>
<h3>testing slaves</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/e7b065781337daa">e7b065781337daa</a> Arne Teuke <i>2019-10-28 16:52:11</i>
<p>
<h3>testing slaves</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/f50af6022925a12">f50af6022925a12</a> Arne Teuke <i>2019-10-28 16:50:21</i>
<p>
<h3>testing slaves</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/44092c835ab2d2a">44092c835ab2d2a</a> Arne Teuke <i>2019-10-28 16:49:11</i>
<p>
<h3>testing slaves</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/e7a1636635266e0">e7a1636635266e0</a> Arne Teuke <i>2019-10-28 16:47:06</i>
<p>
<h3>testing slaves</h3>
</p>
<a href="https://gitlab.confdroid.com/12WW1160/git-changelog-lib/commit/03e4718163c8064">03e4718163c8064</a> Arne Teuke <i>2019-10-28 16:40:12</i>
<p>
<h3>testing slaves</h3>
</p>

View File

@@ -3,7 +3,7 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
puppetversion = ENV.key?('PUPPET_VERSION') ? ENV['PUPPET_VERSION'] : ['<= 5.5.6']
gem 'metadata-json-lint', '~> 2.4'
gem 'puppet', puppetversion
gem 'puppetlabs_spec_helper', '>= 1.0.0'
gem 'puppetlabs_spec_helper', '~> 3.0'
gem 'puppet-lint'
gem 'facter'
gem 'rspec-puppet'
@@ -15,6 +15,7 @@ gem 'rgen'
gem 'public_suffix', '<= 2.0.5'
gem 'parallel', '<= 1.13.0'
gem 'puppet-syntax', '~> 2.6', '>= 2.6.1'
gem 'pathspec', '~> 0.2.1'
# rspec must be v2 for ruby 1.8.7
if RUBY_VERSION >= '1.8.7' && RUBY_VERSION < '1.9'

28
Jenkinsfile vendored
View File

@@ -70,10 +70,32 @@ pipeline {
}
}
stage('update repo structure') {
stage('markdown-lint') {
steps {
sh '''rm -Rf REPOSTRUCTURE.md
echo "$(tree --dirsfirst --charset=ascii .)" > REPOSTRUCTURE.md'''
sh '''
source /opt/rh/rh-ruby27/enable
mdl README.md
'''
}
}
stage('spell check') {
steps {
sh '''
mdspell -r -n -a "**/*.md"
'''
}
}
stage('SonarScan') {
steps {
sh '''
/opt/sonar-scanner/bin/sonar-scanner \
-Dsonar.projectKey=cd_clamav \
-Dsonar.sources=. \
-Dsonar.host.url=http://sonarqube.confdroid.com \
-Dsonar.login=f4d68d1f43370b34439eee7fbf5e2b6182cf449c
'''
}
}

View File

@@ -1,95 +1,80 @@
# Readme
[![Build Status](https://pipelines.confdroid.com/buildStatus/icon?job=cd_clamav)](https://pipelines.confdroid.com/job/cd_clamav/)|
### 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 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://sourcecode.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)
* [Contact Us](https://confdroid.com/contact/)
* [Disclaimer](#disclaimer)
## 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.
* [cd_resources](https://sourcecode.confdroid.com/12WW1160/cd_resources) to manage yum base repos
### Deployment
##### native Puppet deployment
* native Puppet deployment
via site.pp or nodes.pp
```
```bash
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 in question.
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 parameters are documented via puppet strings and [listed here](/docs/index.html). Simply open in web browser.
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.
## SELINUX
#### 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
### Support
* OS: CentOS 7
* Puppet 5.x
### Tests
## Tests
* Puppet Lint
* 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-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
* Markdown-lint
* Spellcheck
* Sonar Quality Gate
## Contact Us
[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.
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.

View File

@@ -1,44 +0,0 @@
.
|-- doc
| |-- css
| | |-- common.css
| | |-- full_list.css
| | `-- style.css
| |-- js
| | |-- app.js
| | |-- full_list.js
| | `-- jquery.js
| |-- puppet_classes
| | |-- cd_clamav_3A_3Amain_3A_3Aconfig.html
| | |-- cd_clamav_3A_3Amain_3A_3Adirs.html
| | |-- cd_clamav_3A_3Amain_3A_3Afiles.html
| | |-- cd_clamav_3A_3Amain_3A_3Ainstall.html
| | |-- cd_clamav_3A_3Amain_3A_3Aservice.html
| | |-- cd_clamav_3A_3Aparams.html
| | `-- cd_clamav.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
| |-- freshclam_conf.erb
| `-- scan_conf.erb
|-- CHANGELOG.md
|-- Gemfile
|-- Gemfile.lock
|-- Jenkinsfile
|-- LICENSE
`-- README.md
7 directories, 34 files

View File

@@ -12,14 +12,12 @@ LogSyslog <%= @cv_logsyslog %>
LogFacility <%= @cv_logfacility %>
LogVerbose <%= @cv_logverbose %>
LogRotate <%= @cv_logrotate %>
PreludeEnable <%= @cv_preludeenable %>
# Enable Prelude output.
# Default: no
PreludeEnable yes
#
# Set the name of the analyzer used by prelude-admin.
# Default: ClamAV
#PreludeAnalyzerName ClamAV
PreludeAnalyzerName ClamAV
# Log additional information about the infected file, such as its
# size and hash, together with the virus name.