Skip to main content
Version: 20.04

Install Centreon MAP extension

Centreon MAP requires a valid license key. To purchase one and retrieve the necessary repositories, contact Centreon.

This chapter describes how to install Centreon MAP. The server must be installed on a dedicated machine to allow Centreon MAP to operate with its own database and avoid any potential conflict with the Centreon central server.

Before installation, be sure to review the Prerequisites chapter for system requirements (CPU and memory). Remember to choose the best type of architecture to suit your needs.

Architecture​

Centreon MAP consists of three components:

  • Centreon MAP Server, developed in Java, using SpringBoot, Hibernate and CXF
  • Centreon MAP Web interface, developed in Javascript, based on Backbone.js
  • Centreon MAP Desktop Client, developed in Java, based on Eclipse RCP 4.

The diagram below summarizes the architecture:

image

Table of network flow

ApplicationSourceDestinationPortProtocolPurpose
Map ServerMap serverCentreon central broker5758TCPGet real-time status updates
Map ServerMap serverCentreon MariaDB database3306TCPRetrieve configuration and other data from Centreon
Map ServerMap serverMap server database3306TCPStore all views and data related to Centreon MAP
Web + DesktopMap serverCentreon central80/443HTTP/HTTPSAuthentication & data retrieval
Web interfaceUserMap server8080/8443HTTP/HTTPSRetrieve views & content
Web interfaceUserInternet* (Mapbox)443HTTPSRetrieve Mapbox data
Desktop clientUserMap server8080/8443HTTP/HTTPSRetrieve and create views & content
Desktop clientUserInternet* (Mapbox)443HTTPSRetrieve Mapbox data
Desktop clientUserInternet* (p2 repo)80HTTPRetrieve automatic desktop client update

* With or without a proxy

Prerequisites​

Centreon​

The required version of Centreon software for compatibility with Centreon MAP is Centreon 20.04

Centreon must be installed using the RPM packages.

Centreon MAP Server​

License​

The server requires the license to be available and valid on Centreon's central server. To do this, you must contact the support Centreon support team to get & install your license key.

Hardware​

Hardware requirements for your dedicated Centreon MAP server are as follows:

Monitored services< 10 000< 20 000< 40 000> 40 000
CPU2 vCPU ( 3Ghz ) minimum4 CPU (3GHz) Minimum4 CPU (3GHz) MinimumAsk Centreon Support
Dedicated Memory2GB4GB8GBAsk Centreon Support
MariaDB data partition2GB5GB10GBAsk Centreon Support

To correctly implement the dedicated memory, you have to edit the JAVA_OPTS parameter in the Centreon Map configurations file /etc/centreon-studio/centreon-map.conf and restart the service:

JAVA_OPTS="-Xms512m -Xmx4G"

The Xmx value depends on the amount of memory indicated in the above table.

Then restart the service:

systemctl restart centreon-map

The space used by Centreon MAP server is directly determined by the number of elements you add into your views. An element is any graphical object in Centreon MAP. Most elements (like hosts, groups, etc.) have children which must be included in the count.

These values are applied after optimization of Centreon MAP tables.

Software​

  • OS: CentOS 7 / Redhat 7
  • DBMS: MariaDB 10.3
  • Firewall: Disabled
  • SELinux: Disabled

Information required during configuration​

  • Centreon Web login with admin rights.

Even with a correctly sized server, you should have in mind the best practices & recommandations when creating views so you don't face performance issues.

Centreon MAP Web interface​

License​

The web interface requires the license to be available and valid on Centreon's central server. To do this, you must contact the support Centreon support team to get & install your license key.

Compatibility​

The Centreon MAP Web interface is compatible with the following web browsers:

  • Google Chrome (latest version at the time of Centreon software release and above). Please visit the Google Chrome FAQ for a description of the Chrome support policy.
  • Mozilla Firefox (latest version at the time of Centreon software release and above). Please visit the Mozilla FAQ for a description of the Firefox support policy.
  • Apple Safari (latest version at the time of Centreon software release and above)
  • Microsoft Edge Chromium (latest version at the time of Centreon software release and above)

If an update to those supported browsers was to cause an incompatibility, Centreon would work on a fix in the shortest possible time (for supported Centreon versions). Though other browsers may work, Centreon will not attempt to resolve problems with browsers other than those listed above.

Your screen resolution must be at least 1280 x 768.

Centreon MAP Desktop Client​

  • 4 GB of RAM minimum, 8 GB advised (mandatory for 10,000 or more services)
  • Java 64 bits version 8
  • Resolution must be at least 1280 x 768.
  • Debian 7,8 or 9

Desktop Client is not compatible with Microsoft Windows Server. * If a version of Java other than 8 is installed, consider installing Java 8 and modifying Centreon-Map4.ini to add the following line -vm $path_to_java8$ BEFORE -vmwargs.

To optimize the desktop client, you have to "give" it more memory than the default value. Modify the following file:

C:\Users\<YOUR_USERNAME>\AppData\Local\Centreon-Map4\Centreon-Map4.ini

And add the following lines at the end of the file, on a new line:

-Xms512m
-Xmx4g

Network requirements​

Centreon MAP Server machine must access:

  • Centreon Central broker, usually on Centreon Central machine, using TCP port 5758
  • Centreon Database, usually on Centreon Central machine, using TCP port 3306
  • Centreon MAP database, usually on localhost, using TCP port 3306.

All the ports above are default values and can be changed if needed.

  • Centreon Web Central, using HTTP port 80 or HTTPS port 443

Centreon MAP Desktop Client machines must access:

  • Centreon MAP Server, using HTTP port 8080 or 8443 when HTTPS/TLS is enabled
  • Internet with or without proxy.

Ports 8080 and 8443 are recommanded default values, but other configurations are possible.

Server installation​

Centreon Web interface​

You must provide to Centreon MAP server a dedicated user who has access to all resources through the appropriate access list groups. Since the password will be stored in human-readable form in a configuration file, you should not use a Centreon admin user account.

Provide this user with access to the Centreon Web real-time API:

image

Centreon Central server​

Create a user in the mysql instance hosting 'centreon' and 'centreon_storage' databases:

CREATE USER 'centreon_map'@'<IP_SERVER_MAP>' IDENTIFIED BY 'centreon_map';
GRANT SELECT ON centreon_storage.* TO 'centreon_map'@'<IP_SERVER_MAP>';
GRANT SELECT, INSERT ON centreon.* TO 'centreon_map'@'<IP_SERVER_MAP>';

The INSERT privilege will only be used during the installation process in order to create new Centreon Broker output. It will be revoked later.

Centreon MAP server​

If you installed your Centreon MAP server from a "fresh CentOS installation" you need to install the centreon-release package:

yum install https://yum.centreon.com/standard/20.04/el7/stable/noarch/RPMS/centreon-release-20.04-1.el7.centos.noarch.rpm

If the URL doesn't work, you can manualy find this package in the folder.

Install Centreon MAP repository, you can find it on the support portal.

Then install Centreon MAP server using the following command:

yum install centreon-map-server

When installing Centreon MAP server, it will automatically install java (OpenJDK 11) if needed.

You need to have a MariaDB database to store Centreon MAP data, whether it's on localhost or somewhere else.

Configuration​

Make sure the database that stores Centreon MAP data is optimized (automatically added by the RPM in /etc/my.cnf.d/map.cnf):

max_allowed_packet = 20M
innodb_log_file_size = 200M

Then, restart MariaDB:

systemctl restart mariadb

Execute the Centreon MAP server configuration script. Two modes are available: interactive or automatic.

  • interactive (no option/default mode): Several questions will be asked to interactively fill in the installation variables.
  • automatic (--automatic or -a): The installation will be done automatically from the values set in /etc/centreon-studio/vars.sh file

If it's your first installation, we advice you to use the standard mode (interactive) and choose No when asked for advanced installation mode:

/etc/centreon-studio/configure.sh

Central server​

Before restarting Broker you must export the configuration from the Centreon Web interface.

Restart Centreon Broker on the Central server:

systemctl restart cbd

Remove the INSERT privilege from user centreon_map:

REVOKE INSERT ON centreon.* FROM 'centreon_map'@'<IP_SERVER_MAP>';

Centreon MAP server​

Check your configuration:

/etc/centreon-studio/diagnostic.sh

If configuration is correct, the centreon-map service can be started from the Centreon MAP server:

systemctl restart centreon-map

Enable the service to start up automatically on server boot:

systemctl enable centreon-map

Centreon MAP server is now started and enabled, let's install the interface part of the extension.

Web Interface installation​

Central server​

Install Centreon MAP repository, you can find it on the support portal.

Then execute the following command:

yum install centreon-map-web-client

Web​

Go to Centreon > Administration > Extensions and click on the install button:

  • License Manager (if not yet installed)
  • Map Web Client

image

You can see a red stripe asking for a license.

Upload the license map.license given by the support team. Refresh the page and the banner must be green with the valid license date.

image

Click on Back to return to the Extensions page. Now that the module is installed, we will configure it.

Configuration​

Go to Administration > Extensions > Options, and in the Centreon MAP menu update the Centreon MAP server address field:

Use the real IP address/hostname of your Centreon MAP server.

image

Using the client​

The Centreon MAP Web interface is now available in Monitoring > MAP.

image

If the content doesn't display, you may empty your browser cache

Centreon MAP Widget​

By installing the Web interface, you automatically add the Centreon MAP Widget, but you need to perform one last task. Go to Administration > Extensions and click on the "Install" button on the widget. The result after installed:

image

Desktop Client​

Executables​

The desktop client is currently available only for 64-bit Windows, Mac and Linux platforms (Debian and Ubuntu).

You can find the installers in Monitoring > Map > Desktop Client or here.

For performance considerations, we highly recommand to have less than 5, 10 users maximum connected at the same time manipulating views.

Installation​

On user's computer​

The desktop client requires Java 8. You can download and install the latest version of Java from here.

Be sure to download the 64-bit version. Browsers are usually 32-bit and the Oracle website generally proposes 32-bit Java instead of the 64-bit version. If you already have Java installed, use the java -version command to check the architecture. If 64-bit does not appear, the version is 32-bit.

On a Mac platform, note that you must install Oracle JDK instead of the usually-required JRE.

To check the Java version run the command:

java -version

Execute centreon-map4-desktop-client-xxxx.exe:

You do not need to be the administrator of your computer to perform the installation. All the files are will be installed in your personnal folders.

The default installation folder is C:\Users\$user$\AppData\LocalCentreon-Map4.

You can install the software at this location without administrator rights but can change the destination to Program files if you have the sufficient rights.

Use the installer to install the software properly and integrate it into the Windows environment. The installer can also be used to uninstall it from the Windows dedicated configuration page.

image

Updates​

Once installed, the Desktop Client is automatically kept up to date through an online update system. When it connects to a Centreon MAP server it automatically downloads and installs the latest version compatible with the server. Auto-update requires your computer to have internet access.