This ZenPack is developed and supported by Zenoss Inc. Contact Zenoss to request more information regarding this or any other ZenPacks. Click here to view all available Zenoss Open Source ZenPacks.
This ZenPack provides support for monitoring OpenvSwitch.
The features added by this ZenPack can be summarized as follows. They are each detailed further below.
The following components will be automatically discovered through the Open vSwitch host, username and password you provide.
The following metrics will be collected every 5 minutes by default.
Use the following steps to start monitoring Open vSwitch using the Zenoss web interface.
The Title field should not be empty; it should be a unique device name within the Zenoss environment. The device's IP address or device's hostname should not be used as the title either. This is especially important if you are adding another device that share the same IP address or hostname that already exist on another device. Not doing this may result in devices with the same name conflicting with each other. (e.g. attempting to model device would show modeling results that belong to another device OR device would show relations that do not belong to that device)
You can add an OVS endpoint by using the zenbatchload command:
where the file should have the format:
<device name> setManageIp='<ip address>', zCommandUsername='<username>', zCommandPassword='<password>'
net.ovs setManageIp='10.4.1.21', zCommandUsername='zenoss', zCommandPassword='secret_pass'
Installing this ZenPack will add the following items to your Zenoss system.
Monitoring Templates (all in /Network/OpenvSwitch)
To start monitoring your Open vSwitch server you will need to setup SSH access so that your Zenoss collector server will be able to SSH into your Open vSwitch server(s) as a user who has permission to run the ovs-vsctl command, and /var/run/openvswitch/db.sock without TTY. This almost always means the root user. In addition, TTY must not be required for the user. See the Using a Root User section below for instructions on relieving root users from having to use TYY. See the Using a Non-Root User section below for instructions on allowing non-root users to run Open vSwitch.
The zCommandUsername property must be set. To use public key authentication you must verify that the public portion of the key referenced in zKeyPath is installed in the ~/.ssh/authorized_keys file for the appropriate user on the Open vSwitch server. If this key has a passphrase you should set it in the zCommandPassword property. If you'd rather use password authentication than setup keys, simply put the user's password in the zCommandPassword property. You should then add the zenoss.ssh.OpenvSwitch modeler plugin to the device, or device class containing your Open vSwitch servers and remodel the device(s).
This ZenPack requires the ability to run the ovs-vsctl command, ovs-ofctl command, and ovsdb-tool command remotely on your Open vSwitch server(s) using SSH. By default, these commands are only allowed to be run locally. To remotely run theses commands, the root use must not be required to use TTY.
root ALL=(ALL) ALL
Add this line underneath it:
Type ESC then :wq to save the sudo configuration.
This ZenPack requires the ability to run the ovs-vsctl command, ovs-ofctl command, and ovsdb-tool command remotely on your Open vSwitch server(s) using SSH. By default, these commands are only allowed to be run by the root user. Furthermore, this ZenPack expects these commands be in the user's path. Normally this is only true for the root user.
Assuming that you've created a user named zenmonitor on your Open vSwitch servers for monitoring purposes, you can follow these steps to allow the zenmonitor user to run ovs-vsctl command, ovs-ofctl command, and ovsdb-tool command.
Add the following line to the bottom of the file.
zenmonitor ALL=(ALL) NOPASSWD: /usr/sbin/ovs-vsctl, /usr/sbin/ovs-ofctl
This ZenPack provides additional support for Zenoss Analytics. Perform the following steps to install extra reporting resources into Zenoss Analytics after installing the ZenPack.
You can now navigate back to the OpenvSwitch ZenPack folder in the repository to see the following resources added by the bundle.
Domains can be used to create ad hoc views using the following steps.
When combined with the Zenoss Service Dynamics product, this ZenPack adds built-in service impact and root cause analysis capabilities. The service impact relationships are automatically added. These will be included in any services that contain one or more of the explicitly mentioned components.
Since the class structure of Open vSwitch is simple, its Impact structure is nearly identical to the class structure shown above.
Since most components will be related to Interfaces we recommend:
Component failures will affect Impact as follows: