granicus.if.org Git - icinga2/blob - INSTALL.md

   1 # Installing Icinga 2
   2
   3 The recommended way of installing Icinga 2 is to use packages. The Icinga
   4 project provides both release and development packages for a number
   5 of operating systems.
   6
   7 Please check the documentation in the [doc/](doc/) directory for a current list
   8 of available packages and detailed installation instructions.
   9
  10 There are a number of known caveats when installing from source such as
  11 incorrect directory and file permissions. So even if you're planning to
  12 not use the official packages it is advisable to build your own Debian
  13 or RPM packages.
  14
  15 ## Build Requirements
  16
  17 The following requirements need to be fulfilled in order to build the
  18 application using a dist tarball (package names for RHEL and Debian in
  19 parentheses):
  20
  21 * cmake
  22 * GNU make (make)
  23 * C++ compiler (gcc-c++ on RHEL, build-essential on Debian)
  24 * OpenSSL library and header files (openssl-devel on RHEL, libssl-dev on Debian)
  25 * Boost library and header files (boost-devel on RHEL, libboost-all-dev on Debian)
  26 * GNU bison (bison)
  27 * GNU flex (flex) >= 2.5.35
  28 * recommended: libexecinfo on FreeBSD (automatically used when Icinga 2 is
  29                installed via port or package)
  30 * recommended: GNU readline (readline-devel on RHEL, libreadline-dev on Debian)
  31 * recommended: ncurses (ncurses-devel on RHEL, libncurses-dev on Debian)
  32 * optional: MySQL (mysql-devel on RHEL, libmysqlclient-dev on Debian); set CMake
  33              variable `ICINGA2_WITH_MYSQL` to disable this module
  34 * optional: PostgreSQL (postgresql-devel on RHEL, libpq-dev on Debian); set CMake
  35             variable `ICINGA2_WITH_PGSQL` to disable this module
  36 * optional: YAJL (yajl-devel on RHEL, libyajl-dev on Debian)
  37
  38 Note: RHEL5 ships an ancient flex version. Updated packages are available for
  39 example from the repoforge buildtools repository.
  40
  41 * x86: http://mirror.hs-esslingen.de/repoforge/redhat/el5/en/i386/buildtools/
  42 * x86\_64: http://mirror.hs-esslingen.de/repoforge/redhat/el5/en/x86_64/buildtools/
  43
  44 ### User Requirements
  45
  46 By default Icinga will run as user 'icinga' and group 'icinga'. Additionally the
  47 external command pipe and livestatus features require a dedicated command group
  48 'icingacmd'. You can choose your own user/group names and pass them to CMake
  49 using the `ICINGA2_USER`, `ICINGA2_GROUP` and `ICINGA2_COMMAND_GROUP` variables.
  50
  51     # groupadd icinga
  52     # groupadd icingacmd
  53     # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
  54
  55 Add the web server user to the icingacmd group in order to grant it write
  56 permissions to the external command pipe and livestatus socket:
  57
  58     # usermod -a -G icingacmd www-data
  59
  60 Make sure to replace "www-data" with the name of the user your web server
  61 is running as.
  62
  63
  64 ## Building Release Tarballs
  65
  66 In order to build a release tarball you should first check out the Git repository
  67 in a new directory. If you're using an existing check-out you should make sure
  68 that there are no local modifications:
  69
  70     $ git status
  71
  72 ### Release Checklist
  73
  74 Here's a short check-list for releases:
  75
  76 Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files
  77
  78     $ git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
  79
  80 Bump the version in icinga2.spec.
  81 Update the [ChangeLog](ChangeLog), [doc/1-about.md](doc/1-about.md) and [INSTALL.md](INSTALL.md)
  82 files.
  83 Commit these changes to the "master" branch.
  84
  85     $ git commit -v -a -m "Release version <VERSION>"
  86
  87 Create a signed tag (tags/v<VERSION>).
  88
  89 GB:
  90
  91     $ git tag -u EE8E0720 -m "Version <VERSION>" v<VERSION>
  92 MF:
  93
  94     $ git tag -u D14A1F16 -m "Version <VERSION>" v<VERSION>
  95
  96 Push the tag.
  97
  98     $ git push --tags
  99
 100 Merge the "master" branch into the "support/2.2" branch (using --ff-only).
 101
 102     $ git checkout support/2.2
 103     $ git merge --ff-only master
 104     $ git push origin support/2.2
 105
 106 Note: CMake determines the Icinga 2 version number using `git describe` if the
 107 source directory is contained in a Git repository. Otherwise the version number
 108 is extracted from the [icinga2.spec](icinga2.spec) file. This behavior can be overridden by
 109 creating a file called `icinga-version.h.force` in the source directory.
 110 Alternatively the `-DICINGA2_GIT_VERSION_INFO=ON option` for CMake can be used to
 111 disable the usage of `git describe`.
 112
 113 ### Build Tarball
 114
 115 Use `git archive` to build the release tarball:
 116
 117     $ VERSION=2.2.3
 118     $ git archive --format=tar --prefix=icinga2-$VERSION/ tags/v$VERSION | gzip >icinga2-$VERSION.tar.gz
 119
 120 Finally you should verify that the tarball only contains the files it should contain:
 121
 122     $ VERSION=2.2.3
 123     $ tar ztf icinga2-$VERSION.tar.gz | less
 124
 125
 126 ## Building Icinga 2
 127
 128 Once you have installed all the necessary build requirements you can build
 129 Icinga 2 using the following commands:
 130
 131     $ mkdir build && cd build
 132     $ cmake ..
 133     $ make
 134     $ make install
 135
 136 You can specify an alternative installation prefix using `-DCMAKE_INSTALL_PREFIX`:
 137
 138     $ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/icinga2
 139
 140 In addition to `CMAKE_INSTALL_PREFIX` the following Icinga-specific cmake
 141 variables are supported:
 142
 143 - `ICINGA2_USER`: The user Icinga 2 should run as; defaults to `icinga`
 144 - `ICINGA2_GROUP`: The group Icinga 2 should run as; defaults to `icinga`
 145 - `ICINGA2_GIT_VERSION_INFO`: Whether to use Git to determine the version number; defaults to `ON`
 146 - `ICINGA2_COMMAND_GROUP`: The command group Icinga 2 should use; defaults to `icingacmd`
 147 - `ICINGA2_UNITY_BUILD`: Whether to perform a unity build; defaults to `OFF`
 148 - `ICINGA2_PLUGINDIR`: The path for the Monitoring Plugins project binaries; defaults to `/usr/lib/nagios/plugins`
 149 - `ICINGA2_RUNDIR`: The location of the "run" directory; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/run`
 150 - `CMAKE_INSTALL_SYSCONFDIR`: The configuration directory; defaults to `CMAKE_INSTALL_PREFIX/etc`
 151 - `ICINGA2_SYSCONFIGFILE`: Where to put the config file the initscript/systemd pulls it's dirs from;
 152 defaults to `CMAKE_INSTALL_PREFIX/etc/sysconfig/icinga2`
 153 - `CMAKE_INSTALL_LOCALSTATEDIR`: The state directory; defaults to `CMAKE_INSTALL_PREFIX/var`
 154 - `USE_SYSTEMD=ON|OFF`: Use systemd or a classic SysV initscript; defaults to `OFF`
 155 - `INSTALL_SYSTEMD_SERVICE_AND_INITSCRIPT=ON|OFF` Force install both the systemd service definition file
 156 and the SysV initscript in parallel, regardless of how `USE_SYSTEMD` is set.
 157 Only use this for special packaging purposes and if you know what you are doing.
 158 Defaults to `OFF`.
 159 - `ICINGA2_WITH_MYSQL`: Determines whether the MySQL IDO module is built; defaults to `ON`
 160 - `ICINGA2_WITH_PGSQL`: Determines whether the PostgreSQL IDO module is built; defaults to `ON`
 161 - `ICINGA2_WITH_CHECKER`: Determines whether the checker module is built; defaults to `ON`
 162 - `ICINGA2_WITH_COMPAT`: Determines whether the compat module is built; defaults to `ON`
 163 - `ICINGA2_WITH_DEMO`: Determines whether the demo module is built; defaults to `OFF`
 164 - `ICINGA2_WITH_HELLO`: Determines whether the hello module is built; defaults to `OFF`
 165 - `ICINGA2_WITH_LIVESTATUS`: Determines whether the Livestatus module is built; defaults to `ON`
 166 - `ICINGA2_WITH_NOTIFICATION`: Determines whether the notification module is built; defaults to `ON`
 167 - `ICINGA2_WITH_PERFDATA`: Determines whether the perfdata module is built; defaults to `ON`
 168
 169 ### Building Icinga 2 RPMs
 170
 171 Setup your build environment on RHEL/SUSE and copy the generated tarball from your git
 172 repository to `rpmbuild/SOURCES`.
 173 Copy the icinga2.spec file to `rpmbuild/SPEC` and then invoke
 174
 175     $ rpmbuild -ba SPEC/icinga2.spec
 176
 177 ### Building Icinga 2 Debs
 178
 179 Setup your build environment on Debian/Ubuntu and run the following command straight from
 180 the git repository checkout:
 181
 182     $ ./debian/updateversion && dpkg-buildpackage -uc -us
 183
 184 ## Running Icinga 2
 185
 186 Icinga 2 comes with a single binary that takes care of loading all the relevant
 187 components (e.g. for check execution, notifications, etc.):
 188
 189     # /usr/sbin/icinga2 daemon
 190     [2014-12-18 10:20:49 +0100] information/cli: Icinga application loader (version: v2.2.2)
 191     [2014-12-18 10:20:49 +0100] information/cli: Loading application type: icinga/IcingaApplication
 192     [2014-12-18 10:20:49 +0100] information/Utility: Loading library 'libicinga.so'
 193     [2014-12-18 10:20:49 +0100] information/ConfigCompiler: Compiling config file: /home/gbeutner/i2/etc/icinga2/icinga2.conf
 194     [2014-12-18 10:20:49 +0100] information/ConfigCompiler: Compiling config file: /home/gbeutner/i2/etc/icinga2/constants.conf
 195     ...
 196
 197 Icinga 2 can be started as daemon using the provided init script:
 198
 199     # /etc/init.d/icinga2
 200     Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
 201
 202 Or if your distribution uses systemd:
 203
 204     # systemctl {start|stop|reload|status|enable|disable} icinga2.service
 205
 206 Icinga 2 reads a single configuration file which is used to specify all
 207 configuration settings (global settings, hosts, services, etc.). The
 208 configuration format is explained in detail in the [doc/](doc/) directory.
 209
 210 By default `make install` installs example configuration files in
 211 `/usr/local/etc/icinga2` unless you have specified a different prefix or
 212 sysconfdir.