Bartosz Bezak 733fb0e7b8 Trivial fixes in grafana-guide doc.
Change-Id: Ie888e84a3b6e27afc23f89f643fdaa58880aae6d
2021-03-18 15:11:56 +01:00

47 lines
1.4 KiB
ReStructuredText

.. _grafana-guide:
=======
Grafana
=======
Overview
~~~~~~~~
`Grafana <https://grafana.com>`_ is open and composable observability and
data visualization platform. Visualize metrics, logs, and traces from
multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB,
Postgres and many more..
Preparation and deployment
~~~~~~~~~~~~~~~~~~~~~~~~~~
To enable Grafana, modify the configuration file ``/etc/kolla/globals.yml``
and change the following:
.. code-block:: yaml
enable_grafana: "yes"
If you would like to set up Prometheus as a data source, additionally set:
.. code-block:: yaml
enable_prometheus: "yes"
Please follow :doc:`Prometheus Guide <prometheus-guide>` for more information.
Custom dashboards provisioning
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Kolla Ansible sets custom dashboards provisioning using `Dashboard provider <https://grafana.com/docs/grafana/latest/administration/provisioning/#dashboards>`_.
Dashboard's JSON files should be placed into
``{{ node_custom_config }}/grafana/dashboards/`` folder.
Dashboards will be imported to Grafana dashboards General Folder.
Grafana provisioner config can be altered by placing ``provisioning.yaml`` to
``{{ node_custom_config }}/grafana/`` folder.
For other settings, follow configuration reference:
`Dashboard provider configuration <https://grafana.com/docs/grafana/latest/administration/provisioning/#dashboards>`_.