Presentation Of the Shinken project

Welcome in the Shinken project.

Shinken is a new, Nagios compatible monitoring tool, written in Python. The main goal of Shinken is to allow users to have a fully flexible architecture for their monitoring system that can easily scale to large environments. It’s as simple as in all the marketing “cloud computing” slides, but here, it’s real!

Shinken is backwards-compatible with the Nagios configuration standard and plug-ins. It works on any operating system and architecture that supports Python, which includes Windows and GNU/Linux.

How to install Shinken

You just need to add a shinken user (in the shinken group) on your system:

useradd --user-group shinken
usermod --lock shinken

First way: all in a directory (ugly but quick way ;)

Then move the shinken directory and give it to the shinken user:

mv shinken /usr/local
chown -R shinken:shinken /usr/local/shinken

Second way: district directory (clean way)

You can install really the application by using the setup.py script. It will install the shinken library in the python path, create the /etc/shinken and /var/lib/shinken directory (you can change them in the setup.cfg file before launching setup.py). You will need the python-setuptools package for it. Then just run:

sudo python setup.py install --install-scripts=/usr/bin/

For the compilation part in both way it's easy: there is no compilation!

Third way: install script

You can use the shinken.sh utility script located at : shinken/contrib/alternative-installation/shinken-install The script create the user and group, install all dependencies and then install shinken. It is compatible with Debian, Ubuntu, Centos/Redhat 5.x and 6.x The only requirement is an internet connection for the server on which you want to install shinken. It also allow to modify the installation folder in a configuration file.

If you want shinken installed in seconds in /opt/shinken, just run :

shinken.sh -i

If you want to remove shinken, just run :

shinken.sh -d

Requirements

shinken requires

• `Python`__ 2.4 or higher (Python 2.6 or higher is recommended)
• `setuptools`__ or `distribute`__ for installation (see below).
• `Pyro`__
• multiprocessing Python package when using Python 2.4 or 2.5 (multiprocessing is already included in Python 2.6 and higher)

If (and only if) you plan to use the livestatus module, I'll also need

• `simplejson`__
• `pysqlite`__

Just untar and launch python setup.py install (and be sure to have installed the python-devel package too).

For Python, it should be okay with nearly all distribution.

Under ubuntu, you can grab the Pyro module with:

sudo apt-get install pyro

Under other distributions, you can search for it:

yum search pyro

And if you do not find it, you can install it from PyPI:

easy_install pyro

And that all folks :)

Where is the configuration?

The configuration is where you put the etc directory (in /usr/local/shinken/etc for a quick and dirty install, /etc/shinken for a clean one).

The nagios.cfg file is meant ot be shared with Nagios. All Shinken specific objects (like link to daemons or realms) are in the file shinken-specific.cfg.

I need to change my existing Nagios configuration?

No, there is no need to change the existing configuration - unless you want to add some new hosts and services.

How to run Shinken

Quick and dirty way

It's easy, there is a already launch script for you:

shinken/bin/launch_all.sh

Clean way

The setup.py installes some init.d scripts, let's use them:

/etc/init.d/shinken-scheduler start
/etc/init.d/shinken-poller start
/etc/init.d/shinken-reactionner start
/etc/init.d/shinken-broker start
/etc/init.d/shinken-arbiter start

Known bugs

None we know :)

If you find one, please post it in our trac site: https://sourceforge.net/apps/trac/shinken/report/2

How to run uninstall Shinken

Clean all :)

There a script call clean.sh on the source directory for this :) Beware, it will supress all Shinken related files!