2020-12-01 16:47:20 +00:00
# Description
This role configures a docker container running [Grafana ](http://docs.grafana.org/ ) as a metrics dashboard.
It connects to a configured instance of [Prometheus ](https://prometheus.io/docs/introduction/overview/ ) or [Cortex ](https://cortexmetrics.io/ ) to query for metrics.
# Configuration
The main settings that matter are:
```yaml
grafana_domain: 'grafana.example.org'
2020-12-01 17:03:23 +00:00
grafana_username: 'admin'
grafana_password: 'super-secret-password'
2020-12-01 16:47:20 +00:00
grafana_version: '7.3.4'
2020-12-01 16:54:03 +00:00
grafana_prometheus_sources:
- { name: 'node-01', addr: '1.1.1.1', port: 8080 }
- { name: 'node-02', addr: '1.1.1.2', port: 8080, path: 'proxy/' }
2020-12-01 16:47:20 +00:00
```
You should also configure OAuth:
```yaml
grafana_oauth_id: '123qwe123qwe123'
2020-12-07 15:48:08 +00:00
grafana_oauth_secret: 'qweasdqweasdqweasdqweasd'
2020-12-01 18:22:08 +00:00
grafana_oauth_gh_org: 'evil-corp'
grafana_oauth_gh_team_ids: [ 1234, 5678 ]
2020-12-01 16:47:20 +00:00
```
Optional email configuration might be useful:
```yaml
grafana_smtp_enabled: true
grafana_smtp_from_addr: 'grafana@example.org'
2020-12-01 17:01:32 +00:00
grafana_smtp_from_name: 'Grafana Email'
grafana_smtp_host: 'smtp'.example.org
grafana_smtp_port: 587
grafana_smtp_user: 'grafana'
grafana_smtp_pass: 'super-secret-password'
2020-12-01 16:47:20 +00:00
```
You can optionally allow anonymous access:
```yaml
grafana_anonymous: true
```
# Details
Configuration consists of two templates:
* `grafana.ini.j2` - Grafana main configuration file.
2020-12-01 17:01:32 +00:00
* `prometheus.yml.j2` - Initial configuration of the query backend(s).
