granicus.if.org Git - icinga2/blob - doc/2.5-setting-up-icinga2-uis.md

   1 ## <a id="setting-up-icinga2-user-interfaces"></a> Setting up Icinga 2 User Interfaces
   2
   3 Icinga 2 is compatible to Icinga 1.x user interfaces by providing additional
   4 features required as backends.
   5
   6 Furthermore these interfaces (and somewhere in the future an Icinga 2
   7 exclusive interface) can be used for the newly created `Icinga Web 2`
   8 user interface.
   9
  10 Some interface features will only work in a limited manner due to
  11 [compatibility reasons](#differences-1x-2), other features like the
  12 statusmap parents are available through intelligent compatibility layers
  13 for dumping the host dependencies as parents.
  14 Special restrictions are noted specifically in the sections below.
  15
  16 > **Tip**
  17 >
  18 > Choose your preferred interface. There's no need to install [Classic UI](#setting-up-icinga-classic-ui)
  19 > if you prefer [Icinga Web](#setting-up-icinga-web) or [Icinga Web 2](#setting-up-icingaweb2) for example.
  20
  21 ### <a id="setting-up-icinga-classic-ui"></a> Setting up Icinga Classic UI
  22
  23 Icinga 2 can write `status.dat` and `objects.cache` files in the format that
  24 is supported by the Icinga 1.x Classic UI. External commands (a.k.a. the
  25 "command pipe") are also supported. It also supports writing Icinga 1.x
  26 log files which are required for the reporting functionality in the Classic UI.
  27
  28 #### <a id="installing-icinga-classic-ui"></a> Installing Icinga Classic UI
  29
  30 The Icinga package repository has both Debian and RPM packages. You can install
  31 the Classic UI using the following packages:
  32
  33   Distribution  | Packages
  34   --------------|---------------------
  35   Debian        | icinga2-classicui
  36   all others    | icinga2-classicui-config icinga-gui
  37
  38 The Debian packages require additional packages which are provided by the
  39 [Debian Monitoring Project](http://www.debmon.org) repository.
  40
  41 On all distributions other than Debian you may have to restart both your web
  42 server as well as Icinga 2 after installing the Classic UI package.
  43
  44 Verify that your Icinga 1.x Classic UI works by browsing to your Classic
  45 UI installation URL:
  46
  47   Distribution  | URL                                                                      | Default Login
  48   --------------|--------------------------------------------------------------------------|--------------------------
  49   Debian        | [http://localhost/icinga2-classicui](http://localhost/icinga2-classicui) | asked during installation
  50   all others    | [http://localhost/icinga](http://localhost/icinga)                       | icingaadmin/icingaadmin
  51
  52 ### <a id="setting-up-icinga-web"></a> Setting up Icinga Web
  53
  54 Icinga 2 can write to the same schema supplied by `Icinga IDOUtils 1.x` which
  55 is an explicit requirement to run `Icinga Web` next to the external command pipe.
  56 Therefore you need to setup the DB IDO feature remarked in the previous sections.
  57
  58 #### <a id="installing-icinga-web"></a> Installing Icinga Web
  59
  60 The Icinga package repository has both Debian and RPM packages. You can install
  61 the Classic UI using the following packages:
  62
  63   Distribution  | Packages
  64   --------------|-------------------------------------
  65   RHEL/SUSE     | icinga-web icinga-web-{mysql,pgsql}
  66   Debian        | icinga-web
  67
  68 Additionally you need to setup the `icinga_web` database.
  69
  70 The Icinga Web RPM packages install the schema files into
  71 `/usr/share/doc/icinga-web-*/schema` (`*` means package version).
  72 The Icinga Web dist tarball ships the schema files in `etc/schema`.
  73
  74 On SuSE-based distributions the schema files are installed in
  75 `/usr/share/doc/packages/icinga-web/schema`.
  76
  77 Additionally you need to enable the `command` feature:
  78
  79     # icinga2-enable-feature command
  80
  81 Then edit the Icinga Web configuration for sending commands in `/etc/icinga-web/conf.d/access.xml`
  82 (RHEL) or `/etc/icinga-web/access.xml` (SUSE) setting the command pipe path
  83 to the default used in Icinga 2. Make sure to clear the cache afterwards.
  84
  85     # vim /etc/icinga-web/conf.d/access.xml
  86
  87                 <write>
  88                     <files>
  89                         <resource name="icinga_pipe">/var/run/icinga2/cmd/icinga.cmd</resource>
  90                     </files>
  91                 </write>
  92
  93     # icinga-web-clearcache
  94
  95 Verify that your Icinga 1.x Web works by browsing to your Web installation URL:
  96
  97   Distribution  | URL                                                         | Default Login
  98   --------------|-------------------------------------------------------------|--------------------------
  99   Debian        | [http://localhost/icinga-web](http://localhost/icinga-web)  | asked during installation
 100   all others    | [http://localhost/icinga-web](http://localhost/icinga-web)  | root/password
 101
 102 ### <a id="setting-up-icingaweb2"></a> Setting up Icinga Web 2
 103
 104 Icinga Web 2 currently supports `status.dat`, `DB IDO`, or `Livestatus` as backends.
 105 Please consult the INSTALL documentation shipped with `Icinga Web 2` for
 106 further instructions.
 107
 108 Icinga Web 2 is still under development. Rather than installing it
 109 yourself you should consider testing it using the available Vagrant
 110 demo VM.
 111
 112 ### <a id="additional-visualization"></a> Additional visualization
 113
 114 There are many visualization addons which can be used with Icinga 2.
 115
 116 Some of the more popular ones are PNP, inGraph (graphing performance data),
 117 Graphite, and NagVis (network maps).