x/fuel-plugin-external-zabbix
Code Issues Proposed changes

add README.md file

Browse Source 
Change-Id: I0acc1c57bb2b3ce1c8580dc79d010e3075d00d8b
This commit is contained in:
Piotr Misiak 2015-03-23 17:30:24 +01:00
parent 40b96dcb76
commit 9647a87731
1 changed files with 73 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
README.md Normal file
View File

@ -0,0 +1,73 @@
Zabbix Plugin for Fuel
=======================
Zabbix plugin
--------------
Zabbix plugin for Fuel extends Mirantis OpenStack functionality by adding
Zabbix monitoring system. It installs Zabbix server, frontend and agent
components. The plugin configures Zabbix by adding templates to monitor nodes
and OpenStack services and APIs.
Requirements
------------
| Requirement | Version/Comment |
|:---------------------------------|:----------------|
| Mirantis OpenStack compatibility | >= 6.1 |
Installation Guide
==================
Zabbix plugin installation
---------------------------
To install Zabbix plugin, follow these steps:
1. Download the plugin from
[Fuel Plugins Catalog](https://software.mirantis.com/fuel-plugins)
2. Copy the plugin on already installed Fuel Master node; ssh can be used for
that. If you do not have the Fuel Master node yet, see
[Quick Start Guide](https://software.mirantis.com/quick-start/) :
# scp zabbix_monitoring-1.0-1.0.0-0.noarch.rpm root@<Fuel_Master_ip>:/tmp
3. Install the plugin:
# cd /tmp
# fuel plugins --install zabbix_monitoring-1.0-1.0.0-0.noarch.rpm
4. Check if the plugin was installed successfully:
# fuel plugins
id | name | version | package_version
---|-------------------|---------|----------------
1 | zabbix_monitoring | 1.0.0 | 2.0.0
Zabbix plugin configuration
----------------------------
1. Create an environment.
2. Enable the plugin on the Settings tab of the Fuel web UI.
3. Optionally, change values in the form:
* username/password - access credentials for Zabbix Administrator
* database password - password for Zabbix database in MySQL
4. Deploy the environment.
5. Zabbix frontend is available at: http://<VIP>/zabbix
For more information and instructions, see the Zabbix Plugin Guide in the
[Fuel Plugins Catalog](https://software.mirantis.com/fuel-plugins)
Release Notes
-------------
This is the first release of the plugin.
Contributors
------------
Dmitry Klenov <dklenov@mirantis.com> (PM)
Piotr Misiak <pmisiak@mirantis.com> (developer)
Szymon Bańka <sbanka@mirantis.com> (developer)
Alexander Zatserklyany <azatserklyany@mirantis.com> (QA engineer)