Ansible Role: grafana

Provision and manage grafana - platform for analytics and monitoring

Requirements

Ansible >= 2.5
libselinux-python on deployer host (only when deployer machine has SELinux)
grafana >= 5.1 (for older grafana versions use this role in version 0.10.1 or earlier)

Role Variables

All variables which can be overridden are stored in defaults/main.yml file as well as in table below.

Name	Default Value	Description
`grafana_use_provisioning`	true	Use Grafana provisioning capalibity when possible (grafana_version=latest will assume >= 5.0)
`grafana_system_user`	grafana	Grafana server system user
`grafana_system_group`	grafana	Grafana server system group
`grafana_version`	latest	Grafana package version
`grafana_instance`	{{ ansible_fqdn \| default(ansible_host) \| default(inventory_hostname) }}	Grafana instance name
`grafana_logs_dir`	/var/log/grafana	Path to logs directory
`grafana_data_dir`	/var/lib/grafana	Path to database directory
`grafana_address`	0.0.0.0	Address on which grafana listens
`grafana_port`	3000	port on which grafana listens
`grafana_url`	"http://{{ grafana_address }}:{{ grafana_port }}"	Full URL used to access Grafana from a web browser
`grafana_api_url`	"{{ grafana_url }}"	URL used for API calls in provisioning if different from public URL. See this issue.
`grafana_domain`	"{{ ansible_fqdn \| default(ansible_host) \| default('localhost') }}"	setting is only used in as a part of the `root_url` option. Useful when using GitHub or Google OAuth
`grafana_server`	{ protocol: http, enforce_domain: false, socket: "", cert_key: "", cert_file: "", enable_gzip: false, static_root_path: public, router_logging: false }	server configuration section
`grafana_security`	{ admin_user: admin, admin_password: "" }	security configuration section
`grafana_database`	{ type: sqlite3 }	database configuration section
`grafana_welcome_email_on_sign_up`	false	Send welcome email after signing up
`grafana_users`	{ allow_sign_up: false, auto_assign_org_role: Viewer, default_theme: dark }	users configuration section
`grafana_auth`	{}	authorization configuration section
`grafana_ldap`	{}	ldap configuration section. group_mappings are expanded, see defaults for example
`grafana_session`	{}	session management configuration section
`grafana_analytics`	{}	Google analytics configuration section
`grafana_smtp`	{}	smtp configuration section
`grafana_alerting`	true	alerting configuration section
`grafana_metrics`	{}	metrics configuration section
`grafana_tracing`	{}	tracing configuration section
`grafana_snapshots`	{}	snapshots configuration section
`grafana_image_storage`	{}	image storage configuration section
`grafana_dashboards`	[]	List of dashboards which should be imported
`grafana_dashboards_dir`	"dashboards"	Path to a local directory containing dashboards files in `json` format
`grafana_datasources`	[]	List of datasources which should be configured

Datasource example:

grafana_datasources:
  - name: prometheus
    type: prometheus
    access: proxy
    url: 'http://{{ prometheus_web_listen_address }}'
    basicAuth: false

Dashboard example:

grafana_dashboards:
  - dashboard_id: 111
    revision_id: 1
    datasource: prometheus

Supported CPU Architectures

Detection is done automatically and packages are taken from different channels according to CPU architecture:

amd64 - via official grafana packages (1, 2)
armv6/armv7 and aarch64/arm64 - via unofficial packages distributed by fg2it

Example

Playbook

- hosts: all
  become: true
  roles:
    - cloudalchemy.grafana

Demo site

We provide demo site for full monitoring solution based on prometheus and grafana. Repository with code and links to running instances is available on github and site is hosted on DigitalOcean.

Local Testing

The preferred way of locally testing the role is to use Docker and molecule (v2.x). You will have to install Docker on your system. See "Get started" for a Docker package suitable to for your system. We are using tox to simplify process of testing on multiple ansible versions. To install tox execute:

pip install tox

To run tests on all ansible versions (WARNING: this can take some time)

tox

To run a custom molecule command on custom environment with only default test scenario:

tox -e py27-ansible25 -- molecule test -s default

For more information about molecule go to their docs.

If you would like to run tests on remote docker host just specify DOCKER_HOST variable before running tox tests.

Travis CI

Combining molecule and travis CI allows us to test how new PRs will behave when used with multiple ansible versions and multiple operating systems. This also allows use to create test scenarios for different role configurations. As a result we have a quite large test matrix (42 parallel role executions in case of ansible-prometheus) which will take more time than local testing, so please be patient.

Contributing

See contributor guideline.

License

This project is licensed under MIT License. See LICENSE for more details.

nicosto/ansible-grafana