REFERENCE.md

Reference

Table of Contents

Classes

• mollyguard: mollyguard main class

Defined types

• mollyguard::checks::ceph: use this to add ceph check to molly-guard
• mollyguard::checks::drbd: use this to add drbd check to molly-guard
• mollyguard::checks::json_web_status: check a json status
• mollyguard::checks::libvirt: use this to add check for running libbvirt domains to molly-guard
• mollyguard::checks::rabbitmq: use this to add drbd check to molly-guard
• mollyguard::checks::repmgr_postgres: use this to add repmgr-postgres check to molly-guard

Classes

mollyguard

mollyguard main class

Parameters

The following parameters are available in the mollyguard class:

• package_ensure
• packages
• checks
• check_destination
• purge_checks
• ignore_sys_checks

package_ensure

Data type: String

what to ensure for packages, defaults to 'present'

Default value: 'present'

packages

Data type: Array

Array of packages to install, defaults to ['molly-guard']

Default value: ['molly-guard']

checks

Data type: Hash

Hash of additional checks to install, defaults to {}. This parameter is hiera hash merged by default.

Example (hiera): mollyguard::checks: libvirt: options: '--state-running --state-paused --state-other' drbd: {}

Default value: {}

check_destination

Data type: String

where to put the additional checks, defaults to '/etc/molly-guard/run.d'

Default value: '/etc/molly-guard/run.d'

purge_checks

Data type: Boolean

if true (default), we purge checks not managed with puppet

Default value: true

ignore_sys_checks

Data type: Array

name of checks to ignore purging, these are the default checks installed with the package. defaults to: ['10-print-message', '30-query-hostname']

Default value: ['10-print-message', '30-query-hostname']

Defined types

mollyguard::checks::ceph

use this to add ceph check to molly-guard

Parameters

The following parameters are available in the mollyguard::checks::ceph defined type:

• destination
• check_name
• sort
• owner
• group
• mode

destination

Data type: String

directory where to put the check (mandatory)

check_name

Data type: String

name of the check (defaults to $title)

Default value: $title

sort

Data type: String

sort parameter (defaults to '20')

Default value: '20'

owner

Data type: String

owner of the check (file), defaults to 'root'

Default value: 'root'

group

Data type: String

group of the check (file), defaults to 'root'

Default value: 'root'

mode

Data type: String

mode of the check (file), defaults to '0755'

Default value: '0755'

mollyguard::checks::drbd

use this to add drbd check to molly-guard

Parameters

The following parameters are available in the mollyguard::checks::drbd defined type:

• destination
• check_name
• sort
• owner
• group
• mode

destination

Data type: String

directory where to put the check (mandatory)

check_name

Data type: String

name of the check (defaults to $title)

Default value: $title

sort

Data type: String

sort parameter (defaults to '20')

Default value: '20'

owner

Data type: String

owner of the check (file), defaults to 'root'

Default value: 'root'

group

Data type: String

group of the check (file), defaults to 'root'

Default value: 'root'

mode

Data type: String

mode of the check (file), defaults to '0755'

Default value: '0755'

mollyguard::checks::json_web_status

request a json file from an url and check a value

ensure that jq and curl is available on the target node.

Parameters

The following parameters are available in the mollyguard::checks::json_web_status defined type:

• destination
• check_name
• sort
• owner
• group
• mode
• uris
• jqueries
• show_json

destination

Data type: String

directory where to put the check (mandatory)

check_name

Data type: String

name of the check (defaults to $title)

Default value: $title

sort

Data type: String

sort parameter (defaults to '20')

Default value: '20'

owner

Data type: String

owner of the check (file), defaults to 'root'

Default value: 'root'

group

Data type: String

group of the check (file), defaults to 'root'

Default value: 'root'

mode

Data type: String

mode of the check (file), defaults to '0755'

Default value: '0755'

uris

Data type: Array[String[1]]

array of uris for json files. each json file received will be checked

Default value: []

jqueries

Data type: Array[String[1]]

array of queries to run on every json for syntax see man jq. The query needs to return 'true' for the check to pass. an examle could be '.numberofmembers|contains(3)' which is true if the json contains a nuberofmembers equal 3

Default value: []

show_json

Data type: Boolean

if we show the json we query (defaults true)

Default value: true

mollyguard::checks::libvirt

use this to add check for running libbvirt domains to molly-guard

Parameters

The following parameters are available in the mollyguard::checks::libvirt defined type:

• destination
• check_name
• sort
• owner
• group
• mode
• options

destination

Data type: String

directory where to put the check (mandatory)

check_name

Data type: String

name of the check (defaults to $title)

Default value: $title

sort

Data type: String

sort parameter (defaults to '20')

Default value: '20'

owner

Data type: String

owner of the check (file), defaults to 'root'

Default value: 'root'

group

Data type: String

group of the check (file), defaults to 'root'

Default value: 'root'

mode

Data type: String

mode of the check (file), defaults to '0755'

Default value: '0755'

options

Data type: String

options to add to virsh list command to select listed domains. defaults to '--all' set this to '--state-running --state-paused --state-other' if you do not care about shutdown instances.

Default value: '--all'

mollyguard::checks::rabbitmq

use this to add drbd check to molly-guard

Parameters

The following parameters are available in the mollyguard::checks::rabbitmq defined type:

• destination
• check_name
• sort
• owner
• group
• mode

destination

Data type: String

directory where to put the check (mandatory)

check_name

Data type: String

name of the check (defaults to $title)

Default value: $title

sort

Data type: String

sort parameter (defaults to '20')

Default value: '20'

owner

Data type: String

owner of the check (file), defaults to 'root'

Default value: 'root'

group

Data type: String

group of the check (file), defaults to 'root'

Default value: 'root'

mode

Data type: String

mode of the check (file), defaults to '0755'

Default value: '0755'

mollyguard::checks::repmgr_postgres

use this to add repmgr-postgres check to molly-guard

Parameters

The following parameters are available in the mollyguard::checks::repmgr_postgres defined type:

• destination
• check_name
• sort
• owner
• group
• mode

destination

Data type: String

directory where to put the check (mandatory)

check_name

Data type: String

name of the check (defaults to $title)

Default value: $title

sort

Data type: String

sort parameter (defaults to '20')

Default value: '20'

owner

Data type: String

owner of the check (file), defaults to 'root'

Default value: 'root'

group

Data type: String

group of the check (file), defaults to 'root'

Default value: 'root'

mode

Data type: String

mode of the check (file), defaults to '0755'

Default value: '0755'