diff --git a/REFERENCE.md b/REFERENCE.md index 4ea2f78..76faf21 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -10,10 +10,11 @@ ### Defined types -* [`mollyguard::checks::ceph`](#mollyguard--checks--ceph): use this to add ceph check to molly-guard -* [`mollyguard::checks::drbd`](#mollyguard--checks--drbd): use this to add drbd check to molly-guard -* [`mollyguard::checks::libvirt`](#mollyguard--checks--libvirt): use this to add check for running libbvirt domains to molly-guard -* [`mollyguard::checks::repmgr_postgres`](#mollyguard--checks--repmgr_postgres): use this to add repmgr-postgres check to molly-guard +* [`mollyguard::checks::ceph`](#mollyguardchecksceph): use this to add ceph check to molly-guard +* [`mollyguard::checks::drbd`](#mollyguardchecksdrbd): use this to add drbd check to molly-guard +* [`mollyguard::checks::libvirt`](#mollyguardcheckslibvirt): use this to add check for running libbvirt domains to molly-guard +* [`mollyguard::checks::rabbitmq`](#mollyguardchecksrabbitmq): use this to add drbd check to molly-guard +* [`mollyguard::checks::repmgr_postgres`](#mollyguardchecksrepmgr_postgres): use this to add repmgr-postgres check to molly-guard ## Classes @@ -25,14 +26,14 @@ mollyguard main class The following parameters are available in the `mollyguard` class: -* [`package_ensure`](#-mollyguard--package_ensure) -* [`packages`](#-mollyguard--packages) -* [`checks`](#-mollyguard--checks) -* [`check_destination`](#-mollyguard--check_destination) -* [`purge_checks`](#-mollyguard--purge_checks) -* [`ignore_sys_checks`](#-mollyguard--ignore_sys_checks) +* [`package_ensure`](#package_ensure) +* [`packages`](#packages) +* [`checks`](#checks) +* [`check_destination`](#check_destination) +* [`purge_checks`](#purge_checks) +* [`ignore_sys_checks`](#ignore_sys_checks) -##### `package_ensure` +##### `package_ensure` Data type: `String` @@ -40,7 +41,7 @@ what to ensure for packages, defaults to 'present' Default value: `'present'` -##### `packages` +##### `packages` Data type: `Array` @@ -48,7 +49,7 @@ Array of packages to install, defaults to ['molly-guard'] Default value: `['molly-guard']` -##### `checks` +##### `checks` Data type: `Hash` @@ -62,7 +63,7 @@ Example (hiera): Default value: `{}` -##### `check_destination` +##### `check_destination` Data type: `String` @@ -71,15 +72,15 @@ defaults to '/etc/molly-guard/run.d' Default value: `'/etc/molly-guard/run.d'` -##### `purge_checks` +##### `purge_checks` Data type: `Boolean` if true (default), we purge checks not managed with puppet -Default value: `true` +Default value: ``true`` -##### `ignore_sys_checks` +##### `ignore_sys_checks` Data type: `Array` @@ -91,7 +92,7 @@ Default value: `['10-print-message', '30-query-hostname']` ## Defined types -### `mollyguard::checks::ceph` +### `mollyguard::checks::ceph` use this to add ceph check to molly-guard @@ -99,20 +100,20 @@ use this to add ceph check to molly-guard The following parameters are available in the `mollyguard::checks::ceph` defined type: -* [`destination`](#-mollyguard--checks--ceph--destination) -* [`check_name`](#-mollyguard--checks--ceph--check_name) -* [`sort`](#-mollyguard--checks--ceph--sort) -* [`owner`](#-mollyguard--checks--ceph--owner) -* [`group`](#-mollyguard--checks--ceph--group) -* [`mode`](#-mollyguard--checks--ceph--mode) +* [`destination`](#destination) +* [`check_name`](#check_name) +* [`sort`](#sort) +* [`owner`](#owner) +* [`group`](#group) +* [`mode`](#mode) -##### `destination` +##### `destination` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -120,7 +121,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -128,7 +129,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -136,7 +137,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -144,7 +145,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String` @@ -152,7 +153,7 @@ mode of the check (file), defaults to '0755' Default value: `'0755'` -### `mollyguard::checks::drbd` +### `mollyguard::checks::drbd` use this to add drbd check to molly-guard @@ -160,20 +161,20 @@ use this to add drbd check to molly-guard The following parameters are available in the `mollyguard::checks::drbd` defined type: -* [`destination`](#-mollyguard--checks--drbd--destination) -* [`check_name`](#-mollyguard--checks--drbd--check_name) -* [`sort`](#-mollyguard--checks--drbd--sort) -* [`owner`](#-mollyguard--checks--drbd--owner) -* [`group`](#-mollyguard--checks--drbd--group) -* [`mode`](#-mollyguard--checks--drbd--mode) +* [`destination`](#destination) +* [`check_name`](#check_name) +* [`sort`](#sort) +* [`owner`](#owner) +* [`group`](#group) +* [`mode`](#mode) -##### `destination` +##### `destination` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -181,7 +182,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -189,7 +190,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -197,7 +198,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -205,7 +206,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String` @@ -213,7 +214,7 @@ mode of the check (file), defaults to '0755' Default value: `'0755'` -### `mollyguard::checks::libvirt` +### `mollyguard::checks::libvirt` use this to add check for running libbvirt domains to molly-guard @@ -222,21 +223,21 @@ to molly-guard The following parameters are available in the `mollyguard::checks::libvirt` defined type: -* [`destination`](#-mollyguard--checks--libvirt--destination) -* [`check_name`](#-mollyguard--checks--libvirt--check_name) -* [`sort`](#-mollyguard--checks--libvirt--sort) -* [`owner`](#-mollyguard--checks--libvirt--owner) -* [`group`](#-mollyguard--checks--libvirt--group) -* [`mode`](#-mollyguard--checks--libvirt--mode) -* [`options`](#-mollyguard--checks--libvirt--options) +* [`destination`](#destination) +* [`check_name`](#check_name) +* [`sort`](#sort) +* [`owner`](#owner) +* [`group`](#group) +* [`mode`](#mode) +* [`options`](#options) -##### `destination` +##### `destination` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -244,7 +245,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -252,7 +253,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -260,7 +261,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -268,7 +269,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String` @@ -276,7 +277,7 @@ mode of the check (file), defaults to '0755' Default value: `'0755'` -##### `options` +##### `options` Data type: `String` @@ -288,7 +289,68 @@ if you do not care about shutdown instances. Default value: `'--all'` -### `mollyguard::checks::repmgr_postgres` +### `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`](#destination) +* [`check_name`](#check_name) +* [`sort`](#sort) +* [`owner`](#owner) +* [`group`](#group) +* [`mode`](#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 @@ -296,20 +358,20 @@ use this to add repmgr-postgres check to molly-guard The following parameters are available in the `mollyguard::checks::repmgr_postgres` defined type: -* [`destination`](#-mollyguard--checks--repmgr_postgres--destination) -* [`check_name`](#-mollyguard--checks--repmgr_postgres--check_name) -* [`sort`](#-mollyguard--checks--repmgr_postgres--sort) -* [`owner`](#-mollyguard--checks--repmgr_postgres--owner) -* [`group`](#-mollyguard--checks--repmgr_postgres--group) -* [`mode`](#-mollyguard--checks--repmgr_postgres--mode) +* [`destination`](#destination) +* [`check_name`](#check_name) +* [`sort`](#sort) +* [`owner`](#owner) +* [`group`](#group) +* [`mode`](#mode) -##### `destination` +##### `destination` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -317,7 +379,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -325,7 +387,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -333,7 +395,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -341,7 +403,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String`