Contexte

Ce guide vous permettra d'installer Shinken Entreprise sur un serveur Linux.

Une fois le guide d'installation suivi, vous aurez rapidement accès à l'interface de Configuration et de Visualisation de Shinken dans une architecture par défaut, c'est-à-dire sur un serveur simple, sur lequel tous les démons seront activés.

Si votre serveur fait parti d'une architecture distribuée, il vous faudra passer à la phase de configuration de vos démons

• noms et IP des serveurs,
• royaume,
• spare,
• Tag des Pollers,
• rétention de données...

En ce qui concerne la procédure de mise à jour, le script "d'update" vous permettra de mettre à jour votre serveur Shinken de manière complète, même si quelques démons sont seulement activés.

La configuration de votre serveur Shinken ne sera pas modifiée.

Historique de l'installeur

Concernant l'installeur à utiliser, il faut prendre le dernier en date.

02.08.01

Voici l'historique des installeurs de la version 02.08.01:

02.08.01.01

Voici l'historique des installeurs de la version 02.08.01.01:

Installation de Shinken Entreprise

Prérequis

Concernant l'OS

Environnement requis : 

• Centos : 6.10, 7.2, 7.3, 7.4, 7.5, 7.6, 7.7, 7.8, 7.9
• RHEL : 8.5, 8.6, 8.7 [ 64bits ]

Shinken Entreprise a choisi les distributions produites par Red Hat : Red Hat Enterprise Linux (RHEL) et CentOS  ( Community  enterprise  Operating  System). Ces distributions Linux, principalement destinées aux serveurs, sont stables, performantes et compatibles avec une très grande majorité des environnements professionnels.

• Red Hat Enterprise Linux (RHEL) est la distribution référente dans l'écosystème professionnel Linux
• CentOS est une distribution dont tous ses paquets, à l'exception du logo, sont des paquets compilés à partir des sources de la distribution Red Hat Enterprise Linux (RHEL)
  • Elle est donc quasiment identique à celle-ci et se veut 100 % compatible d'un point de vue binaire
    

Concernant le support de ces distributions:

Concernant la transformation de la Centos en Centos Stream ( Béta de la Redhat )

Redhat a changé sa politique concernant la Centos, qui devient maintenant une version Béta à la RHEL.
Là ou précédemment elle était une recompilation à l'identique d'une RHEL, elle est désormais une distribution sans version fixe (dite "rolling release") en amont de RHEL :

• qui sert à RedHat afin de tester des nouvelles versions de paquets, avant leur sélection si les tests sont fonctionnels dans la RHEL.
• Elle récupère ainsi le rôle qu'avait la Fedora avant elle.
• Elle ne nous semble donc pas viable pour une utilisation professionnelle en production.

Il y a donc 2 axes possibles :

• Vous restez sur Centos 7, le temps qu'un remplaçant se démarque.
  • Le support de la Centos 7 va jusqu'en Juin 2024, ce que laisse une marge conséquente.
  • Dés qu'un remplaçant sera suffisamment stable, nous intégrerons cette OS dans nos mécanismes d'installation / mise à jour  / patch
• Passer vos Centos en Redhat.

Notre recherche du remplaçant de Centos

Pour le remplacement de Centos 7, pour l'instant nous attendons qu'une distribution fasse consensus sur le marché afin de partir sur une distribution pérenne, pour les prochaines années. Actuellement, nous suivons de prêt l'évolution de deux distributions, clones de Centos:

• Rockylinux ( par le créateur initial de Centos )
• Almalinux ( par la société CloudLinux )

Transformer une Centos en Redhat

RedHat a mis à disposition un outil de conversion CentOS 7.9 vers RedHat 7.9 qui est convert2rhel.

• Il vous faudra posséder un compte et une licences valide pour procéder à cette conversion.

Suite à nos tests, la conversion d'un serveur avec Shinken déjà installé est fonctionnelle et n'a aucun impact sur notre outil.

Concernant la Redhat

Prérequis CPU

La langage de programmation python n'ayant actuellement pas la possibilité d'utiliser plusieurs processus ( multithreading ), chaque démon utilise un ou plusieurs processus :

• Synchronizer
  • 1 Pour l'interface de Configuration
  • 1 Pour le démon
• Broker
  • 1 Par l'interface de Visualisation
  • 1 Pour le démon
• Arbiter
• Receiver
• Reactionner
• Scheduler
• Poller

Extraction du package et installation

Installation automatique :

Il faut être loggué en tant que root,

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

Et que le umask du compte root soit à 0022

$umask 0022

« Décompresser » le package qui vous a été transmis :

• tar zxvf shinken-enterprise_V02.08.XX- LANGUAGE .tar.gz
• Cela vous créera un répertoire shinken-entreprise  contenant le script d’installation et les dépendances nécessaires à l’installation.
  
  

Déplacez-vous à la base du répertoire shinken-entreprise  ( cd shinken-enterprise_V02.08.XX- LANGUAGE )  et exécutez le script :

./install.sh

Il installera Shinken Entreprise et ses composants automatiquement.

• Le SDK VMWare nécessaire aux checks est maintenant installé automatiquement (  nécessitait une installation manuelle dans les versions précédentes ) .
• Pour obtenir plus d'informations sur la consommation des démons et améliorer le fonctionnement de Shinken lorsqu'il est installé sur une machine virtuelle VMWare, le paquet "open-vm-tools" doit être installé manuellement :
  
  

yum install open-vm-tools

Vérification du bon fonctionnement

Vérification : 

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

shinken-healthcheck

Votre licence Shinken Enterprise n'est pas installée, c'est normal, dirigez-vous dans la section Clé de licence plus bas sur cette page afin d'installer votre clé.

Accès aux interfaces web

Interface Utilisateur ( UI ) de configuration 

Une fois Shinken Enterprise installé, pour accéder à l'UI de configuration, vous devez pointer votre navigateur Web vers l'adresse affichée durant l'installation.

• Par défaut, l'interface de configuration est accessible sur le port dédié 7766 ( via le protocole HTTP ). Par exemple : http://192.168.0.1:7766
  
  

Voir la page Paramétrage de l'interface de Configuration pour plus d'information.

Interface Utilisateur ( UI ) de visualisation

Une fois Shinken Enterprise installé, pour accéder à l'UI de visualisation, vous devez pointer votre navigateur Web vers l'adresse affichée durant l'installation.

• Par défaut, l'interface de configuration est accessible sur le port dédié 7767 ( via le protocole HTTP ). Par exemple : http://192.168.0.1:7767
  
  

Voir la page Paramétrage de l'interface de Visualisation pour plus d'information.

Présence du guide d'utilisateur dans le package

Le guide d'utilisateur (en français) est maintenant intégré au package d'installation.

Vous pouvez le retrouver à l'intérieur de shinken-enterprise_V02.08.XX- LANGUAGE .tar.gz dans le répertoire /tools/documentation/ui-visualisation/

Il vous suffira qu'un utilisateur, via son navigateur internet, ouvre le fichier "index.html" afin de pouvoir parcourir le guide d'utilisateur, contenant la documentation liée à l'UI de visualisation.

Installation du script dump_performance.sh 

Ce script permet de stocker les informations systèmes de votre serveur Linux en local. Ces sont des informations très utiles en cas de debug avec le support Shinken.

Sa mise en place est décrite dans la page dump_performance.sh ( top / ps / cpu / kernel / healthcheck )

Installation ( Mode avancé )

Options disponibles

Choisir les démons activés pendant le processus d'installation

Il faut être logué en tant que root,

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

Et que le umask du compte root soit à 0022

$umask 0022

« Dé-tarez » le package qui vous a été transmis :

• tar zxvf shinken-enterprise_V02.08.XX- LANGUAGE .tar.gz
• Cela vous créera un répertoire shinken-entreprise contenant le script d’installation et les dépendances nécessaires à l’installation.
  
  

Déplacez-vous dans le répertoire  (cd shinken-enterprise_V02.08.XX- LANGUAGE)  et l ancez la commande ./ install.sh  mais avec des options basées sur les démons que vous souhaitez activer :

• --pollernode : active le démon Poller ( dédié au lancement des checks )
• --reactionnernode : active le démon Reactionner ( dédié au lancement des notifications )
• --schedulernode : active le démon Scheduler ( planificateur des checks )
• --arbiternode : active le démon Arbiter ( rôle de distribution centrale )
• --receivernode : active le démon Receiver ( reçois les checks passifs )
• --synchronizernode : active le démon Synchronizer ( gère la configuration )
• --brokernode : active le démon Broker ( export des données )

./install.sh --schedulernode --pollernode

Pour vérifier que les démons sélectionnés de Shinken Entreprise sont bien mis à jour, configurés et fonctionnels, lancez la commande :

shinken-healthcheck

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 prend en compte les démons qui sont activés ou non.
  

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ée:  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ée:  NagVis ( Addon ) )

Mise en place du chiffrement

Vous pouvez mettre en place le Chiffrement des données sensibles de façon automatique au moment de l'installation.

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.

Pour cela, lancez la commande suivante :

./install.sh --activate-encryption <nom de clé>  --disable-important-notices-user-input

• --activate-encryption permet d'activer le chiffrement. Le nom de la clé est optionnel toutefois il vous sera demandé lors de l'exécution du programme d'installation si vous ne le précisez pas.

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

Passer les demandes de saisies lors de l'installation

Si vous voulez automatiser l'installation de Shinken, via un script ansible par exemple, vous allez avoir besoin de désactivé les demandes de saisies lors de l'installation de Shinken.

Nous vous conseillons fortement de faire au moins une installation manuel afin de lire les informations fournies lors de l'installation avant de d'automatiser l'installation. 

• --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.

Mise en place d'un serveur sans connexion internet

Dans le cas d'un serveur qui n'a pas de connexion internet, il faut lancer l'installeur avec le paramètre suivant:

• --disable-add-public-epel : permet de ne pas installer le repository epel sur le serveur

•  --disable-epel ( DEPRECATED ): ancien nom du paramètre, sera supprimé dans le futur

Faire l'installation sur un serveur avec des repository internes ( non publics ) fixés sur une version précise

Dans le cas d'un serveur qui n'a accès qu'à des "repository" internes qui ne sont pas forcément synchronisés sur les dernières versions des "repository" centos/redhat officiel, le comportement de base de l'installeur et le script d'update sont de mettre à jour tous les packages si une mise à jour est possible, mais ceci peux entrainer des problèmes si l'installeur a une mise à jour à faire trop récente par rapport à ce qu'il a de disponible dans ses "repository".
Dans ce cas, il faut lancer avec l'option qui demande à ne pas mettre à jour les paquets s'ils sont déjà installés :

• --package-update-only-on-conflict : permet de ne pas chercher à mettre à jour les paquets déjà installés et ainsi tente d'éviter d'installer des paquets trop à jour par rapport au "repository" interne qui n'est pas à jour.

Faire l'installation sur un serveur RedHat non enregistré sur les repository RedHat

Si un serveur RedHat a un accès uniquement à des "repository" locaux, il ne sera pas enregistré directement chez RedHat. La vérification de l'installeur et du script d'update sur les RedHat se base sur la vérification de cette connexion afin de déterminer si le serveur a bien accès aux "repository". Ici cette vérification va bloquer l'installation alors que le serveur a bien accès à des "repository" locaux. Il faut alors utiliser l'option suivante :

• --skip-redhat-subscription-check: permet de ne pas lancer la vérification de la souscription du serveur auprès de RedHat ( qui doit avoir tout de même accès à des repository locaux ).

Permettre d'exclure l'installation ou la mise à jour de certaines dépendances de sondes

L'installeur permet de refuser l'installation ou la mise à jour de certaines dépendances de sondes que l'administrateur ne souhaite pas installer, comme par exemple les paquets sqlplus d'Oracle.

Les options disponibles sont:

• --packs-to-install : permet de ne sélectionner que les dépendances listées
• --packs-to-exclude : permet de ne pas installer les dépendances listées

Les "packs" disponibles pour ces options sont:

• oracle: les dépendances des sondes oracle, notaement le paquet sqlplus founis par Oracle
• mssql: les dépendances pour les sondes Mssql/Sqlserver
• nagios-checks: (seulement disponible pour l'installation sur RedHat8) les dépendances pour les sondes Nagios

L'administrateur peux choisir d'utiliser une ou l'autre des options:

--packs-to-install : nagios-checks,mssql

installera uniquement les dépendances des packs nagios-checks et mssql, donc pas les paquets pour oracle

--packs-to-exclude: oracle,nagios-checks

excluera les dépendances des dépdendances des packs oracle et nagios-checks (seulement en RedHat 8 pour ce dernier)

Clé de licence Shinken Enterprise

Le service Commercial de 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 et sur les serveurs hébergeant le ou les UIs de Visualisation , dans le chemin suivant : /etc/shinken/user.key
• Redémarrez alors Shinken Enterprise via la commande : service shinken restart

Relancez alors la commande shinken-healthcheck le message d'erreur de licence doit avoir disparu et voici un exemple d'information de licence valide :

Si vous n'avez pas de clé de licence ou que celle-ci a expiré, contactez-nous : contact@shinken-solutions.com

Résolution des problèmes liés à l'installation

Lors de l'installation des dépendances, si une machine n'est pas connectée à internet ou connectée à un repository privé, il arrive que les scripts d'installation ou de mise à jour échouent.

Dans ce cas, des fichiers sont créés dans le "home" de l'utilisateur avec lequel est effectuée l'installation/mise à jour. Ces fichiers contiennent plus de détails sur les erreurs rencontrées et peuvent être envoyés à votre contact de support Shinken Entreprise pour la correction du problème.

Pour chaque installation, un dossier est créé dans ~/shinken/versions_et_patch_installations/ et nommé comme suit:

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

• Affichage du script d'installation ( installation seulement ): shinken.enterprise.install.log
• Détails d'installation des paquets: shinken.enterprise.install.detail.log
• Nettoyage de la configuration: sanatize.update.log
• Affichage du script de mise à jour ( mise à jour seulement ): shinken.enterprise.update.log
• Backup de la configuration et données utilisateur ( mise à jour seulement )

En cas de soucis avec les installations de packages via yum, les erreurs seront présentes dans les fichiers:

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

Cas spécifique de la mise à jour d'un cluster Mongo

Dans la version V02.07.00, la base Mongodb est mise à jour. Lorsque Mongodb a été configuré pour fonctionner en tant que cluster, le comportement du script de mise à jour de Shinken Entreprise a été modifié pour prendre en compte cette configuration particulière.

Des explications détaillées sont présentes dans la page de documentation dédiée: Inférieur à V02.07.00 - Montée de version en Mongodb 3.0 (réalisée automatiquement sous conditions )

Cas spécifique d'une machine n'ayant même pas accès à des repository redhat/centos/epel

Dans des cas bien précis un serveur Shinken peux ne pas avoir accès à des repository redhat/centos/epel. Il est important de noter qu'une connexion internet n'est pas nécessaire, juste l'accès à des repository locaux est totalement suffisant.

Si même l'accès à des repository locaux n'est pas possibles, l'installation peux échouer même avec l'usage des options --disable-add-public-epel et --package-update-only-on-conflict car il peuT avoir besoin d'installer des nouveaux paquets dont les dépendances ne seront pas disponibles.

Il est cependant possible de contourner le problème en installant manuellement ces dépendances.

Une fois une installation bloquée sur le serveur, vous allez avoir la liste des paquets manquants, comme par exemple:

-> Running transaction check
--> Package at.x86_64 0:3.1.13-20.el7 will be installed
--> Package audit-libs-python.x86_64 0:2.4.1-5.el7 will be installed
-> Processing Dependency: audit-libs = 2.4.1-5.el7 for package: audit-libs-python-2.4.1-5.el7.x86_64

Dans notre cas, il manque les dépendances at et audit-libs-python pour le paquet installé audit-libs. Il faut donc récupérer leurs rpm, ainsi que ceux de leurs dépendances :

• depuis un serveur ayant un accès aux repository ( publiques ou internes ).
• il ne faut pas que ce serveur ait déjà d'installé les paquets recherchés :
  • idéalement un serveur minimal sans Shinken d'installé dessus donc, sur ce serveur, il faut installer une extension à yum qui va permettre de juste télécharger les dépendances:
    
    

yum install yum-plugin-downloadonly

Puis nous demandons:

• les deux paquets que nous recherchons
• plus le paquet déjà installés ( audit-libs ), au cas où une mise à jour serait disponible.
  
  

Ils seront téléchargés localement:

yum install -y --downloadonly --downloaddir=.  at audit-libs-python audit-libs

Dans notre cas, ceci télécharge deux paquets ( ils n'avaient pas de dépendances et le paquet audit-libs était déjà à jour ), at-3.1.13-24.el7.x86_64.rpm et audit-libs-python-2.8.5-4.el7.x86_64.rpm.

Il faut alors les envoyer sur le serveur qui n'a pas de repository et les installer localement:

rpm -Uvh at-3.1.13-24.el7.x86_64.rpm audit-libs-python-2.8.5-4.el7.x86_64.rpm

Il faut ensuite relancer l'installation, et recommencer l'opération si de nouveaux paquets manquants sont détectés.