summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPiotr Misiak <pmisiak@mirantis.com>2015-08-13 16:01:03 +0200
committerPiotr Misiak <pmisiak@mirantis.com>2015-08-13 16:01:03 +0200
commita359d59809e6b1f5664fc20e7a29ba3c944a3484 (patch)
treeb9912548a853e90f160b3741cdfecd1ea384e213
parentcf38dcaf6838c35943d406bb666e04580d9a3581 (diff)
update documentation
Notes
Notes (review): Verified+2: Jenkins Code-Review+2: Bartosz Kupidura <bkupidura@mirantis.com> Workflow+1: Bartosz Kupidura <bkupidura@mirantis.com> Submitted-by: Jenkins Submitted-at: Thu, 13 Aug 2015 14:51:35 +0000 Reviewed-on: https://review.openstack.org/212542 Project: stackforge/fuel-plugin-zabbix-monitoring-emc Branch: refs/heads/master
-rw-r--r--doc/content/description.rst8
-rw-r--r--doc/content/guide.rst25
-rw-r--r--doc/content/installation.rst2
-rw-r--r--doc/images/settings.pngbin12398 -> 14394 bytes
4 files changed, 20 insertions, 15 deletions
diff --git a/doc/content/description.rst b/doc/content/description.rst
index a06aab9..c320117 100644
--- a/doc/content/description.rst
+++ b/doc/content/description.rst
@@ -4,9 +4,9 @@ EMC hardware monitoring extension for Zabbix plugin
4 4
5EMC hardware monitoring extension plugin extends Zabbix plugin functionality 5EMC hardware monitoring extension plugin extends Zabbix plugin functionality
6by adding monitoring of incoming SNMP traps sent from EMC VNX arrays via 6by adding monitoring of incoming SNMP traps sent from EMC VNX arrays via
7management network to management VIP address. For more information about 7management network to Zabbix VIP address. For more information about
8networks, see the `Logical Networks <https://docs.mirantis.com/openstack/fuel 8networks, see the `Logical Networks <https://docs.mirantis.com/openstack/fuel
9/fuel-6.1/reference-architecture.html#logical-networks>`_ section of MOS 9/fuel-7.0/reference-architecture.html#logical-networks>`_ section of MOS
10documentation. The plugin configures snmptt to parse and pass EMC VNX specific 10documentation. The plugin configures snmptt to parse and pass EMC VNX specific
11traps to Zabbix. It also configures Zabbix by adding Template with appropriate 11traps to Zabbix. It also configures Zabbix by adding Template with appropriate
12items and triggers and by creating Hosts for each EMC VNX array. 12items and triggers and by creating Hosts for each EMC VNX array.
@@ -17,8 +17,8 @@ Requirements
17================================== =============== 17================================== ===============
18Requirement Version/Comment 18Requirement Version/Comment
19================================== =============== 19================================== ===============
20Fuel 6.1 20Fuel 7.0
21Zabbix plugin for Fuel 1.0.0 21Zabbix plugin for Fuel 2.0.0
22SNMP trap daemon for Zabbix plugin 1.0.0 22SNMP trap daemon for Zabbix plugin 1.0.0
23================================== =============== 23================================== ===============
24 24
diff --git a/doc/content/guide.rst b/doc/content/guide.rst
index 3e3c7e4..ddfec2d 100644
--- a/doc/content/guide.rst
+++ b/doc/content/guide.rst
@@ -7,14 +7,15 @@ Environment configuration
7 7
81. Create an environment. For more information about environment creation, see 81. Create an environment. For more information about environment creation, see
9 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel 9 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
10 /fuel-6.1/user-guide.html#create-a-new-openstack-environment>`_. 10 /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
112. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix 112. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix
12 Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis.com 12 Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis.com
13 /products/openstack-drivers-and-plugins/fuel-plugins/>`_. 13 /products/openstack-drivers-and-plugins/fuel-plugins/>`_.
143. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions, 143. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions,
15 see Zabbix Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis 15 see Zabbix Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis
16 .com/products/openstack-drivers-and-plugins/fuel-plugins/>`_. 16 .com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
174. Open *Settings* tab of the Fuel web UI and scroll the page down. Select the 174. Open *Settings* tab of the Fuel web UI and scroll the page down. On the left
18 choose *EMC hardware monitoring extension for Zabbix plugin*, select the
18 plugin checkbox and optionally fill in *EMC hardware to monitor* parameter: 19 plugin checkbox and optionally fill in *EMC hardware to monitor* parameter:
19 20
20 .. image:: images/settings.png 21 .. image:: images/settings.png
@@ -31,7 +32,7 @@ Environment configuration
315. Adjust other environment settings to your requirements and deploy the 325. Adjust other environment settings to your requirements and deploy the
32 environment. For more information, see 33 environment. For more information, see
33 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel 34 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
34 /fuel-6.1/user-guide.html#create-a-new-openstack-environment>`_. 35 /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
35 36
36User Guide 37User Guide
37========== 38==========
@@ -41,7 +42,7 @@ To test if everything is configured properly, follow these steps:
411. Generate an example SNMP trap by running the following command from any 421. Generate an example SNMP trap by running the following command from any
42 node:: 43 node::
43 44
44 [root@node-46 ~]# snmptrap -v 1 -c <SNMP_community> <management_VIP_address> '.1.3.6.1.4.1.1981' <host_ip_address> 6 6 '10' .1.3.6.1.4.1.1981 s "null" .1.3.6.1.4.1.1981 s "null" .1.3.6.1.4.1.1981 s "a37" 45 [root@node-46 ~]# snmptrap -v 1 -c <SNMP_community> <zabbix_VIP_address> '.1.3.6.1.4.1.1981' <host_ip_address> 6 6 '10' .1.3.6.1.4.1.1981 s "null" .1.3.6.1.4.1.1981 s "null" .1.3.6.1.4.1.1981 s "a37"
45 46
46 where: 47 where:
47 48
@@ -51,15 +52,17 @@ To test if everything is configured properly, follow these steps:
51 52
52 .. image:: images/snmptrapd_settings.png 53 .. image:: images/snmptrapd_settings.png
53 54
54 *<management_VIP_address>* 55 *<zabbix_VIP_address>*
55 56
56 If you don’t know the address, run the following command on any node:: 57 If you don’t know the address, run the following command on any node::
57 58
58 [root@node-46 ~]# grep management_vip /etc/astute.yaml 59 [root@node-46 ~]# grep -A2 ^zabbix_vip_management /etc/astute.yaml
59 60
60 You should get the required VIP in the output:: 61 You should get the required VIP in the output::
61 62
62 management_vip: 192.168.0.1 63 zabbix_vip_management:
64 network_role: zabbix
65 ipaddr: 192.168.0.1
63 66
64 *<host_IP_address>* 67 *<host_IP_address>*
65 68
@@ -99,15 +102,17 @@ You have to configure your hardware to enable SNMP traps sending. To do this,
99refer to your hardware’s manual. Generally, you have to set these two 102refer to your hardware’s manual. Generally, you have to set these two
100parameters on your hardware: 103parameters on your hardware:
101 104
1021. SNMP manager - set to management VIP address of your environment 1051. SNMP manager - set to Zabbix VIP address of your environment
103 106
104 If you don’t know the address, run the following command on any node:: 107 If you don’t know the address, run the following command on any node::
105 108
106 [root@node-46 ~]# grep management_vip /etc/astute.yaml 109 [root@node-46 ~]# grep -A2 ^zabbix_vip_management /etc/astute.yaml
107 110
108 You should get the required VIP in the output:: 111 You should get the required VIP in the output::
109 112
110 management_vip: 192.168.0.1 113 zabbix_vip_management:
114 network_role: zabbix
115 ipaddr: 192.168.0.1
111 116
1122. SNMP community - set the same value as in the *SNMP community* parameter 1172. SNMP community - set the same value as in the *SNMP community* parameter
113 from the SNMP trap daemon for Zabbix plugin settings: 118 from the SNMP trap daemon for Zabbix plugin settings:
diff --git a/doc/content/installation.rst b/doc/content/installation.rst
index 520b652..ea6469e 100644
--- a/doc/content/installation.rst
+++ b/doc/content/installation.rst
@@ -33,7 +33,7 @@ steps:
33 # fuel plugins 33 # fuel plugins
34 id | name | version | package_version 34 id | name | version | package_version
35 ---|---------------------------|----------|---------------- 35 ---|---------------------------|----------|----------------
36 1 | zabbix_monitoring | 1.0.0 | 2.0.0 36 1 | zabbix_monitoring | 2.0.0 | 3.0.0
37 2 | zabbix_snmptrapd | 1.0.0 | 2.0.0 37 2 | zabbix_snmptrapd | 1.0.0 | 2.0.0
38 3 | zabbix_monitoring_emc | 1.0.0 | 2.0.0 38 3 | zabbix_monitoring_emc | 1.0.0 | 2.0.0
39 39
diff --git a/doc/images/settings.png b/doc/images/settings.png
index d890f33..c333a1f 100644
--- a/doc/images/settings.png
+++ b/doc/images/settings.png
Binary files differ