Versions Compared

Old Version 5

changes.mady.by.user Mathieu Carrié

Saved on

compared with

New Version 6

changes.mady.by.user Mathieu Carrié

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Context

This guide will guide through the installation and update process of Shinken Enterprise on Linux servers.

Once the steps described in this guide are completed, you will have a quick access to Configuration and Visualization interfaces with the default architecture (single server) with all daemons enabled.

If you are setting up a distributed architecture, after completing the Shinken installation on your servers, you will have to configure each daemon (names and IP address, realm, spare, Poller tags, retentions...).

Concerning the update process, the script in the package will update all daemons of your Shinken server, even if only a few daemons are enabled. The configuration of your Shinken server will not be changed.


Warning
titleImportant

When installation Shinken Enterprise, the document-oriented database management system MongoDB is installed at the v2.6.9 version. This database management system is necessary for the Configuration and Visualization interfaces. Used with MongoDB, Graphite is a tool designed to store metrics retrieved by your probes.

To avoid incompatibilities and ensure proper execution of Shinken, it is strongly discouraged to not update MongoDB/Graphite. Please keep the bundled versions of dependencies delivered with the Shinken package.




Panel
titleSommaire

Table of Contents


Shinken Entreprise installation

Prerequisites

  • Required environment: RHEL/Centos 6.6, 7.2, 7.3, 7.4, 7.5     [ 64bits ]

    Shinken Enterprise chose Linux distributions produced by RedHat: Red Hat Enterprise Linux (RHEL) and CentOS (Community enterprise Operating System). These linux distributions, mainly designed for servers are stable, performant and compatible with a vast majority of professional environments. The CentOS is also very performant (based on the commercially distributed RHEL).

    Info
    titleWarning- Redhat registration

    When installation a RedHat Enterprise Linux (commercial distribution, you must attach your RedHat subscription to your system.

    Here are the commands to use on your server:

    Voici les commandes à utiliser depuis le serveur:

    1/ subscription-manager register
    (-> username / password)

    You also need to attach your subscription to the current OS:

    2/ subscription-manager attach

    Yum can now be used because the subscription is valid (and Shinken will be able to be installed).


Package extraction

et

and installation

  • Automatic installation:

    • Extract the delivery package :
      • tar zxvf shinken-enterprise_V02.05.XXX-LANGUAGE.tar.gz
      • This will create a new directory containing the installation script and dependencies required for the installation.

    • Move to the shinken-entreprise directory (cd shinken-enterprise_V02.05.XXX-LANGUAGE) and execute the script :

Code Block
./install.sh

    • This will automatically install Shinken Enterprise and its component
      • However, the VMWare SDK will require a manual install.
      • The commands to type to launch the VMWare DSK installation are displayed at the end of the installation process:.sh :

Code Block
Please launch: 
/tmp/shinken-enterprise_V02.05.XXX-LANGUAGE/tools/install-vmware-sdk.sh
And follow the instructions in order to install it and allow VMWare communication


We advise to execute these commands directly, but they can also be performed later if needed.


Checking your Shinken Enterprise installation

  • Check the installation: 
    • To check if Shinken Enterprise has been installed correctly, launch the following command :

Code Block
shinken-healthcheck

A warning is issued as expected to say the Shinken Enterprise license key is not installed. Head over to the License key section further down on this page to install your license key.

Tip

The installation process will perform on the server:

  • The installation of the Shinken Enterprise engine, modules and dependencies
  • The activation of all daemons (Synchronizer, Arbiter, Scheduler, Poller, Reactionner, Broker, Receiver).

For a distributed installation, see the Distributed architecture page.



Web interfaces access

Configuration UI 

Once Shinken Enterprise installed, the Configuration UI can be accessed via a web browser at the address displayed during the installation:

  • By default, the Configuration UI is available via the 7766 port (HTTP protocol). For instance: http://192.168.0.1:7766


Info

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


See the Configuration UI page for more information.

Visualization UI

Once Shinken Enterprise installed, the Configuration UI can be accessed via a web browser at the address displayed during the installation:

  • By default, the Configuration UI is available via the 7767 port (HTTP protocol). For instance: http://192.168.0.1:7767


Info

The IP address (or FQDN if your name resolution is configured) corresponds to the server hosting the Broker daemon.


See the Visualization UI page for more information.

Intégration du guide d'utilisateur dans le package

The User Guide (in French) is now integrated  in the installation package.

it can be found in: shinken-enterprise_V02.05.XXX-LANGUAGE.tar.gz/tools/documentation/ui-visualisation/


A user can access this guide by opening the "index.html" file found in this folder.

Installation (advanced mode)

Anchor
Installation Mode Avancé
Installation Mode Avancé


  • Automatic partial installation (only enables selected daemons):
    • Extract the package archive
      • tar zxvf shinken-enterprise_V02.05.XXX-LANGUAGE.tar.gz
      • This will create a new directory containing the installation script and dependencies required for the installation.

    • Move to the shinken-entreprise directory (cd shinken-enterprise_V02.05.XXX-LANGUAGE) and execute the install.sh script, passing the following options based on the daemons you want to enable:

      • --pollernode: Enables the Poller daemon (responsible for check execution)

      • --reactionnernode: Enables the Reactionner daemon (responsible for notifications and event handlers)

      • --schedulernode: Enables the Scheduler daemon (responsible for the planification of the checks execution)

      • --arbiternode: Enables the Arbiter daemon (responsible for the central distribution of configuration and informations)

      • --receivernode: Enables the Receiver daemon (responsible for receiving results for passive checks)

      • --synchronizernode: Enables the Synchronizer daemon (responsible for configuration management)

      • --brokernode: Enables the Broker daemon (responsible for presenting the checks results and data the the world: Visualization UI, SLA)

 

Info
titleExemple

You can for example install Shinken Enterprise and enable only the Scheduler and Pollers daemons by launching the command:


Code Block
./install.sh --schedulernode --pollernode




      • To check that the selected daemons are up to date, correctly configured and running, launch the following command:
Code Block
shinken-healthcheck


The shinken-healthcheck checks that Shinken Enterprise configuration is correct and coherent, and is running (only for enabled daemons)

  • After the initial installation, if you want to enable/disable daemons, use the activation commands detailed in the 

Shinken-healthcheck vérifiera alors que Shinken Entreprise est bien configuré et en cours d'exécution (seulement pour les démons installés)

  • Après l'installation initiale, si vous souhaitez activer/désactiver des démons, utilisez la commande d'activation détaillée dans le chapitre Activation/Désactivation des démons.
  • Lors d'une mise à jour, le script update.sh prends en compte les démons qui sont activés ou non.
  • Daemons listing/enable/disable page.
  • When updating, the update.sh scripts updates all daemons, even if they are disabled. Their enabled/disabled will be kept intact.


The different addons are automatically enabled during the Les différents addons sont automatiquement activés lors de l' installation:

  • nagvis-shinken-architecture: Activé lors d'une installation d'un Arbiter (plus de détails dans la page de documentation dédiéeEnabled on installations with an Arbiter enabled (more details in the dedicated documentation page: Activation et configuration de la fonctionnalité)
  • nagvis: Activé lors d'une installation d'un Broker (plus de détails dans la page de documentation dédiéeEnabled on installations with an Broker enabled (more details in the dedicated documentation page: NagVis)

Mise en place automatique du chiffrement

Enabling data encryption

You can enable Vous pouvez mettre en place le Chiffrement des données sensibles de façon automatique au moment de l' automatically when launching the installation.

Tip

Si vous n'avez jamais activé le chiffrement des données sensibles, nous vous conseillons de procéder à l’installation sans activer le chiffrement et de découvrir la fonctionnalité par la lecture du chapitre If you never enabled the automatic encryption of sensible data, we advise to proceed to the normal installation and enabled data encryption manually after having read the Chiffrement des données sensibles.

Une clé de chiffrement sera alors générée lors du processus d'installation et la base de données du Synchronizer sera chiffrée.

documentation page.


An encryption key is generated during the installation and the Synchronizer database will be encrypted.

To enable this feature, launch the following commandPour cela, lancez la commande suivante :

Code Block
./install.sh --activate-encryption <nom de clé>  --disable-important-notices-user-input
Le paramètre
  • The --activate-
encryption permet d'activer le chiffrement ; le nom de la clé est optionel ; il vous sera demandé lors de l'exécution du programme d'installation si vous ne le précisez pas.Le paramètre
  • encryption parameter enables the encryption: the key name is optionnal; it will be asked during the installation process if not specified in the parameter.
  • The
  • --disable-important-notices-user-
input permet de désactiver les prompts vous demandant confirmation avant de continuer le processus.
Il vous est cependant fortement conseillé de lire les informations fournies lors de l'installation.
  • input parameter disables interactive prompts during the installation process.


Warning
Warning

La mise en place automatique du chiffrement nécessite dans tout les cas d'effectuer l'export et la sauvegarde de la clé générée lors du processus. Veuillez consulter  Enabling the automatic encryption of sensitive data requires to export and save the encryption key generated during the process. Please consult shinken-protected-fields-keyfile-export pour plus d' for more informations.

Shinken-healthcheck vous permettra dé vérifier la bonne configuration des démons et du chiffrement.

Mise à jour de Shinken Entreprise

Prérequis


The shinken-healthcheck can be used to check the daemons configuration and encryption status.

Updating Shinken Enterprise

Prerequisites


  • Environment Environnement : RHEL/Centos 6.6, 7.2, 7.3, 7.4 et 7.5    [64bits]     avec d'une version antérieure déjà installée.

Extraction et mise à jour

  •  with a previous Shinken Enterprise version installed.

Package extraction and updates

  • Updating:
    • Extract the package archive
    Mise à jour:
    • « Dé-tarez » le package qui vous a été transmis :
      • tar zxvf shinken-enterprise_V02.05.XXX-LANGUAGE.tar.gz
      • Cela vous créera un répertoire shinken-entreprise contenant le script de mise à jour et les dépendances nécessaires à la mise à jour.
      • This will create a new directory containing the installation script and dependencies required for the installation.
    • Move into the  Déplacez vous dans le répertoire shinken-entreprise folder (cd shinken-enterprise_V02.05.XXX-LANGUAGE) et exécutez le  and execute the script :

Code Block
./update.sh


      • Il mettra à jour Shinken Entreprise mais n'aura aucune incidence sur le dossier de configuration de This script updates Shinken Enterprise but does not overwrite files in /etc/shinken, évitant tout risque d’écrasement d'une configuration que vous auriez définie. 
      • Au lieu d'écraser votre paramétrage, des fichiers "*.cfg.rpmnew" seront ajoutés. De nouvelles propriétés pourront figurer dans ces fichiers, il est donc conseiller de parcourir ces fichiers et si besoin, récupérer ces nouvelles propriétés pour les intégrer dans votre architecture.
      • avoiding overwriting configuration defined by the Shinken administrator. Instead of overwriting your configuration files, "*.rpmnew" files are added, that may contain new configuration properties. It is advised to check these files after updating to report possible new features in your existing configuration files.
      • Before updating, a backup of configuration and user data is done and placed into /tmp. These backup follow the following naming conventionAvant la mise à jour, une sauvegarde de la configuration et des données utilisateur est effectuée et placée dans /tmp. Ces sauvegardes sont nommées de la manière suivante: "backup-preupdate-version-NUMERO_VERSION".

Vérification du bon fonctionnement

Checking your Shinken Enterprise installation



      • The shinken-healthcheck tool can be used to check daemons configuration and running statePour vérifier que Shinken Entreprise est bien mis à jour, configuré et fonctionnel, lancez la commande :

Code Block
shinken-healthcheck


Mise à jour des checks via la source

Updating configuration objects via the cfg-file-shinken

source

During Shinken Enterprise installation, lots of checks (via Lors de l'installation de Shinken, nous incluons de nombreux checks (via des modèles du Pack Shinken, Linux, Windows,.. templates) .Ces éléments de ces packs (checks, modèles, commandes) sont disponibles au travers de la source are imported in the Configuration UI. These elements, grouped into packs, are available and importedusing the "cfg-file-shinken" :source.

Panel



When updating, these elements may be updated, but these changes are not automatically integrated into your monitoring configuration to avoid unintentional behaviour or breaking changes. To see the changes, make sure the "cfg-file-shinken" source is enabled and import the source. The changed elements will appear with the "New" of "Difference" status.

Lors d'une update, nous vous fournissons également toutes les mises à jour de ces packs, nous vous conseillons donc d'activer la source et de bien regarder les mises à jour possibles, via les éléments qui apparaîtront en "nouveau" et en "différence".

Info

Si vous avez déjà fait des personnalisations sur les éléments de ces packs, soyez vigilant avant d'appliquer les différences.
Cependant, nous vous conseillons au minimum de mettre à jour les éléments relatifs au Pack Shinken. (éléments en "nouveau" et en "différence")

If you made changes on elements of these pacjs, be careful before applying differences because your changes could be overwritten or lost.

However, it is strongly advised to systematically update at least the elements of the Shinken pack (new and differences).


Shinken Enterprise license key

Clé de licence Shinken Enterprise

Anchor
clédelicence
clédelicence
Une fois Once Shinken Enterprise installéis installed, la commande the shinken-healthcheck lancée depuis votre serveur Arbiter affichera un message d'erreur au sujet de la licence:

La licence par défaut installée est une licence d'essai. Vous ne pourrez placer en supervision qu'un très faible nombre d'hôtes

command launched from the server hosting the Arbiter daemon displays an error message concerning your license. The default license is a trial license, limited to 20 hosts.


Panel


Le service Commercial de The Shinken Enterprise a dû vous envoyer une licence nominative vous permettant d'utiliser pleinement le produit.

La licence est un fichier qui a le nom suivant : user.key et cette licence est nominative et limitée dans le temps.

Pour l'installer, rien de plus simple, il suffit de :

Placer ce fichier sur le serveur hébergeant l'Arbiter, dans le chemin suivant :

commercial service should have sent a nominative license allowing you to use the product to its full potential.

The license is a file name user.key, nominative and limite in time.

To install it:

  • Copy this file on the Arbiter server to /etc/shinken/user.key
Redémarrez alors
  • Restart Shinken Enterprise
via la commande : service
  • : /etc/init.d/shinken restart

Relancez alors la commandeRelaunch the shinken-healthcheck le message d'erreur de licence doit avoir disparu et voici un exemple d'information de licence valide :command. The error message concerning the license should have disappeared to be replaced with an informative text about your license;

Panel

Si vous n'avez pas de clé de licence ou que celle ci a expiré contactez-nous : If you don't have a license key or if your license key has expired, contact us: contact@shinken-solutions.com