diff options
| author | Bartosz Bezak <bartosz@stackhpc.com> | 2020-12-22 16:35:43 +0100 |
|---|---|---|
| committer | Bartosz Bezak <bartosz@stackhpc.com> | 2021-03-16 17:10:19 +0100 |
| commit | a9e30382fed49c522d564c1246f220b4dcfdbb5f (patch) | |
| tree | e35be309f83ba1bbdb4026314ed81c89ccec5fa7 /doc | |
| parent | 4b51997e7bbaafd141846b0f1fff4095232ab351 (diff) | |
| download | kolla-ansible-a9e30382fed49c522d564c1246f220b4dcfdbb5f.tar.gz kolla-ansible-a9e30382fed49c522d564c1246f220b4dcfdbb5f.zip | |
Add support for custom grafana dashboards
Allow users to import custom grafana dashboards.
Dashboards as JSON files should be placed into
"{{ node_custom_config }}/grafana/dashboards/" folder.
Change-Id: Id0f83b8d08541b3b74649f097b10c9450201b426
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/reference/logging-and-monitoring/grafana-guide.rst | 46 | ||||
| -rw-r--r-- | doc/source/reference/logging-and-monitoring/index.rst | 1 |
2 files changed, 47 insertions, 0 deletions
diff --git a/doc/source/reference/logging-and-monitoring/grafana-guide.rst b/doc/source/reference/logging-and-monitoring/grafana-guide.rst new file mode 100644 index 000000000..a60536c6a --- /dev/null +++ b/doc/source/reference/logging-and-monitoring/grafana-guide.rst @@ -0,0 +1,46 @@ +.. _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>`_. diff --git a/doc/source/reference/logging-and-monitoring/index.rst b/doc/source/reference/logging-and-monitoring/index.rst index 4aa730c2b..7c164728e 100644 --- a/doc/source/reference/logging-and-monitoring/index.rst +++ b/doc/source/reference/logging-and-monitoring/index.rst @@ -9,6 +9,7 @@ logging and monitoring services available in kolla. :maxdepth: 1 central-logging-guide + grafana-guide influxdb-guide kafka-guide monasca-guide |
