From 4ed391479ca0039845982c04a06926ea4347f2fc Mon Sep 17 00:00:00 2001 From: Patrick Petit Date: Sat, 14 Nov 2015 12:47:40 -0800 Subject: [PATCH] Remove README info duplicates with the plugin documentation Updated the Contribution section with the actual Launchpad and Gerrit link. Aligned the overview chapter with the LMA Collector overview chapter. Change-Id: I5d18b9052ff17f908d197d62110e02b6dd133ffe --- README.md | 200 ++++++++++++---------------------------- doc/source/overview.rst | 6 +- 2 files changed, 63 insertions(+), 143 deletions(-) diff --git a/README.md b/README.md index c7cf5daf..69a25e60 100644 --- a/README.md +++ b/README.md @@ -1,172 +1,94 @@ -InfluxDB-Grafana Plugin for Fuel -================================ - -InfluxDB-Grafana plugin ------------------------ +The InfluxDB-Grafana Plugin for Fuel +==================================== Overview -------- -[InfluxDB](http://influxdb.com/) provides an open source time series database. -[Grafana](http://grafana.org/) is a rich dashboard and graph editor for InfluxDB. +The InfluxDB-Grafana Plugin for Fuel is used to install and configure +[InfluxDB](http://influxdb.com/) and +[Grafana](http://grafana.org/) which collectively provide access to +OpenStack analytics for the metrics collected and processed by the +[LMA Collector](http://fuel-plugin-lma-collector.readthedocs.org/en/latest/index.html) +Plugin. -Requirements ------------- - -| Requirement | Version/Comment | -|----------------------------------|-----------------| -| Mirantis OpenStack compatibility | 7.0 or higher | - -Recommendations ---------------- - -None. - -Limitations ------------ - -None. - -Installation Guide -================== - -**InfluxDB-Grafana** plugin installation ----------------------------------------- - - -To install the InfluxDB-Grafana plugin, follow these steps: - -1. Download the plugin from the [Fuel Plugins - Catalog](https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/). - -2. Copy the plugin file to the Fuel Master node. Follow the [Quick start - guide](https://software.mirantis.com/quick-start/) if you don't have a running - Fuel Master node yet. - - ``` - scp influxdb_grafana-0.8-0.8.0-0.noarch.rpm root@: - ``` - -3. Install the plugin using the `fuel` command line: - - ``` - fuel plugins --install influxdb_grafana-0.8-0.8.0-0.noarch.rpm - ``` - -4. Verify that the plugin is installed correctly: - - ``` - fuel plugins - ``` - -Please refer to the [Fuel Plugins wiki](https://wiki.openstack.org/wiki/Fuel/Plugins) -if you want to build the plugin by yourself, version 3.0.0 (or higher) of the Fuel -Plugin Builder is required. - -User Guide -========== - -**InfluxDB-Grafana** plugin configuration ---------------------------------------------- - -1. Create a new environment with the Fuel UI wizard. -2. Click on the Settings tab of the Fuel web UI. -3. Scroll down the page, select the "InfluxDB-Grafana Server plugin" tab, - enable the plugin and fill-in the required fields. - - The password for the InfluxDB root user. - - The name of the database where you want to store your metrics. - - The username and the password for this specific database. - - The name and the password for the Grafana admin user. -4. Add a node with the "InfluxDB Grafana" role. - -### Disks partitioning -The plugin uses: - -- 20% of the first disk for the operating system by honoring the range of - 15GB minimum and 50GB maximum. -- 10GB for /var/log. -- at least 30GB for the InfluxDB data (/opt/influxdb). - - -Testing -------- - -### InfluxDB - -Once installed, you can check that InfluxDB is working using `curl`: - -``` -curl -G 'http://:8086/' \ - --data-urlencode "u=" \ - --data-urlencode "p=" \ - --data-urlencode "q=show databases" -``` - -Where `HOST` is the IP address or the name of the node that runs the server and -credentials are those provided in the Fuel UI for the InfluxDB root user. - -The curl command should return something similar to: - -``` -{"results":[{"series":[{"name":"databases","columns":["name"],"values":[["lma"]]}]}]} -``` - -### Grafana - -Grafana is available at: - -``` -http://$HOST:8000/ -``` - -You can login by using the username and password that you provided in the Fuel UI. - -Known issues ------------- - -None. +Please check the [InfluxDB-Grafana Plugin Overview]( +http://fuel-plugin-influxdb-grafana.readthedocs.org/en/latest/overview.html) +section of the plugin documentation for additional information. Release Notes ------------- -**0.8.0** +The release notes of the InfluxDB-Grafana Plugin are provided in the +[Release Notes]( +http://fuel-plugin-influxdb-grafana.readthedocs.org/en/latest/releases.html) +section of the plugin documentation. -* Upgrade Grafana to 2.1 -* Upgrade InfluxDB to 0.9 -* Add support for retention policy +Requirements +------------ -**0.7.0** +The InfluxDB-Grafana Plugin requirements are defined in the [Requirements]( +http://fuel-plugin-influxdb-grafana.readthedocs.org/en/latest/overview.html#requirements) +section of the plugin documentation. -* Initial release of the plugin. This is a beta version. +Known issues +------------ -Development -=========== +The LMA Toolchain's related issues are listed on [Launchpad]( +https://bugs.launchpad.net/lma-toolchain). -The *OpenStack Development Mailing List* is the preferred way to communicate, -emails should be sent to `openstack-dev@lists.openstack.org` with the subject +Limitations +----------- + +The InfluxDB-Grafana Plugin limitations are described in the [Limitations]( +http://fuel-plugin-influxdb-grafana.readthedocs.org/en/latest/overview.html#limitations) +section of the plugin documentation. + +Installation +------------ + +The installation instructions of the InfluxDB-Grafana Plugin are provided +in the [Installation]( +http://fuel-plugin-influxdb-grafana.readthedocs.org/en/latest/installation.html) +section of the plugin documentation. + +User Guide +---------- + +Instructions for how to configure and use the InfluxDB-Grafana Plugin +are provided in the [User Guide]( +http://fuel-plugin-influxdb-grafana.readthedocs.org/en/latest/user.html) +section of the plugin documentation. + +Communication +------------- + +The *OpenStack Development Mailing List* is the preferred way to communicate +with the members of the project. +Emails should be sent to `openstack-dev@lists.openstack.org` with the subject prefixed by `[fuel][plugins][lma]`. Reporting Bugs -------------- -Bugs should be filled on the [Launchpad fuel-plugins project]( -https://bugs.launchpad.net/fuel-plugins) (not GitHub) with the tag `lma`. - +Bugs should be filed against the [LMA Toolchain project]( +https://launchpad.net/lma-toolchain) on Launchpad (not Github!). Contributing ------------ -If you would like to contribute to the development of this Fuel plugin you must +If you would like to contribute to the development of this plugin you must follow the [OpenStack development workflow]( -http://docs.openstack.org/infra/manual/developers.html#development-workflow). +http://docs.openstack.org/infra/manual/developers.html#development-workflow) +instructions. -Patch reviews take place on the [OpenStack gerrit]( -https://review.openstack.org/#/q/status:open+project:stackforge/fuel-plugin-influxdb-grafana,n,z) +Patch reviews take place within [OpenStack Gerrit]( +https://review.openstack.org/#/q/status:open+project:openstack/fuel-plugin-influxdb-grafana,n,z) system. Contributors ------------ * Guillaume Thouvenin +* Patrick Petit * Simon Pasquier * Swann Croiset diff --git a/doc/source/overview.rst b/doc/source/overview.rst index ad8098c3..6bbf7fd5 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -21,9 +21,8 @@ that are monitored. Among those dashboards, the *Main Dashboard* provides a single pane of glass overview of your OpenStack environment status. -As shown in the figure below, the InfluxDB-Grafana Plugin is a constituent of the -**Logging, Monitoring and Alerting (LMA) Toolchain** map:: - +The InfluxDB-Grafana Plugin is a key component of the LMA Toolchain project as +shown in the figure below:: ................................................... | LMA Collector Plugin | @@ -46,7 +45,6 @@ As shown in the figure below, the InfluxDB-Grafana Plugin is a constituent of th '................................' - .. _plugin_requirements: Requirements