diff --git a/README.md b/README.md new file mode 100644 index 0000000..e2c1047 --- /dev/null +++ b/README.md @@ -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@:/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:///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 (PM) +Piotr Misiak (developer) +Szymon Bańka (developer) +Alexander Zatserklyany (QA engineer)