|
| 1 | +=================================== |
| 2 | +Presentation Of the Shinken project |
| 3 | +=================================== |
| 4 | + |
| 5 | +Welcome in the Shinken project. |
| 6 | + |
| 7 | +Shinken is a new, Nagios compatible monitoring tool, written in |
| 8 | +Python. The main goal of Shinken is to allow users to have a fully |
| 9 | +flexible architecture for their monitoring system that can easily |
| 10 | +scale to large environments. It’s as simple as in all the marketing |
| 11 | +“cloud computing” slides, but here, it’s real! |
| 12 | + |
| 13 | +Shinken is backwards-compatible with the Nagios configuration standard |
| 14 | +and plug-ins. It works on any operating system and architecture that |
| 15 | +supports Python, which includes Windows and GNU/Linux. |
| 16 | + |
| 17 | + |
| 18 | +How to install Shinken |
| 19 | +========================= |
| 20 | + |
| 21 | +You just need to add a shinken user (in the shinken group) on your |
| 22 | +system:: |
| 23 | + |
| 24 | + useradd --user-group shinken |
| 25 | + usermod --lock shinken |
| 26 | + |
| 27 | +First way: all in a directory (ugly but quick way ;) |
| 28 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 29 | + |
| 30 | +Then move the shinken directory and give it to the shinken user:: |
| 31 | + |
| 32 | + mv shinken /usr/local |
| 33 | + chown -R shinken:shinken /usr/local/shinken |
| 34 | + |
| 35 | +Second way: district directory (clean way) |
| 36 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 37 | + |
| 38 | +You can install really the application by using the `setup.py` script. |
| 39 | +It will install the shinken library in the python path, create the |
| 40 | +`/etc/shinken` and `/var/lib/shinken` directory (you can change them in |
| 41 | +the `setup.cfg` file before launching `setup.py`). You will |
| 42 | +need the `python-setuptools` package for it. Then just run:: |
| 43 | + |
| 44 | + sudo python setup.py install --install-scripts=/usr/bin/ |
| 45 | + |
| 46 | +For the compilation part in both way it's easy: there is no |
| 47 | +compilation! |
| 48 | + |
| 49 | +Requirements |
| 50 | +========================= |
| 51 | + |
| 52 | +`shinken` requires |
| 53 | + |
| 54 | +* `Python`__ 2.4 or higher (Python 2.6 or higher is recommended) |
| 55 | +* `setuptools`__ or `distribute`__ for installation (see below). |
| 56 | +* `Pyro`__ |
| 57 | +* `multiprocessing` Python package when using Python 2.4 or 2.5 |
| 58 | + (`multiprocessing` is already included in Python 2.6 and higher) |
| 59 | + |
| 60 | +__ http://www.python.org/download/ |
| 61 | +__ pyro |
| 62 | +__ http://pypi.python.org/pypi/multiprocessing/ |
| 63 | + |
| 64 | +If (and only if) you plan to use the `livestatus` module, I'll also |
| 65 | +need |
| 66 | + |
| 67 | +* `simplejson`__ |
| 68 | +* `pysqlite`__ |
| 69 | + |
| 70 | +__ http://pypi.python.org/pypi/simplejson/ and |
| 71 | +__ http://code.google.com/p/pysqlite/ |
| 72 | + |
| 73 | +Just untar and launch `python setup.py install` (and be sure to have |
| 74 | +installed the `python-devel` package too). |
| 75 | + |
| 76 | +For Python, it should be okay with nearly all distribution. |
| 77 | + |
| 78 | +Under ubuntu, you can grab the Pyro module with:: |
| 79 | + |
| 80 | + sudo apt-get install pyro |
| 81 | + |
| 82 | +Under other distributions, you can search for it:: |
| 83 | + |
| 84 | + yum search pyro |
| 85 | + |
| 86 | +And if you do not find it, you can install it from PyPI:: |
| 87 | + |
| 88 | + easy_install pyro |
| 89 | + |
| 90 | +And that all folks :) |
| 91 | + |
| 92 | + |
| 93 | +Where is the configuration? |
| 94 | +================================ |
| 95 | + |
| 96 | +The configuration is where you put the etc directory (in |
| 97 | +`/usr/local/shinken/etc` for a quick and dirty install, `/etc/shinken` |
| 98 | +for a clean one). |
| 99 | + |
| 100 | +The `nagios.cfg` file is meant ot be shared with Nagios. All Shinken |
| 101 | +specific objects (like link to daemons or realms) are in the file |
| 102 | +`shinken-specific.cfg`. |
| 103 | + |
| 104 | + |
| 105 | +I need to change my existing Nagios configuration? |
| 106 | +=================================================== |
| 107 | + |
| 108 | +No, there is no need to change the existing configuration - unless |
| 109 | +you want to add some new hosts and services. |
| 110 | + |
| 111 | + |
| 112 | +How to run Shinken |
| 113 | +================================ |
| 114 | + |
| 115 | +Quick and dirty way |
| 116 | +~~~~~~~~~~~~~~~~~~~~ |
| 117 | + |
| 118 | +It's easy, there is a already launch script for you:: |
| 119 | + |
| 120 | + shinken/bin/launch_all.sh |
| 121 | + |
| 122 | +Clean way |
| 123 | +~~~~~~~~~~~~~~~~~~~~ |
| 124 | + |
| 125 | +The `setup.py` installes some `init.d` scripts, let's use them:: |
| 126 | + |
| 127 | + /etc/init.d/shinken-scheduler start |
| 128 | + /etc/init.d/shinken-poller start |
| 129 | + /etc/init.d/shinken-reactionner start |
| 130 | + /etc/init.d/shinken-broker start |
| 131 | + /etc/init.d/shinken-arbiter start |
| 132 | + |
| 133 | + |
| 134 | +Known bugs |
| 135 | +================================ |
| 136 | + |
| 137 | +None we know :) |
| 138 | + |
| 139 | +If you find one, please post it in our trac site: |
| 140 | +https://sourceforge.net/apps/trac/shinken/report/2 |
| 141 | + |
| 142 | + |
| 143 | +How to run uninstall Shinken |
| 144 | +================================ |
| 145 | + |
| 146 | +Clean all :) |
| 147 | +~~~~~~~~~~~~~~~~~~~~ |
| 148 | + |
| 149 | +There a script call clean.sh on the source directory for this :) |
| 150 | +Beware, it will supress all Shinken related files! |
0 commit comments