Browse Source

update documentation

Change-Id: Ibf4a952cf1c89f28fb099308d686ad5157d32785
Piotr Misiak 3 years ago
parent
commit
a359d59809
4 changed files with 20 additions and 15 deletions
  1. 4
    4
      doc/content/description.rst
  2. 15
    10
      doc/content/guide.rst
  3. 1
    1
      doc/content/installation.rst
  4. BIN
      doc/images/settings.png

+ 4
- 4
doc/content/description.rst View File

@@ -4,9 +4,9 @@ EMC hardware monitoring extension for Zabbix plugin
4 4
 
5 5
 EMC hardware monitoring extension plugin extends Zabbix plugin functionality
6 6
 by adding monitoring of incoming SNMP traps sent from EMC VNX arrays via
7
-management network to management VIP address. For more information about
7
+management network to Zabbix VIP address. For more information about
8 8
 networks, 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
10 10
 documentation. The plugin configures snmptt to parse and pass EMC VNX specific
11 11
 traps to Zabbix. It also configures Zabbix by adding Template with appropriate
12 12
 items and triggers and by creating Hosts for each EMC VNX array.
@@ -17,8 +17,8 @@ Requirements
17 17
 ================================== ===============
18 18
 Requirement                        Version/Comment
19 19
 ================================== ===============
20
-Fuel                               6.1
21
-Zabbix plugin for Fuel             1.0.0
20
+Fuel                               7.0
21
+Zabbix plugin for Fuel             2.0.0
22 22
 SNMP trap daemon for Zabbix plugin 1.0.0
23 23
 ================================== ===============
24 24
 

+ 15
- 10
doc/content/guide.rst View File

@@ -7,14 +7,15 @@ Environment configuration
7 7
 
8 8
 1. Create an environment. For more information about environment creation, see
9 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>`_.
11 11
 2. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix
12 12
    Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis.com
13 13
    /products/openstack-drivers-and-plugins/fuel-plugins/>`_.
14 14
 3. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions,
15 15
    see Zabbix Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis
16 16
    .com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
17
-4. Open *Settings* tab of the Fuel web UI and scroll the page down. Select the
17
+4. 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 19
    plugin checkbox and optionally fill in *EMC hardware to monitor* parameter:
19 20
 
20 21
    .. image:: images/settings.png
@@ -31,7 +32,7 @@ Environment configuration
31 32
 5. Adjust other environment settings to your requirements and deploy the
32 33
    environment. For more information, see
33 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
 
36 37
 User Guide
37 38
 ==========
@@ -41,7 +42,7 @@ To test if everything is configured properly, follow these steps:
41 42
 1. Generate an example SNMP trap by running the following command from any
42 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 47
    where:
47 48
 
@@ -51,15 +52,17 @@ To test if everything is configured properly, follow these steps:
51 52
 
52 53
    .. image:: images/snmptrapd_settings.png
53 54
 
54
-   *<management_VIP_address>*
55
+   *<zabbix_VIP_address>*
55 56
 
56 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 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 67
    *<host_IP_address>*
65 68
 
@@ -99,15 +102,17 @@ You have to configure your hardware to enable SNMP traps sending. To do this,
99 102
 refer to your hardware’s manual. Generally, you have to set these two
100 103
 parameters on your hardware:
101 104
 
102
-1. SNMP manager - set to management VIP address of your environment
105
+1. SNMP manager - set to Zabbix VIP address of your environment
103 106
 
104 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 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
 
112 117
 2. SNMP community - set the same value as in the *SNMP community* parameter
113 118
    from the SNMP trap daemon for Zabbix plugin settings:

+ 1
- 1
doc/content/installation.rst View File

@@ -33,7 +33,7 @@ steps:
33 33
     # fuel plugins
34 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 37
     2  | zabbix_snmptrapd          | 1.0.0    | 2.0.0
38 38
     3  | zabbix_monitoring_emc     | 1.0.0    | 2.0.0
39 39
 

BIN
doc/images/settings.png View File


Loading…
Cancel
Save