REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• observium: A short summary of the purpose of this class

Private Classes

• observium::apache: Class: observium::apache inherits observium Configure apache server with virtual host for observium
• observium::config: Class: observium::config Configure observium configuration files lint:ignore:140chars lint:ignore:arrow_alignment
• observium::database_init: Class: obversium Init the observium database after install. lint:ignore:140chars
• observium::firewall: Class: observium::firewall Manage iptables on ubuntu
• observium::firewalld: Class: observium::firewall Manages firewall and opens ports for observium
• observium::install: Class: observium::install Creates folder structure for Observium, and install from tar
• observium::mariadb: Class: observium::mariadb Install mysql or mariadb - OS dependant
• observium::packages: Class: observium::packages Installs required packges for observium
• observium::selinux: Class: observium::selinux Class disables selinux as per observium install guide.
• observium::snmp: Class: observium::snmp Sets up SNMP locally to permit monitoring of local host out of the box.
• observium::yum: Creates requried yumrepo for RHEL and installs GPG keys.

Classes

observium

Observium base class which accepts parameters to customise the observium install.

lint:ignore:140chars

lint:ignore:parameter_order

Examples

include observium

Parameters

The following parameters are available in the observium class:

• auth_mechanism
• db_password
• rootdb_password
• download_url
• installer_name
• install_dir
• db_host
• db_user
• db_charset
• db_collate
• community
• snmpv3_authlevel
• snmpv3_authname
• snmpv3_authpass
• snmpv3_authalgo
• snmpv3_cryptopass
• snmpv3_cryptoalgo
• snmpd_agentaddress
• mib_locations
• additional_mib_location
• additional_snmp_conf_options
• fping_location
• email_default
• email_from
• admin_password
• apache_bind_ip
• apache_access_log
• apache_error_log
• apache_custom_options
• apache_auth_require
• apache_hostname
• apache_port
• apache_sslport
• custom_ssl_cert
• custom_ssl_key
• manage_repo
• manage_selinux
• manage_fw
• manage_snmp
• manage_mysql
• manage_apache
• manage_apachephp
• manage_ssl
• repos
• gpgkeys
• observium_additional_conf

auth_mechanism

Data type: String

Auth mechanism to use default: mysql

db_password

Data type: String

Mysql password for observium user - default 'changeme'

rootdb_password

Data type: String

Mysql root password - default 'hello123'

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

Data type: String

Installer name, IE observium-installer.tar - default 'observium-community-latest.tar.gz'

install_dir

Data type: String

Install directory - default '/opt/observium'

db_host

Data type: String

Database host to use - default 'localhost'

db_user

Data type: String

Database user to use - default 'observium'

db_charset

Data type: String

Database charset to use - default 'utf8' Ubuntu 22.04 'utf8mb3'

db_collate

Data type: String

Database collate to use - default 'utf8_general_ci' Ubuntu 22.04 'utf8mb3_general_ci'

community

Data type: String

Default SNMP community to configure - default 'puppet'

snmpv3_authlevel

Data type: Enum['noAuthNoPriv','authNoPriv','authPriv']

Default SNMP authlevel to use - default 'authPriv' Valid options - ['noAuthNoPriv','authNoPriv','authPriv']

snmpv3_authname

Data type: String

SNMP Authname SNMPv3 user - default 'observium'

snmpv3_authpass

Data type: String

Auth password - min 8 character

snmpv3_authalgo

Data type: Enum['SHA','MD5']

Auth algorithm - defualt 'SHA' Valid options - ['SHA','MD5']

snmpv3_cryptopass

Data type: String

Crypto pass - min 8 character

snmpv3_cryptoalgo

Data type: Enum['AES','DES']

Crypto algorithm - default 'AES' Valid options - ['AES','DES']

snmpd_agentaddress

Data type: Array

An array of addresses, on which snmpd will listen for queries. - 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

Data type: Array

Additional mib locations to add to snmp.conf. Appended to built in mib_locations. default []

Default value: []

additional_snmp_conf_options

Data type: Array

Additional options to add to snmp.conf. default []

Default value: []

fping_location

Data type: String

Change if fping is in a non default locaiton - default, RHEL '/sbin/fping' Ubuntu '/usr/bin/fping'

email_default

Data type: String

Not setup yet, use additional config option to setup email default

email_from

Data type: String

Not setup yet, use additional config option to setup email from

admin_password

Data type: String

Admin password for the default admin observium user - default 'changeme'

apache_bind_ip

Data type: String

Bind IP address - default $facts['ipaddress']

Default value: $facts['networking']['ip']

apache_access_log

Data type: Stdlib::Unixpath

Apache access log file - default '/opt/observium/logs/access_log'

apache_error_log

Data type: Stdlib::Unixpath

Apache error log file - default '/opt/observium/logs/error_log'

apache_custom_options

Data type: Hash

Apache custom options, example could be changing auth type or adding Shibboleth support,

To add Shibboleth support you would add the following to your hiera data

observium::apache_custom_options:
  auth_type: "shibboleth"
  shib_request_settings:
    requireSession: 1

Default value: {}

apache_auth_require

Data type: String

Apache auth require parameter - default 'all granted'

apache_hostname

Data type: String

Apache hostname for observium site - default $facts['hostname']

Default value: $facts['networking']['hostname']

apache_port

Data type: Stdlib::Port

Apache non SSL port - note if SSL is enabled this will have no effect - default '80'

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

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

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

Data type: Boolean

Manage repo, RHEL only, - default true

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

Data type: Boolean

Manage firewalld on RHEL. UFW on ubuntu. - default RHEL true, Ubuntu false

manage_snmp

Data type: Boolean

Configure snmpd on the observium and add to observium - default true

manage_mysql

Data type: Boolean

Install and configure mysql, - default true

manage_apache

Data type: Boolean

Install and configure Apache, - defalt true

manage_apachephp

Data type: Boolean

Configure Apachemod php, - default true

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

Data type: Optional[Hash]

Customise repoistory locations for RedHat

Default value: undef

gpgkeys

Data type: Optional[Hash]

Customise GPG keys for RedHat

Default value: undef

observium_additional_conf

Data type: Optional[Array]

Array of additional configurations options to add to /opt/observium/config.php

Default value: undef