ZenPack:Rundeck

From Zenoss Wiki
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search
Author(s)
David Petzel
Current Maintainer(s)
David Petzel
License
GNU General Public License, Version 2, or later
ZenPack name
ZenPacks.community.Rundeck
Git sources (for cloning)
Link


Applications Monitored: 



Rundeck ZenPack

Monitors Rundeck

Warning

The ZenPack Catalog has moved to its new home at https://www.zenoss.com/product/zenpacks as of January 17, 2017. The following information may be out of date, and this page will eventually be removed.

Support

This ZenPack is developed by the Zenoss user community and supported via our online forums. Zenoss, Inc. does not provide direct support for this ZenPack.

Releases

Version 1.0.0- Download
Summary of changes: Initial Release
Released on 2013/06/10
Compatible with Zenoss Core 3.2.x, Zenoss Core 4.2.x

Background

This ZenPack enables to Zenoss to monitor Rundeck, by leveraging the Rundeck API. It will add the following new items to your Zenoss installation:

  • A new Monitoring Template - Rundeck
  • 3 new zProperties:
    • zRundeckAPIPort - This is the HTTP/HTTPS port that the Rundeck API is listening on. Defaults to 4440
    • zRundeckAPIToken - The Zenpack will leverage the API Token for authentication to the API. Currently password authentication is not supported. There is no default value for this property, you will need to supply a value before stats are collected.
    • zRundeckAPIScheme - Determines if Zenoss will use HTTP or HTTPS when communicating with the API. The default is http. Valid values are http or https (lower case)

Configuration

In order to leverage this ZenPack there are two important tasks you will need to complete.

  1. The first thing you need to do is create (or use an existing) Rundeck account and generate an APIToken. You should review the official Rundeck documentation on the steps necessary to accomplish that.
  2. Once you have your API Token in hand, you will need to enter this value into the zRundeckAPIToken zProperty. The steps necessary to update a zProperty are discussed in the official Zenoss Administration guide, and you should refer to the section titled Configuration Properties

Screen Shots

Rundeck Memory Usage

Rundeck Load Average (As reported via the API)

Rundeck Projects

Total Jobs


Installation

Normal Installation (packaged egg)

  1. Download the appropriate egg file for the version of Zenoss you are running.
  2. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  3. Install the ZenPack:
    $ zenpack --install ZenPacks.community.Rundeck-*.egg
  4. Restart these services:
    $ zenoss restart

Developer Mode Installation

In order to do a development mode installation you will want to clone the existing git repository, and then use the --link flag with the zenpack command:

  1. Ensure you are logged in as the zenoss user:
    $ sudo su - zenoss
  2. Start by cloning the upstream repository:
    $ git clone git://github.com/dpetzel/ZenPacks.community.Rundeck.git
  3. Next, perform the installation:
    $ zenpack --link --install ZenPacks.community.Rundeck
  4. Finally, restart these serivices:
    $ zenoss restart

Discuss

Purplemarker.png New: Don't forget to add yourself to the Zenoss User Map!

blog comments powered by Disqus