From 25ed2334e71294371ed357336e0b77d37f7766b2 Mon Sep 17 00:00:00 2001 From: Benedikt Trefzer Date: Tue, 20 Aug 2024 01:03:14 +0200 Subject: [PATCH] rebuild REFERENCE --- REFERENCE.md | 170 +++++++++++++++++++++++++-------------------------- 1 file changed, 85 insertions(+), 85 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 7d2e19d..e920501 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -10,11 +10,11 @@ ### Defined types -* [`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 +* [`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::rabbitmq`](#mollyguard--checks--rabbitmq): use this to add drbd check to molly-guard +* [`mollyguard::checks::repmgr_postgres`](#mollyguard--checks--repmgr_postgres): use this to add repmgr-postgres check to molly-guard ## Classes @@ -26,14 +26,14 @@ mollyguard main class The following parameters are available in the `mollyguard` class: -* [`package_ensure`](#package_ensure) -* [`packages`](#packages) -* [`checks`](#checks) -* [`check_destination`](#check_destination) -* [`purge_checks`](#purge_checks) -* [`ignore_sys_checks`](#ignore_sys_checks) +* [`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` Data type: `String` @@ -41,7 +41,7 @@ what to ensure for packages, defaults to 'present' Default value: `'present'` -##### `packages` +##### `packages` Data type: `Array` @@ -49,7 +49,7 @@ Array of packages to install, defaults to ['molly-guard'] Default value: `['molly-guard']` -##### `checks` +##### `checks` Data type: `Hash` @@ -64,7 +64,7 @@ Example (hiera): Default value: `{}` -##### `check_destination` +##### `check_destination` Data type: `String` @@ -73,15 +73,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` @@ -93,7 +93,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 @@ -101,20 +101,20 @@ use this to add ceph check to molly-guard The following parameters are available in the `mollyguard::checks::ceph` defined type: -* [`destination`](#destination) -* [`check_name`](#check_name) -* [`sort`](#sort) -* [`owner`](#owner) -* [`group`](#group) -* [`mode`](#mode) +* [`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` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -122,7 +122,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -130,7 +130,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -138,7 +138,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -146,7 +146,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String` @@ -154,7 +154,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 @@ -162,20 +162,20 @@ use this to add drbd check to molly-guard The following parameters are available in the `mollyguard::checks::drbd` defined type: -* [`destination`](#destination) -* [`check_name`](#check_name) -* [`sort`](#sort) -* [`owner`](#owner) -* [`group`](#group) -* [`mode`](#mode) +* [`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` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -183,7 +183,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -191,7 +191,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -199,7 +199,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -207,7 +207,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String` @@ -215,7 +215,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 @@ -224,21 +224,21 @@ to molly-guard The following parameters are available in the `mollyguard::checks::libvirt` defined type: -* [`destination`](#destination) -* [`check_name`](#check_name) -* [`sort`](#sort) -* [`owner`](#owner) -* [`group`](#group) -* [`mode`](#mode) -* [`options`](#options) +* [`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` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -246,7 +246,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -254,7 +254,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -262,7 +262,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -270,7 +270,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String` @@ -278,7 +278,7 @@ mode of the check (file), defaults to '0755' Default value: `'0755'` -##### `options` +##### `options` Data type: `String` @@ -290,7 +290,7 @@ if you do not care about shutdown instances. Default value: `'--all'` -### `mollyguard::checks::rabbitmq` +### `mollyguard::checks::rabbitmq` use this to add drbd check to molly-guard @@ -298,20 +298,20 @@ use this to add drbd check to molly-guard 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`](#-mollyguard--checks--rabbitmq--destination) +* [`check_name`](#-mollyguard--checks--rabbitmq--check_name) +* [`sort`](#-mollyguard--checks--rabbitmq--sort) +* [`owner`](#-mollyguard--checks--rabbitmq--owner) +* [`group`](#-mollyguard--checks--rabbitmq--group) +* [`mode`](#-mollyguard--checks--rabbitmq--mode) -##### `destination` +##### `destination` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -319,7 +319,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -327,7 +327,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -335,7 +335,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -343,7 +343,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String` @@ -351,7 +351,7 @@ mode of the check (file), defaults to '0755' Default value: `'0755'` -### `mollyguard::checks::repmgr_postgres` +### `mollyguard::checks::repmgr_postgres` use this to add repmgr-postgres check to molly-guard @@ -359,20 +359,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`](#destination) -* [`check_name`](#check_name) -* [`sort`](#sort) -* [`owner`](#owner) -* [`group`](#group) -* [`mode`](#mode) +* [`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` Data type: `String` directory where to put the check (mandatory) -##### `check_name` +##### `check_name` Data type: `String` @@ -380,7 +380,7 @@ name of the check (defaults to $title) Default value: `$title` -##### `sort` +##### `sort` Data type: `String` @@ -388,7 +388,7 @@ sort parameter (defaults to '20') Default value: `'20'` -##### `owner` +##### `owner` Data type: `String` @@ -396,7 +396,7 @@ owner of the check (file), defaults to 'root' Default value: `'root'` -##### `group` +##### `group` Data type: `String` @@ -404,7 +404,7 @@ group of the check (file), defaults to 'root' Default value: `'root'` -##### `mode` +##### `mode` Data type: `String`