Ansible Role icingaweb2_module_grafana

This role installs and configures the IcingaWeb2 Grafana Module. Additionally, it deploys the the graph configuration for the Linuxfabrik Monitoring Plugins. This can be disabled using icingaweb2_module_grafana__skip_monitoring_plugins_graphs_config.

This role is tested with the following IcingaWeb2 Grafana Module versions:

1.4.2
2.0.3

Mandatory Requirements

A configured IcingaWeb2. This can be done using the linuxfabrik.lfops.icingaweb2 role.
A configured Grafana. This can be done using the linuxfabrik.lfops.grafana role.

If you use the Setup Icinga2 Master Playbook, this is automatically done for you.

Tags

Tag	What it does
`icingaweb2_module_grafana`	Installs and configures the IcingaWeb2 Grafana Module
`icingaweb2_module_grafana:configure`	Configures the IcingaWeb2 Grafana Module, excluding the graph configs.
`icingaweb2_module_grafana:monitoring_plugins_graphs`	Deploys the configuration for the graphs for the Linuxfabrik Monitoring Plugins

Mandatory Role Variables

Variable	Description
`icingaweb2_module_grafana__version`	The module version to install. Possible options: https://github.com/Mikesch-mp/icingaweb2-module-grafana/releases.

Example:

# mandatory
icingaweb2_module_grafana__version: 'v1.4.2'

Optional Role Variables

Variable	Description	Default Value
`icingaweb2_module_grafana__custom_graphs_config`	Multiline string. Custom configuration for the Grafana Graphs, will be deployed to `/etc/icingweb2/modules/grafana/graphs.ini` along with the configuration for the Linuxfabrik Monitoring Plugins	`''`
`icingaweb2_module_grafana__default_dashboard`	Name of the default Grafana dashboard	`'Default'`
`icingaweb2_module_grafana__monitoring_plugins_version`	The version of the monitoring plugins that will be used for generating the grafana graph configuration. Possible options: * `latest`: The latest stable release. See the Releases. * `main`: The development version. Use with care. * A specific release, for example `2022030201`. See the Releases.	`'{{ lfops__monitoring_plugins_version \| default("latest") }}'`
`icingaweb2_module_grafana__skip_monitoring_plugins_graphs_config`	Skip the deployment of the graph configuration for Linuxfabrik Monitoring Plugins.	`false`
`icingaweb2_module_grafana__theme`	The theme for the Grafana graphs. Possible options: * `dark` * `light`	`'light'`
`icingaweb2_module_grafana__url`	The Grafana URL. This should be reachable from both the IcingaWeb2 server and the client device.	`{{ grafana__root_url }}`

Example:

# optional
icingaweb2_module_grafana__custom_graphs_config: |-
  [icingacli-x509]
  dashboard = "Default"
  panelId = "1"
  orgId = ""
  repeatable = "no"
  dashboarduid = "default"
  timerange = "7d"
icingaweb2_module_grafana__default_dashboard: 'Default'
icingaweb2_module_grafana__monitoring_plugins_version: 'latest'
icingaweb2_module_grafana__skip_monitoring_plugins_graphs_config: true
icingaweb2_module_grafana__theme: 'light'
icingaweb2_module_grafana__url: 'https://monitoring.example.com/grafana'

License

The Unlicense

Author Information

Linuxfabrik GmbH, Zurich