x/fuel-plugin-influxdb-grafana
Code Issues Proposed changes

Create the installation chapter

Browse Source 
Change-Id: Ic420f72f52bf8c488fbe883ed2e684814aa59d24
This commit is contained in:
Patrick Petit
2015-11-02 08:53:31 +01:00
parent 4ce58670b9
commit fc661bf8da
1 changed files with 83 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
doc/source/installation.rst
View File

@@ -3,4 +3,86 @@
Installation Guide
==================
TBD
InfluxDB-Grafana Fuel Plugin install using the RPM file of the Fuel Plugins Catalog
-----------------------------------------------------------------------------------
To install the InfluxDB-Grafana Fuel Plugin using the RPM file of the Fuel Plugins
Catalog, you need to follow these steps:
1. Download the RPM file from the `Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
2. Copy the RPM file to the Fuel Master node::
[root@home ~]# scp influxdb_grafana-0.8-0.8.0-1.noarch.rpm root@<Fuel Master node IP address>:
3. Install the plugin using the `Fuel CLI <http://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#using-fuel-cli>`_::
[root@fuel ~]# fuel plugins --install influxdb_grafana-0.8-0.8.0-1.noarch.rpm
4. Verify that the plugin is installed correctly::
[root@fuel ~]# fuel plugins --list
id | name | version | package_version
---|----------------------|---------|----------------
1 | influxdb_grafana | 0.8.0 | 3.0.0
InfluxDB-Grafana Fuel Plugin install from source
------------------------------------------------
Alternatively, you may want to build the RPM file of the plugin from the
lastest stable release if, for example, you want to modify some built-in
configuration parameters. But note that this is at your own risk.
To install the InfluxDB-Grafana Plugin from source, you first need to prepare an
environement to build the RPM file.
The recommended approach is to build the RPM file directly onto the Fuel Master
node so that you won't have to copy that file later on.
**Prepare an environment for building the plugin on the Fuel Master Node**
1. Install the standard Linux development tools::
[root@home ~] yum install createrepo rpm rpm-build dpkg-devel
2. Install the Fuel Plugin Builder. To do that, you should first get pip::
[root@home ~] easy_install pip
3. Then install the Fuel Plugin Builder (the `fpb` command line) with `pip`::
[root@home ~] pip install fuel-plugin-builder
**Note**: You may also need to build the Fuel Plugin Builder if the package version of the
plugin is higher than package version supported by the Fuel Plugin Builder you get from `pypi`.
In this case, please refer to the section "Preparing an environment for plugin development"
of the `Fuel Plugins wiki <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
if you need further instructions about how to build the Fuel Plugin Builder.
4. Clone the plugin git repository::
[root@home ~] git clone git@github.com:stackforge/fuel-plugin-influxdb-grafana.git
5. Check that the plugin is valid::
[root@home ~] fpb --check ./fuel-plugin-influxdb-grafana
6. And finally, build the plugin::
[root@home ~] fpb --build ./fuel-plugin-influxdb-grafana
7. Now that you have created the RPM file, you can install the plugin using the `fuel plugins --install` command::
[root@fuel ~] fuel plugins --install ./fuel-plugin-influxdb-grafana/influxdb_grafana-0.8-0.8.0-1.noarch.rpm
InfluxDB-Grafana Fuel Plugin software components
------------------------------------------------
List of software components installed by the plugin.
+----------------+-------------------------------------+
| Components | Version |
+================+=====================================+
| InfluxDB | v0.9.4 for Ubuntu (64-bit) |
+----------------+-------------------------------------+
| Grafana | v2.5.0 for Ubuntu (64-bit) |
+----------------+-------------------------------------+