Difference between revisions of "Icinga"

From ArchWiki
Jump to: navigation, search
m (Configure IDOUtils: SQL error)
m (Style fixes.)
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Daemons and system services]]
+
[[Category:Status monitoring and notification]]
 
[[Category:Networking]]
 
[[Category:Networking]]
 
{{Article summary start}}
 
{{Article summary start}}
Line 7: Line 7:
 
[http://www.icinga.org/ Icinga] is an open source host, service and network monitoring program. It monitors specified hosts and services, alerting you to any developing issues, errors or improvements. This article describes the installation and configuration of Icinga.
 
[http://www.icinga.org/ Icinga] is an open source host, service and network monitoring program. It monitors specified hosts and services, alerting you to any developing issues, errors or improvements. This article describes the installation and configuration of Icinga.
  
==Installation==
+
== Installation ==
  
> Follow [[Web Application Package Guidelines#Install Web Application Package|Install Web Application Package]]  
+
Follow [[Web Application Package Guidelines#Install Web Application Package|Install Web Application Package]]  
  
Install [https://aur.archlinux.org/packages.php?ID=26818 icinga] from the [[AUR]].
+
Before you install the package create the user {{ic|icinga:icinga}} with these commands:
 +
# groupadd -g 667 icinga
 +
# useradd -u 667 -g icinga -G http -d /dev/null -s /bin/false icinga
 +
Install {{AUR|icinga}} from the [[AUR]].
  
Users may also want to install [https://aur.archlinux.org/packages.php?ID=12307 nagios-plugins].
+
Users may also want to install {{AUR|nagios-plugins}}.
  
==Icinga Configuration==
+
== Icinga configuration ==
  
 
Copy the sample config files as root:
 
Copy the sample config files as root:
  
  # cd /etc/icinga
+
# cd /etc/icinga
  # cp cgi.cfg.sample cgi.cfg
+
# cp cgi.cfg.sample cgi.cfg
  # cp resource.cfg.sample resource.cfg
+
# cp resource.cfg.sample resource.cfg
  # cp icinga.cfg.sample icinga.cfg
+
# cp icinga.cfg.sample icinga.cfg
  # cp objects/commands.cfg.sample objects/commands.cfg
+
# cp objects/commands.cfg.sample objects/commands.cfg
  # cp objects/contacts.cfg.sample objects/contacts.cfg
+
# cp objects/contacts.cfg.sample objects/contacts.cfg
  # cp objects/localhost.cfg.sample objects/localhost.cfg
+
# cp objects/localhost.cfg.sample objects/localhost.cfg
  # cp objects/templates.cfg.sample objects/templates.cfg
+
# cp objects/templates.cfg.sample objects/templates.cfg
  # cp objects/timeperiods.cfg.sample objects/timeperiods.cfg
+
# cp objects/timeperiods.cfg.sample objects/timeperiods.cfg
  
Edit /etc/icinga/resource.cfg
+
Edit {{ic|/etc/icinga/resource.cfg}}:
  
  $USER1$=/usr/share/nagios/libexec
+
$USER1$=/usr/share/nagios/libexec
  
==Webserver Configuration==
+
== Webserver configuration ==
  
 
Create htpasswd.users file with a username and password.
 
Create htpasswd.users file with a username and password.
  
  # htpasswd -c /etc/icinga/htpasswd.users icingaadmin
+
# htpasswd -c /etc/icinga/htpasswd.users icingaadmin
  
 
If you define another user foo, you need grant access permission to that user. Edit /etc/icinga/cgi.cfg
 
If you define another user foo, you need grant access permission to that user. Edit /etc/icinga/cgi.cfg
  
  authorized_for_system_information=icingaadmin,foo
+
authorized_for_system_information=icingaadmin,foo
  authorized_...
+
authorized_...
  ...
+
...
  
===Additional Nginx Configuration===
+
=== Additional Nginx configuration ===
  
Configure Authentication
+
Configure Authentication:
  
 
   location /icinga/ {
 
   location /icinga/ {
Line 54: Line 57:
 
   }
 
   }
  
Configure CGI
+
Configure CGI:
  
 
     location ~ \.cgi$ {
 
     location ~ \.cgi$ {
Line 63: Line 66:
 
     }
 
     }
  
==Icinga-web==
+
== Icinga-web ==
  
> Follow [[Web Application Package Guidelines#Install Web Application Package|Install Web Application Package]]  
+
Follow [[Web Application Package Guidelines#Install Web Application Package|Install Web Application Package]]  
  
Install {{aur|icinga-web}} from the [[AUR]].
+
Install {{AUR|icinga-web}} from the [[AUR]].
  
===Configure IDOUtils===
+
=== Configure IDOUtils ===
 
    
 
    
 
   # cd /etc/icinga
 
   # cd /etc/icinga
Line 89: Line 92:
 
   $ mysql -u root -p icinga < /usr/share/icinga/idoutils/db/mysql/mysql.sql
 
   $ mysql -u root -p icinga < /usr/share/icinga/idoutils/db/mysql/mysql.sql
  
===Configure WebServer===
+
=== Configure web server ===
  
====Configure PHP====
+
Example config files are located at
  
Edit /etc/php.ini
+
  /etc/icinga-web/apache.example.conf
 +
  /etc/icinga-web/nginx.example.conf
 +
 
 +
==== Configure PHP ====
 +
 
 +
Edit {{ic|/etc/php.ini}}
  
 
   open_basedir = ...:/usr/share/icinga-web:/var/cache/icinga-web:/var/log/icinga
 
   open_basedir = ...:/usr/share/icinga-web:/var/cache/icinga-web:/var/log/icinga
 
   extension=pdo_mysql.so
 
   extension=pdo_mysql.so
 +
  extension=xsl.so
 +
  extension=sockets.so
  
====Confiure Database====
+
==== Configure database ====
  
=====Mysql=====
+
===== MySQL =====
  
  ! Create database and grants.
+
! Create database and grants.
  # mysql -u root -p
+
# mysql -u root -p
  > CREATE USER 'icinga_web' IDENTIFIED BY 'icinga_web'
+
> CREATE USER 'icinga_web' IDENTIFIED BY 'icinga_web';
  > CREATE DATABASE icinga_web;
+
> CREATE DATABASE icinga_web;
  > GRANT USAGE ON icinga_web.* TO 'icinga_web'@'localhost' WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0;
+
> GRANT USAGE ON icinga_web.* TO 'icinga_web'@'localhost' WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0;
  > GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, INDEX ON icinga_web.* TO 'icinga_web'@'localhost';
+
> GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, INDEX ON icinga_web.* TO 'icinga_web'@'localhost';
 +
> quit
 
    
 
    
 
   ! Import the schema.
 
   ! Import the schema.
  # mysql -u root -p icinga_web < /usr/share/icinga-web/etc/schema/mysql.sql
+
# mysql -u root -p icinga_web < /usr/share/icinga-web/etc/schema/mysql.sql
 +
 
 +
=== Finally ===
  
 +
! Start IDOUtils
 +
# systemctl start ido2db
 +
 +
! Start Icinga
 +
# systemctl start icinga
 +
 +
! Start Mysql
 +
# systemctl start mysqld
 +
 +
! Start Web Server
 +
# systemctl start httpd or nginx
 +
 +
! goto http://localhost/icinga-web
 +
> login with 'root' and 'password'
  
===Finally===
+
== Upgrade database ==
  
  ! Start IDOUtils
+
A new version usually requires an upgrade of the database. You find the sql upgrade scripts in:
  # systemctl start ido2db
+
/usr/share/icinga/idoutils/db/mysql/upgrade
   
+
/usr/share/icinga-web/etc/schema/updates/mysql
  ! Start Icinga
+
Commands to upgrade with these scripts are:
  # systemctl start icinga
+
# mysql -u root -p icinga < ./mysql-upgrade-1.8.0.sql
   
+
# mysql -u root -p icinga_web < ./mysql_v1-7-2_to_v1-8-0.sql
  ! Start Mysql
+
# systemctl --system daemon-reload
  # systemctl start mysqld
+
# systemctl restart icinga
   
+
  ! Start Web Server
+
  # systemctl start httpd or nginx
+
   
+
  ! goto http://localhost/icinga-web
+
  > login with 'root' and 'password'
+
  
==See also==
+
== See also ==
  
* [http://www.icinga.org/ icinga.org] Official website
+
* [http://www.icinga.org/ icinga.org] - Official website
* [http://www.nagiosplugins.org/ Nagios Plugins] the home of the official plugins  
+
* [http://www.nagiosplugins.org/ Nagios Plugins] - The home of the official plugins  
* [[Wikipedia:Icinga|wikipedia.org]] Wikipedia article
+
* [[Wikipedia:Icinga|wikipedia.org]] - Wikipedia article
* [http://www.nagiosexchange.org NagiosExchange] overview of plugins, addons, mailing lists for Icinga
+
* [http://www.nagiosexchange.org NagiosExchange] - Overview of plugins, addons, mailing lists for Icinga

Revision as of 20:43, 13 October 2013

Template:Article summary start Template:Article summary text Template:Article summary end

Icinga is an open source host, service and network monitoring program. It monitors specified hosts and services, alerting you to any developing issues, errors or improvements. This article describes the installation and configuration of Icinga.

Installation

Follow Install Web Application Package

Before you install the package create the user icinga:icinga with these commands:

# groupadd -g 667 icinga
# useradd -u 667 -g icinga -G http -d /dev/null -s /bin/false icinga

Install icingaAUR from the AUR.

Users may also want to install nagios-pluginsAUR.

Icinga configuration

Copy the sample config files as root:

# cd /etc/icinga
# cp cgi.cfg.sample cgi.cfg
# cp resource.cfg.sample resource.cfg
# cp icinga.cfg.sample icinga.cfg
# cp objects/commands.cfg.sample objects/commands.cfg
# cp objects/contacts.cfg.sample objects/contacts.cfg
# cp objects/localhost.cfg.sample objects/localhost.cfg
# cp objects/templates.cfg.sample objects/templates.cfg
# cp objects/timeperiods.cfg.sample objects/timeperiods.cfg

Edit /etc/icinga/resource.cfg:

$USER1$=/usr/share/nagios/libexec

Webserver configuration

Create htpasswd.users file with a username and password.

# htpasswd -c /etc/icinga/htpasswd.users icingaadmin

If you define another user foo, you need grant access permission to that user. Edit /etc/icinga/cgi.cfg

authorized_for_system_information=icingaadmin,foo
authorized_...
...

Additional Nginx configuration

Configure Authentication:

 location /icinga/ {
   auth_basic              "Restricted";
   auth_basic_user_file    /etc/icinga/htpasswd.users;
 }

Configure CGI:

   location ~ \.cgi$ {
     fastcgi_pass    unix:/var/run/fcgiwrap.sock;
     include        fastcgi.conf;
     fastcgi_param  AUTH_USER          $remote_user;
     fastcgi_param  REMOTE_USER        $remote_user;
   }

Icinga-web

Follow Install Web Application Package

Install icinga-webAUR from the AUR.

Configure IDOUtils

 # cd /etc/icinga
 # mv idomod.cfg-sample idomod.cfg
 # mv ido2db.cfg-sample ido2db.cfg
 
 ! Database Setup
 
 (Mysql)
 $ mysql -u root -p
 > CREATE USER 'icinga' IDENTIFIED BY 'icinga';
 > CREATE DATABASE icinga;
 > GRANT USAGE ON icinga.* TO 'icinga'@'localhost' WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0;
 > GRANT SELECT , INSERT , UPDATE , DELETE, DROP, CREATE VIEW, INDEX
  ON icinga.* TO 'icinga'@'localhost';
 > FLUSH PRIVILEGES;
 > quit
 
 $ mysql -u root -p icinga < /usr/share/icinga/idoutils/db/mysql/mysql.sql

Configure web server

Example config files are located at

 /etc/icinga-web/apache.example.conf
 /etc/icinga-web/nginx.example.conf

Configure PHP

Edit /etc/php.ini

 open_basedir = ...:/usr/share/icinga-web:/var/cache/icinga-web:/var/log/icinga
 extension=pdo_mysql.so
 extension=xsl.so
 extension=sockets.so

Configure database

MySQL
! Create database and grants.
# mysql -u root -p
> CREATE USER 'icinga_web' IDENTIFIED BY 'icinga_web';
> CREATE DATABASE icinga_web;
> GRANT USAGE ON icinga_web.* TO 'icinga_web'@'localhost' WITH MAX_QUERIES_PER_HOUR 0 MAX_CONNECTIONS_PER_HOUR 0 MAX_UPDATES_PER_HOUR 0;
> GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, INDEX ON icinga_web.* TO 'icinga_web'@'localhost';
> quit
  
 ! Import the schema.
# mysql -u root -p icinga_web < /usr/share/icinga-web/etc/schema/mysql.sql

Finally

! Start IDOUtils
# systemctl start ido2db

! Start Icinga
# systemctl start icinga

! Start Mysql
# systemctl start mysqld

! Start Web Server
# systemctl start httpd or nginx

! goto http://localhost/icinga-web
> login with 'root' and 'password'

Upgrade database

A new version usually requires an upgrade of the database. You find the sql upgrade scripts in:

/usr/share/icinga/idoutils/db/mysql/upgrade
/usr/share/icinga-web/etc/schema/updates/mysql

Commands to upgrade with these scripts are:

# mysql -u root -p icinga < ./mysql-upgrade-1.8.0.sql 
# mysql -u root -p icinga_web < ./mysql_v1-7-2_to_v1-8-0.sql
# systemctl --system daemon-reload
# systemctl restart icinga

See also