Requirements

• Fresh system of Ubuntu Xenial
• PHP ≥ 5.5.9
• PHP Composer
• MySQL-Server
• Working Nagios or Naemon configuration
• Fresh installation of openITCOCKPIT (on a separate machine)

Limitations

By writing your configurations files by hand, you have a lot of freedoms. Unfortunately it is very hard to automatically import complex configuration files.
Instead of implementing every possible scenario, we decided to implement a default behavior which should fit 90% of the configurations out there.

Timeperiods

openITCOCKPIT only supports time periods, which are using weekdays defined by there name, like in the following example:

define timeperiod{
    timeperiod_name                     24x7
    alias                               24x7
    monday                              00:00-24:00
    tuesday                             00:00-24:00
    wednesday                           00:00-24:00
    thursday                            00:00-24:00
    friday                              00:00-24:00
    saturday                            00:00-24:00
    sunday                              00:00-24:00
}

So maybe your definition of some complex time periods is broken after the import. If you use complex time periods, you should check this after the import process is done.

Host- and Service templates

openITCOCKPIT requires an host or service template for every host or service, that should be created. You can read more about host and service templates in our Beginners guide. Due to the fact, that the objects which are defined with register 0 are missing in the database, our import script needs to "guess" them.

Host templates

Every host that will be created by the import script, simply uses the default host template with the id 1.
This host template exists by default on every openITCOCKPIT system.

Service templates

The import script will create an service template of every check command, which is defined in your configuration files.
The service template name, will be the same as the command name, converted to uppercase. So the check command check_ping will become the service template CHECK_PING.
To keep the templates as generic as possible, the importer will set the following fields check_interval, retry_interval, notification_interval, active_checks_enabled and process_perf_data to the most used value.

For example, you have ten Services using the check command check_ping with an check_interval of 1 and two services with an check_interval of 15. Than the service template will use the value 1 as default value for check_interval.
Please notice: The custom value for check_interval is not lost! The service will just overwrite the service template value with 15.

Host- and Service escalations

The migration uses Statusengine as database backend, which does not support the dumping host and service escalation configuration to the database anymore.
For this reason, you need to recreate your host and services escalations after the migration process.

Host- and Service depandencies

Same as for Host- and Service escalations. You need to recreate your host and services depandencies after the migration process.

Install openITCOCKPIT

First of all, you need to install an instance of openITCOCKPIT. Please visit the download section for more information.

Build up the importer system

We will use Ubuntu Xenial (16.04) in this example.
All commands needs to be executed by user root!

1. Install Naemon Core

We will just use this machine to dump your monitoring configuration to a MySQL database. It is not important that the checks really work!

It does not matter if your current monitoring configuration is running on Nagios 3.x, Nagios 4.x or Naemon.

cd /tmp
wget https://labs.consol.de/naemon/release/v1.0.6/ubuntu16.04/amd64/naemon-core_1.0.6_ubuntu16.04_amd64.deb
wget https://labs.consol.de/naemon/release/v1.0.6/ubuntu16.04/amd64/libnaemon_1.0.6_ubuntu16.04_amd64.deb
dpkg -i libnaemon_1.0.6_ubuntu16.04_amd64.deb naemon-core_1.0.6_ubuntu16.04_amd64.deb
apt-get install -f -y
systemctl stop naemon
systemctl stop postfix

2. Install Statusengine database backend

Statusengine (2.x) will dump all Naemon configuration items to a MySQL database.

apt-get install mysql-server
cd /tmp
wget https://github.com/nook24/statusengine/archive/2.1.3-1.tar.gz
tar xfv 2.1.3-1.tar.gz
cd statusengine-2.1.3-1/
./install.sh
cp statusengine/src/statusengine-naemon-1-0-5.o /opt/statusengine/statusengine-naemon-1-0-5.o
echo "broker_module=/opt/statusengine/statusengine-naemon-1-0-5.o use_log_data=0" > /etc/naemon/module-conf.d/statusengine.cfg

Database setup

Now you need to connect Statusengine with your database. Due to the fact, that the system will only live for a very short time, we will use the MySQL root user for everything.

Open the file /opt/statusengine/cakephp/app/Config/database.php and search for the line public $legacy = array(.
Now pass your mysql root credentials, like in this example:

public $legacy = array(
    'datasource' => 'Database/Mysql',
    'persistent' => false,
    'host' => 'localhost',
    'login' => 'root',
    'password' => 'passw0rd',
    'database' => 'naemon',
    'prefix' => 'naemon_',
    'encoding' => 'utf8',
);

Now we can creat the database and table schema.

cd /tmp/statusengine-2.1.3-1/
mysql -u root -p < sql/naemon.sql
/opt/statusengine/cakephp/app/Console/cake schema update -y --plugin Legacy --file legacy_schema_innodb.php --connection legacy

3. Import your existing configuration

Copy the file objects.cache from your current monitoring system to /etc/naemon/conf.d/.

scp root@current-monitoring.lan:/opt/naemon/var/objects.cache /etc/naemon/conf.d/objects.cache

If you don't know where this file is located on your currently running monitoring machine, open the nagios.cfg or naemon.cfg and look out for the line object_cache_file=/opt/naemon/var/objects.cache.

Load your existing configuration

After you copied the file objects.cache, you are new ready to load the configuration in the file /etc/naemon/naemon.cfg.
Remove all predefined cfg_dir and cfg_file lines and add the following two lines:

cfg_dir=/etc/naemon/conf.d/templates/
cfg_file=/etc/naemon/conf.d/objects.cache

4. Start Naemon Core - in foreground mode

As already mentioned, we only need this system to dump all configuration objects to the MySQL database.
For this reason, we switch the the user naemon and start Naemon Core in foreground.

sudo -u naemon /bin/bash
naemon /etc/naemon/naemon.cfg

Press CTRL+C as soon as you can see these line (or after 10 minutes):
Successfully launched command file worker with pid 21162
At this point, all configuration objects where put to the gearman-job-server and we don't need the Naemon Core anymore.
Type exit to switch back to the user root

5. Start Statusengine - in foreground mode

Now you need to start Statusengine, also in foreground mode, to get all required data into the database.

/opt/statusengine/cakephp/app/Console/cake statusengine_legacy -w

As soon as you can see the line Info: Finished dumping objects you can kill Statusengine by pressing CTRL+C.
Alternatively you can kill it after 10 minutes.

Migrate configuration to openITCOCKPIT

The openITCOCKPIT Configuration Importer it self is a PHP script. It will connect the the MySQL database to get all your configuration items, and create all objects on the openITCOCKPIT system via the HTTP API.

1. Install PHP Composer

apt-get install git php-zip php-mysql

cd /tmp
curl -o composer-setup.php  https://getcomposer.org/installer
php composer-setup.php
cp composer.phar /usr/local/bin/composer

2. Download openITCOCKPIT Nagios Migration tool

cd /tmp
git clone https://github.com/it-novum/openITCOCKPIT-configuration-import.git
cd openITCOCKPIT-configuration-import/
composer install

3. Copy resource.cfg

If you also want to migrate all $USERx$ macros, you need to copy your resource.cfg from your current monitoring system.

scp root@current-monitoring.lan:/opt/openitc/nagios/etc/resource.cfg /tmp/openITCOCKPIT-configuration-import/resource.cfg

If you don't know where this file is located on your currently running monitoring machine, open the nagios.cfg or naemon.cfg and look out for the line resource_file=/opt/openitc/nagios/etc/resource.cfg.

4. Configuration

You can set various configuration options. Open the file etc/config.yml and adjust the folowing values to your environment

# Set the same value, as you use in your nagios.cfg or naemon.cfg.
interval_length: 60

# Path where the Importer will search for the resource.cfg
resource_cfg: resource.cfg

# 1 is the default config type of Statusengine - do not change
config_type: 1

# MySQL database host
mysql_host: 127.0.0.1

# MySQL database user
mysql_user: root

# MySQL database password
mysql_password: passw0rd

# MySQL database
mysql_database: naemon

# MySQL database table prefix
mysql_table_prefix: naemon

# IP address of your openITCOCKPIT V3 System
oitc_host: 192.168.1.10

# e-mail address for login
oitc_user: admin@openitcockpit.io

# Password of the given user
oitc_password: password123

5. Start migration

Now you are ready to start the migration process.

php bin/Importer.php

If the process is finished, you can destroy this machine and continue working with openITCOCKPIT!

Found a bug or have some issues?

If you found a bug or have some issues running the import script, please create an issue at our GitHub repository.