Browse Source

update documentation

Change-Id: Ie3d68183d800c611a4232760390744ed7daf195c
Piotr Misiak 3 years ago
parent
commit
924d68fa30
5 changed files with 32 additions and 22 deletions
  1. 3
    3
      README.md
  2. 3
    3
      doc/content/description.rst
  3. 21
    12
      doc/content/guide.rst
  4. 5
    4
      doc/content/installation.rst
  5. BIN
      doc/images/settings.png

+ 3
- 3
README.md View File

@@ -15,8 +15,8 @@ Requirements
15 15
 
16 16
 | Requirement                      | Version/Comment |
17 17
 |:---------------------------------|:----------------|
18
-| Mirantis OpenStack compatibility | 6.1             |
19
-| Zabbix plugin for Fuel           | 1.0.0           |
18
+| Mirantis OpenStack compatibility | 7.0             |
19
+| Zabbix plugin for Fuel           | 2.0.0           |
20 20
 
21 21
 Installation Guide
22 22
 ==================
@@ -48,7 +48,7 @@ To install SNMP trap daemon plugin, follow these steps:
48 48
         # fuel plugins
49 49
         id | name              | version | package_version
50 50
         ---|-------------------|---------|----------------
51
-        1  | zabbix_monitoring | 1.0.0   | 2.0.0
51
+        1  | zabbix_monitoring | 2.0.0   | 3.0.0
52 52
         2  | zabbix_snmptrapd  | 1.0.0   | 2.0.0
53 53
 
54 54
 For more information and instructions, see the SNMP trap daemon plugin Guide

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

@@ -5,7 +5,7 @@ SNMP trap daemon for Zabbix plugin
5 5
 This plugin extends Zabbix plugin functionality by adding ability to receive
6 6
 SNMP traps from management network and pass them to Zabbix. For more
7 7
 information about networks, see the `Logical Networks <https://
8
-docs.mirantis.com/openstack/fuel/fuel-6.1/reference-architecture.html
8
+docs.mirantis.com/openstack/fuel/fuel-7.0/reference-architecture.html
9 9
 #logical-networks>`_ section of MOS documentation. The plugins installs
10 10
 snmptrapd daemon for receiving and snmptt software for parsing and passing
11 11
 traps to Zabbix. This plugin does not provide any additional features from user
@@ -20,7 +20,7 @@ Requirements
20 20
 ====================== ===============
21 21
 Requirement            Version/Comment
22 22
 ====================== ===============
23
-Fuel                   6.1
24
-Zabbix plugin for Fuel 1.0.0
23
+Fuel                   7.0
24
+Zabbix plugin for Fuel 2.0.0
25 25
 ====================== ===============
26 26
 

+ 21
- 12
doc/content/guide.rst View File

@@ -7,14 +7,16 @@ 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
-3. Open *Settings* tab of the Fuel web UI and scroll the page down. Select the
15
-   plugin checkbox and set *SNMP community* parameter:
14
+3. Open *Settings* tab of the Fuel web UI and scroll the page down. On the left
15
+   choose *SNMP trap daemon for Zabbix plugin*, select the plugin checkbox and
16
+   set *SNMP community* parameter:
16 17
 
17 18
    .. image:: images/settings.png
19
+      :width: 100%
18 20
 
19 21
    You could see default value by clicking on the eye icon. It is highly
20 22
    recommended to change default SNMP community, because it is used to
@@ -22,15 +24,15 @@ Environment configuration
22 24
 4. Adjust other environment settings to your requirements and deploy the
23 25
    environment. For more information, see
24 26
    `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
25
-   /fuel-6.1/user-guide.html#create-a-new-openstack-environment>`_.
27
+   /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
26 28
 
27 29
 Environment validation
28 30
 ======================
29 31
 
30 32
 After a successful deployment, all Controller Nodes should have the following:
31 33
 
32
-1. snmptrapd daemon running and listening on UDP/162 port on the VIP management
33
-   address.
34
+1. snmptrapd daemon running and listening on UDP/162 port on the VIP address
35
+   reserved for Zabbix.
34 36
 2. snmptrapd daemon configured to pass all SNMP traps to snmptt handler.
35 37
 3. snmptt daemon running which parse SNMP traps and stores them in a log file
36 38
    in a format accepted by Zabbix.
@@ -41,7 +43,8 @@ To test if everything is installed and configured properly, follow these steps:
41 43
 
42 44
 1. Generate a test SNMP trap running following command from any node::
43 45
 
44
-       [root@node-46 ~]# snmptrap -v 2c -c <SNMP_community> <management_VIP_address> "" .1.3.6.1.4.1.8072.2.3.0.1
46
+       [root@node-46 ~]# snmptrap -v 2c -c <SNMP_community> \
47
+       <zabbix_VIP_address> "" .1.3.6.1.4.1.8072.2.3.0.1
45 48
 
46 49
    where:
47 50
 
@@ -50,23 +53,29 @@ To test if everything is installed and configured properly, follow these steps:
50 53
        It is set in the SNMP trap daemon for Zabbix plugin Settings in Fuel UI:
51 54
 
52 55
    .. image:: images/settings.png
56
+      :width: 100%
53 57
 
54
-   *<management_VIP_address>*
58
+   *<zabbix_VIP_address>*
55 59
 
56 60
        If you don’t know the address, run the following command on any node::
57 61
 
58
-           [root@node-46 ~]# grep management_vip /etc/astute.yaml
62
+           [root@node-46 ~]# grep -A2 ^zabbix_vip_management /etc/astute.yaml
59 63
 
60 64
        You should get the required VIP in the output::
61 65
 
62
-           management_vip: 192.168.0.1
66
+           zabbix_vip_management:
67
+             network_role: zabbix
68
+             ipaddr: 192.168.0.1
63 69
 
64 70
 
65 71
 2. After several seconds of running the snmptrap command you should see a line
66 72
    in the Zabbix Server log file similar to this one::
67 73
 
68
-       [root@node-45 ~]# grep netSnmpExampleHeartbeatNotification \ /var/log/zabbix/zabbix_server.log
69
-       10730:20150611:182933.176 unmatched trap received from [192.168.0.4]: 18:29:27 2015/06/11 .1.3.6.1.4.1.8072.2.3.0.1 Normal "Status Events" node-46.domain.tld - netSnmpExampleHeartbeatNotification
74
+       [root@node-45 ~]# grep netSnmpExampleHeartbeatNotification \
75
+       /var/log/zabbix/zabbix_server.log
76
+       10730:20150611:182933.176 unmatched trap received from [192.168.0.4]:
77
+       18:29:27 2015/06/11 .1.3.6.1.4.1.8072.2.3.0.1 Normal "Status Events"
78
+       node-46.domain.tld - netSnmpExampleHeartbeatNotification
70 79
 
71 80
    This is a proof that test SNMP trap has been received and passed to Zabbix.
72 81
    It is “unmatched” for Zabbix because there is no configuration for this trap

+ 5
- 4
doc/content/installation.rst View File

@@ -9,15 +9,16 @@ To install SNMP trap daemon for Zabbix plugin, follow these steps:
9 9
 
10 10
 1. Download and install the Zabbix plugin for Fuel from the
11 11
    `Fuel Plugins Catalog <https://www.mirantis.com/products/
12
-   openstack-drivers-and-plugins/fuel-plugins/>`_
12
+   openstack-drivers-and-plugins/fuel-plugins/>`_.
13 13
 2. Download the SNMP trap daemon for Zabbix plugin from the
14 14
    `Fuel Plugins Catalog <https://www.mirantis.com/products/
15
-   openstack-drivers-and-plugins/fuel-plugins/>`_
15
+   openstack-drivers-and-plugins/fuel-plugins/>`_.
16 16
 3. Copy the plugin on already installed Fuel Master node; ssh can be used for
17 17
    that. If you do not have the Fuel Master node yet, see `Quick Start Guide
18 18
    <https://software.mirantis.com/quick-start/>`_::
19 19
 
20
-    # scp zabbix_snmptrapd-1.0-1.0.0-1.noarch.rpm root@<The_Fuel_Master_node_IP>:/tmp
20
+    # scp zabbix_snmptrapd-1.0-1.0.0-1.noarch.rpm \
21
+      root@<The_Fuel_Master_node_IP>:/tmp
21 22
 
22 23
 4. Log into the Fuel Master node. Install the plugin::
23 24
 
@@ -29,6 +30,6 @@ To install SNMP trap daemon for Zabbix plugin, follow these steps:
29 30
     # fuel plugins
30 31
     id | name                      | version  | package_version
31 32
     ---|---------------------------|----------|----------------
32
-    1  | zabbix_monitoring         | 1.0.0    | 2.0.0
33
+    1  | zabbix_monitoring         | 2.0.0    | 3.0.0
33 34
     2  | zabbix_snmptrapd          | 1.0.0    | 2.0.0
34 35
 

BIN
doc/images/settings.png View File


Loading…
Cancel
Save