granicus.if.org Git - icinga2/blob - doc/8-alternative-frontends.md

   1 # <a id="alternative-frontends"></a> Alternative Frontends
   2
   3 ## <a id="setting-up-icinga-classic-ui"></a> Setting up Icinga Classic UI 1.x
   4
   5 Icinga 2 can write `status.dat` and `objects.cache` files in the format that
   6 is supported by the Icinga 1.x Classic UI. [External commands](3-monitoring-basics.md#external-commands)
   7 (a.k.a. the "command pipe") are also supported. It also supports writing Icinga 1.x
   8 log files which are required for the reporting functionality in the Classic UI.
   9
  10 ### <a id="installing-icinga-classic-ui"></a> Installing Icinga Classic UI 1.x
  11
  12 The Icinga package repository has both Debian and RPM packages. You can install
  13 the Classic UI using the following packages:
  14
  15   Distribution  | Packages
  16   --------------|---------------------
  17   Debian        | icinga2-classicui
  18   RHEL/SUSE     | icinga2-classicui-config icinga-gui
  19
  20 The Debian packages require additional packages which are provided by the
  21 [Debian Monitoring Project](http://www.debmon.org) (`debmon`) repository.
  22
  23 `libjs-jquery-ui` requires at least version `1.10.*` which is not available
  24 in Debian 7 (Wheezy) and Ubuntu 12.04 LTS (Precise). Add the following repositories
  25 to satisfy this dependency:
  26
  27   Distribution                  | Package Repositories
  28   ------------------------------|------------------------------
  29   Debian Wheezy                 | [wheezy-backports](http://backports.debian.org/Instructions/) or [debmon](http://www.debmon.org)
  30   Ubuntu 12.04 LTS (Precise)    | [Icinga PPA](https://launchpad.net/~formorer/+archive/icinga)
  31
  32 On all distributions other than Debian you may have to restart both your web
  33 server as well as Icinga 2 after installing the Classic UI package.
  34
  35 Icinga Classic UI requires the [StatusDataWriter](3-monitoring-basics.md#status-data), [CompatLogger](3-monitoring-basics.md#compat-logging)
  36 and [ExternalCommandListener](3-monitoring-basics.md#external-commands) features.
  37 Enable these features and restart Icinga 2.
  38
  39     # icinga2 feature enable statusdata compatlog command
  40
  41 In order for commands to work you will need to [setup the external command pipe](2-getting-started.md#setting-up-external-command-pipe).
  42
  43 ### <a id="setting-up-icinga-classic-ui-summary"></a> Setting Up Icinga Classic UI 1.x Summary
  44
  45 Verify that your Icinga 1.x Classic UI works by browsing to your Classic
  46 UI installation URL:
  47
  48   Distribution  | URL                                                                      | Default Login
  49   --------------|--------------------------------------------------------------------------|--------------------------
  50   Debian        | [http://localhost/icinga2-classicui](http://localhost/icinga2-classicui) | asked during installation
  51   all others    | [http://localhost/icinga](http://localhost/icinga)                       | icingaadmin/icingaadmin
  52
  53 For further information on configuration, troubleshooting and interface documentation
  54 please check the official [Icinga 1.x user interface documentation](http://docs.icinga.org/latest/en/ch06.html).
  55
  56 ## <a id="setting-up-icinga-web"></a> Setting up Icinga Web 1.x
  57
  58 Icinga 2 can write to the same schema supplied by `Icinga IDOUtils 1.x` which
  59 is an explicit requirement to run `Icinga Web` next to the external command pipe.
  60 Therefore you need to setup the [DB IDO feature](2-getting-started.md#configuring-db-ido) remarked in the previous sections.
  61
  62 ### <a id="installing-icinga-web"></a> Installing Icinga Web 1.x
  63
  64 The Icinga package repository has both Debian and RPM packages. You can install
  65 Icinga Web using the following packages (RPMs ship an additional configuration package):
  66
  67   Distribution  | Packages
  68   --------------|-------------------------------------------------------
  69   RHEL/SUSE     | icinga-web icinga-web-{mysql,pgsql}
  70   Debian        | icinga-web icinga-web-config-icinga2-ido-{mysql,pgsql}
  71
  72 ### <a id="icinga-web-rpm-notes"></a> Icinga Web 1.x on RPM based systems
  73
  74 Additionally you need to setup the `icinga_web` database and import the database schema.
  75 Details can be found in the package `README` files, for example [README.RHEL](https://github.com/Icinga/icinga-web/blob/master/doc/README.RHEL)
  76
  77 The Icinga Web RPM packages install the schema files into
  78 `/usr/share/doc/icinga-web-*/schema` (`*` means package version).
  79 The Icinga Web dist tarball ships the schema files in `etc/schema`.
  80
  81 On SuSE-based distributions the schema files are installed in
  82 `/usr/share/doc/packages/icinga-web/schema`.
  83
  84 Example for RHEL and MySQL:
  85
  86     # mysql -u root -p
  87
  88     mysql> CREATE DATABASE icinga_web;
  89            GRANT SELECT, INSERT, UPDATE, DELETE, DROP, CREATE VIEW, INDEX, EXECUTE ON icinga_web.* TO 'icinga_web'@'localhost' IDENTIFIED BY 'icinga_web';
  90            quit
  91
  92     # mysql -u root -p icinga_web <  /usr/share/doc/icinga-web-<version>/schema/mysql.sql
  93
  94 Icinga Web requires the IDO feature as database backend using MySQL or PostgreSQL.
  95 Enable that feature, e.g. for MySQL.
  96
  97     # icinga2 feature enable ido-mysql
  98
  99 If you've changed your default credentials you may either create a read-only user
 100 or use the credentials defined in the IDO feature for Icinga Web backend configuration.
 101 Edit `databases.xml` accordingly and clear the cache afterwards. Further details can be
 102 found in the [Icinga Web documentation](http://docs.icinga.org/latest/en/icinga-web-config.html).
 103
 104     # vim /etc/icinga-web/conf.d/databases.xml
 105
 106     # icinga-web-clearcache
 107
 108 Additionally you need to enable the `command` feature for sending [external commands](3-monitoring-basics.md#external-commands):
 109
 110     # icinga2 feature enable command
 111
 112 In order for commands to work you will need to [setup the external command pipe](2-getting-started.md#setting-up-external-command-pipe).
 113
 114 Then edit the Icinga Web configuration for sending commands in `/etc/icinga-web/conf.d/access.xml`
 115 (RHEL) or `/etc/icinga-web/access.xml` (SUSE) setting the command pipe path
 116 to the default used in Icinga 2. Make sure to clear the cache afterwards.
 117
 118     # vim /etc/icinga-web/conf.d/access.xml
 119
 120                 <write>
 121                     <files>
 122                         <resource name="icinga_pipe">/var/run/icinga2/cmd/icinga2.cmd</resource>
 123                     </files>
 124                 </write>
 125
 126     # icinga-web-clearcache
 127
 128 > **Note**
 129 >
 130 > The path to the Icinga Web `clearcache` script may differ. Please check the
 131 > [Icinga Web documentation](https://docs.icinga.org) for details.
 132
 133 ### <a id="icinga-web-debian-notes"></a> Icinga Web on Debian systems
 134
 135 Since Icinga Web `1.11.1-2` the IDO auto-configuration has been moved into
 136 additional packages on Debian and Ubuntu.
 137
 138 The package `icinga-web` no longer configures the IDO connection. You must now
 139 use one of the config packages:
 140
 141  - `icinga-web-config-icinga2-ido-mysql`
 142  - `icinga-web-config-icinga2-ido-pgsql`
 143
 144 These packages take care of setting up the [DB IDO](2-getting-started.md#configuring-db-ido) configuration,
 145 enabling the external command pipe for Icinga Web and depend on
 146 the corresponding packages of Icinga 2.
 147
 148 Please read the `README.Debian` files for details and advanced configuration:
 149
 150  - `/usr/share/doc/icinga-web/README.Debian`
 151  - `/usr/share/doc/icinga-web-config-icinga2-ido-mysql/README.Debian`
 152  - `/usr/share/doc/icinga-web-config-icinga2-ido-pgsql/README.Debian`
 153
 154 When changing Icinga Web configuration files make sure to clear the config cache:
 155
 156     # /usr/lib/icinga-web/bin/clearcache.sh
 157
 158 > **Note**
 159 >
 160 > If you are using an older version of Icinga Web, install it like this and adapt
 161 > the configuration manually as shown in [the RPM notes](8-alternative-frontends.md#icinga-web-rpm-notes):
 162 >
 163 > `apt-get install --no-install-recommends icinga-web`
 164
 165 ### <a id="setting-up-icinga-web-summary"></a> Setting Up Icinga Web 1.x Summary
 166
 167 Verify that your Icinga 1.x Web works by browsing to your Web installation URL:
 168
 169   Distribution  | URL                                                         | Default Login
 170   --------------|-------------------------------------------------------------|--------------------------
 171   Debian        | [http://localhost/icinga-web](http://localhost/icinga-web)  | asked during installation
 172   all others    | [http://localhost/icinga-web](http://localhost/icinga-web)  | root/password
 173
 174 For further information on configuration, troubleshooting and interface documentation
 175 please check the official [Icinga 1.x user interface documentation](http://docs.icinga.org/latest/en/ch06.html).
 176