From 925f50702fff5e845a53318c322765f8739c2c4b Mon Sep 17 00:00:00 2001 From: ben Date: Thu, 13 Jun 2024 18:59:39 +1000 Subject: [PATCH] Update reference.md --- REFERENCE.md | 195 ++++++++++++++++++++++++++------------------------- 1 file changed, 101 insertions(+), 94 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 7e71c0f..8780e87 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -46,165 +46,172 @@ include observium The following parameters are available in the `observium` class: -* [`auth_mechanism`](#auth_mechanism) -* [`db_password`](#db_password) -* [`rootdb_password`](#rootdb_password) -* [`download_url`](#download_url) -* [`installer_name`](#installer_name) -* [`install_dir`](#install_dir) -* [`db_host`](#db_host) -* [`db_user`](#db_user) -* [`db_charset`](#db_charset) -* [`db_collate`](#db_collate) -* [`community`](#community) -* [`snmpv3_authlevel`](#snmpv3_authlevel) -* [`snmpv3_authname`](#snmpv3_authname) -* [`snmpv3_authpass`](#snmpv3_authpass) -* [`snmpv3_authalgo`](#snmpv3_authalgo) -* [`snmpv3_cryptopass`](#snmpv3_cryptopass) -* [`snmpv3_cryptoalgo`](#snmpv3_cryptoalgo) -* [`mib_locations`](#mib_locations) -* [`additional_mib_location`](#additional_mib_location) -* [`additional_snmp_conf_options`](#additional_snmp_conf_options) -* [`fping_location`](#fping_location) -* [`email_default`](#email_default) -* [`email_from`](#email_from) -* [`admin_password`](#admin_password) -* [`apache_bind_ip`](#apache_bind_ip) -* [`apache_access_log`](#apache_access_log) -* [`apache_error_log`](#apache_error_log) -* [`apache_custom_options`](#apache_custom_options) -* [`apache_auth_require`](#apache_auth_require) -* [`apache_hostname`](#apache_hostname) -* [`apache_port`](#apache_port) -* [`apache_sslport`](#apache_sslport) -* [`custom_ssl_cert`](#custom_ssl_cert) -* [`custom_ssl_key`](#custom_ssl_key) -* [`manage_repo`](#manage_repo) -* [`manage_selinux`](#manage_selinux) -* [`manage_fw`](#manage_fw) -* [`manage_snmp`](#manage_snmp) -* [`manage_mysql`](#manage_mysql) -* [`manage_apache`](#manage_apache) -* [`manage_apachephp`](#manage_apachephp) -* [`manage_ssl`](#manage_ssl) -* [`repos`](#repos) -* [`gpgkeys`](#gpgkeys) -* [`observium_additional_conf`](#observium_additional_conf) - -##### `auth_mechanism` +* [`auth_mechanism`](#-observium--auth_mechanism) +* [`db_password`](#-observium--db_password) +* [`rootdb_password`](#-observium--rootdb_password) +* [`download_url`](#-observium--download_url) +* [`installer_name`](#-observium--installer_name) +* [`install_dir`](#-observium--install_dir) +* [`db_host`](#-observium--db_host) +* [`db_user`](#-observium--db_user) +* [`db_charset`](#-observium--db_charset) +* [`db_collate`](#-observium--db_collate) +* [`community`](#-observium--community) +* [`snmpv3_authlevel`](#-observium--snmpv3_authlevel) +* [`snmpv3_authname`](#-observium--snmpv3_authname) +* [`snmpv3_authpass`](#-observium--snmpv3_authpass) +* [`snmpv3_authalgo`](#-observium--snmpv3_authalgo) +* [`snmpv3_cryptopass`](#-observium--snmpv3_cryptopass) +* [`snmpv3_cryptoalgo`](#-observium--snmpv3_cryptoalgo) +* [`snmpd_agentaddress`](#-observium--snmpd_agentaddress) +* [`mib_locations`](#-observium--mib_locations) +* [`additional_mib_location`](#-observium--additional_mib_location) +* [`additional_snmp_conf_options`](#-observium--additional_snmp_conf_options) +* [`fping_location`](#-observium--fping_location) +* [`email_default`](#-observium--email_default) +* [`email_from`](#-observium--email_from) +* [`admin_password`](#-observium--admin_password) +* [`apache_bind_ip`](#-observium--apache_bind_ip) +* [`apache_access_log`](#-observium--apache_access_log) +* [`apache_error_log`](#-observium--apache_error_log) +* [`apache_custom_options`](#-observium--apache_custom_options) +* [`apache_auth_require`](#-observium--apache_auth_require) +* [`apache_hostname`](#-observium--apache_hostname) +* [`apache_port`](#-observium--apache_port) +* [`apache_sslport`](#-observium--apache_sslport) +* [`custom_ssl_cert`](#-observium--custom_ssl_cert) +* [`custom_ssl_key`](#-observium--custom_ssl_key) +* [`manage_repo`](#-observium--manage_repo) +* [`manage_selinux`](#-observium--manage_selinux) +* [`manage_fw`](#-observium--manage_fw) +* [`manage_snmp`](#-observium--manage_snmp) +* [`manage_mysql`](#-observium--manage_mysql) +* [`manage_apache`](#-observium--manage_apache) +* [`manage_apachephp`](#-observium--manage_apachephp) +* [`manage_ssl`](#-observium--manage_ssl) +* [`repos`](#-observium--repos) +* [`gpgkeys`](#-observium--gpgkeys) +* [`observium_additional_conf`](#-observium--observium_additional_conf) + +##### `auth_mechanism` Data type: `String` Auth mechanism to use default: mysql -##### `db_password` +##### `db_password` Data type: `String` Mysql password for observium user - default 'changeme' -##### `rootdb_password` +##### `rootdb_password` Data type: `String` Mysql root password - default 'hello123' -##### `download_url` +##### `download_url` Data type: `String` Url to the installer, IE http://observium.com/, can be a file path - default 'http://www.observium.org/' -##### `installer_name` +##### `installer_name` Data type: `String` Installer name, IE observium-installer.tar - default 'observium-community-latest.tar.gz' -##### `install_dir` +##### `install_dir` Data type: `String` Install directory - default '/opt/observium' -##### `db_host` +##### `db_host` Data type: `String` Database host to use - default 'localhost' -##### `db_user` +##### `db_user` Data type: `String` Database user to use - default 'observium' -##### `db_charset` +##### `db_charset` Data type: `String` Database charset to use - default 'utf8' Ubuntu 22.04 'utf8mb3' -##### `db_collate` +##### `db_collate` Data type: `String` Database collate to use - default 'utf8_general_ci' Ubuntu 22.04 'utf8mb3_general_ci' -##### `community` +##### `community` Data type: `String` Default SNMP community to configure - default 'puppet' -##### `snmpv3_authlevel` +##### `snmpv3_authlevel` Data type: `Enum['noAuthNoPriv','authNoPriv','authPriv']` Default SNMP authlevel to use - default 'authPriv' Valid options - ['noAuthNoPriv','authNoPriv','authPriv'] -##### `snmpv3_authname` +##### `snmpv3_authname` Data type: `String` SNMP Authname SNMPv3 user - default 'observium' -##### `snmpv3_authpass` +##### `snmpv3_authpass` Data type: `String` Auth password - min 8 character -##### `snmpv3_authalgo` +##### `snmpv3_authalgo` Data type: `Enum['SHA','MD5']` Auth algorithm - defualt 'SHA' Valid options - ['SHA','MD5'] -##### `snmpv3_cryptopass` +##### `snmpv3_cryptopass` Data type: `String` Crypto pass - min 8 character -##### `snmpv3_cryptoalgo` +##### `snmpv3_cryptoalgo` Data type: `Enum['AES','DES']` Crypto algorithm - default 'AES' Valid options - ['AES','DES'] -##### `mib_locations` +##### `snmpd_agentaddress` + +Data type: `Array` + +Array Snmp_agentaddress - default ['udp:127.0.0.1:161','udp6:[::1]:161'] + +##### `mib_locations` Data type: `Array` Miblocations for observium to add to snmp.conf, default ['/opt/observium/mibs/rfc','/opt/observium/mibs/net-snmp'] -##### `additional_mib_location` +##### `additional_mib_location` Data type: `Array` @@ -212,7 +219,7 @@ Additional mib locations to add to snmp.conf. Appended to built in mib_locations Default value: `[]` -##### `additional_snmp_conf_options` +##### `additional_snmp_conf_options` Data type: `Array` @@ -220,31 +227,31 @@ Additional options to add to snmp.conf. default [] Default value: `[]` -##### `fping_location` +##### `fping_location` Data type: `String` Change if fping is in a non default locaiton - default, RHEL '/sbin/fping' Ubuntu '/usr/bin/fping' -##### `email_default` +##### `email_default` Data type: `String` Not setup yet, use additional config option to setup email default -##### `email_from` +##### `email_from` Data type: `String` Not setup yet, use additional config option to setup email from -##### `admin_password` +##### `admin_password` Data type: `String` Admin password for the default admin observium user - default 'changeme' -##### `apache_bind_ip` +##### `apache_bind_ip` Data type: `String` @@ -252,19 +259,19 @@ Bind IP address - default $facts['ipaddress'] Default value: `$facts['networking']['ip']` -##### `apache_access_log` +##### `apache_access_log` Data type: `Stdlib::Unixpath` Apache access log file - default '/opt/observium/logs/access_log' -##### `apache_error_log` +##### `apache_error_log` Data type: `Stdlib::Unixpath` Apache error log file - default '/opt/observium/logs/error_log' -##### `apache_custom_options` +##### `apache_custom_options` Data type: `Hash` @@ -279,13 +286,13 @@ observium::apache_custom_options: ``` Default value: {} -##### `apache_auth_require` +##### `apache_auth_require` Data type: `String` Apache auth require parameter - default 'all granted' -##### `apache_hostname` +##### `apache_hostname` Data type: `String` @@ -293,99 +300,99 @@ Apache hostname for observium site - default $facts['hostname'] Default value: `$facts['networking']['hostname']` -##### `apache_port` +##### `apache_port` Data type: `Stdlib::Port` Apache non SSL port - note if SSL is enabled this will have no effect - default '80' -##### `apache_sslport` +##### `apache_sslport` Data type: `Stdlib::Port` Apache SSL port - note if SSL isn't enable this will have no effect - defautl '443' -##### `custom_ssl_cert` +##### `custom_ssl_cert` Data type: `String` Path to SSL certificate, note this module will automatically create a cert in this location '/etc/ssl/observium_cert.pem' - default '/etc/ssl/observium_cert.pem' -##### `custom_ssl_key` +##### `custom_ssl_key` Data type: `String` Path to SSL certificate key, note this module will automatically create a key in this location '/etc/ssl/observium_key.pem' - default '/etc/ssl/observium_key.pem' -##### `manage_repo` +##### `manage_repo` Data type: `Boolean` Manage repo, RHEL only, - default true -##### `manage_selinux` +##### `manage_selinux` Data type: `Boolean` Manage selinux, RHEL only. This will set selinux to permissive mode as observium havn't published a selinux profile - default true -##### `manage_fw` +##### `manage_fw` Data type: `Boolean` Manage firewalld on RHEL. UFW on ubuntu. - default RHEL true, Ubuntu false -##### `manage_snmp` +##### `manage_snmp` Data type: `Boolean` Configure snmpd on the observium and add to observium - default true -##### `manage_mysql` +##### `manage_mysql` Data type: `Boolean` Install and configure mysql, - default true -##### `manage_apache` +##### `manage_apache` Data type: `Boolean` Install and configure Apache, - defalt true -##### `manage_apachephp` +##### `manage_apachephp` Data type: `Boolean` Configure Apachemod php, - default true -##### `manage_ssl` +##### `manage_ssl` Data type: `Boolean` Setup the web site as SSL. If no cert provided, a self signed one will be used. - default false -##### `repos` +##### `repos` Data type: `Optional[Hash]` Customise repoistory locations for RedHat -Default value: ``undef`` +Default value: `undef` -##### `gpgkeys` +##### `gpgkeys` Data type: `Optional[Hash]` Customise GPG keys for RedHat -Default value: ``undef`` +Default value: `undef` -##### `observium_additional_conf` +##### `observium_additional_conf` Data type: `Optional[Array]` Array of additional configurations options to add to /opt/observium/config.php -Default value: ``undef`` +Default value: `undef`