1 # Development <a id="development"></a>
3 This chapter provides hints on Icinga 2 debugging,
4 development, package builds and tests.
6 * [Debug Icinga 2](21-development.md#development-debug)
7 * [GDB Backtrace](21-development.md#development-debug-gdb-backtrace)
8 * [Core Dump](21-development.md#development-debug-core-dump)
9 * [Test Icinga 2](21-development.md#development-tests)
10 * [Snapshot Packages (Nightly Builds)](21-development.md#development-tests-snapshot-packages)
11 * [Develop Icinga 2](21-development.md#development-develop)
12 * [Preparations](21-development.md#development-develop-styleguide)
13 * [Design Patterns](21-development.md#development-develop-design-patterns)
14 * [Build Tools](21-development.md#development-develop-builds-tools)
15 * [Unit Tests](21-development.md#development-develop-tests)
16 * [Style Guide](21-development.md#development-develop-styleguide)
17 * [Development Environment](21-development.md#development-environment)
18 * [Linux Dev Environment](21-development.md#development-linux-dev-env)
19 * [macOS Dev Environment](21-development.md#development-macos-dev-env)
20 * [Windows Dev Environment](21-development.md#development-windows-dev-env)
21 * [Package Builds](21-development.md#development-package-builds)
22 * [RPM](21-development.md#development-package-builds-rpms)
23 * [DEB](21-development.md#development-package-builds-deb)
24 * [Windows](21-development.md#development-package-builds-windows)
25 * [Advanced Tips](21-development.md#development-advanced)
27 <!-- mkdocs requires 4 spaces indent for nested lists: https://github.com/Python-Markdown/markdown/issues/3 -->
29 ## Debug Icinga 2 <a id="development-debug"></a>
31 This chapter targets all users who have been asked by developers to provide
32 a stack trace or coredump if the application crashed. It is also useful
33 for developers working with different debuggers.
37 > This is intentionally mentioned before any development insights
38 > as debugging is a more frequent and commonly asked question.
40 ### Debug Requirements <a id="debug-requirements"></a>
42 Make sure that the debug symbols are available for Icinga 2.
43 The Icinga 2 packages provide a debug package which must be
44 installed separately for all involved binaries, like `icinga2-bin`
45 or `icinga2-ido-mysql`.
47 Distribution | Command
48 -------------------|------------------------------------------
49 Debian/Ubuntu | `apt-get install icinga2-dbg`
50 RHEL/CentOS | `yum install icinga2-debuginfo`
51 Fedora | `dnf install icinga2-debuginfo icinga2-bin-debuginfo icinga2-ido-mysql-debuginfo`
52 SLES/openSUSE | `zypper install icinga2-bin-debuginfo icinga2-ido-mysql-debuginfo`
54 Furthermore, you may also have to install debug symbols for Boost and your C++ library.
56 If you're building your own binaries, you should use the `-DCMAKE_BUILD_TYPE=Debug` cmake
57 build flag for debug builds.
60 ### GDB as Debugger <a id="development-debug-gdb"></a>
62 Install GDB in your development environment.
64 Distribution | Command
65 -------------------|------------------------------------------
66 Debian/Ubuntu | `apt-get install gdb`
67 RHEL/CentOS | `yum install gdb`
68 Fedora | `dnf install gdb`
69 SLES/openSUSE | `zypper install gdb`
71 #### GDB Run <a id="development-debug-gdb-run"></a>
73 Call GDB with the binary (`/usr/sbin/icinga2` is a wrapper script calling
74 `/usr/lib64/icinga2/sbin/icinga2` since 2.4) and all arguments and run it in foreground.
77 gdb --args /usr/lib64/icinga2/sbin/icinga2 daemon -x debug
80 The exact path to the Icinga 2 binary differs on each distribution. On Ubuntu
81 it is installed into `/usr/lib/x86_64-linux-gnu/icinga2/sbin/icinga2` on 64-bit systems
86 > If gdb tells you it's missing debug symbols, quit gdb and install
87 > them: `Missing separate debuginfos, use: debuginfo-install ...`
89 Run/restart the application.
95 Kill the running application.
101 Continue after breakpoint.
107 #### GDB Core Dump <a id="development-debug-gdb-coredump"></a>
109 Either attach to the running process using `gdb -p PID` or start
114 (gdb) generate-core-file
117 #### GDB Backtrace <a id="development-debug-gdb-backtrace"></a>
119 If Icinga 2 aborted its operation abnormally, generate a backtrace.
123 > Please install the [required debug symbols](21-development.md#debug-requirements)
124 > prior to generating a backtrace.
126 `thread apply all` is important here since this includes all running threads.
127 We need this information when e.g. debugging dead locks and hanging features.
131 (gdb) thread apply all bt full
134 If gdb stops at a SIGPIPE signal please disable the signal before
135 running Icinga 2. This isn't an error, but we need to workaround it.
138 (gdb) handle SIGPIPE nostop noprint pass
142 If you create a [new issue](https://github.com/Icinga/icinga2/issues),
143 make sure to attach as much detail as possible.
145 #### GDB Backtrace from Running Process <a id="development-debug-gdb-backtrace-running"></a>
147 If Icinga 2 is still running, generate a full backtrace from the running
148 process and store it into a new file (e.g. for debugging dead locks).
152 > Please install the [required debug symbols](21-development.md#debug-requirements)
153 > prior to generating a backtrace.
155 Icinga 2 runs with 2 processes: main and command executor, therefore generate two backtrace logs
156 and add them to the GitHub issue.
159 for pid in $(pidof icinga2); do gdb -p $pid -batch -ex "thread apply all bt full" -ex "detach" -ex "q" > gdb_bt_${pid}_`date +%s`.log; done
162 #### GDB Thread List from Running Process <a id="development-debug-gdb-thread-list-running"></a>
164 Instead of a full backtrace, you sometimes just need a list of running threads.
167 for pid in $(pidof icinga2); do gdb -p $pid -batch -ex "info threads" -ex "detach" -ex "q" > gdb_threads_${pid}_`date +%s`.log; done
170 #### GDB Backtrace Stepping <a id="development-debug-gdb-backtrace-stepping"></a>
172 Identifying the problem may require stepping into the backtrace, analysing
173 the current scope, attributes, and possible unmet requirements. `p` prints
174 the value of the selected variable or function call result.
180 (gdb) p checkable.px->m_Name
183 #### GDB Breakpoints <a id="development-debug-gdb-breakpoint"></a>
185 To set a breakpoint to a specific function call, or file specific line.
188 (gdb) b checkable.cpp:125
189 (gdb) b icinga::Checkable::SetEnablePerfdata
192 GDB will ask about loading the required symbols later, select `yes` instead
195 Then run Icinga 2 until it reaches the first breakpoint. Continue with `c`
203 In case you want to step into the next line of code, use `n`. If there is a
204 function call where you want to step into, use `s`.
212 If you want to delete all breakpoints, use `d` and select `yes`.
220 > When debugging exceptions, set your breakpoint like this: `b __cxa_throw`.
230 #11 0x00007ffff7cbf9ff in icinga::Utility::GlobRecursive(icinga::String const&, icinga::String const&, boost::function<void (icinga::String const&)> const&, int) (path=..., pattern=..., callback=..., type=1)
231 at /home/michi/coding/icinga/icinga2/lib/base/utility.cpp:609
235 605 #endif /* _WIN32 */
237 607 std::sort(files.begin(), files.end());
238 608 BOOST_FOREACH(const String& cpath, files) {
242 612 std::sort(dirs.begin(), dirs.end());
243 613 BOOST_FOREACH(const String& cpath, dirs) {
245 $3 = std::vector of length 11, capacity 16 = {{static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/agent.conf"}, {static NPos = 18446744073709551615,
246 m_Data = "/etc/icinga2/conf.d/commands.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/downtimes.conf"}, {static NPos = 18446744073709551615,
247 m_Data = "/etc/icinga2/conf.d/groups.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/notifications.conf"}, {static NPos = 18446744073709551615,
248 m_Data = "/etc/icinga2/conf.d/satellite.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/services.conf"}, {static NPos = 18446744073709551615,
249 m_Data = "/etc/icinga2/conf.d/templates.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/test.conf"}, {static NPos = 18446744073709551615,
250 m_Data = "/etc/icinga2/conf.d/timeperiods.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/users.conf"}}
254 ### Core Dump <a id="development-debug-core-dump"></a>
256 When the Icinga 2 daemon crashes with a `SIGSEGV` signal
257 a core dump file should be written. This will help
258 developers to analyze and fix the problem.
260 #### Core Dump File Size Limit <a id="development-debug-core-dump-limit"></a>
262 This requires setting the core dump file size to `unlimited`.
268 systemctl edit icinga2.service
274 systemctl daemon-reload
276 systemctl restart icinga2
282 vim /etc/init.d/icinga2
286 service icinga2 restart
291 Verify that the Icinga 2 process core file size limit is set to `unlimited`.
294 for pid in $(pidof icinga2); do cat /proc/$pid/limits; done
297 Max core file size unlimited unlimited bytes
301 #### Core Dump Kernel Format <a id="development-debug-core-dump-format"></a>
303 The Icinga 2 daemon runs with the SUID bit set. Therefore you need
304 to explicitly enable core dumps for SUID on Linux.
307 sysctl -w fs.suid_dumpable=2
310 Adjust the coredump kernel format and file location on Linux:
313 sysctl -w kernel.core_pattern=/var/lib/cores/core.%e.%p
315 install -m 1777 -d /var/lib/cores
321 sysctl -w kern.corefile=/cores/core.%P
326 #### Core Dump Analysis <a id="development-debug-core-dump-analysis"></a>
328 Once Icinga 2 crashes again a new coredump file will be written. Please
329 attach this file to your bug report in addition to the general details.
331 Simple test case for a `SIGSEGV` simulation with `sleep`:
338 gdb `which sleep` /var/lib/cores/core.sleep.<PID>
340 rm /var/lib/cores/core.sleep.*
346 gdb /usr/lib64/icinga2/sbin/icinga2 core.icinga2.<PID>
350 ### LLDB as Debugger <a id="development-debug-lldb"></a>
352 LLDB is available on macOS with the Xcode command line tools.
355 $ xcode-select --install
358 In order to run Icinga 2 with LLDB you need to pass the binary as argument.
361 lldb -- /usr/local/icinga2/lib/icinga2/sbin/icinga2 daemon
368 > b icinga::Checkable::ProcessCheckResult
401 Up/down in stacktrace:
408 ## Test Icinga 2 <a id="development-tests"></a>
410 ### Snapshot Packages (Nightly Builds) <a id="development-tests-snapshot-packages"></a>
412 Icinga provides snapshot packages as nightly builds from [Git master](https://github.com/icinga/icinga2).
414 These packages contain development code which should be considered "work in progress".
415 While developers ensure that tests are running fine with CI actions on PRs,
416 things might break, or changes are not yet documented in the changelog.
418 You can help the developers and test the snapshot packages, e.g. when larger
419 changes or rewrites are taking place for a new major version. Your feedback
420 is very much appreciated.
422 Snapshot packages are available for all supported platforms including
423 Linux and Windows and can be obtained from [https://packages.icinga.com](https://packages.icinga.com).
425 The [Vagrant boxes](https://github.com/Icinga/icinga-vagrant) also use
426 the Icinga snapshot packages to allow easier integration tests. It is also
427 possible to use Docker with base OS images and installing the snapshot
430 If you encounter a problem, please [open a new issue](https://github.com/Icinga/icinga2/issues/new/choose)
431 on GitHub and mention that you're testing the snapshot packages.
433 #### RHEL/CentOS <a id="development-tests-snapshot-packages-rhel"></a>
435 2.11+ requires the [EPEL repository](02-installation.md#package-repositories-rhel-epel) for Boost 1.66+.
437 In addition to that, the `icinga-rpm-release` package already provides the `icinga-snapshot-builds`
438 repository but it is disabled by default.
441 yum -y install https://packages.icinga.com/epel/icinga-rpm-release-7-latest.noarch.rpm
442 yum -y install epel-release
445 yum install --enablerepo=icinga-snapshot-builds icinga2
448 #### Debian <a id="development-tests-snapshot-packages-debian"></a>
450 2.11+ requires Boost 1.66+ which either is provided by the OS, backports or Icinga stable repositories.
451 It is advised to configure both Icinga repositories, stable and snapshot and selectively
452 choose the repository with the `-t` flag on `apt-get install`.
456 apt-get -y install apt-transport-https wget gnupg
458 wget -O - https://packages.icinga.com/icinga.key | apt-key add -
460 DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
461 echo "deb https://packages.icinga.com/debian icinga-${DIST} main" > \
462 /etc/apt/sources.list.d/${DIST}-icinga.list
463 echo "deb-src https://packages.icinga.com/debian icinga-${DIST} main" >> \
464 /etc/apt/sources.list.d/${DIST}-icinga.list
466 DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
467 echo "deb http://packages.icinga.com/debian icinga-${DIST}-snapshots main" > \
468 /etc/apt/sources.list.d/${DIST}-icinga-snapshots.list
469 echo "deb-src http://packages.icinga.com/debian icinga-${DIST}-snapshots main" >> \
470 /etc/apt/sources.list.d/${DIST}-icinga-snapshots.list
475 On Debian Stretch, you'll also need to add Debian Backports.
478 DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
479 echo "deb https://deb.debian.org/debian ${DIST}-backports main" > \
480 /etc/apt/sources.list.d/${DIST}-backports.list
485 Then install the snapshot packages.
488 DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
489 apt-get install -t icinga-${DIST}-snapshots icinga2
492 #### Ubuntu <a id="development-tests-snapshot-packages-ubuntu"></a>
496 apt-get -y install apt-transport-https wget gnupg
498 wget -O - https://packages.icinga.com/icinga.key | apt-key add -
500 . /etc/os-release; if [ ! -z ${UBUNTU_CODENAME+x} ]; then DIST="${UBUNTU_CODENAME}"; else DIST="$(lsb_release -c| awk '{print $2}')"; fi; \
501 echo "deb https://packages.icinga.com/ubuntu icinga-${DIST} main" > \
502 /etc/apt/sources.list.d/${DIST}-icinga.list
503 echo "deb-src https://packages.icinga.com/ubuntu icinga-${DIST} main" >> \
504 /etc/apt/sources.list.d/${DIST}-icinga.list
506 . /etc/os-release; if [ ! -z ${UBUNTU_CODENAME+x} ]; then DIST="${UBUNTU_CODENAME}"; else DIST="$(lsb_release -c| awk '{print $2}')"; fi; \
507 echo "deb https://packages.icinga.com/ubuntu icinga-${DIST}-snapshots main" > \
508 /etc/apt/sources.list.d/${DIST}-icinga-snapshots.list
509 echo "deb-src https://packages.icinga.com/ubuntu icinga-${DIST}-snapshots main" >> \
510 /etc/apt/sources.list.d/${DIST}-icinga-snapshots.list
515 Then install the snapshot packages.
518 . /etc/os-release; if [ ! -z ${UBUNTU_CODENAME+x} ]; then DIST="${UBUNTU_CODENAME}"; else DIST="$(lsb_release -c| awk '{print $2}')"; fi; \
519 apt-get install -t icinga-${DIST}-snapshots icinga2
522 #### SLES <a id="development-tests-snapshot-packages-sles"></a>
524 The required Boost packages are provided with the stable release repository.
527 rpm --import https://packages.icinga.com/icinga.key
529 zypper ar https://packages.icinga.com/SUSE/ICINGA-release.repo
532 zypper ar https://packages.icinga.com/SUSE/ICINGA-snapshot.repo
536 Selectively install the snapshot packages using the `-r` parameter.
539 zypper in -r icinga-snapshot-builds icinga2
543 ### Unit Tests <a id="development-tests-unit"></a>
545 Build the binaries and run the tests.
553 Run a specific boost test:
556 debug/Bin/Debug/boosttest-test-base --run_test=remote_url
561 ## Develop Icinga 2 <a id="development-develop"></a>
563 Icinga 2 can be built on many platforms such as Linux, Unix and Windows.
564 There are limitations in terms of support, e.g. Windows is only supported for agents,
565 not a full-featured master or satellite.
567 Before you start with actual development, there is a couple of pre-requisites.
569 ### Preparations <a id="development-develop-prepare"></a>
571 #### Choose your Editor <a id="development-develop-choose-editor"></a>
573 Icinga 2 can be developed with your favorite editor. Icinga developers prefer
577 - CLion (macOS, Linux)
578 - MS Visual Studio (Windows)
581 Editors differ on the functionality. The more helpers you get for C++ development,
582 the faster your development workflow will be.
584 #### Get to know the architecture <a id="development-develop-get-to-know-the-architecture"></a>
586 Icinga 2 can run standalone or in distributed environments. It contains a whole lot
587 more than a simple check execution engine.
589 Read more about it in the [Technical Concepts](19-technical-concepts.md#technical-concepts) chapter.
591 #### Get to know the code <a id="development-develop-get-to-know-the-code"></a>
593 First off, you really need to know C++ and portions of C++11 and the boost libraries.
594 Best is to start with a book or online tutorial to get into the basics.
595 Icinga developers gained their knowledge through studies, training and self-teaching
596 code by trying it out and asking senior developers for guidance.
598 Here's a few books we can recommend:
600 * [Accelerated C++: Practical Programming by Example](https://www.amazon.com/Accelerated-C-Practical-Programming-Example/dp/020170353X) (Andrew Koenig, Barbara E. Moo)
601 * [Effective C++](https://www.amazon.com/Effective-Specific-Improve-Programs-Designs/dp/0321334876) (Scott Meyers)
602 * [Boost C++ Application Development Cookbook - Second Edition: Recipes to simplify your application development](https://www.amazon.com/dp/1787282244/ref=cm_sw_em_r_mt_dp_U_dN1OCbERS00EQ) (Antony Polukhin)
603 * [Der C++ Programmierer](https://www.amazon.de/Programmierer-lernen-Professionell-anwenden-L%C3%B6sungen/dp/3446416447), German (Ulrich Breymann)
604 * [C++11 programmieren](https://www.amazon.de/gp/product/3836217325/), German (Torsten T. Will)
606 In addition, it is a good bet to also know SQL when diving into backend development.
608 * [SQL Performance Explained](https://www.amazon.de/gp/product/3950307826/) (Markus Winand)
610 Last but not least, if you are developing on Windows, get to know the internals about services and the Win32 API.
612 ### Design Patterns <a id="development-develop-design-patterns"></a>
614 Icinga 2 heavily relies on object-oriented programming and encapsulates common
615 functionality into classes and objects. It also uses modern programming techniques
616 to e.g. work with shared pointer memory management.
618 Icinga 2 consists of libraries bundled into the main binary. Therefore you'll
619 find many code parts in the `lib/` directory wheras the actual application is
620 built from `icinga-app/`. Accompanied with Icinga 2, there's the Windows plugins
621 which are standalone and compiled from `plugins/`.
623 Library | Description
624 ---------------|------------------------------------
625 base | Objects, values, types, streams, tockets, TLS, utilities, etc.
626 config | Configuration compiler, expressions, etc.
627 cli | CLI (sub) commands and helpers.
628 icinga | Icinga specific objects and event handling.
629 remote | Cluster and HTTP client/server and REST API related code.
630 checker | Checker feature, check scheduler.
631 notification | Notification feature, notification scheduler.
632 methods | Command execution methods, plugins and built-in checks.
633 perfdata | Performance data related, including Graphite, Elastic, etc.
634 db\_ido | IDO database abstraction layer.
635 db\_ido\_mysql | IDO database driver for MySQL.
636 db\_ido\_pgsql | IDO database driver for PgSQL.
637 mysql\_shin | Library stub for linking against the MySQL client libraries.
638 pgsql\_shim | Library stub for linking against the PgSQL client libraries.
640 #### Class Compiler <a id="development-develop-design-patterns-class-compiler"></a>
642 Another thing you will recognize are the `.ti` files which are compiled
643 by our own class compiler into actual source code. The meta language allows
644 developers to easily add object attributes and specify their behaviour.
646 Some object attributes need to be stored over restarts in the state file
647 and therefore have the `state` attribute set. Others are treated as `config`
648 attribute and automatically get configuration validation functions created.
649 Hidden or read-only REST API attributes are marked with `no_user_view` and
652 The most beneficial thing are getters and setters being generated. The actual object
653 inherits from `ObjectImpl<TYPE>` and therefore gets them "for free".
658 vim lib/perfdata/gelfwriter.ti
662 vim lib/perfdata/gelfwriter.cpp
664 if (GetEnableTls()) {
667 The logic is hidden in `tools/mkclass/` in case you want to learn more about it.
668 The first steps during CMake & make also tell you about code generation.
670 ### Build Tools <a id="development-develop-builds-tools"></a>
672 #### CMake <a id="development-develop-builds-cmake"></a>
674 In its early development stages in 2012, Icinga 2 was built with autoconf/automake
675 and separate Windows project files. We've found this very fragile, and have changed
676 this into CMake as our build tool.
678 The most common benefits:
680 * Everything is described in CMakeLists.txt in each directory
681 * CMake only needs to know that a sub directory needs to be included.
682 * The global CMakeLists.txt acts as main entry point for requirement checks and library/header includes.
683 * Separate binary build directories, the actual source tree stays clean.
684 * CMake automatically generates a Visual Studio project file `icinga2.sln` on Windows.
686 #### Unity Builds <a id="development-develop-builds-unity-builds"></a>
688 Another thing you should be aware of: Unity builds on and off.
690 Typically, we already use caching mechanisms to reduce recompile time with ccache.
691 For release builds, there's always a new build needed as the difference is huge compared
692 to a previous (major) release.
694 Therefore we've invented the Unity builds, which basically concatenates all source files
695 into one big library source code file. The compiler then doesn't need to load the many small
696 files but compiles and links this huge one.
698 Unity builds require more memory which is why you should disable them for development
699 builds in small sized VMs (Linux, Windows) and also Docker containers.
701 There's a couple of header files which are included everywhere. If you touch/edit them,
702 the cache is invalidated and you need to recompile a lot more files then. `base/utility.hpp`
703 and `remote/zone.hpp` are good candidates for this.
705 ### Unit Tests <a id="development-develop-tests"></a>
707 New functions and classes must implement new unit tests. Whenever
708 you decide to add new functions, ensure that you don't need a complex
709 mock or runtime attributes in order to test them. Better isolate
710 code into function interfaces which can be invoked in the Boost tests
713 Look into the existing tests in the [test/](https://github.com/Icinga/icinga2/tree/master/test) directory
714 and adopt new test cases.
716 Specific tests require special time windows, they are only
717 enabled in debug builds for developers. This is the case e.g.
718 for testing the flapping algorithm with expected state change
719 detection at a specific point from now.
722 ### Style Guide <a id="development-develop-styleguide"></a>
724 Overview of project files:
726 File Type | File Name/Extension | Description
727 ---------------|---------------------|-----------------------------
728 Header | .hpp | Classes, enums, typedefs inside the icinga Namespace.
729 Source | .cpp | Method implementation for class functions, static/global variables.
730 CMake | CMakeLists.txt | Build configuration, source and header file references.
731 CMake Source | .cmake | Source/Header files generated from CMake placeholders.
732 ITL/conf.d | .conf | Template library and example files as configuration
733 Class Compiler | .ti | Object classes in our own language, generates source code as `<filename>-ti.{c,h}pp`.
734 Lexer/Parser | .ll, .yy | Flex/Bison code generated into source code from CMake builds.
735 Docs | .md | Markdown docs and READMEs.
737 Anything else are additional tools and scripts for developers and build systems.
739 All files must include the copyright header. We don't use the
740 current year as this implies yearly updates we don't want.
742 Depending on the file type, this must be a comment.
745 /* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
747 # Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+
750 #### Code Formatting <a id="development-develop-code-formatting"></a>
752 We follow the clang format, with some exceptions.
754 - Curly braces for functions and classes always start at a new line.
757 String ConfigObjectUtility::EscapeName(const String& name)
762 String ConfigObjectUtility::CreateObjectConfig(const Type::Ptr& type, const String& fullName,
763 bool ignoreOnError, const Array::Ptr& templates, const Dictionary::Ptr& attrs)
769 - Too long lines break at a parameter, the new line needs a tab indent.
772 static String CreateObjectConfig(const Type::Ptr& type, const String& fullName,
773 bool ignoreOnError, const Array::Ptr& templates, const Dictionary::Ptr& attrs);
776 - Conditions require curly braces if it is not a single if with just one line.
790 - There's a space between `if` and the opening brace `(`. Also after the closing brace `)` and opening curly brace `{`.
791 - Negation with `!` doesn't need an extra space.
792 - Else branches always start in the same line after the closing curly brace.
795 #### Code Comments <a id="development-develop-code-comments"></a>
797 Add comments wherever you think that another developer will have a hard
798 time to understand the complex algorithm. Or you might have forgotten
799 it in a year and struggle again. Also use comments to highlight specific
800 stages in a function. Generally speaking, make things easier for the
801 team and external contributors.
803 Comments can also be used to mark additional references and TODOs.
804 If there is a specific GitHub issue or discussion going on,
805 use that information as a summary and link over to it on purpose.
807 - Single line comments may use `//` or `/* ... */`
808 - Multi line comments must use this format:
811 /* Ensure to check for XY
812 * This relies on the fact that ABC has been set before.
816 #### Function Docs <a id="development-develop-function-docs"></a>
818 Function header documentation must be added. The current code basis
819 needs rework, future functions must provide this.
821 Editors like CLion or Visual Studio allow you to type `/**` followed
822 by Enter and generate the skeleton from the implemented function.
824 Add a short summary in the first line about the function's purpose.
825 Edit the param section with short description on their intention.
826 The `return` value should describe the value type and additional details.
832 * Reads a message from the connected peer.
834 * @param stream ASIO TLS Stream
835 * @param yc Yield Context for ASIO
836 * @param maxMessageLength maximum size of bytes read.
838 * @return A JSON string
840 String JsonRpc::ReadMessage(const std::shared_ptr<AsioTlsStream>& stream, boost::asio::yield_context yc, ssize_t maxMessageLength)
843 While we can generate code docs from it, the main idea behind it is
844 to provide on-point docs to fully understand all parameters and the
845 function's purpose in the same spot.
848 #### Header <a id="development-develop-styleguide-header"></a>
850 Only include other headers which are mandatory for the header definitions.
851 If the source file requires additional headers, add them there to avoid
854 The included header order is important.
856 - First, include the library header `i2-<libraryname>.hpp`, e.g. `i2-base.hpp`.
857 - Second, include all headers from Icinga itself, e.g. `remote/apilistener.hpp`. `base` before `icinga` before `remote`, etc.
858 - Third, include third-party and external library headers, e.g. openssl and boost.
859 - Fourth, include STL headers.
861 #### Source <a id="development-develop-styleguide-source"></a>
863 The included header order is important.
865 - First, include the header whose methods are implemented.
866 - Second, include all headers from Icinga itself, e.g. `remote/apilistener.hpp`. `base` before `icinga` before `remote`, etc.
867 - Third, include third-party and external library headers, e.g. openssl and boost.
868 - Fourth, include STL headers.
870 Always use an empty line after the header include parts.
872 #### Namespace <a id="development-develop-styleguide-namespace"></a>
874 The icinga namespace is used globally, as otherwise we would need to write `icinga::Utility::FormatDateTime()`.
877 using namespace icinga;
880 Other namespaces must be declared in the scope they are used. Typically
881 this is inside the function where `boost::asio` and variants would
885 namespace ssl = boost::asio::ssl;
887 auto context (std::make_shared<ssl::context>(ssl::context::sslv23));
890 #### Functions <a id="development-develop-styleguide-functions"></a>
892 Ensure to pass values and pointers as const reference. By default, all
893 values will be copied into the function scope, and we want to avoid this
897 std::vector<EventQueue::Ptr> EventQueue::GetQueuesForType(const String& type)
900 C++ only allows to return a single value. This can be abstracted with
901 returning a specific class object, or with using a map/set. Array and
902 Dictionary objects increase the memory footprint, use them only where needed.
904 A common use case for Icinga value types is where a function can return
905 different values - an object, an array, a boolean, etc. This happens in the
906 inner parts of the config compiler expressions, or config validation.
908 The function caller is responsible to determine the correct value type
909 and handle possible errors.
911 Specific algorithms may require to populate a list, which can be passed
912 by reference to the function. The inner function can then append values.
913 Do not use a global shared resource here, unless this is locked by the caller.
916 #### Conditions and Cases <a id="development-develop-styleguide-conditions"></a>
918 Prefer if-else-if-else branches. When integers are involved,
919 switch-case statements increase readability. Don't forget about `break` though!
921 Avoid using ternary operators where possible. Putting a condition
922 after an assignment complicates reading the source. The compiler
923 optimizes this anyways.
928 int res = s == "OK" ? 0 : s == "WARNING" ? 1;
940 } else if (s == "WARNING") {
945 Even better: Create a lookup map instead of if branches. The complexity
946 is reduced to O(log(n)).
949 std::map<String, unsigned int> stateMap = {
954 auto it = stateMap.find(s);
956 if (it == stateMap.end()) {
963 The code is not as short as with a ternary operator, but one can re-use
964 this design pattern for other generic definitions with e.g. moving the
965 lookup into a utility class.
967 Once a unit test is written, everything works as expected in the future.
969 #### Locks and Guards <a id="development-develop-locks-guards"></a>
971 Lock access to resources where multiple threads can read and write.
972 Icinga objects can be locked with the `ObjectLock` class.
974 Object locks and guards must be limited to the scope where they are needed. Otherwise we could create dead locks.
978 ObjectLock olock(frame.Locals);
979 for (const Dictionary::Pair& kv : frame.Locals) {
980 AddSuggestion(matches, word, kv.first);
985 #### Objects and Pointers <a id="development-develop-objects-pointers"></a>
987 Use shared pointers for objects. Icinga objects implement the `Ptr`
988 typedef returning an `intrusive_ptr` for the class object (object.hpp).
989 This also ensures reference counting for the object's lifetime.
991 Use raw pointers with care!
993 Some methods and classes require specific shared pointers, especially
994 when interacting with the Boost library.
996 #### Value Types <a id="development-develop-styleguide-value-types"></a>
998 Icinga has its own value types. These provide methods to allow
999 generic serialization into JSON for example, and other type methods
1000 which are made available in the DSL too.
1002 - Always use `String` instead of `std::string`. If you need a C-string, use the `CStr()` method.
1003 - Avoid casts and rather use the `Convert` class methods.
1006 double s = static_cast<double>(v); //Wrong
1008 double s = Convert::ToDouble(v); //Correct, ToDouble also provides overloads with different value types
1011 - Prefer STL containers for internal non-user interfaces. Icinga value types add a small overhead which may decrease performance if e.g. the function is called 100k times.
1012 - `Array::FromVector` and variants implement conversions, use them.
1014 #### Utilities <a id="development-develop-styleguide-utilities"></a>
1016 Don't re-invent the wheel. The `Utility` class provides
1017 many helper functions which allow you e.g. to format unix timestamps,
1018 search in filesystem paths.
1020 Also inspect the Icinga objects, they also provide helper functions
1021 for formatting, splitting strings, joining arrays into strings, etc.
1023 #### Libraries <a id="development-develop-styleguide-libraries"></a>
1025 2.11 depends on [Boost 1.66](https://www.boost.org/doc/libs/1_66_0/).
1026 Use the existing libraries and header-only includes
1027 for this specific version.
1029 Note: Prefer C++11 features where possible, e.g. std::atomic and lambda functions.
1033 - [exception](https://www.boost.org/doc/libs/1_66_0/libs/exception/doc/boost-exception.html) (header only)
1034 - [algorithm](https://www.boost.org/doc/libs/1_66_0/libs/algorithm/doc/html/index.html) (header only)
1035 - [lexical_cast](https://www.boost.org/doc/libs/1_66_0/doc/html/boost_lexical_cast.html) (header only)
1036 - [regex](https://www.boost.org/doc/libs/1_66_0/libs/regex/doc/html/index.html)
1037 - [uuid](https://www.boost.org/doc/libs/1_66_0/libs/uuid/doc/uuid.html) (header only)
1038 - [range](https://www.boost.org/doc/libs/1_66_0/libs/range/doc/html/index.html) (header only)
1039 - [variant](https://www.boost.org/doc/libs/1_66_0/doc/html/variant.html) (header only)
1040 - [multi_index](https://www.boost.org/doc/libs/1_66_0/libs/multi_index/doc/index.html) (header only)
1041 - [function_types](https://www.boost.org/doc/libs/1_66_0/libs/function_types/doc/html/index.html) (header only)
1042 - [circular_buffer](https://www.boost.org/doc/libs/1_66_0/doc/html/circular_buffer.html) (header only)
1043 - [math](https://www.boost.org/doc/libs/1_66_0/libs/math/doc/html/index.html) (header only)
1047 - [system](https://www.boost.org/doc/libs/1_66_0/libs/system/doc/index.html)
1048 - [thread](https://www.boost.org/doc/libs/1_66_0/doc/html/thread.html)
1049 - [signals2](https://www.boost.org/doc/libs/1_66_0/doc/html/signals2.html) (header only)
1050 - [program_options](https://www.boost.org/doc/libs/1_66_0/doc/html/program_options.html)
1051 - [date_time](https://www.boost.org/doc/libs/1_66_0/doc/html/date_time.html)
1052 - [filesystem](https://www.boost.org/doc/libs/1_66_0/libs/filesystem/doc/index.htm)
1056 - [asio](https://www.boost.org/doc/libs/1_66_0/doc/html/boost_asio.html) (header only)
1057 - [beast](https://www.boost.org/doc/libs/1_66_0/libs/beast/doc/html/index.html) (header only)
1058 - [coroutine](https://www.boost.org/doc/libs/1_66_0/libs/coroutine/doc/html/index.html)
1059 - [context](https://www.boost.org/doc/libs/1_66_0/libs/context/doc/html/index.html)
1061 Consider abstracting their usage into `*utility.{c,h}pp` files with
1062 wrapping existing Icinga types. That also allows later changes without
1063 rewriting large code parts.
1067 > A new Boost library should be explained in a PR and discussed with the team.
1069 > This requires package dependency changes.
1071 If you consider an external library or code to be included with Icinga, the following
1072 requirements must be fulfilled:
1074 - License is compatible with GPLv2+. Boost license, MIT works, Apache is not.
1075 - C++11 is supported, C++14 or later doesn't work
1076 - Header only implementations are preferred, external libraries require packages on every distribution.
1077 - No additional frameworks, Boost is the only allowed.
1078 - The code is proven to be robust and the GitHub repository is alive, or has 1k+ stars. Good libraries also provide a user list, if e.g. Ceph is using it, this is a good candidate.
1081 #### Log <a id="development-develop-styleguide-log"></a>
1083 Icinga allows the user to configure logging backends, e.g. syslog or file.
1085 Any log message inside the code must use the `Log()` function.
1087 - The first parameter is the severity level, use them with care.
1088 - The second parameter defines the location/scope where the log
1089 happened. Typically we use the class name here, to better analyse
1090 the logs the user provide in GitHub issues and on the community
1092 - The third parameter takes a log message string
1094 If the message string needs to be computed from existing values,
1095 everything must be converted to the String type beforehand.
1096 This conversion for every value is very expensive which is why
1099 Instead, use Log() with the shift operator where everything is written
1100 on the stream and conversions are explicitly done with templates
1103 The trick here is that the Log object is destroyed immediately
1104 after being constructed once. The destructor actually
1105 evaluates the values and sends it to registers loggers.
1107 Since flushing the stream every time a log entry occurs is
1108 very expensive, a timer takes care of flushing the stream
1113 > If logging stopped, the flush timer thread may be dead.
1114 > Inspect that with gdb/lldb.
1116 Avoid log messages which could irritate the user. During
1117 implementation, developers can change log levels to better
1118 see what's going one, but remember to change this back to `debug`
1119 or remove it entirely.
1122 #### Goto <a id="development-develop-styleguide-goto"></a>
1124 Avoid using `goto` statements. There are rare occasions where
1127 - The code would become overly complicated within nested loops and conditions.
1128 - Event processing and C interfaces.
1129 - Question/Answer loops within interactive CLI commands.
1131 #### Typedef and Auto Keywords <a id="development-develop-styleguide-typedef-auto"></a>
1133 Typedefs allow developers to use shorter names for specific types,
1134 classes and structs.
1137 typedef std::map<String, std::shared_ptr<NamespaceValue> >::iterator Iterator;
1140 These typedefs should be part of the Class definition in the header,
1141 or may be defined in the source scope where they are needed.
1143 Avoid declaring global typedefs, unless necessary.
1145 Using the `auto` keyword allows to ignore a specific value type.
1146 This comes in handy with maps/sets where no specific access
1149 The following example iterates over a map returned from `GetTypes()`.
1152 for (const auto& kv : GetTypes()) {
1153 result.insert(kv.second);
1157 The long example would require us to define a map iterator, and a slightly
1158 different algorithm.
1161 typedef std::map<String, DbType::Ptr> TypeMap;
1162 typedef std::map<String, DbType::Ptr>::const_iterator TypeMapIterator;
1164 TypeMap types = GetTypes();
1166 for (TypeMapIterator it = types.begin(); it != types.end(); it++) {
1167 result.insert(it.second);
1171 We could also use a pair here, but requiring to know
1172 the specific types of the map keys and values.
1175 typedef std::pair<String, DbType::Ptr> kv_pair;
1177 for (const kv_pair& kv : GetTypes()) {
1178 result.insert(kv.second);
1182 After all, `auto` shortens the code and one does not always need to know
1183 about the specific types. Function documentation for `GetTypes()` is
1188 #### Whitespace Cleanup <a id="development-develop-choose-editor-whitespaces"></a>
1190 Patches must be cleaned up and follow the indent style (tabs instead of spaces).
1191 You should also remove any trailing whitespaces.
1193 `git diff` allows to highlight such.
1196 vim $HOME/.gitconfig
1199 whitespace = red reverse
1201 whitespace=fix,-indent-with-non-tab,trailing-space,cr-at-eol
1204 `vim` also can match these and visually alert you to remove them.
1209 highlight ExtraWhitespace ctermbg=red guibg=red
1210 match ExtraWhitespace /\s\+$/
1211 autocmd BufWinEnter * match ExtraWhitespace /\s\+$/
1212 autocmd InsertEnter * match ExtraWhitespace /\s\+\%#\@<!$/
1213 autocmd InsertLeave * match ExtraWhitespace /\s\+$/
1214 autocmd BufWinLeave * call clearmatches()
1218 ## Development Environment <a id="development-environment"></a>
1220 ### Linux Dev Environment <a id="development-linux-dev-env"></a>
1222 Based on CentOS 7, we have an early draft available inside the Icinga Vagrant boxes:
1223 [centos7-dev](https://github.com/Icinga/icinga-vagrant/tree/master/centos7-dev).
1225 If you're compiling Icinga 2 natively without any virtualization layer in between,
1226 this usually is faster. This is also the reason why developers on macOS prefer native builds
1227 over Linux or Windows VMs. Don't forget to test the actual code on Linux later! Socket specific
1228 stuff like `epoll` is not available on Unix kernels.
1230 Depending on your workstation and environment, you may either develop and run locally,
1231 use a container deployment pipeline or put everything in a high end resource remote VM.
1233 Fork https://github.com/Icinga/icinga2 into your own repository, e.g. `https://github.com/dnsmichi/icinga2`.
1235 Create two build directories for different binary builds.
1237 * `debug` contains the debug build binaries. They contain more debug information and run tremendously slower than release builds from packages. Don't use them for benchmarks.
1238 * `release` contains the release build binaries, as you would install them on a live system. This helps comparing specific scenarios for race conditions and more.
1241 mkdir -p release debug
1244 Proceed with the specific distribution examples below.
1246 * [CentOS 7](21-development.md#development-linux-dev-env-centos)
1247 * [Debian 9](21-development.md#development-linux-dev-env-debian)
1250 #### CentOS 7 <a id="development-linux-dev-env-centos"></a>
1253 yum -y install gdb git bash-completion htop rpmdevtools \
1254 ccache cmake make gcc-c++ flex bison \
1255 openssl-devel boost-devel systemd-devel mysql-devel \
1256 postgresql-devel libedit-devel libstdc++-devel
1260 useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
1262 ln -s /bin/ccache /usr/local/bin/gcc
1263 ln -s /bin/ccache /usr/local/bin/g++
1265 git clone https://github.com/icinga/icinga2.git && cd icinga2
1269 cmake .. -DCMAKE_BUILD_TYPE=Debug -DICINGA2_UNITY_BUILD=OFF -DCMAKE_INSTALL_PREFIX=/usr/local/icinga2 -DICINGA2_PLUGINDIR=/usr/local/sbin
1271 make -j2 install -C debug
1276 chown -R icinga:icinga /usr/local/icinga2/var/
1278 /usr/local/icinga2/lib/icinga2/prepare-dirs /usr/local/icinga2/etc/sysconfig/icinga2
1279 /usr/local/icinga2/sbin/icinga2 api setup
1280 vim /usr/local/icinga2/etc/icinga2/conf.d/api-users.conf
1282 gdb --args /usr/local/icinga2/lib/icinga2/sbin/icinga2 daemon
1285 #### Debian 9 <a id="development-linux-dev-env-debian"></a>
1288 apt-get -y install gdb vim git cmake make ccache build-essential libssl-dev libboost-all-dev bison flex default-libmysqlclient-dev libpq-dev libedit-dev monitoring-plugins
1290 ln -s /usr/bin/ccache /usr/local/bin/gcc
1291 ln -s /usr/bin/ccache /usr/local/bin/g++
1295 useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
1297 git clone https://github.com/icinga/icinga2.git && cd icinga2
1301 cmake .. -DCMAKE_BUILD_TYPE=Debug -DICINGA2_UNITY_BUILD=OFF -DCMAKE_INSTALL_PREFIX=/usr/local/icinga2 -DICINGA2_PLUGINDIR=/usr/local/sbin
1303 make -j2 install -C debug
1308 chown -R icinga:icinga /usr/local/icinga2/var/
1310 /usr/local/icinga2/lib/icinga2/prepare-dirs /usr/local/icinga2/etc/sysconfig/icinga2
1311 /usr/local/icinga2/sbin/icinga2 api setup
1312 vim /usr/local/icinga2/etc/icinga2/conf.d/api-users.conf
1314 gdb --args /usr/local/icinga2/lib/icinga2/sbin/icinga2 daemon
1318 #### Ubuntu 18 Bionic <a id="development-linux-dev-env-ubuntu"></a>
1320 Requires Boost packages from packages.icinga.com.
1323 $ docker run -ti ubuntu:bionic bash
1326 apt-get -y install apt-transport-https wget gnupg
1328 wget -O - https://packages.icinga.com/icinga.key | apt-key add -
1330 . /etc/os-release; if [ ! -z ${UBUNTU_CODENAME+x} ]; then DIST="${UBUNTU_CODENAME}"; else DIST="$(lsb_release -c| awk '{print $2}')"; fi; \
1331 echo "deb https://packages.icinga.com/ubuntu icinga-${DIST} main" > \
1332 /etc/apt/sources.list.d/${DIST}-icinga.list
1333 echo "deb-src https://packages.icinga.com/ubuntu icinga-${DIST} main" >> \
1334 /etc/apt/sources.list.d/${DIST}-icinga.list
1340 apt-get -y install gdb vim git cmake make ccache build-essential libssl-dev bison flex default-libmysqlclient-dev libpq-dev libedit-dev monitoring-plugins
1342 apt-get install -y libboost1.67-icinga-all-dev
1344 ln -s /usr/bin/ccache /usr/local/bin/gcc
1345 ln -s /usr/bin/ccache /usr/local/bin/g++
1349 useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
1351 git clone https://github.com/icinga/icinga2.git && cd icinga2
1355 export I2_DEB="-DBoost_NO_BOOST_CMAKE=TRUE -DBoost_NO_SYSTEM_PATHS=TRUE -DBOOST_LIBRARYDIR=/usr/lib/x86_64-linux-gnu/icinga-boost -DBOOST_INCLUDEDIR=/usr/include/icinga-boost -DCMAKE_INSTALL_RPATH=/usr/lib/x86_64-linux-gnu/icinga-boost"
1356 export I2_GENERIC="-DCMAKE_INSTALL_PREFIX=/usr/local/icinga2 -DICINGA2_PLUGINDIR=/usr/local/sbin"
1357 export I2_DEBUG="$I2_DEB $I2_GENERIC -DCMAKE_BUILD_TYPE=Debug -DICINGA2_UNITY_BUILD=OFF"
1365 make -j2 install -C debug
1370 chown -R icinga:icinga /usr/local/icinga2/var/
1372 /usr/local/icinga2/lib/icinga2/prepare-dirs /usr/local/icinga2/etc/sysconfig/icinga2
1373 /usr/local/icinga2/sbin/icinga2 api setup
1374 vim /usr/local/icinga2/etc/icinga2/conf.d/api-users.conf
1376 gdb --args /usr/local/icinga2/lib/icinga2/sbin/icinga2 daemon
1379 ### macOS Dev Environment <a id="development-macos-dev-env"></a>
1381 It is advised to use Homebrew to install required build dependencies.
1382 Macports have been reported to work as well, typically you'll get more help
1383 with Homebrew from Icinga developers.
1385 The idea is to run Icinga with the current user, avoiding root permissions.
1386 This requires at least v2.11.
1390 > This is a pure development setup for Icinga developers reducing the compile
1391 > time in contrast to VMs. There are no packages, startup scripts or dependency management involved.
1393 > **macOS agents are not officially supported.**
1395 > macOS uses its own TLS implementation, Icinga relies on extra OpenSSL packages
1396 > requiring updates apart from vendor security updates.
1400 OpenSSL 1.0.x doesn't build anymore, so we're explicitly using 1.1.x here.
1403 brew install ccache boost cmake bison flex openssl@1.1 mysql-connector-c++ postgresql libpq
1409 sudo mkdir /opt/ccache
1411 sudo ln -s `which ccache` /opt/ccache/clang
1412 sudo ln -s `which ccache` /opt/ccache/clang++
1414 vim $HOME/.bash_profile
1416 # ccache is managed with symlinks to avoid collision with cgo
1417 export PATH="/opt/ccache:$PATH"
1419 source $HOME/.bash_profile
1424 Icinga is built as release (optimized build for packages) and debug (more symbols and details for debugging). Debug builds
1425 typically run slower than release builds and must not be used for performance benchmarks.
1427 The preferred installation prefix is `/usr/local/icinga/icinga2`. This allows to put e.g. Icinga Web 2 into the `/usr/local/icinga` directory as well.
1430 mkdir -p release debug
1432 export I2_USER=$(id -u -n)
1433 export I2_GROUP=$(id -g -n)
1434 export I2_GENERIC="-DCMAKE_INSTALL_PREFIX=/usr/local/icinga/icinga2 -DICINGA2_USER=$I2_USER -DICINGA2_GROUP=$I2_GROUP -DOPENSSL_INCLUDE_DIR=/usr/local/opt/openssl@1.1/include -DOPENSSL_SSL_LIBRARY=/usr/local/opt/openssl@1.1/lib/libssl.dylib -DOPENSSL_CRYPTO_LIBRARY=/usr/local/opt/openssl@1.1/lib/libcrypto.dylib -DICINGA2_PLUGINDIR=/usr/local/sbin -DICINGA2_WITH_PGSQL=OFF -DCMAKE_EXPORT_COMPILE_COMMANDS=ON"
1435 export I2_DEBUG="-DCMAKE_BUILD_TYPE=Debug -DICINGA2_UNITY_BUILD=OFF $I2_GENERIC"
1436 export I2_RELEASE="-DCMAKE_BUILD_TYPE=RelWithDebInfo -DICINGA2_WITH_TESTS=ON -DICINGA2_UNITY_BUILD=ON $I2_GENERIC"
1443 make -j4 install -C debug
1446 In order to run Icinga without any path prefix, and also use Bash completion it is advised to source additional
1447 things into the local dev environment.
1450 export PATH=/usr/local/icinga/icinga2/sbin/:$PATH
1452 test -f /usr/local/icinga/icinga2/etc/bash_completion.d/icinga2 && source /usr/local/icinga/icinga2/etc/bash_completion.d/icinga2
1457 This is derived from [dnsmichi's flavour](https://github.com/dnsmichi/dotfiles) and not generally best practice.
1460 vim $HOME/.bash_profile
1462 export I2_USER=$(id -u -n)
1463 export I2_GROUP=$(id -g -n)
1464 export I2_GENERIC="-DCMAKE_INSTALL_PREFIX=/usr/local/icinga/icinga2 -DICINGA2_USER=$I2_USER -DICINGA2_GROUP=$I2_GROUP -DOPENSSL_INCLUDE_DIR=/usr/local/opt/openssl@1.1/include -DOPENSSL_SSL_LIBRARY=/usr/local/opt/openssl@1.1/lib/libssl.dylib -DOPENSSL_CRYPTO_LIBRARY=/usr/local/opt/openssl@1.1/lib/libcrypto.dylib -DICINGA2_PLUGINDIR=/usr/local/sbin -DICINGA2_WITH_PGSQL=OFF -DCMAKE_EXPORT_COMPILE_COMMANDS=ON"
1466 export I2_DEBUG="-DCMAKE_BUILD_TYPE=Debug -DICINGA2_UNITY_BUILD=OFF $I2_GENERIC"
1467 export I2_RELEASE="-DCMAKE_BUILD_TYPE=RelWithDebInfo -DICINGA2_WITH_TESTS=ON -DICINGA2_UNITY_BUILD=ON $I2_GENERIC"
1469 alias i2_debug="mkdir -p debug; cd debug; cmake $I2_DEBUG ..; make -j4; make -j4 install; cd .."
1470 alias i2_release="mkdir -p release; cd release; cmake $I2_RELEASE ..; make -j4; make -j4 install; cd .."
1472 export PATH=/usr/local/icinga/icinga2/sbin/:$PATH
1473 test -f /usr/local/icinga/icinga2/etc/bash_completion.d/icinga2 && source /usr/local/icinga/icinga2/etc/bash_completion.d/icinga2
1476 source $HOME/.bash_profile
1481 `make install` doesn't set all required permissions, override this.
1484 chown -R $I2_USER:$I2_GROUP /usr/local/icinga/icinga2
1489 Start Icinga in foreground.
1495 Reloads triggered with HUP or cluster syncs just put the process into background.
1500 brew install monitoring-plugins
1502 sudo vim /usr/local/icinga/icinga2/etc/icinga2/constants.conf
1503 const PluginDir = "/usr/local/sbin"
1506 #### Backends: Redis
1510 brew services start redis
1513 #### Databases: MariaDB
1516 brew install mariadb
1517 mkdir -p /usr/local/etc/my.cnf.d
1518 brew services start mariadb
1520 mysql_secure_installation
1528 password = supersecurerootpassword
1531 ln -s /Users/michi/.my.cnf $HOME/.my.cnf
1536 mysql -e 'create database icinga;'
1537 mysql -e "grant all on icinga.* to 'icinga'@'localhost' identified by 'icinga';"
1538 mysql icinga < $HOME/dev/icinga/icinga2/lib/db_ido_mysql/schema/mysql.sql
1545 cd /usr/local/icinga/icinga2/var/lib/icinga2/certs
1546 HOST_NAME=mbpmif.int.netways.de
1547 icinga2 pki new-cert --cn ${HOST_NAME} --csr ${HOST_NAME}.csr --key ${HOST_NAME}.key
1548 icinga2 pki sign-csr --csr ${HOST_NAME}.csr --cert ${HOST_NAME}.crt
1549 echo "const NodeName = \"${HOST_NAME}\"" >> /usr/local/icinga/icinga2/etc/icinga2/constants.conf
1554 While it is recommended to use Docker or the Icinga Web 2 development VM pointing to the shared IDO database resource/REST API, you can also install it locally on macOS.
1556 The required steps are described in [this script](https://github.com/dnsmichi/dotfiles/blob/master/icingaweb2.sh).
1558 ### Windows Dev Environment <a id="development-windows-dev-env"></a>
1560 The following sections explain how to setup the required build tools
1561 and how to run and debug the code.
1565 Open an administrative command prompt (Win key, type “cmd”, right-click and “run as administrator”) and paste the following instructions:
1568 @powershell -NoProfile -ExecutionPolicy Bypass -Command "iex ((new-object net.webclient).DownloadString('https://chocolatey.org/install.ps1'))" && SET PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin
1571 In case you are used to `vim`, start a new administrative Powershell and run `choco install -y vim`.
1576 Thanks to Microsoft they’ll now provide their Professional Edition of Visual Studio 2017
1577 as community version, free for use for open source projects such as Icinga.
1578 The installation requires ~9GB disk space. [Download](https://www.visualstudio.com/downloads/)
1579 the web installer and start the installation.
1581 You need a free Microsoft account to download and also store your preferences.
1583 Install the following Workloads:
1588 In addition also choose these individual components on Visual Studio 2017:
1591 * .NET Framework 4.6 targeting pack
1592 * .NET Framework 4.6.1 SDK
1593 * .NET Framework 4.6.1 targeting pack
1596 * Static analysis tools
1597 * GitHub Extension for Visual Studio
1598 * Compilers, build tools and runtimes
1599 * C# and Visual Basic Roslyn compilers
1601 * VC++ 2017 v141 toolset (x86_64)
1602 * Debugging and testing
1603 * C++ profiling tools
1604 * Just-in-Time debugger
1605 * Development activities
1606 * Visual Studio C++ core features
1607 * Games and Graphics
1608 * Graphics debugger and GPU profiler for DirectX (required by C++ profiling tools)
1609 * SDKs, libraries and frameworks
1610 * Graphics Tools Windows 8.1 SDK (required by C++ profiling tools)
1611 * Windows 10 SDK **10.0.10240.0 - exactly this version**
1613 * Windows Universal C Runtime
1615 After a while, Visual Studio will be ready.
1619 Install it using [chocolatey](https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html):
1622 choco install -y winflexbison
1625 Chocolatey installs these tools into the hidden directory `C:\ProgramData\chocolatey\lib\winflexbison\tools`.
1629 Icinga 2 requires the OpenSSL library. [Download](http://slproweb.com/products/Win32OpenSSL.html)
1630 and install it into the default path.
1632 Install both, 32 and 64 bit variants.
1634 Once asked for `Copy OpenSSLs DLLs to` select `The Windows system directory`. That way CMake/Visual Studio
1635 will automatically detect them for builds and packaging.
1639 > We cannot use the chocolatey package as this one does not provide any development headers.
1641 > Choose 1.1.1 LTS from manual downloads for best compatibility.
1645 In order to use the boost development header and library files you need to [download](http://www.boost.org/users/download/)
1646 Boost and then extract it to e.g. `C:\boost_1_69_0`.
1650 > Just use `C:`, the zip file already contains the sub folder. Extraction takes a while,
1651 > the archive contains more than 70k files.
1653 In order to integrate Boost into Visual Studio 2017, open the `Developer Command Prompt` from the start menu,
1654 and navigate to `C:\boost_1_69_0`.
1656 Execute `bootstrap.bat` first.
1663 Once finished, specify the required `toolset` to compile boost against Visual Studio.
1664 This takes quite some time in a Windows VM. Boost Context uses Assembler code,
1665 which isn't treated as exception safe by the VS compiler. Therefore set the
1666 additional compilation flag according to [this entry](https://lists.boost.org/Archives/boost/2015/08/224570.php).
1669 b2 --toolset=msvc-14.1 asmflags=\safeseh
1672 ![Windows Boost Build in VS2017 Development Console](images/development/windows_boost_build_dev_cmd.png)
1676 TortoiseGit provides a graphical integration into the Windows explorer. This makes it easier to checkout, commit
1679 [Download](https://tortoisegit.org/download/) TortoiseGit on your system.
1681 In order to clone via Git SSH you also need to create a new directory called `.ssh`
1682 inside your user's home directory.
1683 Therefore open a command prompt (win key, type `cmd`, enter) and run `mkdir .ssh`.
1684 Add your `id_rsa` private key and `id_rsa.pub` public key files into that directory.
1686 Start the setup routine and choose `OpenSSH` as default secure transport when asked.
1688 Open a Windows Explorer window and navigate into
1691 cd %HOMEPATH%\source\repos
1694 Right click and select `Git Clone` from the context menu.
1696 Use `ssh://git@github.com/icinga/icinga2.git` for SSH clones, `https://github.com/icinga/icinga2.git` otherwise.
1700 CMake uses CPack and NSIS to create the setup executable including all binaries and libraries
1701 in addition to setup dialogues and configuration. Therefore we’ll need to install [NSIS](http://nsis.sourceforge.net/Download)
1704 We also need to install the Windows Installer XML (WIX) toolset.
1707 choco install -y wixtoolset
1712 Icinga 2 uses CMake to manage the build environment. You can generate the Visual Studio project files
1713 using CMake. [Download](https://cmake.org/download/) and install CMake. Select to add it to PATH for all users
1718 > In order to properly detect the Boost libraries, install the CMake 3.14+.
1720 Once setup is completed, open a command prompt and navigate to
1723 cd %HOMEPATH%\source\repos
1726 Build Icinga with specific CMake variables. This generates a new Visual Studio project file called `icinga2.sln`.
1728 You need to specify the previously installed component paths:
1730 Variable | Value | Description
1731 ----------------------|----------------------------------------------------------------------|-------------------------------------------------------
1732 `BOOST_ROOT` | `C:\boost_1_69_0` | Root path where you've extracted and compiled Boost.
1733 `BOOST_LIBRARYDIR` | `C:\boost_1_69_0\stage` | Path to the static compiled Boost libraries, directory must contain `lib`.
1734 `BISON_EXECUTABLE` | `C:\ProgramData\chocolatey\lib\winflexbison\tools\win_bison.exe` | Path to the Bison executable.
1735 `FLEX_EXECUTABLE` | `C:\ProgramData\chocolatey\lib\winflexbison\tools\win_flex.exe` | Path to the Flex executable.
1736 `ICINGA2_WITH_MYSQL` | OFF | Requires extra setup for MySQL if set to `ON`. Not supported for client setups.
1737 `ICINGA2_WITH_PGSQL` | OFF | Requires extra setup for PgSQL if set to `ON`. Not supported for client setups.
1738 `ICINGA2_UNITY_BUILD` | OFF | Disable unity builds for development environments.
1740 Tip: If you have previously opened a terminal, run `refreshenv` to re-read updated PATH variables.
1744 Icinga provides the build scripts inside the Git repository.
1746 Open a new Powershell and navigate into the cloned Git repository. Set
1747 specific environment variables and run the build scripts.
1750 cd %HOMEPATH%\source\repos
1752 $env:ICINGA2_BUILDPATH='debug'
1753 $env:CMAKE_BUILD_TYPE='Debug'
1754 $env:OPENSSL_ROOT_DIR='C:\OpenSSL-Win64'
1755 $env:BOOST_ROOT='C:\boost_1_69_0'
1756 $env:BOOST_LIBRARYDIR='C:\boost_1_69_0\stage'
1758 .\tools\win32\configure.ps1
1759 .\tools\win32\build.ps1
1760 .\tools\win32\test.ps1
1765 > You may need to modify `configure.ps1` and
1766 > add a changed CMake variable for the installation
1767 > prefix: `-DCMAKE_INSTALL_PREFIX="C:\Program Files\Icinga2-build"`.
1769 #### Icinga 2 in Visual Studio
1774 cd %HOMEPATH%\source\repos\icinga2
1777 Open `icinga2.sln`. Log into Visual Studio when asked.
1779 On the right panel, select to build the `Bin/icinga-app` solution.
1781 The executable binaries are located in `Bin\Release\Debug` in your `icinga2`
1784 Navigate there and run `icinga2.exe --version`.
1787 cd %HOMEPATH%\source\repos\icinga2\Bin\Release\Debug
1788 icinga2.exe --version
1792 #### Release Package
1794 This is part of the build process script already.
1798 > You may need to modify `configure.ps1` and
1799 > add a changed CMake variable for the installation
1800 > prefix: `-DCMAKE_INSTALL_PREFIX="C:\Program Files\Icinga2-build"`.
1803 cd %HOMEPATH%\source\repos
1805 $env:ICINGA2_BUILDPATH='debug'
1806 $env:CMAKE_BUILD_TYPE='Debug'
1807 $env:OPENSSL_ROOT_DIR='C:\OpenSSL-Win64'
1808 $env:BOOST_ROOT='C:\boost_1_69_0'
1809 $env:BOOST_LIBRARYDIR='C:\boost_1_69_0\stage'
1811 .\tools\win32\configure.ps1
1812 .\tools\win32\build.ps1
1813 .\tools\win32\test.ps1
1818 ### Embedded Dev Env: Pi <a id="development-embedded-dev-env"></a>
1822 > This isn't officially supported yet, just a few hints how you can do it yourself.
1824 The following examples source from armhf on Raspberry Pi.
1829 apt install -y ccache
1831 /usr/sbin/update-ccache-symlinks
1833 echo 'export PATH="/usr/lib/ccache:$PATH"' | tee -a ~/.bashrc
1835 source ~/.bashrc && echo $PATH
1840 Copy the icinga2 source code into `$HOME/icinga2`. Clone the `deb-icinga2` repository into `debian/`.
1843 git clone https://github.com/Icinga/icinga2 $HOME/icinga2
1844 git clone https://github.com/Icinga/deb-icinga2 $HOME/icinga2/debian
1847 Then build a Debian package and install it like normal.
1849 dpkg-buildpackage -uc -us
1852 ## Package Builds <a id="development-package-builds"></a>
1854 This documentation is explicitly meant for packagers and the Icinga
1855 build infrastructure.
1857 The following requirements need to be fulfilled in order to build the
1858 Icinga application using a dist tarball (including notes for distributions):
1861 * GNU make (make) or ninja-build
1862 * C++ compiler which supports C++11
1863 * RHEL/Fedora/SUSE: gcc-c++ >= 4.7 (extra Developer Tools on RHEL5/6 see below)
1864 * Debian/Ubuntu: build-essential
1865 * Alpine: build-base
1866 * you can also use clang++
1868 * OpenSSL library and header files >= 1.0.1
1869 * RHEL/Fedora: openssl-devel
1870 * SUSE: libopenssl-devel
1871 * Debian/Ubuntu: libssl-dev
1872 * Alpine: libressl-dev
1873 * Boost library and header files >= 1.66.0
1874 * RHEL/Fedora: boost166-devel
1875 * Debian/Ubuntu: libboost-all-dev
1878 * GNU flex (flex) >= 2.5.35
1880 * Only required when using systemd
1881 * Debian/Ubuntu: libsystemd-dev
1882 * RHEL/Fedora: systemd-devel
1884 ### Optional features <a id="development-package-builds-optional-features"></a>
1886 * MySQL (disable with CMake variable `ICINGA2_WITH_MYSQL` to `OFF`)
1887 * RHEL/Fedora: mysql-devel
1888 * SUSE: libmysqlclient-devel
1889 * Debian/Ubuntu: default-libmysqlclient-dev | libmysqlclient-dev
1890 * Alpine: mariadb-dev
1891 * PostgreSQL (disable with CMake variable `ICINGA2_WITH_PGSQL` to `OFF`)
1892 * RHEL/Fedora: postgresql-devel
1893 * Debian/Ubuntu: libpq-dev
1894 * postgresql-dev on Alpine
1895 * libedit (CLI console)
1896 * RHEL/Fedora: libedit-devel on CentOS (RHEL requires rhel-7-server-optional-rpms)
1897 * Debian/Ubuntu/Alpine: libedit-dev
1898 * Termcap (only required if libedit doesn't already link against termcap/ncurses)
1899 * RHEL/Fedora: libtermcap-devel
1900 * Debian/Ubuntu: (not necessary)
1902 ### Special requirements <a id="development-package-builds-special-requirements"></a>
1904 **FreeBSD**: libexecinfo (automatically used when Icinga 2 is installed via port or package)
1906 **RHEL6**: Requires a newer boost version which is available on packages.icinga.com
1907 with a version suffixed name.
1909 ### Runtime user environment <a id="development-package-builds-runtime-user-env"></a>
1911 By default Icinga will run as user `icinga` and group `icinga`. Additionally the
1912 external command pipe and livestatus features require a dedicated command group
1913 `icingacmd`. You can choose your own user/group names and pass them to CMake
1914 using the `ICINGA2_USER`, `ICINGA2_GROUP` and `ICINGA2_COMMAND_GROUP` variables.
1918 # groupadd icingacmd
1919 # useradd -c "icinga" -s /sbin/nologin -G icingacmd -g icinga icinga
1922 On Alpine (which uses ash busybox) you can run:
1925 # addgroup -S icinga
1926 # addgroup -S icingacmd
1927 # adduser -S -D -H -h /var/spool/icinga2 -s /sbin/nologin -G icinga -g icinga icinga
1928 # adduser icinga icingacmd
1931 Add the web server user to the icingacmd group in order to grant it write
1932 permissions to the external command pipe and livestatus socket:
1935 # usermod -a -G icingacmd www-data
1938 Make sure to replace "www-data" with the name of the user your web server
1941 ### Building Icinga 2: Example <a id="development-package-builds-example"></a>
1943 Once you have installed all the necessary build requirements you can build
1944 Icinga 2 using the following commands:
1947 $ mkdir release && cd release
1951 $ make install -C release
1954 You can specify an alternative installation prefix using `-DCMAKE_INSTALL_PREFIX`:
1957 $ cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/icinga2
1960 ### CMake Variables <a id="development-package-builds-cmake-variables"></a>
1962 In addition to `CMAKE_INSTALL_PREFIX` here are most of the supported Icinga-specific cmake variables.
1964 For all variables regarding defaults paths on in CMake, see
1965 [GNUInstallDirs](https://cmake.org/cmake/help/latest/module/GNUInstallDirs.html).
1967 Also see `CMakeLists.txt` for details.
1969 #### System Environment
1971 * `CMAKE_INSTALL_SYSCONFDIR`: The configuration directory; defaults to `CMAKE_INSTALL_PREFIX/etc`
1972 * `CMAKE_INSTALL_LOCALSTATEDIR`: The state directory; defaults to `CMAKE_INSTALL_PREFIX/var`
1973 * `ICINGA2_CONFIGDIR`: Main config directory; defaults to `CMAKE_INSTALL_SYSCONFDIR/icinga2` usually `/etc/icinga2`
1974 * `ICINGA2_CACHEDIR`: Directory for cache files; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/cache/icinga2` usually `/var/cache/icinga2`
1975 * `ICINGA2_DATADIR`: Data directory for the daemon; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/lib/icinga2` usually `/var/lib/icinga2`
1976 * `ICINGA2_LOGDIR`: Logfiles of the daemon; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/log/icinga2 usually `/var/log/icinga2`
1977 * `ICINGA2_SPOOLDIR`: Spooling directory ; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/spool/icinga2` usually `/var/spool/icinga2`
1978 * `ICINGA2_INITRUNDIR`: Runtime data for the init system; defaults to `CMAKE_INSTALL_LOCALSTATEDIR/run/icinga2` usually `/run/icinga2`
1979 * `ICINGA2_GIT_VERSION_INFO`: Whether to use Git to determine the version number; defaults to `ON`
1980 * `ICINGA2_USER`: The user Icinga 2 should run as; defaults to `icinga`
1981 * `ICINGA2_GROUP`: The group Icinga 2 should run as; defaults to `icinga`
1982 * `ICINGA2_COMMAND_GROUP`: The command group Icinga 2 should use; defaults to `icingacmd`
1983 * `ICINGA2_SYSCONFIGFILE`: Where to put the config file the initscript/systemd pulls it's dirs from;
1984 * defaults to `CMAKE_INSTALL_PREFIX/etc/sysconfig/icinga2`
1985 * `ICINGA2_PLUGINDIR`: The path for the Monitoring Plugins project binaries; defaults to `/usr/lib/nagios/plugins`
1987 #### Build Optimization
1989 * `ICINGA2_UNITY_BUILD`: Whether to perform a unity build; defaults to `ON`. Note: This requires additional memory and is not advised for building VMs, Docker for Mac and embedded hardware.
1990 * `ICINGA2_LTO_BUILD`: Whether to use link time optimization (LTO); defaults to `OFF`
1994 * `USE_SYSTEMD=ON|OFF`: Use systemd or a classic SysV initscript; defaults to `OFF`
1995 * `INSTALL_SYSTEMD_SERVICE_AND_INITSCRIPT=ON|OFF` Force install both the systemd service definition file
1996 and the SysV initscript in parallel, regardless of how `USE_SYSTEMD` is set.
1997 Only use this for special packaging purposes and if you know what you are doing.
2002 * `ICINGA2_WITH_CHECKER`: Determines whether the checker module is built; defaults to `ON`
2003 * `ICINGA2_WITH_COMPAT`: Determines whether the compat module is built; defaults to `ON`
2004 * `ICINGA2_WITH_LIVESTATUS`: Determines whether the Livestatus module is built; defaults to `ON`
2005 * `ICINGA2_WITH_NOTIFICATION`: Determines whether the notification module is built; defaults to `ON`
2006 * `ICINGA2_WITH_PERFDATA`: Determines whether the perfdata module is built; defaults to `ON`
2007 * `ICINGA2_WITH_TESTS`: Determines whether the unit tests are built; defaults to `ON`
2009 #### MySQL or MariaDB
2011 The following settings can be tuned for the MySQL / MariaDB IDO feature.
2013 * `ICINGA2_WITH_MYSQL`: Determines whether the MySQL IDO module is built; defaults to `ON`
2014 * `MYSQL_CLIENT_LIBS`: Client implementation used (mysqlclient / mariadbclient); defaults searches for `mysqlclient` and `mariadbclient`
2015 * `MYSQL_INCLUDE_DIR`: Directory containing include files for the mysqlclient; default empty -
2016 checking multiple paths like `/usr/include/mysql`
2018 See [FindMySQL.cmake](https://github.com/Icinga/icinga2/blob/master/third-party/cmake/FindMySQL.cmake)
2019 for implementation details.
2023 The following settings can be tuned for the PostgreSQL IDO feature.
2025 * `ICINGA2_WITH_PGSQL`: Determines whether the PostgreSQL IDO module is built; defaults to `ON`
2026 * `PostgreSQL_INCLUDE_DIR`: Top-level directory containing the PostgreSQL include directories
2027 * `PostgreSQL_LIBRARY`: File path to PostgreSQL library : libpq.so (or libpq.so.[ver] file)
2029 See [FindPostgreSQL.cmake](https://github.com/Icinga/icinga2/blob/master/third-party/cmake/FindPostgreSQL.cmake)
2030 for implementation details.
2032 #### Version detection
2034 CMake determines the Icinga 2 version number using `git describe` if the
2035 source directory is contained in a Git repository. Otherwise the version number
2036 is extracted from the [VERSION](VERSION) file. This behavior can be
2037 overridden by creating a file called `icinga-version.h.force` in the source
2038 directory. Alternatively the `-DICINGA2_GIT_VERSION_INFO=OFF` option for CMake
2039 can be used to disable the usage of `git describe`.
2042 ### Building RPMs <a id="development-package-builds-rpms"></a>
2044 #### Build Environment on RHEL, CentOS, Fedora, Amazon Linux
2046 Setup your build environment:
2049 yum -y install rpmdevtools
2052 #### Build Environment on SuSE/SLES
2057 zypper addrepo http://download.opensuse.org/repositories/devel:tools/SLE_12_SP4/devel:tools.repo
2059 zypper install rpmdevtools spectool
2065 zypper addrepo http://download.opensuse.org/repositories/devel:tools/openSUSE_Leap_15.0/devel:tools.repo
2067 zypper install rpmdevtools spectool
2070 #### Package Builds <a id="development-package-builds-rpms-package-builds"></a>
2072 Prepare the rpmbuild directory tree:
2082 curl https://raw.githubusercontent.com/Icinga/rpm-icinga2/master/icinga2.spec -o $HOME/rpmbuild/SPECS/icinga2.spec
2087 > The above command builds snapshot packages. Change to the `release` branch
2088 > for release package builds.
2090 Copy the tarball to `rpmbuild/SOURCES` e.g. by using the `spectool` binary
2091 provided with `rpmdevtools`:
2094 cd $HOME/rpmbuild/SOURCES
2095 spectool -g ../SPECS/icinga2.spec
2100 Install the build dependencies. Example for CentOS 7:
2103 yum -y install libedit-devel ncurses-devel gcc-c++ libstdc++-devel openssl-devel \
2104 cmake flex bison boost-devel systemd mysql-devel postgresql-devel httpd \
2105 selinux-policy-devel checkpolicy selinux-policy selinux-policy-doc
2108 Note: If you are using Amazon Linux, systemd is not required.
2110 A shorter way is available using the `yum-builddep` command on RHEL based systems:
2113 yum-builddep SPECS/icinga2.spec
2119 rpmbuild -ba SPECS/icinga2.spec
2122 #### Additional Hints <a id="development-package-builds-rpms-additional-hints"></a>
2124 ##### SELinux policy module
2126 The following packages are required to build the SELinux policy module:
2129 * selinux-policy (selinux-policy on CentOS 6, selinux-policy-devel on CentOS 7)
2130 * selinux-policy-doc
2134 The RedHat Developer Toolset is required for building Icinga 2 beforehand.
2135 This contains a modern version of flex and a C++ compiler which supports
2138 cat >/etc/yum.repos.d/devtools-2.repo <<REPO
2139 [testing-devtools-2-centos-\$releasever]
2140 name=testing 2 devtools for CentOS $releasever
2141 baseurl=https://people.centos.org/tru/devtools-2/\$releasever/\$basearch/RPMS
2146 Dependencies to devtools-2 are used in the RPM SPEC, so the correct tools
2147 should be used for building.
2149 As an alternative, you can use newer Boost packages provided on
2150 [packages.icinga.com](https://packages.icinga.com/epel).
2152 cat >$HOME/.rpmmacros <<MACROS
2159 If you prefer to build packages offline, a suitable Vagrant box is located
2160 [here](https://atlas.hashicorp.com/mvbcoding/boxes/awslinux/).
2162 ### Build Debian/Ubuntu packages <a id="development-package-builds-deb"></a>
2164 Setup your build environment on Debian/Ubuntu, copy the 'debian' directory from
2165 the Debian packaging Git repository (https://github.com/Icinga/deb-icinga2)
2166 into your source tree and run the following command:
2169 dpkg-buildpackage -uc -us
2172 ### Build Alpine Linux packages <a id="development-package-builds-alpine"></a>
2174 A simple way to setup a build environment is installing Alpine in a chroot.
2175 In this way, you can set up an Alpine build environment in a chroot under a
2176 different Linux distro.
2177 There is a script that simplifies these steps with just two commands, and
2178 can be found [here](https://github.com/alpinelinux/alpine-chroot-install).
2180 Once the build environment is installed, you can setup the system to build
2181 the packages by following [this document](https://wiki.alpinelinux.org/wiki/Creating_an_Alpine_package).
2183 ### Build Post Install Tasks <a id="development-package-builds-post-install-tasks"></a>
2185 After building Icinga 2 yourself, your package build system should at least run the following post
2186 install requirements:
2188 * enable the `checker`, `notification` and `mainlog` feature by default
2189 * run 'icinga2 api setup' in order to enable the `api` feature and generate SSL certificates for the node
2191 ### Run Icinga 2 <a id="development-package-builds-run-icinga"></a>
2193 Icinga 2 comes with a binary that takes care of loading all the relevant
2194 components (e.g. for check execution, notifications, etc.):
2199 [2016-12-08 16:44:24 +0100] information/cli: Icinga application loader (version: v2.5.4-231-gb10a6b7; debug)
2200 [2016-12-08 16:44:24 +0100] information/cli: Loading configuration file(s).
2201 [2016-12-08 16:44:25 +0100] information/ConfigItem: Committing config item(s).
2205 #### Init Script <a id="development-package-builds-init-script"></a>
2207 Icinga 2 can be started as a daemon using the provided init script:
2211 Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
2214 #### Systemd <a id="development-package-builds-systemd"></a>
2216 If your distribution uses systemd:
2219 systemctl {start|stop|reload|status|enable|disable} icinga2
2222 In case the distribution is running systemd >227, you'll also
2223 need to package and install the `etc/initsystem/icinga2.service.limits.conf`
2224 file into `/etc/systemd/system/icinga2.service.d`.
2226 #### openrc <a id="development-package-builds-openrc"></a>
2228 Or if your distribution uses openrc (like Alpine):
2232 Usage: /etc/init.d/icinga2 {start|stop|restart|reload|checkconfig|status}
2235 Note: the openrc's init.d is not shipped by default.
2236 A working init.d with openrc can be found here: (https://git.alpinelinux.org/cgit/aports/plain/community/icinga2/icinga2.initd). If you have customized some path, edit the file and adjust it according with your setup.
2237 Those few steps can be followed:
2240 wget https://git.alpinelinux.org/cgit/aports/plain/community/icinga2/icinga2.initd
2241 mv icinga2.initd /etc/init.d/icinga2
2242 chmod +x /etc/init.d/icinga2
2245 Icinga 2 reads a single configuration file which is used to specify all
2246 configuration settings (global settings, hosts, services, etc.). The
2247 configuration format is explained in detail in the [doc/](doc/) directory.
2249 By default `make install` installs example configuration files in
2250 `/usr/local/etc/icinga2` unless you have specified a different prefix or
2254 ### Windows Builds <a id="development-package-builds-windows"></a>
2256 The Windows MSI packages are located at https://packages.icinga.com/windows/
2258 #### Requirements <a id="development-package-builds-windows-requirements"></a>
2260 * 32 or 64-bit system
2261 * Visual Studio >= 14 2015
2268 Download the community edition from [visualstudio.com](https://www.visualstudio.com/en/downloads/)
2270 Workloads to install:
2275 ##### OpenSSL for Icinga
2277 Download custom OpenSSL builds from [openssl-windows GitHub project](https://github.com/Icinga/openssl-windows/releases).
2279 You need to install a binary dist version to 'C:\\Program Files\\OpenSSL'.
2281 The Powershell script `.\tools\win32\download-openssl.ps1` can be used for automated downloads.
2285 A simple package manager for Windows, please see [install instructions](https://chocolatey.org/install).
2289 Use Chocolatey, see [package details](https://chocolatey.org/packages/git).
2297 Use Chocolatey, see [package details](https://chocolatey.org/packages/winflexbison3).
2300 choco install winflexbison3
2305 Use Chocolatey, see [package details](https://chocolatey.org/packages/cmake)
2306 or download from: [cmake.org](https://cmake.org/download/)
2314 Use Chocolatey, see [package details](https://chocolatey.org/packages/wixtoolset).
2317 choco install wixtoolset
2322 Download third party Windows binaries from: [boost.org](http://www.boost.org/users/download/)
2324 For example: `https://dl.bintray.com/boostorg/release/1.65.1/binaries/boost_1_65_1-msvc-14.1-64.exe`
2327 * Must match your Visual Studio version!
2328 * CMake might not support the latest Boost version (we used CMake 3.10 and Boost 1_65_1)
2330 Run the installer exe.
2335 Run with VC Native x64 Command Prompt:
2338 powershell .\tools\win32\configure.ps1
2339 powershell .\tools\win32\build.ps1
2340 powershell .\tools\win32\test.ps1
2343 See these scripts for details.
2347 We are building [Icinga 2 with AppVeyor](https://ci.appveyor.com/project/icinga/icinga2) for testing and CI integration.
2349 Please check `appveyor.yml` for instructions.
2353 ## Advanced Development Tips <a id="development-advanced"></a>
2355 ### GDB Pretty Printers <a id="development-advanced-gdb-pretty-printer"></a>
2357 Install the `boost`, `python` and `icinga2` pretty printers. Absolute paths are required,
2358 so please make sure to update the installation paths accordingly (`pwd`).
2361 $ mkdir -p ~/.gdb_printers && cd ~/.gdb_printers
2364 Boost Pretty Printers compatible with Python 3:
2367 $ git clone https://github.com/mateidavid/Boost-Pretty-Printer.git && cd Boost-Pretty-Printer
2368 $ git checkout python-3
2370 /home/michi/.gdb_printers/Boost-Pretty-Printer
2373 Python Pretty Printers:
2376 $ cd ~/.gdb_printers
2377 $ svn co svn://gcc.gnu.org/svn/gcc/trunk/libstdc++-v3/python
2380 Icinga 2 Pretty Printers:
2383 $ mkdir -p ~/.gdb_printers/icinga2 && cd ~/.gdb_printers/icinga2
2384 $ wget https://raw.githubusercontent.com/Icinga/icinga2/master/tools/debug/gdb/icingadbg.py
2387 Now you'll need to modify/setup your `~/.gdbinit` configuration file.
2388 You can download the one from Icinga 2 and modify all paths.
2390 Example on Fedora 22:
2393 $ wget https://raw.githubusercontent.com/Icinga/icinga2/master/tools/debug/gdb/gdbinit -O ~/.gdbinit
2400 sys.path.insert(0, '/home/michi/.gdb_printers/icinga2')
2401 from icingadbg import register_icinga_printers
2402 register_icinga_printers()
2407 sys.path.insert(0, '/home/michi/.gdb_printers/python')
2408 from libstdcxx.v6.printers import register_libstdcxx_printers
2410 register_libstdcxx_printers(None)
2417 sys.path.insert(0, '/home/michi/.gdb_printers/Boost-Pretty-Printer')
2419 boost_print.register_printers()
2423 If you are getting the following error when running gdb, the `libstdcxx`
2424 printers are already preloaded in your environment and you can remove
2425 the duplicate import in your `~/.gdbinit` file.
2428 RuntimeError: pretty-printer already registered: libstdc++-v6