]> granicus.if.org Git - icinga2/blob - doc/2-getting-started.md
Implement the Dictionary#keys method
[icinga2] / doc / 2-getting-started.md
1 # <a id="getting-started"></a> Getting Started
2
3 This tutorial is a step-by-step introduction to installing Icinga 2 and
4 Icinga Web 2. It assumes that you are familiar with the operating system
5 you're using to install Icinga 2.
6
7 ## <a id="setting-up-icinga2"></a> Setting up Icinga 2
8
9 First off you will have to install Icinga 2. The preferred way of doing this
10 is to use the official package repositories depending on which operating system
11 and distribution you are running.
12
13   Distribution            | Repository
14   ------------------------|---------------------------
15   Debian                  | [debmon](http://debmon.org/packages/debmon-jessie/icinga2), [Icinga Repository](http://packages.icinga.org/debian/)
16   Ubuntu                  | [Icinga PPA](https://launchpad.net/~formorer/+archive/ubuntu/icinga), [Icinga Repository](http://packages.icinga.org/ubuntu/)
17   RHEL/CentOS             | [Icinga Repository](http://packages.icinga.org/epel/)
18   openSUSE                | [Icinga Repository](http://packages.icinga.org/openSUSE/), [Server Monitoring Repository](https://build.opensuse.org/package/show/server:monitoring/icinga2)
19   SLES                    | [Icinga Repository](http://packages.icinga.org/SUSE/)
20   Gentoo                  | [Upstream](http://packages.gentoo.org/package/net-analyzer/icinga2)
21   FreeBSD                 | [Upstream](http://www.freshports.org/net-mgmt/icinga2)
22   ArchLinux               | [Upstream](https://aur.archlinux.org/packages/icinga2)
23
24 Packages for distributions other than the ones listed above may also be
25 available. Please contact your distribution packagers.
26
27 ### <a id="package-repositories"></a> Package Repositories
28
29 You need to add the Icinga repository to your package management configuration.
30 Below is a list with examples for the various distributions.
31
32 Debian (debmon):
33
34     # wget -O - http://debmon.org/debmon/repo.key 2>/dev/null | apt-key add -
35     # echo 'deb http://debmon.org/debmon debmon-jessie main' >/etc/apt/sources.list.d/debmon.list
36     # apt-get update
37
38 Ubuntu (PPA):
39
40     # add-apt-repository ppa:formorer/icinga
41     # apt-get update
42
43 RHEL/CentOS:
44
45     # rpm --import http://packages.icinga.org/icinga.key
46     # curl -o /etc/yum.repos.d/ICINGA-release.repo http://packages.icinga.org/epel/ICINGA-release.repo
47     # yum makecache
48
49 The packages for RHEL/CentOS depend on other packages which are distributed
50 as part of the [EPEL repository](http://fedoraproject.org/wiki/EPEL). Please
51 make sure to enable this repository by following
52 [these instructions](http://fedoraproject.org/wiki/EPEL#How_can_I_use_these_extra_packages.3F).
53
54 Fedora:
55
56     # rpm --import http://packages.icinga.org/icinga.key
57     # curl -o /etc/yum.repos.d/ICINGA-release.repo http://packages.icinga.org/fedora/ICINGA-release.repo
58     # yum makecache
59
60 SLES 11:
61
62     # zypper ar http://packages.icinga.org/SUSE/ICINGA-release-11.repo
63     # zypper ref
64
65 The packages for SLES 11 depend on the `openssl1` package which is distributed
66 as part of the [SLES 11 Security Module](https://www.suse.com/communities/conversations/introducing-the-suse-linux-enterprise-11-security-module/).
67
68 SLES 12:
69
70     # zypper ar http://packages.icinga.org/SUSE/ICINGA-release.repo
71     # zypper ref
72
73 openSUSE:
74
75     # zypper ar http://packages.icinga.org/openSUSE/ICINGA-release.repo
76     # zypper ref
77
78 ### <a id="installing-icinga2"></a> Installing Icinga 2
79
80 You can install Icinga 2 by using your distribution's package manager
81 to install the `icinga2` package.
82
83 Debian/Ubuntu:
84
85     # apt-get install icinga2
86
87 RHEL/CentOS 5/6:
88
89     # yum install icinga2
90     # chkconfig icinga2 on
91     # service icinga2 start
92
93 RHEL/CentOS 7 and Fedora:
94
95     # yum install icinga2
96     # systemctl enable icinga2
97     # systemctl start icinga2
98
99 SLES/openSUSE:
100
101     # zypper install icinga2
102
103 ### <a id="installation-enabled-features"></a> Enabled Features during Installation
104
105 The default installation will enable three features required for a basic
106 Icinga 2 installation:
107
108 * `checker` for executing checks
109 * `notification` for sending notifications
110 * `mainlog` for writing the `icinga2.log` file
111
112 You can verify that by calling `icinga2 feature list`
113 [CLI command](8-cli-commands.md#cli-command-feature) to see which features are
114 enabled and disabled.
115
116     # icinga2 feature list
117     Disabled features: api command compatlog debuglog graphite icingastatus ido-mysql ido-pgsql livestatus notification perfdata statusdata syslog
118     Enabled features: checker mainlog notification
119
120
121 ### <a id="installation-paths"></a> Installation Paths
122
123 By default Icinga 2 uses the following files and directories:
124
125   Path                                | Description
126   ------------------------------------|------------------------------------
127   /etc/icinga2                        | Contains Icinga 2 configuration files.
128   /etc/init.d/icinga2                 | The Icinga 2 init script.
129   /usr/sbin/icinga2                   | The Icinga 2 binary.
130   /usr/share/doc/icinga2              | Documentation files that come with Icinga 2.
131   /usr/share/icinga2/include          | The Icinga Template Library and plugin command configuration.
132   /var/run/icinga2                    | PID file.
133   /var/run/icinga2/cmd                | Command pipe and Livestatus socket.
134   /var/cache/icinga2                  | status.dat/objects.cache, icinga2.debug files
135   /var/spool/icinga2                  | Used for performance data spool files.
136   /var/lib/icinga2                    | Icinga 2 state file, cluster log, local CA and configuration files.
137   /var/log/icinga2                    | Log file location and compat/ directory for the CompatLogger feature.
138
139 ## <a id="setting-up-check-plugins"></a> Setting up Check Plugins
140
141 Without plugins Icinga 2 does not know how to check external services. The
142 [Monitoring Plugins Project](https://www.monitoring-plugins.org/) provides
143 an extensive set of plugins which can be used with Icinga 2 to check whether
144 services are working properly.
145
146 The recommended way of installing these standard plugins is to use your
147 distribution's package manager.
148
149 For your convenience here is a list of package names for some of the more
150 popular operating systems/distributions:
151
152 OS/Distribution        | Package Name       | Installation Path
153 -----------------------|--------------------|---------------------------
154 RHEL/CentOS (EPEL)     | nagios-plugins-all | /usr/lib/nagios/plugins or /usr/lib64/nagios/plugins
155 Debian                 | nagios-plugins     | /usr/lib/nagios/plugins
156 FreeBSD                | nagios-plugins     | /usr/local/libexec/nagios
157 OS X (MacPorts)        | nagios-plugins     | /opt/local/libexec
158
159 Depending on which directory your plugins are installed into you may need to
160 update the global `PluginDir` constant in your [Icinga 2 configuration](4-configuring-icinga-2.md#constants-conf).
161 This constant is used by the check command definitions contained in the Icinga Template Library
162 to determine where to find the plugin binaries.
163
164 Please refer to the [plugins](13-addons-plugins.md#plugins) chapter for details about how to integrate
165 additional check plugins into your Icinga 2 setup.
166
167 ## <a id="running-icinga2"></a> Running Icinga 2
168
169 ### <a id="init-script"></a> Init Script
170
171 Icinga 2's init script is installed in `/etc/init.d/icinga2` by default:
172
173     # /etc/init.d/icinga2
174     Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
175
176 The init script supports the following actions:
177
178   Command             | Description
179   --------------------|------------------------
180   start               | The `start` action starts the Icinga 2 daemon.
181   stop                | The `stop` action stops the Icinga 2 daemon.
182   restart             | The `restart` action is a shortcut for running the `stop` action followed by `start`.
183   reload              | The `reload` action sends the `HUP` signal to Icinga 2 which causes it to restart. Unlike the `restart` action `reload` does not wait until Icinga 2 has restarted.
184   checkconfig         | The `checkconfig` action checks if the `/etc/icinga2/icinga2.conf` configuration file contains any errors.
185   status              | The `status` action checks if Icinga 2 is running.
186
187 By default the Icinga 2 daemon is running as `icinga` user and group
188 using the init script. Using Debian packages the user and group are set to
189 `nagios` for historical reasons.
190
191 ### <a id="systemd-service"></a> systemd Service
192
193 Some distributions (e.g. Fedora, openSUSE and RHEL/CentOS 7) use systemd. The
194 Icinga 2 packages automatically install the necessary systemd unit files.
195
196 The Icinga 2 systemd service can be (re-)started, reloaded, stopped and also
197 queried for its current status.
198
199     # systemctl status icinga2
200     icinga2.service - Icinga host/service/network monitoring system
201        Loaded: loaded (/usr/lib/systemd/system/icinga2.service; disabled)
202        Active: active (running) since Mi 2014-07-23 13:39:38 CEST; 15s ago
203       Process: 21692 ExecStart=/usr/sbin/icinga2 -c ${ICINGA2_CONFIG_FILE} -d -e ${ICINGA2_ERROR_LOG} -u ${ICINGA2_USER} -g ${ICINGA2_GROUP} (code=exited, status=0/SUCCESS)
204       Process: 21674 ExecStartPre=/usr/sbin/icinga2-prepare-dirs /etc/sysconfig/icinga2 (code=exited, status=0/SUCCESS)
205      Main PID: 21727 (icinga2)
206        CGroup: /system.slice/icinga2.service
207                21727 /usr/sbin/icinga2 -c /etc/icinga2/icinga2.conf -d -e /var/log/icinga2/error.log -u icinga -g icinga --no-stack-rlimit
208
209     Jul 23 13:39:38 nbmif icinga2[21692]: [2014-07-23 13:39:38 +0200] information/ConfigItem: Checked 309 Service(s).
210     Jul 23 13:39:38 nbmif icinga2[21692]: [2014-07-23 13:39:38 +0200] information/ConfigItem: Checked 1 User(s).
211     Jul 23 13:39:38 nbmif icinga2[21692]: [2014-07-23 13:39:38 +0200] information/ConfigItem: Checked 15 Notification(s).
212     Jul 23 13:39:38 nbmif icinga2[21692]: [2014-07-23 13:39:38 +0200] information/ConfigItem: Checked 4 ScheduledDowntime(s).
213     Jul 23 13:39:38 nbmif icinga2[21692]: [2014-07-23 13:39:38 +0200] information/ConfigItem: Checked 1 UserGroup(s).
214     Jul 23 13:39:38 nbmif icinga2[21692]: [2014-07-23 13:39:38 +0200] information/ConfigItem: Checked 1 IcingaApplication(s).
215     Jul 23 13:39:38 nbmif icinga2[21692]: [2014-07-23 13:39:38 +0200] information/ConfigItem: Checked 8 Dependency(s).
216     Jul 23 13:39:38 nbmif systemd[1]: Started Icinga host/service/network monitoring system.
217
218 The `systemctl` command supports the following actions:
219
220   Command             | Description
221   --------------------|------------------------
222   start               | The `start` action starts the Icinga 2 daemon.
223   stop                | The `stop` action stops the Icinga 2 daemon.
224   restart             | The `restart` action is a shortcut for running the `stop` action followed by `start`.
225   reload              | The `reload` action sends the `HUP` signal to Icinga 2 which causes it to restart. Unlike the `restart` action `reload` does not wait until Icinga 2 has restarted.
226   status              | The `status` action checks if Icinga 2 is running.
227   enable              | The `enable` action enables the service being started at system boot time (similar to `chkconfig`)
228
229 Examples:
230
231     # systemctl enable icinga2
232
233     # systemctl restart icinga2
234     Job for icinga2.service failed. See 'systemctl status icinga2.service' and 'journalctl -xn' for details.
235
236 If you're stuck with configuration errors, you can manually invoke the
237 [configuration validation](8-cli-commands.md#config-validation).
238
239
240 ## <a id="configuration-syntax-highlighting"></a> Configuration Syntax Highlighting
241
242 Icinga 2 ships configuration examples for syntax highlighting using the `vim` and `nano` editors.
243 The RHEL, SUSE and Debian package `icinga2-common` install these files into
244 `/usr/share/*/icinga2-common/syntax`. Sources provide these files in `tools/syntax`.
245
246 ### <a id="configuration-syntax-highlighting-vim"></a> Configuration Syntax Highlighting using Vim
247
248 Create a new local vim configuration storage, if not already existing.
249 Edit `vim/ftdetect/icinga2.vim` if your paths to the Icinga 2 configuration
250 differ.
251
252     $ PREFIX=~/.vim
253     $ mkdir -p $PREFIX/{syntax,ftdetect}
254     $ cp vim/syntax/icinga2.vim $PREFIX/syntax/
255     $ cp vim/ftdetect/icinga2.vim $PREFIX/ftdetect/
256
257 Test it:
258
259     $ vim /etc/icinga2/conf.d/templates.conf
260
261 ### <a id="configuration-syntax-highlighting-nano"></a> Configuration Syntax Highlighting using Nano
262
263 Copy the `/etc/nanorc` sample file to your home directory. Create the `/etc/nano` directory
264 and copy the provided `icinga2.nanorc` into it.
265
266     $ cp /etc/nanorc ~/.nanorc
267
268     # mkdir -p /etc/nano
269     # cp icinga2.nanorc /etc/nano/
270
271 Then include the icinga2.nanorc file in your ~/.nanorc by adding the following line:
272
273     $ vim ~/.nanorc
274
275     ## Icinga 2
276     include "/etc/nano/icinga2.nanorc"
277
278 Test it:
279
280     $ nano /etc/icinga2/conf.d/templates.conf
281
282
283 ## <a id="setting-up-the-user-interface"></a> Setting up Icinga Web 2
284
285 Icinga 2 can be used with Icinga Web 2 and a number of other web interfaces.
286 This chapter explains how to set up Icinga Web 2. The
287 [Alternative Frontends](14-alternative-frontends.md#alternative-frontends)
288 chapter can be used as a starting point for installing some of the other web
289 interfaces which are also available.
290
291 The DB IDO (Database Icinga Data Output) modules for Icinga 2 take care of
292 exporting all configuration and status information into a database. The IDO
293 database is used by a number of projects including
294 [Icinga Web 2](2-getting-started.md#setting-up-icingaweb2), Icinga Reporting
295 or Icinga Web 1.x.
296
297 There is a separate module for each database backend. At present support for
298 both MySQL and PostgreSQL is implemented.
299
300 ### <a id="configuring-db-ido-mysql"></a> Configuring DB IDO MySQL
301
302 #### <a id="installing-database-mysql-server"></a> Installing MySQL database server
303
304 Debian/Ubuntu:
305
306     # apt-get install mysql-server mysql-client
307
308 RHEL/CentOS 5/6:
309
310     # yum install mysql-server mysql
311     # chkconfig mysqld on
312     # service mysqld start
313     # mysql_secure_installation
314
315 RHEL/CentOS 7 and Fedora:
316
317     # yum install mariadb-server mariadb
318     # systemctl enable mariadb
319     # systemctl start mariadb
320     # mysql_secure_installation
321
322 SUSE:
323
324     # zypper install mysql mysql-client
325     # chkconfig mysqld on
326     # service mysqld start
327
328 #### <a id="installing-database-mysql-modules"></a> Installing the IDO modules for MySQL
329
330 The next step is to install the `icinga2-ido-mysql` package using your
331 distribution's package manager.
332
333 Debian/Ubuntu:
334
335     # apt-get install icinga2-ido-mysql
336
337 RHEL/CentOS:
338
339     # yum install icinga2-ido-mysql
340
341 SUSE:
342
343     # zypper install icinga2-ido-mysql
344
345
346 > **Note**
347 >
348 > The Debian/Ubuntu packages provide a database configuration wizard by
349 > default. You can skip the automated setup and install/upgrade the
350 > database manually if you prefer that.
351
352 #### <a id="setting-up-mysql-db"></a> Setting up the MySQL database
353
354 Set up a MySQL database for Icinga 2:
355
356     # mysql -u root -p
357
358     mysql>  CREATE DATABASE icinga;
359             GRANT SELECT, INSERT, UPDATE, DELETE, DROP, CREATE VIEW, INDEX, EXECUTE ON icinga.* TO 'icinga'@'localhost' IDENTIFIED BY 'icinga';
360
361 After creating the database you can import the Icinga 2 IDO schema using the
362 following command:
363
364     # mysql -u root -p icinga < /usr/share/icinga2-ido-mysql/schema/mysql.sql
365
366
367 #### <a id="enabling-ido-mysql"></a> Enabling the IDO MySQL module
368
369 The package provides a new configuration file that is installed in
370 `/etc/icinga2/features-available/ido-mysql.conf`. You will need to
371 update the database credentials in this file.
372
373 All available attributes are explained in the
374 [IdoMysqlConnection object](6-object-types.md#objecttype-idomysqlconnection)
375 chapter.
376
377 You can enable the `ido-mysql` feature configuration file using
378 `icinga2 feature enable`:
379
380     # icinga2 feature enable ido-mysql
381     Module 'ido-mysql' was enabled.
382     Make sure to restart Icinga 2 for these changes to take effect.
383
384 After enabling the ido-mysql feature you have to restart Icinga 2:
385
386 Debian/Ubuntu, RHEL/CentOS 6 and SUSE:
387
388     # service icinga2 restart
389
390 RHEL/CentOS 7 and Fedora:
391
392     # systemctl restart icinga2
393
394 ### <a id="configuring-db-ido-postgresql"></a> Configuring DB IDO PostgreSQL
395
396 #### <a id="installing-database-postgresql-server"></a> Installing PostgreSQL database server
397
398 Debian/Ubuntu:
399
400     # apt-get install postgresql
401
402 RHEL/CentOS 5/6:
403
404     # yum install postgresql-server postgresql
405     # chkconfig postgresql on
406     # service postgresql start
407
408 RHEL/CentOS 7:
409
410     # yum install postgresql-server postgresql
411     # systemctl enable postgresql
412     # systemctl start postgresql
413
414 SUSE:
415
416     # zypper install postgresql postgresql-server
417     # chkconfig postgresql on
418     # service postgresql start
419
420 #### <a id="installing-database-postgresql-modules"></a> Installing the IDO modules for PostgreSQL
421
422 The next step is to install the `icinga2-ido-pgsql` package using your
423 distribution's package manager.
424
425 Debian/Ubuntu:
426
427     # apt-get install icinga2-ido-pgsql
428
429 RHEL/CentOS:
430
431     # yum install icinga2-ido-pgsql
432
433 SUSE:
434
435     # zypper install icinga2-ido-pgsql
436
437 > **Note**
438 >
439 > Upstream Debian packages provide a database configuration wizard by default.
440 > You can skip the automated setup and install/upgrade the database manually
441 > if you prefer that.
442
443 #### Setting up the PostgreSQL database
444
445 Set up a PostgreSQL database for Icinga 2:
446
447     # cd /tmp
448     # sudo -u postgres psql -c "CREATE ROLE icinga WITH LOGIN PASSWORD 'icinga'";
449     # sudo -u postgres createdb -O icinga -E UTF8 icinga
450     # sudo -u postgres createlang plpgsql icinga
451
452 > **Note**
453 >
454 > When using PostgreSQL 9.x you can omit the `createlang` command.
455
456 Locate your pg_hba.conf (Debian: `/etc/postgresql/*/main/pg_hba.conf`,
457 RHEL/SUSE: `/var/lib/pgsql/data/pg_hba.conf`), add the icinga user with md5
458 authentication method and restart the postgresql server.
459
460     # vim /var/lib/pgsql/data/pg_hba.conf
461
462     # icinga
463     local   icinga      icinga                            md5
464     host    icinga      icinga      127.0.0.1/32          md5
465     host    icinga      icinga      ::1/128               md5
466
467     # "local" is for Unix domain socket connections only
468     local   all         all                               ident
469     # IPv4 local connections:
470     host    all         all         127.0.0.1/32          ident
471     # IPv6 local connections:
472     host    all         all         ::1/128               ident
473
474     # /etc/init.d/postgresql restart
475
476
477 After creating the database and permissions you can import the Icinga 2 IDO
478 schema using the following command:
479
480     # export PGPASSWORD=icinga
481     # psql -U icinga -d icinga < /usr/share/icinga2-ido-pgsql/schema/pgsql.sql
482
483
484 #### <a id="enabling-ido-postgresql"></a> Enabling the IDO PostgreSQL module
485
486 The package provides a new configuration file that is installed in
487 `/etc/icinga2/features-available/ido-pgsql.conf`. You will need to update
488 the database credentials in this file.
489
490 All available attributes are explained in the
491 [IdoPgsqlConnection object](6-object-types.md#objecttype-idopgsqlconnection)
492 chapter.
493
494 You can enable the `ido-pgsql` feature configuration file using
495 `icinga2 feature enable`:
496
497     # icinga2 feature enable ido-pgsql
498     Module 'ido-pgsql' was enabled.
499     Make sure to restart Icinga 2 for these changes to take effect.
500
501 After enabling the ido-pgsql feature you have to restart Icinga 2:
502
503 Debian/Ubuntu, RHEL/CentOS 6 and SUSE:
504
505     # service icinga2 restart
506
507 RHEL/CentOS 7 and Fedora:
508
509     # systemctl restart icinga2
510
511
512 ### <a id="icinga2-user-interface-webserver"></a> Webserver
513
514 Debian/Ubuntu:
515
516     # apt-get install apache2
517
518 RHEL/CentOS 6:
519
520     # yum install httpd
521     # chkconfig httpd on
522     # service httpd start
523
524 RHEL/CentOS 7/Fedora:
525
526     # yum install httpd
527     # systemctl enable httpd
528     # systemctl start httpd
529
530 SUSE:
531
532     # zypper install apache2
533     # chkconfig on
534     # service apache2 start
535
536 ### <a id="icinga2-user-interface-firewall-rules"></a> Firewall Rules
537
538 Example:
539
540     # iptables -A INPUT -p tcp -m tcp --dport 80 -j ACCEPT
541     # service iptables save
542
543 RHEL/CentOS 7 specific:
544
545     # firewall-cmd --add-service=http
546     # firewall-cmd --permanent --add-service=http
547
548
549 ### <a id="setting-up-external-command-pipe"></a> Setting Up External Command Pipe
550
551 Web interfaces and other Icinga addons are able to send commands to
552 Icinga 2 through the external command pipe.
553
554 You can enable the External Command Pipe using the CLI:
555
556     # icinga2 feature enable command
557
558 After that you will have to restart Icinga 2:
559
560 Debian/Ubuntu, RHEL/CentOS 6 and SUSE:
561
562     # service icinga2 restart
563
564 RHEL/CentOS 7 and Fedora:
565
566     # systemctl restart icinga2
567
568 By default the command pipe file is owned by the group `icingacmd` with
569 read/write permissions. Add your webserver's user to the group `icingacmd` to
570 enable sending commands to Icinga 2 through your web interface:
571
572     # usermod -a -G icingacmd www-data
573
574 Debian packages use `nagios` as the default user and group name. Therefore
575 change `icingacmd` to `nagios`.
576
577 The webserver's user is different between distributions so you might have to
578 change `www-data` to `wwwrun`, `www`, or `apache`.
579
580 Change "www-data" to the user you're using to run queries.
581
582 You can verify that the user has been successfully added to the `icingacmd`
583 group using the `id` command:
584
585     $ id <your-webserver-user>
586
587
588 ### <a id="setting-up-icingaweb2"></a> Installing up Icinga Web 2
589
590 Please consult the [installation documentation](https://github.com/Icinga/icingaweb2/blob/master/doc/installation.md)
591 for further instructions on how to install Icinga Web 2.
592
593
594 ## <a id="install-addons"></a> Addons
595
596 A number of additional features are available in the form of addons. A list of
597 popular addons is available in the
598 [Addons and Plugins](13-addons-plugins.md#addons-plugins) chapter.