[current version = 1.0.0]
This community zenpack fully integrates RANCID into Zenoss without any manual coniguration required.
Backup all your routers, switches, load balancers, etc. right from the Zenoss interface.
The new "zenrancid" daemon takes care of running RANCID once a day in the background, by default at 02:00 am.
The Rancid modeler checks the SVN database for config changes and displays each config version as a device component.
The zenoss device ID is used in the Rancid config files. so make sure that it can resolve to a valid IP address. Possibly you need to add the hosts to the local /etc/hosts file. Examples can be found in the Zenoss community to automate this.
Check the screenshots here.
Check the pre-requisites before starting the installation Install the ZenPack from command line to make sure everything went ok
During the installation the RANCID binaries are being compiled from source (make & gcc) so the ZenPack only works on Unix. Currently the ZenPack has only been tested on CentOS but it should work on all unix flavors capable of compiling Rancid.
Make sure your system meets these requirements, you might also check the requirements for Rancid on their website:
It is recommended to install this package from commandline so that you can see if there were any pre-requisites missing and if the compilation of RANCID was succesful.
zenpack --link --install=/<path to files>/ZenPacks.TwoNMS.Rancid
zenoss restart
If there were no errors and the folder $ZENHOME/rancid exists then the installation went ok.
Make sure that the new daemon "zenrancid" is started:
zenrancid status
NOTE: re-installing the zenpack will remove all files in the $ZENHOME/rancid folder !
Upgrading the ZenPack is currently not specifically supported. If upgrading will not work then the old version has to be removed before installing the new version. It is possible that upgrading will remove all old config files.
Uninstalling the ZenPack can be done using the Zenoss web interface or via commandline:
zenpack --remove=ZenPacks.TwoNMS.Rancid
NOTE: re-installing the zenpack will remove all files in the $ZENHOME/rancid folder !
Devices can be added to RANCID using the zenoss interface by changing the zRancid properties. There is no need to manually populate the RANCID "router.db" files.
Don't forget to add the zenrancid modeler to the devices that you want to include in Rancid! The modeler takes care of integrating the configs in the Zenoss GUI. Withouth the modeler Rancid will take the backups but you will not see the results inside Zenoss. The modeler to add is community.twonms.python.RancidMap
By default no devices will be added to the RANCID monitoring.
In order to add a device you have to make sure the zRancid properties are set correctly. Disabling the zRancidIgnore property will include the device to the RANCID router.db file and the next time RANCID runs the device will be included.
After a device has been enabled for Rancid via the zRancid properties the zenrancid daemon has to run. You can run this manually or if the daemon is started you can wait until it's started automatically, by default once a day. The modeler takes care of displaying the configs into zenoss, each config version is a device component called Rancid Revision.
It may take 2 runs of zenrancid before the configuration of the device will show up as a component. The first run just checks in the device into the Subversion repository and as of the second run any configuration changes will be stored. The zenrancid daemon only runs once a day by default so if zenmodeler was started before zenrancid then any changes will be visible in Zenoss only after the next time zenmodeler is started.
The is the daemon that takes care of running RANCID so it calls "rancid-run" in the background. It is possible to disable the daemon but then you have to schedule rancid-run manually as a cron job.
The daemon can be configured using the zenrancid.conf config file. By default zenrancid will start at 02:00am every day but this can be changed in the zenrancid.conf file.
It is possible to run zenrancid via command-line for all devices or for a single device:
zenrancid run --device=MYDEVICE
(MYDEVICE should exist in Zenoss)
The modeler will check if new config versions or SVN revisions are available. Each revision will be visible as a device os component called "Rancid Revision"
To run the modeler for a single device, this could be useful after running zenrancid for a single device:
zenmodeler run --device=MYDEVICE
(MYDEVICE should exist in Zenoss)
A few new zProperties are created when the ZenPack is installed. zRancid properties are used to indicate if a device will be added to Rancid, what Rancid device type it should be, what group is created and the username + password.
This ZenPack runs "out of the box" so no configuration changes have to be made. However it is possible to change to the default Rancid configuration files which are stored in $ZENHOME/rancid/etc
This is the default zenrancid daemon config file and is available in $ZENHOME/etc/zenrancid.conf Usually you won't have to make any changes here except if you want to update the time and frequency when zenrancid should start.
This is the default configuration file used by Rancid and can be found in $ZENHOME/rancid/etc. This file is auto-generated and over-written each time zenrancid runs. You can override the generated file by creating a new file called $ZENHOME/rancid/etc/rancid-custom.conf All settings in this custom file will override the standard settings.
This is the default device authentication file used by Rancid and can be found in the zenoss user home folder. This file is auto-generated and over-written each time zenrancid runs. You can override the generated file by creating a new file called $ZENHOME/rancid/etc/cloginrc-custom All settings in this custom file will override the standard settings.
The router.db files contain a list of all the devices that should be included in Rancid. Each device group has its own router.db file. These files are generated automatically from Zenoss by disabling the "zRancidIgnore" property and configuring the "zRancidGroup" property. This is done each time the zenrancid daemon runs.
If you want to include devices to Rancid which are not managed in Zenoss then you need to create your own router.db files using the same folder structure as Rancid uses. This has to be done in the folder $ZENHOME/rancid/etc/customdb/
For example if you have a folder structure $ZENHOME/rancid/var/Switches/router.db then you'll need to create the following file : $ZENHOME/rancid/etc/customdb/Switches/router.db
So many things to add, so little time :)
Check the readme.txt file for the TODO list for the next release.
For Professional services contact us at TwoNMS.com