From 578c6a6e83976bb7e2faa8be94c9a44a3df8848e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Mon, 4 Dec 2023 23:08:03 +0100 Subject: [PATCH] cleaning --- doc/ADMIN.md | 35 ----------------------------------- doc/DESCRIPTION.md | 10 +++++++++- doc/POST_INSTALL.md | 8 ++++++++ doc/PRE_INSTALL.md | 4 ++++ 4 files changed, 21 insertions(+), 36 deletions(-) delete mode 100644 doc/ADMIN.md create mode 100644 doc/POST_INSTALL.md create mode 100644 doc/PRE_INSTALL.md diff --git a/doc/ADMIN.md b/doc/ADMIN.md deleted file mode 100644 index 8aca1f0..0000000 --- a/doc/ADMIN.md +++ /dev/null @@ -1,35 +0,0 @@ -## Configuration - -**Important at first login:** - -* you have to go the Grafana Menu (Grafana icon), select your account menu and select *Switch to Main Org.* -* you can now access the default NetData dashboard via the Home menu - -**Don't hesitate to create new dashboards**: the default dashboard contains metrics from NetData, but only generic ones that are generated on every machine. NetData dynamically detects services and applications (e.g.redis, nginx, etc.) and enriches its dashboard and generated metrics. Many NetData metrics don't appear in the provided default Grafana dashboard! - -## Documentation - - * Official Grafana documentation: https://grafana.com/docs/grafana/latest/ - * Official InfluxdB documentation: https://docs.influxdata.com/influxdb/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -* installs InfluxDB as time series database -* if the NetData package is installed, configures NetData to feed InfluxDB every minute -* installs Grafana as dashboard server -* creates a Grafana Data Source to fetch data from InfluxDB (and hence NetData!) -* creates a default dashboard to plot some data from NetData (doesn't cover every metric, can be greatly enhanced!) - -#### General architecture - -![image](https://cloud.githubusercontent.com/assets/2662304/20649711/29f182ba-b4ce-11e6-97c8-ab2c0ab59833.png) - -#### Multi-users support - -LDAP and HTTP auth are supported. - -## Limitations - -* The default dashboard may be updated in a further release of this package, so please make sure you create your own dashboards! -* Organizations creation doesn't play well with LDAP integration; it is disabled for standard users, but can't be disabled for administrators: **please do not create organizations**! diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index d174a55..cbadcbb 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1 +1,9 @@ -Grafana is a multi-platform open source analytics and interactive visualization web application. It provides charts, graphs, and alerts for the web when connected to supported data sources. \ No newline at end of file +Grafana is a multi-platform open source analytics and interactive visualization web application. It provides charts, graphs, and alerts for the web when connected to supported data sources. + +## YunoHost specific features + +* installs InfluxDB as time series database +* if the NetData package is installed, configures NetData to feed InfluxDB every minute +* installs Grafana as dashboard server +* creates a Grafana Data Source to fetch data from InfluxDB (and hence NetData!) +* creates a default dashboard to plot some data from NetData (doesn't cover every metric, can be greatly enhanced!) diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md new file mode 100644 index 0000000..f2c2a80 --- /dev/null +++ b/doc/POST_INSTALL.md @@ -0,0 +1,8 @@ +## Configuration + +**Important at first login:** + +* you have to go the Grafana Menu (Grafana icon), select your account menu and select *Switch to Main Org.* +* you can now access the default NetData dashboard via the Home menu + +**Don't hesitate to create new dashboards**: the default dashboard contains metrics from NetData, but only generic ones that are generated on every machine. NetData dynamically detects services and applications (e.g.redis, nginx, etc.) and enriches its dashboard and generated metrics. Many NetData metrics don't appear in the provided default Grafana dashboard! diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md new file mode 100644 index 0000000..0de1133 --- /dev/null +++ b/doc/PRE_INSTALL.md @@ -0,0 +1,4 @@ +## Limitations + +* The default dashboard may be updated in a further release of this package, so please make sure you create your own dashboards! +* Organizations creation doesn't play well with LDAP integration; it is disabled for standard users, but can't be disabled for administrators: **please do not create organizations**!