Context

This guide will help you install Shinken Enterprise on a Linux server.

Once you've followed the installation guide, you'll have quick access to the Shinken Configuration and Visualization interface in a default architecture, i.e. on a single server, on which all daemons will be enabled.

If your server is part of a distributed architecture, you will have to go to the configuration phase of your daemons

  • server names and IPs,
  • kingdom,
  • spare,
  • Pollers Tag,
  • data retention...

As for the update procedure, the "update" script will allow you to update your Shinken server completely, even if only a few daemons are activated. The configuration of your Shinken server will not be changed.


Important

When installing Shinken Enterprise, the document-oriented database management system MongoDB is implemented with the v3.0.15. This database system will allow the proper functioning of the Configuration and Visualization interface. Used with a MongoDB database, Graphiteis a tool to store the metrics of your sensors.

So as not to create a malfunction, we ask you not to update MongoDB / Graphite. Just leave the versions provided by our services in place.

(warning) To prevent any risk, Shinken Enterprise daemons will refuse to start if the installed version of MongoDB is not the one recommended.

(warning) If a different version of MongoDB is already present on the server, the installation will be interrupted

(warning) If you upgrade Shinken Enterprise from a version prior to 2.6.1 and the MongoDB installed is not 2.6.9, the update will be interrupted


Installing Shinken Enterprise

Prerequisites

Required environment: RHEL/Centos 6.6, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8 and 7.9 [ 64bits ]

Shinken Company has chosen distributions produced by Red Hat: Red Hat Enterprise Linux (RHEL) and CentOS ( Community enterprise Operating System ).

These distributions Linux, mainly intended for servers, are stable, powerful and compatible with the vast majority of professional environments. The CentOS distribution is also very powerful ( based on a commercial distribution RHEL quality ).


  • When installing a Redhat Enterprise Linux (commercial) distribution, you must attach your Redhat subscription to your system.

    Here are the commands to use from the server:

    1/ subscription-manager register
    (-> User name / Password )

    and it must also be attached to the current OS:

    2/ subscription-manager attach

    Yum will then be able to be used correctly because the subscription will be valid. (and therefore Shinken can be installed)


CPU requirements

The python programming language does not currently have the ability to use multiple processes ( multithreading ), so each daemon uses one or more :

  • Synchronizer
    • 1 for the configuration UI
    • 1 for the daemon
  • Broker
    • 1 / Web UI
    • 1 for the daemon
  • Arbiter
  • Receiver
  • Reactionner
  • Scheduler
  • Bollard

Package extraction and installation

Automatic installation :

  • You must be logged in as root,

    $id
uid=0(root) gid=0(root)


  • And that the umask of the root account is 0022

    $umask 0022


  • "Untar" the package that was sent to you:
    • tar zxvf shinken-enterprise_V02.07.XX-LANGUAGE.tar.gz
    • This will create a directory shinken-enterprise containing the installation script and the dependencies needed for the installation.

  • Enter the directory shinken-enterprise ( cd shinken-enterprise_V02.07.XX-LANGUAGE ) and run le script :

    ./install.sh


  • It will automatically install Shinken Company and its components.
    • The VMWare SDK for checks is now installed automatically ( was requiring manual installation in previous versions ).

    • To get more information about daemon consumption and to improve the performance of Shinken when installed on a VMWare virtual machine, the "open-vm-tools" package must be installed manually:

      yum install open-vm-tools


Verification of correct operation

  • Vérification: 

    • Pour vérifier que Shinken Entreprise est bien installé, configuré et fonctionnel, lancez la commande :

      shinken-healthcheck


    • Your Shinken Enterprise license is not installed, this is normal, go to the License key below on this page to install your key.

      The complete installation will be done on the same server:

      • Installation of the Shinken Enterprise engine, modules and dependencies.
      • activation of all les démons (Synchronizer, Arbiter, Scheduler, Poller, Reactionner, Broker, Receiver).

      For a distributed installation, see the Distributed Architecture



Checking web interfaces

Configuration UI ( User Interface )

Once Shinken Enterprise is installed, to access the configuration UI, you must point your web browser to the address displayed during installation.

  • By default, the configuration interface is accessible on the dedicated port 7766 (via the HTTP protocol). For example : http://192.168.0.1:7766

The IP address ( or FQDN if your DNS resolution is operational ) corresponds to your server hosting the daemon Synchronizer.


View page Configuration - Configuration UI for more information.

Visualization UI ( User Interface )




Shinken Enterprise License Key

Once Shinken Enterprise is installed, the shinken-healthcheck launched from your Arbiter server will display an error message about the license:

The default license installed is a trial license. You will only be able to place a very small number of hosts under supervision.






The Shinken Enterprise sales department must have sent you a named license to fully use the product.

The license is a file with the following name: user.key and this licence is nominative and limited in time.

To install it, nothing could be easier, just :

  • Place this file on the server hosting the Arbiter and on the servers hosting the Visualization UI(s), in the following path: /etc/shinken/user.key
  • Then restart Shinken Enterprise with the command : service shinken restart

Then run the command again shinken-healthcheck the license error message should be gone and here is an example of valid license information:

If you don't have a license key or your license key has expired, contact us: contact@shinken-solutions.com

Troubleshooting installation issues

When installing dependencies, if a machine is not connected to the internet or connected to a private repository, the installation or update scripts may fail.

In this case, files are created in the "home" of the user with whom the installation/update is performed. These files contain more details about the errors encountered and can be sent to your Shinken Enterprise support contact for correction.




For each installation/upgrade, a folder is created in ~/shinken/versions_and_patch_installations/ and named as follows:

YYYY-MM-DD-HHhMMmSS-install-VXX.XX.XX


This folder contains the following files:

  • Display the installation script (installation only): shinken.enterprise.install.log

  • Package installation details: shinken.enterprise.install.detail.log

  • Cleaning the configuration: sanatize.update.log

  • Display the update script (update only): shinken.enterprise.update.log

  • Configuration and user data backup (update only)

In case of problems with package installations via yum, the errors will be present in the files:

  • /tmp/install.txt
  • /tmp/install_bogus.txt

Specific case of updating a Mongo cluster

In version V02.07.00, the Mongodb database is updated. When Mongodb has been configured to run as a cluster, the behaviour of the Shinken Enterprise update script has been modified to take into account this particular configuration.

Detailed explanations can be found in the dedicated documentation page: If Shinken Lower than V02.07.00 - Upgrade to Mongodb 3.0 (done automatically under conditions)